Skip to content

Commit 368f7db

Browse files
author
bria4010
committedJul 11, 2016
WADL to RST migration (part 2 - metadefs)
This brings the Images API Reference to the glance tree as part of the effort described here: https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan This patch includes the Metadefs API reference, with the content revised and corrected. Change-Id: I8c10893e92edb7c608b58d33539ab57ab4f57d3e Closes-bug: #1599314
1 parent 514d10a commit 368f7db

File tree

50 files changed

+4397
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+4397
-0
lines changed
 

‎api-ref/source/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,4 @@ Image Service APIs
2424
versions/index
2525
v1/index
2626
v2/index
27+
v2/metadefs-index

‎api-ref/source/v2/metadefs-index.rst

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
..
2+
Copyright 2010 OpenStack Foundation
3+
All Rights Reserved.
4+
5+
Licensed under the Apache License, Version 2.0 (the "License"); you may
6+
not use this file except in compliance with the License. You may obtain
7+
a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13+
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14+
License for the specific language governing permissions and limitations
15+
under the License.
16+
17+
:tocdepth: 3
18+
19+
=============================================
20+
Metadata Definitions Service API v2 (CURRENT)
21+
=============================================
22+
23+
.. rest_expand_all::
24+
25+
Metadefs
26+
********
27+
28+
General information
29+
~~~~~~~~~~~~~~~~~~~
30+
31+
The Metadata Definitions Service ("metadefs", for short) provides a common API
32+
for vendors, operators, administrators, services, and users to meaningfully
33+
define available key:value pairs that can be used on different types of cloud
34+
resources (for example, images, artifacts, volumes, flavors, aggregates, etc).
35+
To get you started, Glance contains a default catalog of metadefs that may be
36+
installed at your site; see the `README
37+
<https://github.com/openstack/glance/tree/master/etc/metadefs/README>`_ in the
38+
code repository for details.
39+
40+
Once a common catalog of metadata definitions has been created, the catalog is
41+
available for querying through the API. Note that this service stores only the
42+
*catalog*, because metadefs are meta-metadata. Metadefs provide information
43+
*about* resource metadata, but do not themselves serve as actual metadata.
44+
45+
Actual key:value pairs are stored on the resources to which they apply using
46+
the metadata facilities provided by the appropriate API. (For example, the
47+
Images API would be used to put specific key:value pairs on a virtual machine
48+
image.)
49+
50+
A metadefs definition includes a property’s key, its description, its
51+
constraints, and the resource types to which it can be associated. See
52+
`Metadata Definition Concepts
53+
<http://docs.openstack.org/developer/glance/metadefs-concepts.html>`_ in the
54+
Glance Developer documentation for more information.
55+
56+
57+
.. include:: metadefs-namespaces.inc
58+
.. include:: metadefs-resourcetypes.inc
59+
.. include:: metadefs-namespaces-objects.inc
60+
.. include:: metadefs-namespaces-properties.inc
61+
.. include:: metadefs-namespaces-tags.inc
62+
.. include:: metadefs-schemas.inc

0 commit comments

Comments
 (0)