OpenStack Image Management (Glance) Specifications

Go to file

Travis Tripp 279570ab05 Metadata Definitions Catalog A common API hosted by the Glance service for vendors, admins, services, and users to meaningfully define available key / value pair and tag metadata. The intent is to enable better metadata collaboration across artifacts,services, and projects for OpenStack users. This is about the definition of the available metadata that can be used on different types of resources (images, artifacts, volumes, flavors, aggregates, etc). A definition includes the properties type, its key, it's description, and it's constraints. This catalog will not store the values for specific instance properties. This patch updates the spec to reflect the Juno release. Change-Id: Idc6b24c8caf5ce07800352ab6f4c5829ec35ca4f Co-Authored-By: Travis Tripp <travis.tripp@hp.com> Co-Authored-By: Lakshmi N Sampath <lakshmi.sampath@hp.com> Co-Authored-By: murali sundar <murali.sundar@intel.com> Co-Authored-By: Wayne Okuma <wayne.okuma@hp.com>		2014-09-08 17:44:52 -06:00
doc/source	Adjust title	2014-08-06 13:57:08 +00:00
specs	Metadata Definitions Catalog	2014-09-08 17:44:52 -06:00
tests	Add base glance-specs framework	2014-05-28 17:20:37 -07:00
.gitignore	Add base glance-specs framework	2014-05-28 17:20:37 -07: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	Fix template and reST online renderer links	2014-07-18 16:19:52 +05:30
requirements.txt	Add base glance-specs framework	2014-05-28 17:20:37 -07:00
setup.cfg	Add base glance-specs framework	2014-05-28 17:20:37 -07:00
setup.py	Add base glance-specs framework	2014-05-28 17:20:37 -07:00
tox.ini	Add base glance-specs framework	2014-05-28 17:20:37 -07:00

README.rst

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

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:

https://wiki.openstack.org/wiki/Gerrit_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.