Difference between revisions of "Obsolete:GlanceAPISpec"
m (Dan Smith moved page GlanceAPISpec to Obsolete:GlanceAPISpec) |
|||
(9 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | ||
= Glance API Specification = | = Glance API Specification = | ||
Line 7: | Line 7: | ||
** Parallax - Image Registry service | ** Parallax - Image Registry service | ||
** Teller - Image Delivery service | ** Teller - Image Delivery service | ||
− | * | + | * Client Classes |
− | ** ` | + | ** `glance.client.[[GlanceClient]]` - A client used in Nova to query Glance about images |
− | *** ` | + | *** `glance.client.[[ParallaxClient]]` - A client tool for querying Parallax about available images |
− | *** ` | + | *** `glance.client.[[TellerClient]]` - A client tool for the chunked retrieval of an image |
− | + | __TOC__ | |
== Parallax API Commands == | == Parallax API Commands == | ||
− | This section describes the Parallax REST API for creating, listing, modifying, and deleting | + | This section describes the Parallax REST API for creating, listing, modifying, and deleting image metadata. |
=== Fetch id/name basic information on all public images === | === Fetch id/name basic information on all public images === | ||
Line 61: | Line 61: | ||
"image_type": "kernel" | "image_type": "kernel" | ||
"is_public": true, | "is_public": true, | ||
− | " | + | "properties": { "mykey": "myvalue" }, |
"files": [ { "location": "swift://user:passwd@acct/container/obj.tar.gz.0", | "files": [ { "location": "swift://user:passwd@acct/container/obj.tar.gz.0", | ||
"size": 101 } ] | "size": 101 } ] | ||
Line 72: | Line 72: | ||
==== Notes ==== | ==== Notes ==== | ||
− | The ` | + | The `properties` element is a mapping of custom key/value pairs the image may have saved with it. |
The `files` element is a list of mappings containing the chunks comprising an image along with the chunk's size | The `files` element is a list of mappings containing the chunks comprising an image along with the chunk's size | ||
Line 96: | Line 96: | ||
"image_type": "kernel" | "image_type": "kernel" | ||
"is_public": true, | "is_public": true, | ||
− | " | + | "properties": { "mykey": "myvalue" }, |
"files": [ { "location": "swift://user:passwd@acct/container/obj.tar.gz.0", | "files": [ { "location": "swift://user:passwd@acct/container/obj.tar.gz.0", | ||
"size": 101 } ] | "size": 101 } ] | ||
Line 108: | Line 108: | ||
The reason the returned dict contains only a single element, 'image', is for XML conversion purposes, where the root element will be `<image>` and not the root XML namespace. | The reason the returned dict contains only a single element, 'image', is for XML conversion purposes, where the root element will be `<image>` and not the root XML namespace. | ||
− | The ` | + | The `properties` element is a mapping of custom key/value pairs the image may have saved with it. |
The `files` element is a list of mappings containing the chunks comprising an image along with the chunk's size | The `files` element is a list of mappings containing the chunks comprising an image along with the chunk's size | ||
Line 117: | Line 117: | ||
=== Register/create a new image === | === Register/create a new image === | ||
− | |||
− | |||
Line 125: | Line 123: | ||
</nowiki></pre> | </nowiki></pre> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
The body of the request shall be a JSON encoded mapping of the image's metadata: | The body of the request shall be a JSON encoded mapping of the image's metadata: | ||
Line 156: | Line 131: | ||
"image": | "image": | ||
{ | { | ||
− | "name": " | + | "name": "My Image", |
− | " | + | "status": "available", |
− | " | + | "image_type": "kernel" |
+ | "is_public": true, | ||
+ | "properties": { "mykey": "myvalue" }, | ||
+ | "files": [ { "location": "swift://user:passwd@acct/container/obj.tar.gz.0", | ||
+ | "size": 101 } ] | ||
} | } | ||
} | } | ||
Line 164: | Line 143: | ||
− | + | The returned response, is successful, will be a JSON encoded mapping of the newly-created image in Parallax, including a populated `id` column with the new image's internal identifier: | |
− | |||
− | The returned response, will be a JSON encoded mapping of | ||
<pre><nowiki> | <pre><nowiki> | ||
{ | { | ||
− | |||
− | |||
− | |||
− | |||
"image": | "image": | ||
{ | { | ||
− | "id": | + | "id": 1, |
− | "name": " | + | "name": "My Image", |
− | "status": " | + | "status": "available", |
− | " | + | "image_type": "kernel" |
+ | "is_public": true, | ||
+ | "properties": { "mykey": "myvalue" }, | ||
+ | "files": [ { "location": "swift://user:passwd@acct/container/obj.tar.gz.0", | ||
+ | "size": 101 } ] | ||
} | } | ||
} | } | ||
Line 188: | Line 165: | ||
==== Notes ==== | ==== Notes ==== | ||
− | The ` | + | The reason the body dict and result dict contains only a single element, 'image', is for XML conversion purposes, where the root element will be `<image>` and not the root XML namespace. |
+ | |||
+ | The `properties` element is a mapping of custom key/value pairs the image may have saved with it. | ||
+ | |||
+ | The `files` element is a list of mappings containing the chunks comprising an image along with the chunk's size | ||
=== Update an existing image's metadata === | === Update an existing image's metadata === | ||
Line 210: | Line 191: | ||
"image_type": "kernel" | "image_type": "kernel" | ||
"is_public": true, | "is_public": true, | ||
− | " | + | "properties": { "mykey": "myvalue" }, |
"files": [ { "location": "swift://user:passwd@acct/container/obj.tar.gz.0", | "files": [ { "location": "swift://user:passwd@acct/container/obj.tar.gz.0", | ||
"size": 101 } ] | "size": 101 } ] | ||
Line 242: | Line 223: | ||
The reason the body dict and result dict contains only a single element, 'image', is for XML conversion purposes, where the root element will be `<image>` and not the root XML namespace. | The reason the body dict and result dict contains only a single element, 'image', is for XML conversion purposes, where the root element will be `<image>` and not the root XML namespace. | ||
− | The ` | + | The `properties` element is a mapping of custom key/value pairs the image may have saved with it. |
The `files` element is a list of mappings containing the chunks comprising an image along with the chunk's size | The `files` element is a list of mappings containing the chunks comprising an image along with the chunk's size | ||
Line 272: | Line 253: | ||
<pre><nowiki> | <pre><nowiki> | ||
− | GET /images | + | GET http://teller.openstack.org/images/<ID> |
</nowiki></pre> | </nowiki></pre> | ||
Line 281: | Line 262: | ||
404:: Image was not found | 404:: Image was not found | ||
+ | |||
+ | === Store an Image === | ||
+ | |||
+ | |||
+ | <pre><nowiki> | ||
+ | POST http://teller.openstack.org/images/<ID> | ||
+ | </nowiki></pre> | ||
+ | |||
+ | |||
+ | The body of the POST request shall be a mime-encoded blob of data representing the image to be stored. | ||
+ | |||
+ | Note: All this does is store the raw image data in Teller's backend. If you are responsible for storing the metadata about the image, you should do that with a similar call to Parallax's API. | ||
+ | |||
+ | Immediately returns a mapping of image information indicating status of the image: | ||
+ | |||
+ | |||
+ | <pre><nowiki> | ||
+ | { | ||
+ | 'image': | ||
+ | { | ||
+ | 'id': identifier for image, | ||
+ | 'status': 'pending' | ||
+ | } | ||
+ | } | ||
+ | </nowiki></pre> | ||
+ | |||
+ | |||
+ | === Update an Image === | ||
+ | |||
+ | There is no operation for updating an image. All images are immutable once created. | ||
+ | |||
+ | === Delete an Image === | ||
+ | |||
+ | |||
+ | <pre><nowiki> | ||
+ | DELETE http://teller.openstack.org/images/<ID> | ||
+ | </nowiki></pre> | ||
+ | |||
+ | |||
+ | Returns 200 OK on success | ||
+ | |||
+ | Returns 404 when image with URI does not exist |
Latest revision as of 19:06, 11 May 2016
Glance API Specification
Glance <=> Nova Integration requires these components:
- Glance - VM Image Management Service
- Parallax - Image Registry service
- Teller - Image Delivery service
- Client Classes
- `glance.client.GlanceClient` - A client used in Nova to query Glance about images
- `glance.client.ParallaxClient` - A client tool for querying Parallax about available images
- `glance.client.TellerClient` - A client tool for the chunked retrieval of an image
- `glance.client.GlanceClient` - A client used in Nova to query Glance about images
Contents
- 1 Glance API Specification
- 1.1 Parallax API Commands
- 1.2 Teller API Commands
Parallax API Commands
This section describes the Parallax REST API for creating, listing, modifying, and deleting image metadata.
Fetch id/name basic information on all public images
GET http://parallax.openstack.org/images
Returns a mapping containing a list of mappings containing details information about the public images encoded in JSON:
{ "images": [ {"id": 1, "name": "My Image 1"}, {"id": 2, "name": "My Image 2"}, ] }
Fetch detailed information on all public images
GET http://parallax.openstack.org/images/detail
Returns a mapping containing a list of mappings containing details information about the public images encoded in JSON:
{ "images": [ { "id": 1, "name": "My Image", "status": "available", "image_type": "kernel" "is_public": true, "properties": { "mykey": "myvalue" }, "files": [ { "location": "swift://user:passwd@acct/container/obj.tar.gz.0", "size": 101 } ] } ] }
Notes
The `properties` element is a mapping of custom key/value pairs the image may have saved with it.
The `files` element is a list of mappings containing the chunks comprising an image along with the chunk's size
Fetch a single image's metadata
GET http://parallax.openstack.org/images/<ID>
Returns the image's metadata encoded in JSON:
{ "image": { "id": 1, "name": "My Image", "status": "available", "image_type": "kernel" "is_public": true, "properties": { "mykey": "myvalue" }, "files": [ { "location": "swift://user:passwd@acct/container/obj.tar.gz.0", "size": 101 } ] } }
Notes
The reason the returned dict contains only a single element, 'image', is for XML conversion purposes, where the root element will be `<image>` and not the root XML namespace.
The `properties` element is a mapping of custom key/value pairs the image may have saved with it.
The `files` element is a list of mappings containing the chunks comprising an image along with the chunk's size
Exceptions
404:: Image was not found
Register/create a new image
POST http://parallax.openstack.org/images
The body of the request shall be a JSON encoded mapping of the image's metadata:
{ "image": { "name": "My Image", "status": "available", "image_type": "kernel" "is_public": true, "properties": { "mykey": "myvalue" }, "files": [ { "location": "swift://user:passwd@acct/container/obj.tar.gz.0", "size": 101 } ] } }
The returned response, is successful, will be a JSON encoded mapping of the newly-created image in Parallax, including a populated `id` column with the new image's internal identifier:
{ "image": { "id": 1, "name": "My Image", "status": "available", "image_type": "kernel" "is_public": true, "properties": { "mykey": "myvalue" }, "files": [ { "location": "swift://user:passwd@acct/container/obj.tar.gz.0", "size": 101 } ] } }
Notes
The reason the body dict and result dict contains only a single element, 'image', is for XML conversion purposes, where the root element will be `<image>` and not the root XML namespace.
The `properties` element is a mapping of custom key/value pairs the image may have saved with it.
The `files` element is a list of mappings containing the chunks comprising an image along with the chunk's size
Update an existing image's metadata
PUT http://parallax.openstack.org/images/<ID>
The body of the request shall be a JSON encoded mapping of the image's metadata:
{ "image": { "id": 2349823, "name": "My Image", "status": "disabled", "image_type": "kernel" "is_public": true, "properties": { "mykey": "myvalue" }, "files": [ { "location": "swift://user:passwd@acct/container/obj.tar.gz.0", "size": 101 } ] } }
The returned response, if successful, will be a JSON encoded mapping of the updated image metadata in Parallax:
{ "image": { "id": 2349823, "name": "My Image", "status": "disabled", "image_type": "kernel" "is_public": true, "metadata": { "mykey": "myvalue" }, "files": [ { "location": "swift://user:passwd@acct/container/obj.tar.gz.0", "size": 101 } ] } }
Notes
The reason the body dict and result dict contains only a single element, 'image', is for XML conversion purposes, where the root element will be `<image>` and not the root XML namespace.
The `properties` element is a mapping of custom key/value pairs the image may have saved with it.
The `files` element is a list of mappings containing the chunks comprising an image along with the chunk's size
Exceptions
404:: Image was not found
Delete an existing image from the registry
DELETE http://parallax.openstack.org/images/<ID>
The body of the request will be ignored.
Exceptions
404:: Image was not found
Teller API Commands
This section describes the Teller REST API.
Fetch an Image
GET http://teller.openstack.org/images/<ID>
Returns the virtual machine image data as response body.
Exceptions
404:: Image was not found
Store an Image
POST http://teller.openstack.org/images/<ID>
The body of the POST request shall be a mime-encoded blob of data representing the image to be stored.
Note: All this does is store the raw image data in Teller's backend. If you are responsible for storing the metadata about the image, you should do that with a similar call to Parallax's API.
Immediately returns a mapping of image information indicating status of the image:
{ 'image': { 'id': identifier for image, 'status': 'pending' } }
Update an Image
There is no operation for updating an image. All images are immutable once created.
Delete an Image
DELETE http://teller.openstack.org/images/<ID>
Returns 200 OK on success
Returns 404 when image with URI does not exist