OpenStack Compute (Nova) Specifications

Go to file

Chris Friesen 020ed7497b Fix up instructions for proposing spec for approval The README.rst instructions say to put the proposed spec under 'specs/<release>' but really we want them under 'specs/<release>/approved' so let's make that explicit. Change-Id: I9e124efd4d13168d97b94fb4ac6da7ec7b0acf18		2015-03-30 11:05:13 -06:00
doc/source	Open Liberty specs.	2015-02-16 14:15:33 +11:00
priorities	Fill out kilo priorities as discussed at the summit	2014-12-01 22:39:37 +02:00
specs	Mark specs implemented in kilo as implemented	2015-03-23 11:27:10 +11:00
tests	Re-organize juno specs	2014-10-07 07:49:59 +11:00
.gitignore	Add .testrepository to gitignore	2014-04-04 19:07:21 +02:00
.gitreview	Added .gitreview	2014-03-14 23:09:48 +00:00
.testr.conf	Add unit test to make sure all sections are present	2014-03-31 12:03:41 -04:00
LICENSE	Switch license to CC-BY 3.0.	2014-03-24 16:28:41 -04:00
README.rst	Fix up instructions for proposing spec for approval	2015-03-30 11:05:13 -06:00
requirements.txt	Merge "Remove docutils pin"	2014-10-13 21:07:54 +00:00
setup.cfg	Make sphinxbuild fail on formatting errors	2014-03-31 11:56:45 -04:00
setup.py	Make nova-specs an oslosphinx project	2014-03-24 16:28:41 -04:00
tox.ini	Relax min tox from 1.6 to 1.4	2014-06-03 15:04:29 +01:00

README.rst

README

OpenStack Nova Specifications

This git repository is used to hold approved design specifications for additions to the Nova project. Reviews of the specs are done in gerrit, using a similar workflow to how we review and merge changes to the code itself.

The layout of this repository is:

specs/<release>/

Where there are two sub-directories:

specs/<release>/approved: specifications approved but not yet implemented specs/<release>/implemented: implemented specifications

This directory structure allows you to see what we thought about doing, decided to do, and actually got done. Users interested in functionality in a given release should only refer to the implemented directory.

You can find an example spec in specs/template.rst.

Additionally, we allow the proposal of specifications that do not have a developer assigned to them. These are proposed for review in the same manner as above, but are added to:

specs/backlog/approved

Specifications in this directory indicate the original author has either become unavailable, or has indicated that they are not going to implement the specification. The specifications found here are available as projects for people looking to get involved with Nova. If you are interested in claiming a spec, start by posting a review for the specification that moves it from this directory to the next active release. Please set yourself as the new primary assignee and maintain the original author in the other contributors list.

Specifications are proposed for a given release by adding them to the specs/<release>/approved directory and posting it for review. The implementation status of a blueprint for a given release can be found by looking at the blueprint in launchpad. Not all approved blueprints will get fully implemented.

Specifications have to be re-proposed for every release. The review may be quick, but even if something was previously approved, it should be re-reviewed to make sure it still makes sense as written.

Prior to the Juno development cycle, this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints

Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see https://wiki.openstack.org/wiki/Blueprints

For more information about working with gerrit, see http://docs.openstack.org/infra/manual/developers.html#development-workflow

To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:

$ tox

After running tox, the documentation will be available for viewing in HTML format in the doc/build/ directory.