Jump to: navigation, search

Difference between revisions of "Puppet"

(→‎Puppet Modules)
(→‎Getting started)
 
(78 intermediate revisions by 18 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 OpenStack modules were written as a collaborative effort between operators deploying OpenStack environments.
+
<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 OFTC ([http://eavesdrop.openstack.org/irclogs/%23puppet-openstack/ log])
 +
* 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 modules for the OpenStack project are hosted on [http://ci.openstack.org/stackforge.html StackForge].
+
==== 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/stackforge/puppet-ceilometer stackforge/puppet-ceilometer]
+
* [[Open]] - What openness means to us
−
* [https://github.com/stackforge/puppet-cinder stackforge/puppet-cinder]
+
* How Puppet OpenStack is [http://governance.openstack.org/reference/projects/puppet-openstack.html governed]
−
* [https://github.com/stackforge/puppet-glance stackforge/puppet-glance]
+
* Participate to our [[Meetings/Puppet|Online Meetings]]
−
* [https://github.com/stackforge/puppet-horizon stackforge/puppet-horizon]
+
* Puppet OpenStack [https://review.openstack.org/#/admin/groups/134,members core team]
−
* [https://github.com/stackforge/puppet-keystone stackforge/puppet-keystone]
+
* Puppet OpenStack [https://review.openstack.org/#/admin/groups/1022,members release team]
−
* [https://github.com/stackforge/puppet-nova stackforge/puppet-nova]
+
* Puppet OpenStack [[Puppet/PTL|PTL duty]]
−
* [https://github.com/stackforge/puppet-openstack stackforge/puppet-openstack]
 
−
* [https://github.com/stackforge/puppet-openstack_dev_env stackforge/puppet-openstack_dev_env]
 
−
* [https://github.com/stackforge/puppet-quantum stackforge/puppet-quantum]
 
−
* [https://github.com/stackforge/puppet-swift stackforge/puppet-swift]
 
−
* [https://github.com/stackforge/puppet-tempest stackforge/puppet-tempest]
 
  
−
=== Branches ===
+
</td></tr></table>
 +
----
 +
<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%>
  
−
The master branch of each modules corresponds to the master branch of the current OpenStack core projects. Once released, a new branch will be created and should be considered stable.
+
==== Other repositories ====
 +
* [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%>
  
−
For example, the current master branch of stackforge/puppet-keystone is for grizzly, once released a new grizzly branch will be created, from that point onward the master branch should target the Havana release.
+
==== Other modules ====
 +
* [http://git.openstack.org/cgit/stackforge/puppet-ceph/ Storage] ('''Ceph''')
 +
* [http://git.openstack.org/cgit/openstack/puppet-monasca/ Monitoring] ('''Monasca''')
 +
* [http://git.openstack.org/cgit/stackforge/puppet-openstack/ Composition Layer] (deprecated in Juno) ('''OpenStack''')
 +
</td></tr>
 +
</table>
 +
</div>
  
−
=== Releases ===
+
__NOTOC__
−
 
+
[[Category: Working_Groups]]
−
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.
+
[[Category: Stackforge]]
−
 
 
−
Each version of OpenStack will have a related release on the forge (fosom = 1.x, grizzly = 2.x)
 
−
 
 
−
When patches are accepted against a branch targeting a stable version, this will trigger a new release to that module on the forge.
 
−
 
 
−
NOTE: the automatic triggered forge releases still have not been setup, this process will have to be manual until this is completed.
 
−
 
 
−
=== Supported Platforms ===
 
−
 
 
−
The following OS/version are supported by the modules:
 
−
* Fedora 18
 
−
* RHEL 6.4
 
−
* Ubuntu 12.04 (Precise)
 
−
* Debian 7.0 (Wheezy)
 
−
 
 
−
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 supported, but that support will be dropped soon b/c 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.
 
−
 
 
−
You can read and subscribe to the mailing list here: https://groups.google.com/a/puppetlabs.com/forum/#!forum/puppet-openstack
 
−
 
 
−
puppet-openstack@puppetlabs.com
 
−
 
 
−
=== IRC ===
 
−
 
 
−
You can talk to us directly in IRC on the '''#puppet-openstack''' 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/puppet-openstack/ Puppet OpenStack] 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-*)
 
−
 
 
−
=== 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.
 
−
 
 
−
Puppet OpenStack CI, and SmokeStack are two continuous integration environments that can be used to verify that any given patch can be used to deploy a functional multi-node environments. The integration of both of these systems is an ongoing process, so failures should be followed up on, but are not considered blockers at this moment.
 
−
 
 
−
=== 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/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]
 
−
 
 
−
==== 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.
 

Latest revision as of 15:47, 31 May 2021

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=178616"