OpenStack Image Management (Glance) Specifications
Go to file
Travis Tripp 505573a345 Software Metadata Definitions
The spec will provide a base library of metadata definitions for
various common software products, components, and libraries that
may exist on particular image (or volume or instance). These
metadata definitions will make it easier for end users and
admins to easily describe the software and its properties.
This information will enable an improved and faster user
experience for applying software metadata, searching based
on software metadata, and viewing the software information
about an image.

Various improvements in horizon are underway to take
advantage of this metadata. For example, a user launching
an instance will be able to expand the image row to see
additional information about the image.  This will include
providing the metadata definition for properties on the image.
This same information will also be visible from the image and
instance details page.

Implements: blueprint software-metadefs
Change-Id: I70c13d1c903ef4b447eaaeb4c3af40a4cbfb3c71
2015-01-22 14:56:49 -07:00
doc/source Merge "Adds Image service v1 and v2 specification info in general" 2014-12-11 23:11:32 +00:00
specs Software Metadata Definitions 2015-01-22 14:56:49 -07:00
tests Merge "Adds Image service v1 and v2 specification info in general" 2014-12-11 23:11:32 +00: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 Workflow documentation is now in infra-manual 2014-12-05 03:30:36 +00:00
requirements.txt Merge "Remove docutils pin" 2014-10-14 18:28:58 +00: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

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:

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.