Jump to: navigation, search

Difference between revisions of "Puppet"

(→‎How code gets merged)
(retire page (but don't strike out))
(36 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
== Introduction ==
+
'''These docs are outdated, but kept here for historical reasons and search access. To view the latest docs, please refer to http://docs.openstack.org/developer/puppet-openstack-guide/'''
  
−
The Puppet modules for OpenStack are written as a collaborative effort between OpenStack operators using Puppet.
+
<div id="mf-index">
 +
<table border=0 width=100%><tr><td>
 +
'''The Puppet OpenStack Mission:''' to bring scalable and reliable IT automation to OpenStack cloud deployments.
  
−
== Puppet Modules ==
+
Puppet OpenStack is [[Open|open]] source, [[Open|openly]] designed, [[Open|openly]] developed by an [[Open|open]] community.
 +
</td></tr>
 +
</table>
 +
<table border=0 width=100%>
 +
<tr valign=top><td width=33%>
 +
==== Getting started ====
 +
* Learn [http://docs.puppetlabs.com/ Puppet]
 +
* Talk to us on '''#puppet-openstack''' on Freenode ([http://irclog.perlgeek.de/puppet-openstack/ logs])
 +
* Join the conversation on our [[Puppet/Mailing lists|Mailing lists]]
 +
* All Puppet OpenStack [[Puppet/releases |releases]] and release notes
 +
* See [[Puppet/supported platforms |supported platforms]]
 +
* [[Puppet/Deploy|Deploy]] your own OpenStack cloud with Puppet All-In-One
 +
* Go back to [[Main_Page| OpenStack main page]]
 +
</td><td width=33%>
  
−
Puppet OpenStack modules are part of OpenStack and most have moved under the OpenStack big tent. Some modules (like ceph) remain in the stackforge namespace.
+
==== Contribute ====
 +
* '''How to [http://docs.openstack.org/infra/manual/developers.html submit changes]'''
 +
* [https://goo.gl/HWfFuX Puppet Code reviews (Gerrit)]
 +
* [http://docs.openstack.org/infra/manual/developers.html#peer-review Guidelines for code reviewers]
 +
* '''Understand Puppet OpenStack [[Puppet/Coding style|coding style]]'''
 +
* '''Understand our [[Puppet/CI| CI jobs]]'''
 +
* How to use Launchpad [[Bugs]] and [[Blueprints]]
 +
* [https://trello.com/b/4X3zxWRZ/on-going-effort Trello board]
 +
* [[Puppet/New_module|Create a new Puppet module]]
 +
* [[StableBranch#Processes|How to backport]] patches to stable branches
 +
* [[Puppet/reviews#Abandonment|Patch abandonment policy]]
 +
* [[Puppet/Unit_testing|Running unit testing]]
 +
* [[Puppet/Functional_testing|Running functional testing]]
 +
* [[Puppet/Backport_policy|Backport policy]]
 +
</td><td width=33%>
  
−
The following Puppet modules exist:
+
==== Community ====
−
* [https://github.com/openstack/puppet-ceilometer openstack/puppet-ceilometer]
+
* [[Open]] - What openness means to us
−
* [https://github.com/stackforge/puppet-ceph stackforge/puppet-ceph]
+
* How Puppet OpenStack is [http://governance.openstack.org/reference/projects/puppet-openstack.html governed]
−
* [https://github.com/openstack/puppet-cinder openstack/puppet-cinder]
+
* Participate to our [[Meetings/Puppet|Online Meetings]]
−
* [https://github.com/openstack/puppet-designate openstack/puppet-designate]
+
* Puppet OpenStack [https://review.openstack.org/#/admin/groups/134,members core team]
−
* [https://github.com/openstack/puppet-glance openstack/puppet-glance]
+
* Puppet OpenStack [https://review.openstack.org/#/admin/groups/1022,members release team]
−
* [https://github.com/openstack/puppet-gnocchi openstack/puppet-gnocchi]
+
* Puppet OpenStack [[Puppet/PTL|PTL duty]]
−
* [https://github.com/openstack/puppet-heat openstack/puppet-heat]
 
−
* [https://github.com/openstack/puppet-horizon openstack/puppet-horizon]
 
−
* [https://github.com/openstack/puppet-ironic openstack/puppet-ironic]
 
−
* [https://github.com/openstack/puppet-keystone openstack/puppet-keystone]
 
−
* [https://github.com/openstack/puppet-manila openstack/puppet-manila]
 
−
* [https://github.com/openstack/puppet-monasca openstack/puppet-monasca]
 
−
* [https://github.com/openstack/puppet-neutron openstack/puppet-neutron]
 
−
* [https://github.com/openstack/puppet-nova openstack/puppet-nova]
 
−
* [https://github.com/stackforge/puppet-openstack stackforge/puppet-openstack]
 
−
* [https://github.com/openstack/puppet-sahara openstack/puppet-sahara]
 
−
* [https://github.com/openstack/puppet-swift openstack/puppet-swift]
 
−
* [https://github.com/openstack/puppet-tempest openstack/puppet-tempest]
 
−
* [https://github.com/openstack/puppet-tripleo openstack/puppet-tripleo]
 
−
* [https://github.com/openstack/puppet-trove openstack/puppet-trove]
 
−
* [https://github.com/openstack/puppet-tuskar openstack/puppet-tuskar]
 
−
* [https://github.com/openstack/puppet-vswitch openstack/puppet-vswitch]
 
  
−
Library repository, used for common resources accross all modules:
+
</td></tr></table>
−
* [https://github.com/openstack/puppet-openstacklib openstack/puppet-openstacklib]
+
----
 +
<table border=0 width=100%><tr><td align=center width=20%>
 +
[[File:Openstack-compute-icon.png]]
 +
</td><td>
 +
Each '''Puppet OpenStack module''' corresponds to an OpenStack component and has its own Git repository. The modules produce a number of deliverable, in order to achieve a clearly stated objective: deploy OpenStack.
 +
</td></tr>
 +
</table>
 +
<table border=0 width=100%>
 +
<tr valign=top><td rowspan=2 width=33%>
 +
==== OpenStack modules ====
 +
* [http://git.openstack.org/cgit/openstack/puppet-aodh/ Alarming] (''Aodh'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-barbican/ Key Manager] (''Barbican'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-ceilometer/ Telemetry] (''Ceilometer'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-cinder/ Block Storage] (''Cinder'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-designate/ DNS] (''Designate'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-glance/ Image service] (''Glance'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-gnocchi/ Time Series Database] (''Gnocchi'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-heat/ Orchestration] (''Heat'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-horizon/ Dashboard] (''Horizon'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-ironic/ Bare Metal] (''Ironic'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-keystone/ Identity] (''Keystone'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-manila/ Shared Filesystems] (''Manila'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-mistral/ Workflow service] (''Mistral'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-murano/ Application catalog] (''Murano'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-neutron/ Networking] (''Neutron'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-nova/ Compute] (''Nova'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-octavia/ Load Balancer] (''Octavia'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-oslo/ Oslo libraries] (''Oslo'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-rally/ Benchmarking] (''Rally'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-sahara/ Data processing] (''Sahara'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-swift/ Object Storage] (''Swift'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-tempest/ Testing] (''Tempest'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-tripleo/ Deployment] (''TripleO'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-trove/ Database service] (''Trove'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-tuskar/ Deployment UI] (''TripleO UI'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-vitrage/ Root Cause Analysis] (''Vitrage'')
 +
* [http://git.openstack.org/cgit/openstack/puppet-zaqar/ Message service] (''Zaqar'')
 +
</td><td rowspan=2 width=33%>
  
−
Optional tools that can be used in composition layer and might be helpful to deploy OpenStack:
+
==== Other repositories ====
−
* [https://github.com/openstack/puppet-openstack_extras openstack/puppet-openstack_extras]
+
* [http://git.openstack.org/cgit/openstack/puppet-openstacklib/ Common Puppet library] ('''OpenStackLib''')
 +
* [http://git.openstack.org/cgit/openstack/puppet-openstack_spec_helper/ Common Ruby helper library] ('''puppet-openstack_spec_helper''')
 +
* [http://git.openstack.org/cgit/openstack/puppet-openstack_extras/ Puppet OpenStack helpers] ('''OpenStackExtras''')
 +
* [http://git.openstack.org/cgit/openstack/puppet-vswitch Virtual Bridging] ('''OpenvSwitch''')
 +
* [http://git.openstack.org/cgit/openstack/puppet-openstack-integration Integration CI tools] ('''Puppet OpenStack Integration''')
 +
* [http://git.openstack.org/cgit/openstack/puppet-openstack-specs Blueprints] ('''Puppet OpenStack Specs''') (hosted [http://specs.openstack.org/openstack/puppet-openstack-specs/ here])
 +
* [http://git.openstack.org/cgit/openstack/puppet-openstack-cookiebutter Compliant tool] ('''Cookiebutter''')
 +
* [http://git.openstack.org/cgit/openstack/puppet-modulesync-configs Sync tool] ('''Modulesync''')
 +
</td><td width=33%>
  
−
Blueprints/specs repository:
+
==== Other modules ====
−
* [https://github.com/openstack/puppet-openstack-specs openstack/puppet-openstack-specs]
+
* [http://git.openstack.org/cgit/stackforge/puppet-ceph/ Storage] ('''Ceph''')
−
 
+
* [http://git.openstack.org/cgit/openstack/puppet-monasca/ Monitoring] ('''Monasca''')
−
=== Branches ===
+
* [http://git.openstack.org/cgit/stackforge/puppet-openstack/ Composition Layer] (deprecated in Juno) ('''OpenStack''')
−
 
+
</td></tr>
−
The master branch of each modules corresponds to the latest packages available in upstream repositories. So if you submit a patch in master, it should pass beaker jobs that rely on upstream packaging (RDO in CentOS7 and UCA in Ubuntu Trusty).
+
</table>
−
 
+
</div>
−
For example, the current master branch of stackforge/puppet-keystone is targeting OpenStack Kilo, once released, a new stable/kilo branch will be created, from that point onward the master branch should target the OpenStack L release.
 
−
 
 
−
=== Releases ===
 
−
 
 
−
Master version of the modules will be released as a new major version to Puppet Forge (forge.puppetlabs.com) when its related version of OpenStack is released.
 
−
 
 
−
Each version of OpenStack have a corresponding release on the forge.
 
−
 
 
−
{| class="wikitable"
 
−
|-
 
−
! Module Version !! OpenStack Version !! OpenStack Version Codename !! Supported
 
−
|-
 
−
| 2.y.z || 2013.1.x || Grizzly || No
 
−
|-
 
−
| 3.y.z || 2013.2.x || Havana || No
 
−
|-
 
−
| 4.y.z || 2014.1.x || Icehouse || Yes
 
−
|-
 
−
| 5.z.y || 2014.2.x || Juno || Yes
 
−
|-
 
−
| 6.z.y || 2015.1.x || Kilo || Yes (current master)
 
−
|}
 
−
 
 
−
=== Supported Platforms ===
 
−
 
 
−
The following OS/version are supported by the Puppet modules:
 
−
* Fedora 18 / 19 / 20 / 21 / 22
 
−
* RHEL 6.4 / 6.5 / 7
 
−
* Ubuntu 12.04 (Precise) / 14.04 (Trusty)
 
−
* Debian 7.0 (Wheezy) / Debian 8.0 (Jessie)
 
−
 
 
−
The modules have been primarily tested on Puppet 2.7.x and Ruby 1.8.7, although they are also being used with Puppet 3.1.x, 3.0.x, with Ruby 1.9.3.
 
−
 
 
−
Puppet 2.6.x is currently NOT supported, it has been EOL'ed by PuppetLabs.
 
−
 
 
−
== Getting Help ==
 
−
 
 
−
=== Mailing list ===
 
−
 
 
−
In general, the mailing list is preferred, because it makes the information more readily available so that others who have the same question can search for and find those answers.
 
−
 
 
−
Dev discussions: openstack-dev@lists.openstack.org with [puppet] tag.
 
−
 
 
−
User discussions: puppet-openstack@puppetlabs.com
 
−
You can read and subscribe to the mailing list here: https://groups.google.com/a/puppetlabs.com/forum/#!forum/puppet-openstack
 
−
 
 
−
=== IRC ===
 
−
 
 
−
You can talk to us directly in IRC on the <code><nowiki>#puppet-openstack</nowiki></code> channel. (freenode.net)
 
−
 
 
−
IRC logs can be found [http://irclog.perlgeek.de/puppet-openstack/ here].
 
−
 
 
−
=== Reporting bugs ===
 
−
 
 
−
We are using [https://launchpad.net/ Launchpad] for bugs and features tracking. Issues and requests should be submitted under the [https://launchpad.net/openstack-puppet-modules/ OpenStack Puppet Modules] project.
 
−
 
 
−
== Developer documentation ==
 
−
 
 
−
=== Contributing to the modules ===
 
−
 
 
−
==== Getting Started ====
 
−
 
 
−
We follow the same process as all of the other OpenStack projects.
 
−
 
 
−
To contribute, the following docs contain enough information to get started:
 
−
* https://wiki.openstack.org/wiki/How_To_Contribute
 
−
* https://wiki.openstack.org/wiki/GettingTheCode
 
−
* https://wiki.openstack.org/wiki/GerritWorkflow
 
−
 
 
−
* go to : settings > watched projects and add the puppet projects (all of the form stackforge/puppet-*)
 
−
* hint: [https://groups.google.com/a/puppetlabs.com/forum/#!topic/puppet-openstack/kp202_zmYbI Download all puppet-openstack git repo using mr]
 
−
 
 
−
=== How code gets merged ===
 
−
 
 
−
Code is merged based on the voting process of the modules in Gerrit. All submitted patches automatically trigger a job that runs its rspec-puppet tests. This job is considered to be a gate in that no code is allowed to be merged that does not pass these tests. The results of this job are listed for every patch as a +1 Verified vote from Jenkins.
 
−
 
 
−
Any users can +/- 1 a commit and add comments on commit, but only members of the puppet-manager-core group have the ability to +2 and approve code to be merged.
 
−
 
 
−
=== Continuous Integration ===
 
−
 
 
−
Our modules are running CI that test different things against a patch.
 
−
You can read more about how our CI works here: [[Puppet/CI]].
 
−
 
 
−
=== Patches ===
 
−
 
 
−
Patches waiting to be merged can be viewed in Gerrit e.g. for stackforge/puppet-keystone
 
−
 
 
−
https://review.openstack.org/#/q/status:open+project:stackforge/puppet-keystone,n,z
 
−
 
 
−
Q. How do I go about submitting a patch for a released branch, what the correct process?
 
−
Unless is not relevant all patches should be approved for the master branch before you submit them for a stable branch. This ensures we maintain stability in the stable branches and functionality
 
−
 
 
−
==== Downloading a local patch ====
 
−
 
 
−
Clone the relevant module from StackForge, ex:
 
−
 
 
−
    git clone git://github.com/stackforge/puppet-openstack
 
−
 
 
−
in the patch, find the git checkout or cherry-pick command, and copy it:
 
−
 
 
−
    git fetch https://review.openstack.org/stackforge/puppet-openstack refs/changes/52/29452/9 && git checkout FETCH_HEAD
 
−
 
 
−
if you wanted to update an existing patch:
 
−
 
 
−
make a topic branch:
 
−
 
 
−
    git checkout -b my_topic
 
−
 
 
−
make your changes:
 
−
 
 
−
    hack,hack,hack
 
−
 
 
−
amend the current commit:
 
−
 
 
−
    git commit --amend .
 
−
 
 
−
now resubmit:
 
−
 
 
−
    git review
 
−
 
 
−
=== Rspec puppet tests ===
 
−
 
−
Rspec puppet tests are a requirement for getting code merged into the StackForge modules.
 
−
 
 
−
The best reference for getting started with rspec-puppet can be found [http://rspec-puppet.com/ here]
 
−
 
 
−
For a new puppet stackforge project, please see this [[Puppet-openstack/Development|page]]
 
−
 
 
−
==== Running local tests ====
 
−
 
 
−
The following command can invoked from any if the  modules' directories to run their rspec puppet tests.
 
−
 
 
−
It assumes that both bundler as well as rubygems (and ruby) are already installed on the system.
 
−
 
 
−
mkdir vendor
 
−
export GEM_HOME=vendor
 
−
bundle install
 
−
# bundle exec rake -T
 
−
bundle exec rake spec
 
−
 
 
−
This relies on the file .fixtures.yaml to install all of the external module required for testing.
 
−
The urls in this file use the git:// protocol, so this may need to be updated if you are behind a proxy.
 
−
 
 
−
=== Patch abandonment policy ===
 
−
 
 
−
If a change is submitted and given a -1, and subsequently the author becomes unresponsive for a few weeks, reviewers should leave reminder comments on the review or attempt to contact the original author via IRC or email. If the change is easy to fix, anyone should feel welcome to check out the change and resubmit it using the same change ID to preserve original authorship. Core reviewers will not abandon such a change.
 
−
 
 
−
If a change is submitted and given a -2, or it otherwise becomes clear that the change can not make it in (for example, if an alternate change was chosen to solve the problem), and the author has been unresponsive for at least 3 months, a core reviewer should abandon the change.
 
−
 
 
−
This policy is subject to change as we review our bandwidth for taking up forgotten patches and monitor our backlog growth.
 
−
 
 
−
=== stable branches ===
 
−
 
 
−
Master of the modules should be targeting the trunk of openstack as soon as a release is announced.
 
−
 
 
−
When this happens, a stable branch is created for any previous releases.
 
−
 
 
−
    ie: stable/juno
 
−
 
 
−
It is the responsibility for the patch submitted to know if their patch should be backported to previous stable branches.
 
−
 
 
−
 
 
−
The general process for this can be found here: https://wiki.openstack.org/wiki/StableBranch#Workflow
 
−
 
 
−
==== create a stable branch ====
 
−
For branching you just go to the project page on Gerrit and make a new branch under the branches option.
 
−
 
 
−
Example https://review.openstack.org/#/admin/projects/stackforge/puppet-nova,branches
 
−
 
 
−
When you first create it it doesn't really appear in git until the first commit gets pushed to it or master.
 
−
 
 
−
== [[Meetings#Puppet_OpenStack_Team_Meeting|Weekly meetings]] ==
 
−
Please see http://eavesdrop.openstack.org/#Puppet_OpenStack_Team_Meeting
 
  
 +
__NOTOC__
 
[[Category: Working_Groups]]
 
[[Category: Working_Groups]]
 
[[Category: Stackforge]]
 
[[Category: Stackforge]]

Revision as of 23:35, 18 May 2016

These docs are outdated, but kept here for historical reasons and search access. To view the latest docs, please refer to http://docs.openstack.org/developer/puppet-openstack-guide/

The Puppet OpenStack Mission: to bring scalable and reliable IT automation to OpenStack cloud deployments.

Puppet OpenStack is open source, openly designed, openly developed by an open community.

Getting started

Contribute

Community

Openstack-compute-icon.png

Each Puppet OpenStack module corresponds to an OpenStack component and has its own Git repository. The modules produce a number of deliverable, in order to achieve a clearly stated objective: deploy OpenStack.

OpenStack modules

Other repositories

Other modules

Retrieved from "https://wiki.openstack.org/w/index.php?title=Puppet&oldid=125562"