OpenStack Image Management (Glance) Specifications
Go to file
Zuul 5b14f26d10 Merge "[Spec Lite] Deprecate cachemanage middleware" 2024-01-16 06:37:57 +00:00
doc Add 2024.1 directory for specs 2023-10-26 05:35:30 +00:00
priorities Caracal project priorities 2023-11-01 12:42:39 +00:00
scripts Add a script to prepare the next cycle 2023-04-05 15:20:52 +02:00
specs Merge "[Spec Lite] Deprecate cachemanage middleware" 2024-01-16 06:37:57 +00:00
tests Remove reviewers section from template 2016-05-13 15:37:10 -05:00
.gitignore Switch to stestr 2018-07-11 09:51:46 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:34:52 +00:00
.stestr.conf Switch to stestr 2018-07-11 09:51:46 +07:00
.zuul.yaml [ussuri][goal] Drop python 2.7 support 2020-02-02 11:45:52 +01:00
LICENSE Add base glance-specs framework 2014-05-28 17:20:37 -07:00
README.rst Add a script to prepare the next cycle 2023-04-05 15:20:52 +02:00
bindep.txt [ussuri][goal] Drop python 2.7 support 2020-02-02 11:45:52 +01:00
requirements.txt Switch to newer openstackdocstheme version 2020-05-30 16:56:41 +02:00
tox.ini Add a script to prepare the next cycle 2023-04-05 15:20:52 +02:00

README.rst

Team and repository tags

The following tags have been asserted for the Glance Specifications
repository:
"project:official".
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:

https://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:

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.

At the start of a new cycle, the right files and directories can be created and modified using the following command:

$ tox -eprepare-next-cycle <cycle>

For instance:

$ tox -eprepare-next-cycle 2023.2

The changes should then be reviewed and committed manually.