glance/api-ref/source/v2/metadefs-index.rst
Travis Tripp 5829139ccf Fix use of etc. in metadefs docs.
OpenStack house style is no Latin, which includes "etc.".
This fixes the usage in the metadefs documentation.

Change-Id: Ic88bd2a9286b2647a927f2fb8ecdec480053a91c
Closes-Bug: 1610311
2016-08-05 16:42:20 -06:00

2.5 KiB
Raw Blame History

tocdepth

3

Metadata Definitions Service API v2 (CURRENT)

Metadefs

General information

The Metadata Definitions Service ("metadefs", for short) provides a common API for vendors, operators, administrators, services, and users to meaningfully define available key:value pairs that can be used on different types of cloud resources (for example, images, artifacts, volumes, flavors, aggregates, and other resources).

To get you started, Glance contains a default catalog of metadefs that may be installed at your site; see the README in the code repository for details.

Once a common catalog of metadata definitions has been created, the catalog is available for querying through the API. Note that this service stores only the catalog, because metadefs are meta-metadata. Metadefs provide information about resource metadata, but do not themselves serve as actual metadata.

Actual key:value pairs are stored on the resources to which they apply using the metadata facilities provided by the appropriate API. (For example, the Images API would be used to put specific key:value pairs on a virtual machine image.)

A metadefs definition includes a propertys key, its description, its constraints, and the resource types to which it can be associated. See Metadata Definition Concepts in the Glance Developer documentation for more information.