Update api-ref for v.2.6
2.6 was experimental in Pike but is current in Queens. Change-Id: I4f8c4ff72808aac1fc52c65673d28530aa9939f2 Closes-bug: #1748218
This commit is contained in:
parent
4c221c7cc7
commit
32f8724f6e
@ -5,27 +5,10 @@
|
|||||||
Interoperable image import
|
Interoperable image import
|
||||||
**************************
|
**************************
|
||||||
|
|
||||||
An interoperable image import process is introduced in the Pike release
|
An interoperable image import process is introduced in the Image API v2.6.
|
||||||
as part of the EXPERIMENTAL Image API v2.6.
|
|
||||||
|
|
||||||
*This EXPERIMENTAL API is optional and may not be enabled in your
|
Use the :ref:`API versions call <versions-call>` to determine what API verisons
|
||||||
cloud. Consult your cloud operator's documentation for details.*
|
are available in your cloud.
|
||||||
|
|
||||||
In version 2.5 of the API, these calls return a 404 (Not Found).
|
|
||||||
Use the :ref:`API versions call <versions-call>` to determine
|
|
||||||
what API verisons are available in your cloud.
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
This EXPERIMENTAL API is subject to change. It is a partial implementation
|
|
||||||
of what's described in the Glance design document `Image Import Refactor`_.
|
|
||||||
We expect any changes to be expansive and to be in accord with what's
|
|
||||||
described in that document, but we are releasing version 2.6 in
|
|
||||||
EXPERIMENTAL status in the Pike release so that we can reserve the right to
|
|
||||||
make backward-incompatible changes in light of feedback from users and
|
|
||||||
operators. Our intent is that these calls will be finalized before the
|
|
||||||
Queens release and the EXPERIMENTAL status will be lifted at that time.
|
|
||||||
|
|
||||||
.. _`Image Import Refactor`: https://specs.openstack.org/openstack/glance-specs/specs/mitaka/approved/image-import/image-import-refactor.html
|
|
||||||
|
|
||||||
General information
|
General information
|
||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
@ -35,9 +18,14 @@ the import methods available in the cloud in which you want to import
|
|||||||
an image. Each of these methods is well defined (which is what makes
|
an image. Each of these methods is well defined (which is what makes
|
||||||
this process interoperable among different OpenStack clouds).
|
this process interoperable among different OpenStack clouds).
|
||||||
|
|
||||||
|
Two import methods are defined, ``glance-direct`` and ``web-download``.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
In the EXPERIMENTAL Image API v2.6, the only import method available
|
|
||||||
is ``glance-direct``.
|
Use the :ref:`Import Method Discovery <import-discovery-call>` call
|
||||||
|
to determine what import methods are available in the cloud to which
|
||||||
|
you wish to import an image.
|
||||||
|
|
||||||
|
|
||||||
The ``glance-direct`` workflow has three parts:
|
The ``glance-direct`` workflow has three parts:
|
||||||
|
|
||||||
@ -59,10 +47,7 @@ The ``glance-direct`` workflow has three parts:
|
|||||||
3. Issue the :ref:`Image Import <image-import-call>` call to complete
|
3. Issue the :ref:`Image Import <image-import-call>` call to complete
|
||||||
the import process.
|
the import process.
|
||||||
|
|
||||||
Additionally, there is an :ref:`Import Method Discovery
|
.. TODO(rosmaita): describe the web-download workflow
|
||||||
<import-discovery-call>` call that allows you to determine what import
|
|
||||||
methods are available in the cloud to which you wish to import an image.
|
|
||||||
|
|
||||||
|
|
||||||
.. _image-stage-call:
|
.. _image-stage-call:
|
||||||
|
|
||||||
@ -74,7 +59,7 @@ Stage binary image data
|
|||||||
Places the binary image data in a staging area. It is not stored in
|
Places the binary image data in a staging area. It is not stored in
|
||||||
the storage backend and is not accessible for download until after
|
the storage backend and is not accessible for download until after
|
||||||
the :ref:`Image Import <image-import-call>` call is made.
|
the :ref:`Image Import <image-import-call>` call is made.
|
||||||
*(EXPERIMENTAL in Image API v2.6)*
|
*(Since Image API v2.6)*
|
||||||
|
|
||||||
Set the ``Content-Type`` request header to ``application/octet-stream``.
|
Set the ``Content-Type`` request header to ``application/octet-stream``.
|
||||||
|
|
||||||
@ -84,7 +69,7 @@ Example call:
|
|||||||
|
|
||||||
curl -i -X PUT -H "X-Auth-Token: $token" \
|
curl -i -X PUT -H "X-Auth-Token: $token" \
|
||||||
-H "Content-Type: application/octet-stream" \
|
-H "Content-Type: application/octet-stream" \
|
||||||
-d @/home/glance/experimental.qcow2 \
|
-d @/home/glance/my.to-import.qcow2 \
|
||||||
$image_url/v2/images/{image_id}/stage
|
$image_url/v2/images/{image_id}/stage
|
||||||
|
|
||||||
**Preconditions**
|
**Preconditions**
|
||||||
@ -142,14 +127,15 @@ Import an image
|
|||||||
|
|
||||||
Signals the Image Service to complete the image import workflow
|
Signals the Image Service to complete the image import workflow
|
||||||
by processing the previously staged image data.
|
by processing the previously staged image data.
|
||||||
*(EXPERIMENTAL in Image API v2.6)*
|
*(Since Image API v2.6)*
|
||||||
|
|
||||||
Example call: ``curl -i -X POST -H "X-Auth-Token: $token"
|
Example call: ``curl -i -X POST -H "X-Auth-Token: $token"
|
||||||
$image_url/v2/images/{image_id}/import``
|
$image_url/v2/images/{image_id}/import``
|
||||||
|
|
||||||
The JSON request body specifies what import method you wish to use
|
The JSON request body specifies what import method you wish to use
|
||||||
for this image request. *Note: In the EXPERIMENTAL Image API v2.6,
|
for this image request.
|
||||||
the only method available is glance-direct.*
|
|
||||||
|
.. TODO(rosmaita): rewrite to include web-download info
|
||||||
|
|
||||||
Before you can complete the ``glance-direct`` image import workflow, you
|
Before you can complete the ``glance-direct`` image import workflow, you
|
||||||
must meet the following preconditions:
|
must meet the following preconditions:
|
||||||
@ -210,10 +196,10 @@ formats, supported disk formats, maximum image size, etc. This call
|
|||||||
contains a ``import-methods`` field consisting of an array of string
|
contains a ``import-methods`` field consisting of an array of string
|
||||||
identifiers indicating what import methods are supported in the cloud
|
identifiers indicating what import methods are supported in the cloud
|
||||||
in which the call is made.
|
in which the call is made.
|
||||||
*(EXPERIMENTAL in Image API v2.6)*
|
*(Since Image API v2.6)*
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
In the EXPERIMENTAL Image API v2.6, this discovery call contains
|
In the Image API v2.6, this discovery call contains
|
||||||
**only** the ``import-methods`` field.
|
**only** the ``import-methods`` field.
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
|
@ -52,8 +52,7 @@ Content-Type-patch:
|
|||||||
import-header:
|
import-header:
|
||||||
description: |
|
description: |
|
||||||
A comma separated list of import method identifiers. Included
|
A comma separated list of import method identifiers. Included
|
||||||
only if image import is enabled in your cloud. *Introduced
|
only if image import is enabled in your cloud. *Since Image API v2.6*
|
||||||
in the EXPERIMENTAL Image API v2.6*
|
|
||||||
in: header
|
in: header
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
@ -436,8 +435,7 @@ method-in-request:
|
|||||||
A JSON object indicating what import method you wish to use to import
|
A JSON object indicating what import method you wish to use to import
|
||||||
your image. The content of this JSON object is another JSON object
|
your image. The content of this JSON object is another JSON object
|
||||||
with a ``name`` field whose value is the identifier for the import
|
with a ``name`` field whose value is the identifier for the import
|
||||||
method. *(Note: In the EXPERIMENTAL Image API v2.6, the only supported
|
method.
|
||||||
import method is glance-direct.*
|
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: object
|
type: object
|
||||||
|
@ -24,6 +24,11 @@ Image Service Versions
|
|||||||
Version History
|
Version History
|
||||||
***************
|
***************
|
||||||
|
|
||||||
|
**Queens changes**
|
||||||
|
|
||||||
|
- version 2.6 is CURRENT
|
||||||
|
- version 2.5 is SUPPORTED
|
||||||
|
|
||||||
**Pike changes**
|
**Pike changes**
|
||||||
|
|
||||||
- version 2.6 is EXPERIMENTAL
|
- version 2.6 is EXPERIMENTAL
|
||||||
|
@ -8,7 +8,7 @@
|
|||||||
"rel": "self"
|
"rel": "self"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"status": "EXPERIMENTAL"
|
"status": "CURRENT"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "v2.5",
|
"id": "v2.5",
|
||||||
@ -18,7 +18,7 @@
|
|||||||
"rel": "self"
|
"rel": "self"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"status": "CURRENT"
|
"status": "SUPPORTED"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "v2.4",
|
"id": "v2.4",
|
||||||
|
Loading…
Reference in New Issue
Block a user