Jump to: navigation, search

Difference between revisions of "Chef/GettingStarted"

(Code)
(Remove link to meeting that no longer takes place)
(32 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This page serves as a getting started guide for community members interested in contributing to the OpenStack Chef cookbooks and example repository.
+
This page serves as a getting started guide for community members interested in introducing themselves to the OpenStack Chef cookbooks and community.
  
 
==Communication==
 
==Communication==
  
The OpenStack + Chef community has a mailing list on Google Groups. Join the conversation: https://groups.google.com/forum/?fromgroups=#!forum/opscode-chef-openstack
+
* The OpenStack + Chef community leverages the main [http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev openstack-dev mailing list] with the tag of [chef] in the subject line.
 
+
* There is an [https://webchat.freenode.net/?channels=openstack-chef #openstack-chef channel] on freenode.net. Come hang out with us and collaborate there.
There is an '''#openstack-chef''' channel on Freenode.net. Come hang out with us and collaborate there.
+
* We have a maintainers list located [http://bit.ly/openstack-chef-maintainers here]. Please don't hesitate to reach out.
  
 
==Bug Tracking==
 
==Bug Tracking==
Line 14: Line 14:
  
 
For major feature enhancements and planning you can use Launchpad's Blueprints system for the OpenStack + Chef project on Launchpad. You can [https://blueprints.launchpad.net/openstack-chef/+addspec create a new blueprint] that may be targeted to a milestone and tracked appropriately.
 
For major feature enhancements and planning you can use Launchpad's Blueprints system for the OpenStack + Chef project on Launchpad. You can [https://blueprints.launchpad.net/openstack-chef/+addspec create a new blueprint] that may be targeted to a milestone and tracked appropriately.
 +
The process for blueprint content reviews is documented here: https://github.com/openstack/openstack-chef-specs
  
==Code==
+
==How to Contribute==
 
+
We have broken this off into another page [https://wiki.openstack.org/wiki/Chef/Contributing here].
The canonical upstream Chef cookbooks and example repository are located in the [https://github.com/stackforge Stackforge Github organization]. There is a single Chef cookbook for each integrated OpenStack project:
 
 
 
* [https://github.com/stackforge/cookbook-openstack-compute OpenStack Compute (Nova) cookbook]
 
* [https://github.com/stackforge/cookbook-openstack-image OpenStack Image (Glance) cookbook]
 
* [https://github.com/stackforge/cookbook-openstack-identity OpenStack Identity (Keystone) cookbook]
 
* [https://github.com/stackforge/cookbook-openstack-network OpenStack Network (formerly known as Quantum) cookbook]
 
* [https://github.com/stackforge/cookbook-openstack-dashboard OpenStack Dashboard (Horizon) cookbook]
 
* [https://github.com/stackforge/cookbook-openstack-object-storage OpenStack Object Storage (Swift) cookbook]
 
* [https://github.com/stackforge/cookbook-openstack-block-storage OpenStack Block Storage (Cinder) cookbook]
 
* [https://github.com/stackforge/cookbook-openstack-metering OpenStack Telemetry (formerly known as Metering) (Ceilometer) cookbook]
 
* [https://github.com/stackforge/cookbook-openstack-orchestration OpenStack Orchestration (Heat) cookbook]
 
* [https://github.com/stackforge/cookbook-openstack-database OpenStack Database (Trove) cookbook]
 
 
 
 
 
In addition to the project cookbooks, there are three support cookbooks:
 
 
 
* [https://github.com/stackforge/cookbook-openstack-common Common library cookbook]
 
* [https://github.com/stackforge/cookbook-openstack-ops-database Example database configuration cookbook]
 
* [https://github.com/stackforge/cookbook-openstack-ops-messaging Example message queue configuration cookbook]
 
 
 
 
 
As well as an example [http://docs.opscode.com/essentials_repository.html Chef Repository] that sets up an OpenStack environment:
 
 
 
* [https://github.com/stackforge/openstack-chef-repo Example OpenStack Chef Repository]
 
 
 
===Contributing to the OpenStack Chef Cookbooks===
 
 
 
See [http://www.joinfu.com/2013/05/working-with-the-openstack-code-review-and-ci-system-chef-edition/ this blog entry] for an introduction to contributing and pushing code to for the OpenStack Chef cookbooks housed on Stackforge.
 
 
 
===Guidelines for Commit Messages===
 
 
 
Please try to make commit messages useful. Read [http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html this excellent blog post], as well as the [[GitCommitMessages|standard commit message guidelines for OpenStack projects]] before making your first code push.
 
 
 
===Guidelines for Code Reviewers===
 
 
 
Here are some simple rules for reviewers of code on the [https://review.openstack.org Gerrit Review site]:
 
 
 
'''Rule #1''': Never +1/+2R or +1A your own patch.
 
 
 
'''Rule #2''': All patches must have a commit message that meets the [[GitCommitMessages|standard commit message guidelines for OpenStack projects]]. Failure of the commit message to meet these guidelines should prevent a +1A by a core reviewer.
 
 
 
'''Rule #3''': If the patch is more than just stylistic or typo fixes, it requires at least 2 core reviewers to add a +2R to the review before any core reviewer can +1A the review.
 
 
 
'''Rule #4''': If the patch '''''changes''''' existing behavior of any cookbook in a backwards-incompatible way, a corresponding bump in the version in the cookbook's metadata.rb must be included in patch set. Failure to do so should prevent a +1A by a core reviewer.
 
 
 
'''Rule #5''': If the patch '''''adds''''' additional functionality to a '''''library''''' cookbook, a corresponding bump in version number in the metadata.rb file should accompany the patch. Failure to do so should prevent a +1A by a core review.
 

Revision as of 10:42, 9 February 2017

This page serves as a getting started guide for community members interested in introducing themselves to the OpenStack Chef cookbooks and community.

Communication

  • The OpenStack + Chef community leverages the main openstack-dev mailing list with the tag of [chef] in the subject line.
  • There is an #openstack-chef channel on freenode.net. Come hang out with us and collaborate there.
  • We have a maintainers list located here. Please don't hesitate to reach out.

Bug Tracking

We track bugs and feature requests using a single Launchpad project called OpenStack + Chef. You can see the list of open bugs or file a new bug.

Blueprints / Feature Tracking

For major feature enhancements and planning you can use Launchpad's Blueprints system for the OpenStack + Chef project on Launchpad. You can create a new blueprint that may be targeted to a milestone and tracked appropriately. The process for blueprint content reviews is documented here: https://github.com/openstack/openstack-chef-specs

How to Contribute

We have broken this off into another page here.