Difference between revisions of "Barbican/Blueprints"
< Barbican
(Added link to the barbican gerrit setup wiki page.) |
(→Blueprints) |
||
| Line 1: | Line 1: | ||
== Blueprints == | == Blueprints == | ||
| − | At the Juno design summit in Atlanta, Barbican decided to adopt a new process for creating and approving blueprints. This process is based on similar processes that many other teams have adopted for the Juno cycle. You can review the high level blueprinting process [https://wiki.openstack.org/wiki/Blueprints here]. We are reproducing the Nova process below so as to prevent any inadvertent changes to the Barbican process if Nova decides to update theirs, but the rest of the content on the page should be useful. | + | At the Juno design summit in Atlanta, the Barbican team decided to adopt a new process for creating and approving blueprints. This process is based on similar processes that many other teams have adopted for the Juno cycle. You can review the high level blueprinting process [https://wiki.openstack.org/wiki/Blueprints here]. We are reproducing the Nova process below so as to prevent any inadvertent changes to the Barbican process if Nova decides to update theirs, but the rest of the content on the page should be useful. |
=== Creating a Blueprint === | === Creating a Blueprint === | ||
| − | Barbican has a team of people, led by the PTL, that are responsible for reviewing blueprints. That is the [https:// | + | Barbican has a team of people, led by the PTL, that are responsible for reviewing blueprints. That is the [https://review.openstack.org/#/admin/groups/178,members barbican-core] team. |
To aid the reviewing of a blueprint by a team of people, the the design specifications related to each blueprint are reviewed in Gerrit, and stored in git, just like all the code: | To aid the reviewing of a blueprint by a team of people, the the design specifications related to each blueprint are reviewed in Gerrit, and stored in git, just like all the code: | ||
| − | http://git.openstack.org/cgit/ | + | http://git.openstack.org/cgit/openstack/barbican-specs |
Starting with the Juno release, the process for getting your blueprint in Barbican is: | Starting with the Juno release, the process for getting your blueprint in Barbican is: | ||
* Register your blueprint in launchpad (as normal) | * Register your blueprint in launchpad (as normal) | ||
* Upload a design specification in the "specs/<release>" folder in nova-specs | * Upload a design specification in the "specs/<release>" folder in nova-specs | ||
| − | ** e.g. http://git.openstack.org/cgit/ | + | ** e.g. http://git.openstack.org/cgit/openstack/barbican-specs/tree/specs/kilo/name-of-your-blueprint-in-launchpad.rst |
| − | ** it should be based on the [http://git.openstack.org/cgit/ | + | ** it should be based on the [http://git.openstack.org/cgit/openstack/barbican-specs/tree/specs/template.rst template], see the instructions in the template for more details |
** get it reviewed by submitting your patch using Gerrit, in the usual way: [[Gerrit_Workflow]] | ** get it reviewed by submitting your patch using Gerrit, in the usual way: [[Gerrit_Workflow]] | ||
*** For new contributors, [https://github.com/cloudkeep/barbican/wiki/Gerrit-Review-Process this page] may also be helpful for setting up Gerrit locally. | *** For new contributors, [https://github.com/cloudkeep/barbican/wiki/Gerrit-Review-Process this page] may also be helpful for setting up Gerrit locally. | ||
| Line 26: | Line 26: | ||
** should blueprint slip to the next milestone, blueprint will be re-evaluated | ** should blueprint slip to the next milestone, blueprint will be re-evaluated | ||
* Now everything continues as it would with any other OpenStack project | * Now everything continues as it would with any other OpenStack project | ||
| − | |||
Current Launchpad blueprints for Barbican can be found [https://blueprints.launchpad.net/barbican here]. | Current Launchpad blueprints for Barbican can be found [https://blueprints.launchpad.net/barbican here]. | ||
Revision as of 21:06, 19 November 2014
Blueprints
At the Juno design summit in Atlanta, the Barbican team decided to adopt a new process for creating and approving blueprints. This process is based on similar processes that many other teams have adopted for the Juno cycle. You can review the high level blueprinting process here. We are reproducing the Nova process below so as to prevent any inadvertent changes to the Barbican process if Nova decides to update theirs, but the rest of the content on the page should be useful.
Creating a Blueprint
Barbican has a team of people, led by the PTL, that are responsible for reviewing blueprints. That is the barbican-core team.
To aid the reviewing of a blueprint by a team of people, the the design specifications related to each blueprint are reviewed in Gerrit, and stored in git, just like all the code: http://git.openstack.org/cgit/openstack/barbican-specs
Starting with the Juno release, the process for getting your blueprint in Barbican is:
- Register your blueprint in launchpad (as normal)
- Upload a design specification in the "specs/<release>" folder in nova-specs
- e.g. http://git.openstack.org/cgit/openstack/barbican-specs/tree/specs/kilo/name-of-your-blueprint-in-launchpad.rst
- it should be based on the template, see the instructions in the template for more details
- get it reviewed by submitting your patch using Gerrit, in the usual way: Gerrit_Workflow
- For new contributors, this page may also be helpful for setting up Gerrit locally.
- at the end of each release, non-completed specs will be removed
- you need to re-submit for the following release, should the blueprint slip
- Once your design specification has been committed to barbican-specs:
- Update your blueprint's specification URL to point to the design specification in barbican-specs
- Propose your blueprint, as above, by selecting the milestone in which you plan to complete the blueprint
- barbican-core will approve blueprint once:
- proposer has picked a target milestone, URL points to barbican-specs correctly, and code has been started
- barbican-specs check there is code in gerrit, such that they think the proposed target is achievable
- should blueprint slip to the next milestone, blueprint will be re-evaluated
- Now everything continues as it would with any other OpenStack project
Current Launchpad blueprints for Barbican can be found here.
