OpenStack Image Management (Glance) Specifications
Go to file
Erno Kuvaja 4497aa6c83 Amend the Remove v1 spec with new details
Change-Id: I80ce444b2073e9db1872603b6a0c71c73c644389
2018-07-06 12:30:25 +01:00
doc Move specs implemented in Rocky-{1,2} milestones 2018-06-20 17:53:20 -04:00
priorities Add release dates to Rocky priorities page 2018-03-26 19:10:19 -04:00
specs Amend the Remove v1 spec with new details 2018-07-06 12:30:25 +01:00
tests Remove reviewers section from template 2016-05-13 15:37:10 -05:00
.gitignore Adds Image service v1 and v2 specification info in general 2014-12-05 16:50:39 -06:00
.gitreview Added .gitreview 2014-05-08 19:05:52 +00:00
.testr.conf Add base glance-specs framework 2014-05-28 17:20:37 -07:00
LICENSE Add base glance-specs framework 2014-05-28 17:20:37 -07:00
README.rst Add alt text for badges 2016-12-01 11:56:10 -05:00
requirements.txt add whereto for testing redirects 2017-12-02 17:13:38 +00:00
setup.cfg Update glance-specs to use openstackdocstheme 2017-11-28 14:19:44 -05:00
setup.py Add base glance-specs framework 2014-05-28 17:20:37 -07:00
tox.ini add whereto for testing redirects 2017-12-02 17:13:38 +00:00

README.rst

Team and repository tags

The following tags have been asserted for the Glance Specifications
repository:
"project:official",
"team:diverse-affiliation".
Follow the link for an explanation of these tags.

OpenStack Glance Specifications

This git repository is used to hold approved design specifications for additions to the Glance 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 general layout of this repository is:

specs/<release>/

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

Beginning with the Mitaka release, there is a further subdivision into:

specs/<release>/approved
specs/<release>/implemented

A specification is proposed for a given release by adding it 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.

When a feature has been completed, its specification will be moved to the 'implemented' directory for the release in which it was 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:

http://blueprints.launchpad.net/glance

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