Difference between revisions of "Puppet"

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

Learn Puppet
Talk to us on #puppet-openstack on OFTC (log)
Join the conversation on our Mailing lists
All Puppet OpenStack releases and release notes
See supported platforms
Deploy your own OpenStack cloud with Puppet All-In-One
Go back to OpenStack main page

Contribute

How to submit changes
Puppet Code reviews (Gerrit)
Guidelines for code reviewers
Understand Puppet OpenStack coding style
Understand our CI jobs
How to use Launchpad Bugs and Blueprints
Trello board
Create a new Puppet module
How to backport patches to stable branches
Patch abandonment policy
Running unit testing
Running functional testing
Backport policy

Community

Open - What openness means to us
How Puppet OpenStack is governed
Participate to our Online Meetings
Puppet OpenStack core team
Puppet OpenStack release team
Puppet OpenStack PTL duty

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

Alarming (Aodh)
Key Manager (Barbican)
Telemetry (Ceilometer)
Block Storage (Cinder)
DNS (Designate)
Image service (Glance)
Time Series Database (Gnocchi)
Orchestration (Heat)
Dashboard (Horizon)
Bare Metal (Ironic)
Identity (Keystone)
Shared Filesystems (Manila)
Workflow service (Mistral)
Application catalog (Murano)
Networking (Neutron)
Compute (Nova)
Load Balancer (Octavia)
Oslo libraries (Oslo)
Benchmarking (Rally)
Data processing (Sahara)
Object Storage (Swift)
Testing (Tempest)
Deployment (TripleO)
Database service (Trove)
Deployment UI (TripleO UI)
Root Cause Analysis (Vitrage)
Message service (Zaqar)

Other repositories

Common Puppet library (OpenStackLib)
Common Ruby helper library (puppet-openstack_spec_helper)
Puppet OpenStack helpers (OpenStackExtras)
Virtual Bridging (OpenvSwitch)
Integration CI tools (Puppet OpenStack Integration)
Blueprints (Puppet OpenStack Specs) (hosted here)
Compliant tool (Cookiebutter)
Sync tool (Modulesync)

Other modules

Storage (Ceph)
Monitoring (Monasca)
Composition Layer (deprecated in Juno) (OpenStack)

@@ Line 1: / Line 1: @@
-== Developer documentation ==
+'''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/'''
-steps to get started:
+<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.
-* follow the regular process for contributing to openstack [https://wiki.openstack.org/wiki/Gerrit_Workflow]
+Puppet OpenStack is [[Open|open]] source, [[Open|openly]] designed, [[Open|openly]] developed by an [[Open|open]] community.
-* go to : settings > watched projects and add the puppet projects (all of the form stackforge/puppet-*)
+</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%>
-=== Downloading a local patch ===
+==== 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%>
-glone the relevant module from stackforge, ex:
+==== Community ====
+* [[Open]] - What openness means to us
+* How Puppet OpenStack is [http://governance.openstack.org/reference/projects/puppet-openstack.html governed]
+* Participate to our [[Meetings/Puppet|Online Meetings]]
+* Puppet OpenStack [https://review.openstack.org/#/admin/groups/134,members core team]
+* Puppet OpenStack [https://review.openstack.org/#/admin/groups/1022,members release team]
+* Puppet OpenStack [[Puppet/PTL|PTL duty]]
-    > git clone git://github.com/stackforge/puppet-openstack
+</td></tr></table>
+----
-in the patch, find the git checkout or chery-pick command, and copy it:
+<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%>
-    > git fetch https://review.openstack.org/stackforge/puppet-openstack refs/changes/52/29452/9 && git checkout FETCH_HEAD
+==== 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%>
-=== rspec puppet tests ===
+==== 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>
-==== running local tests ====
+__NOTOC__
+[[Category: Working_Groups]]
-    > mkdir vendor
+[[Category: Stackforge]]
-    > export GEM_HOME=vendor
-    > bundle install
-    > # bundle exec rake -T
-    > bundle exec rake spec
-==== writing tests ====
-  The best reference for getting started with rspec-puppet can be found [http://rspec-puppet.com/ here]