OpenStack Block Storage (Cinder) Specifications
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
zhangbailin 6d01907082 Docs:Correct the CLI in the completed spec 1 day ago
doc Add Train specs directory 4 months ago
specs Docs:Correct the CLI in the completed spec 1 day ago
.gitignore Adds Block Storage v2 API specification information 4 years ago
.gitreview OpenDev Migration Patch 1 month ago
.testr.conf Initialize the Cinder-Specs Repository 5 years ago
.zuul.yaml import zuul job settings from project-config 8 months ago
LICENSE Initialize the Cinder-Specs Repository 5 years ago
README.rst Update url of the cinder-specs's document 1 year ago
bindep.txt Update bindep.txt for doc builds 1 year ago
setup.cfg Change openstack-dev to openstack-discuss 5 months ago
setup.py Fix rst formatting and fix tox 4 years ago
test-requirements.txt Clean up required packages 1 year ago
tox.ini Update min tox version to 2.0 6 months ago

README.rst

Team and repository tags

image

OpenStack Cinder Specifications

This git repository is used to hold approved design specifications for additions to the Cinder 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>/

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

Specifications are proposed for a given release by adding them to the specs/<release> 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:

https://blueprints.launchpad.net/cinder

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:

https://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. Please do not checkin the generated HTML files as a part of your commit.