Image metadata made available through Glance can be stored in image registries. Image registries are any web service that adheres to the Glance REST-like API for image metadata.
Glance comes with a server program glance-registry that acts as a reference implementation of a Glance Registry.
Please see the document on Controlling Servers for more information on starting up the Glance registry server that ships with Glance.
Any web service that publishes an API that conforms to the following REST-like API specification can be used by Glance as a registry.
The following is a brief description of the Glance API:
GET /images Return brief information about public images
GET /images/detail Return detailed information about public images
GET /images/<ID> Return metadata about an image in HTTP headers
POST /images Register metadata about a new image
PUT /images/<ID> Update metadata about an existing image
DELETE /images/<ID> Remove an image's metadata from the registry
Both the GET /images and GET /images/detail requests take query parameters that serve to filter the returned list of images. The following list details these query parameters.
name=NAME
Filters images having a name attribute matching NAME.
container_format=FORMAT
Filters images having a container_format attribute matching FORMAT
For more information, see About Disk and Container Formats
disk_format=FORMAT
Filters images having a disk_format attribute matching FORMAT
For more information, see About Disk and Container Formats
status=STATUS
Filters images having a status attribute matching STATUS
For more information, see About Image Statuses
size_min=BYTES
Filters images having a size attribute greater than or equal to BYTES
size_max=BYTES
Filters images having a size attribute less than or equal to BYTES
These two resources also accept sort parameters:
sort_key=KEY
Results will be ordered by the specified image attribute KEY. Accepted values include id, name, status, disk_format, container_format, size, created_at (default) and updated_at.
sort_dir=DIR
Results will be sorted in the direction DIR. Accepted values are asc for ascending or desc (default) for descending.
The body of the request will be a JSON-encoded set of data about the image to add to the registry. It will be in the following format:
{'image':
{'id': <ID>|None,
'name': <NAME>,
'status': <STATUS>,
'disk_format': <DISK_FORMAT>,
'container_format': <CONTAINER_FORMAT>,
'properties': [ ... ]
}
}
The request shall validate the following conditions and return a 400 Bad request when any of the conditions are not met:
Todo
Complete examples for Glance registry API