Difference between revisions of "Packstack"
m (→Links) |
|||
(40 intermediate revisions by 13 users not shown) | |||
Line 1: | Line 1: | ||
− | + | ||
= Packstack = | = Packstack = | ||
/!\ This page is far from complete, help by adding information. | /!\ This page is far from complete, help by adding information. | ||
== Summary == | == Summary == | ||
− | Packstack is a utility that uses Puppet modules to deploy various parts of [[OpenStack]] on multiple pre-installed servers over SSH automatically. Currently only | + | '''Packstack''' is a utility that uses '''Puppet''' modules to deploy various parts of [[OpenStack]] on multiple pre-installed servers over <code><nowiki>SSH</nowiki></code> automatically. Currently only <code><nowiki>CentOS</nowiki></code>, <code><nowiki>Red Hat Enterprise Linux (RHEL)</nowiki></code> and compatible derivatives of both are supported. |
+ | |||
+ | == Example Usage == | ||
− | == | + | === All in One === |
− | + | <pre><nowiki> | |
+ | $ packstack --allinone | ||
+ | </nowiki></pre> | ||
− | + | For detailed options, please refer to the Packstack documentation at https://github.com/openstack/packstack/blob/master/docs/packstack.rst | |
== Development : Getting started == | == Development : Getting started == | ||
+ | In general, you will want to use a packaged version of Packstack. Refer to https://www.rdoproject.org/install/quickstart/ for details on how to enable the required repositories and install Packstack. | ||
+ | |||
+ | If you are a developer and want to install Packstack from source, please refer to https://github.com/openstack/packstack/blob/master/README.md#installation-of-packstack for detailed information. | ||
+ | |||
+ | === Using an answer file === | ||
<pre><nowiki> | <pre><nowiki> | ||
− | + | $ packstack --gen-answer-file=answers.txt | |
− | |||
− | |||
− | |||
− | |||
</nowiki></pre> | </nowiki></pre> | ||
+ | Then edit <code><nowiki>answers.txt</nowiki></code> as appropriate. | ||
== Links == | == Links == | ||
− | * [https://github.com/ | + | * [https://github.com/openstack/packstack Primary Git Repository] |
− | * [https://review.openstack.org/#/q/status:open+project: | + | * [https://review.openstack.org/#/q/status:open+project:openstack/packstack,n,z Open reviews in Gerrit] |
− | * [https:// | + | * [https://issues.redhat.com/projects/RDO/issues Bug Reporting Tool] - use packstack component to report bugs found in packstack package in RDO |
* [https://launchpad.net/~packstack-core Launchpad (core developers)] | * [https://launchpad.net/~packstack-core Launchpad (core developers)] | ||
+ | |||
+ | === Presentations === | ||
+ | * [http://goo.gl/Niebi Packstack Overview] (30 slides, >=~10 minutes, 2013-04-24, CC0) | ||
+ | |||
== IRC == | == IRC == | ||
− | Developers meet in [http://webchat.freenode.net?channels= | + | Developers meet in [http://webchat.freenode.net?channels=rdo #rdo] on Freenode for discussion. |
+ | |||
+ | End-user questions are probably best answered in [http://webchat.freenode.net?channels=openstack #openstack] or [http://webchat.freenode.net?channels=rdo #rdo] | ||
== Packstack Development == | == Packstack Development == | ||
=== Making your first contribution === | === Making your first contribution === | ||
− | The process you need to follow in order to | + | The process you need to follow in order to contribute to packstack is the same as the openstack core projects, documented here http://wiki.openstack.org/HowToContribute the steps to follow look something like this |
− | + | ||
− | + | '''→''' Sign the CLA | |
− | + | ||
− | + | '''→''' Get the code | |
− | |||
− | |||
− | |||
− | <pre><nowiki> | + | <pre><nowiki> |
− | + | $ git clone https://github.com/openstack/packstack.git | |
− | + | $ cd packstack | |
+ | </nowiki></pre> | ||
+ | '''→''' Make a topic branch: | ||
+ | <pre><nowiki> | ||
+ | $ git checkout -b my_topic | ||
+ | </nowiki></pre> | ||
− | + | '''→''' Make your change | |
− | + | <pre><nowiki> | |
− | + | $ hack, hack, hack !! ;-) | |
− | + | </nowiki></pre> | |
− | |||
− | + | '''→''' Commit your change | |
+ | <pre><nowiki> | ||
+ | $ git commit -a | ||
+ | </nowiki></pre> | ||
+ | '''→''' Submit your change for review | ||
<pre><nowiki> | <pre><nowiki> | ||
− | # to | + | $ git review |
− | + | </nowiki></pre> | |
+ | |||
+ | '''→''' Wait for people on gerrit https://review.openstack.org/#/q/status:open+project:openstack/packstack,n,z to review your change, if it needs to be altered simply amend your commit and submit it for review again | ||
− | + | <pre><nowiki> | |
− | git review | + | $ git add -p |
+ | $ git commit --amend | ||
+ | $ git review | ||
</nowiki></pre> | </nowiki></pre> | ||
+ | === Git branches === | ||
+ | There is a branch for each openstack major release, this branch starts off is life as master, once development of the next release starts, it will be renamed and then master will be the branch for the next openstack release e.g. | ||
+ | once we start <code><nowiki>Ocata</nowiki></code> development, master will branch off a <code><nowiki>stable/ocata</nowiki></code> branch. Then | ||
+ | * <code><nowiki>stable/ocata</nowiki></code> → should only accept bug fixes and exceptional approved new features, these should be merged into master first if appropriate | ||
+ | * <code><nowiki>master</nowiki></code> → new features and bugs | ||
+ | |||
+ | |||
+ | '''Note :''' (be careful to send your changes to the correct branch and also that your basing any commits on a parent from the correct branch) | ||
− | + | * To send review request for the master branch | |
− | + | <pre><nowiki> | |
+ | $ git review | ||
+ | </nowiki></pre> | ||
− | + | * To send review request for the stable branch | |
− | + | <pre><nowiki> | |
− | + | $ git review stable/ocata | |
− | + | </nowiki></pre> | |
− | |||
− | |||
=== Bugs === | === Bugs === | ||
− | Bugs are tracked in https:// | + | Bugs are tracked in RDO issue tracker ([https://issues.redhat.com/projects/RDO/ New bug]) with packstack component |
=== Reviews === | === Reviews === | ||
Line 81: | Line 110: | ||
=== New Features === | === New Features === | ||
− | New | + | New features go into the master branch. There may be new features committed to a stable branch but these should be the exception and not the norm. |
− | === | + | === Gerrit === |
− | Open review requests https://review.openstack.org/#/q/status:open+project: | + | Open review requests https://review.openstack.org/#/q/status:open+project:openstack/packstack,n,z |
− | === | + | === Packstack Core === |
− | You do not need to be a core member to packstack in order to contribute code. Members of packstack-core can approve commits in gerrit to be merged into the code, new members to packstack-core should be | + | You do not need to be a core member to packstack in order to contribute code. Members of packstack-core can approve commits in gerrit to be merged into the code, new members to packstack-core should be actively (and reliably) reviewing commits in gerrit before being considered. New members will be invited to join. Core members can be found [https://review.openstack.org/#/admin/groups/124,members here] |
Latest revision as of 14:16, 14 February 2024
Contents
Packstack
/!\ This page is far from complete, help by adding information.
Summary
Packstack is a utility that uses Puppet modules to deploy various parts of OpenStack on multiple pre-installed servers over SSH
automatically. Currently only CentOS
, Red Hat Enterprise Linux (RHEL)
and compatible derivatives of both are supported.
Example Usage
All in One
$ packstack --allinone
For detailed options, please refer to the Packstack documentation at https://github.com/openstack/packstack/blob/master/docs/packstack.rst
Development : Getting started
In general, you will want to use a packaged version of Packstack. Refer to https://www.rdoproject.org/install/quickstart/ for details on how to enable the required repositories and install Packstack.
If you are a developer and want to install Packstack from source, please refer to https://github.com/openstack/packstack/blob/master/README.md#installation-of-packstack for detailed information.
Using an answer file
$ packstack --gen-answer-file=answers.txt
Then edit answers.txt
as appropriate.
Links
- Primary Git Repository
- Open reviews in Gerrit
- Bug Reporting Tool - use packstack component to report bugs found in packstack package in RDO
- Launchpad (core developers)
Presentations
- Packstack Overview (30 slides, >=~10 minutes, 2013-04-24, CC0)
IRC
Developers meet in #rdo on Freenode for discussion.
End-user questions are probably best answered in #openstack or #rdo
Packstack Development
Making your first contribution
The process you need to follow in order to contribute to packstack is the same as the openstack core projects, documented here http://wiki.openstack.org/HowToContribute the steps to follow look something like this
→ Sign the CLA
→ Get the code
$ git clone https://github.com/openstack/packstack.git $ cd packstack
→ Make a topic branch:
$ git checkout -b my_topic
→ Make your change
$ hack, hack, hack !! ;-)
→ Commit your change
$ git commit -a
→ Submit your change for review
$ git review
→ Wait for people on gerrit https://review.openstack.org/#/q/status:open+project:openstack/packstack,n,z to review your change, if it needs to be altered simply amend your commit and submit it for review again
$ git add -p $ git commit --amend $ git review
Git branches
There is a branch for each openstack major release, this branch starts off is life as master, once development of the next release starts, it will be renamed and then master will be the branch for the next openstack release e.g.
once we start Ocata
development, master will branch off a stable/ocata
branch. Then
-
stable/ocata
→ should only accept bug fixes and exceptional approved new features, these should be merged into master first if appropriate -
master
→ new features and bugs
Note : (be careful to send your changes to the correct branch and also that your basing any commits on a parent from the correct branch)
- To send review request for the master branch
$ git review
- To send review request for the stable branch
$ git review stable/ocata
Bugs
Bugs are tracked in RDO issue tracker (New bug) with packstack component
Reviews
All commits should be reviewed and approved by at least one core packstack member (ideally 2 for any commit more then a trivial change) and author of a commit shouldn't approve their own code.
New Features
New features go into the master branch. There may be new features committed to a stable branch but these should be the exception and not the norm.
Gerrit
Open review requests https://review.openstack.org/#/q/status:open+project:openstack/packstack,n,z
Packstack Core
You do not need to be a core member to packstack in order to contribute code. Members of packstack-core can approve commits in gerrit to be merged into the code, new members to packstack-core should be actively (and reliably) reviewing commits in gerrit before being considered. New members will be invited to join. Core members can be found here