stx-docs: API ref doc content added for remaining 4 docs.
I added the api-ref-blockstorage-v2-cgcs-ext.rst, api-ref-compute-v2-cgcs-ext.rst, api-ref-image-v2-cgcs-ext.rst, and api-ref-networking-v2-cgcs-ext.rst files, which are content for the remaining 4 API reference manuals to the api-ref/source dir. This represents the converted old-style files to the newer OpenStack supported RST files. I updated the index.rst file to include the new .rst file so that the api-ref document can build. Change-Id: I4c3e89d38b1e6afd52d0307fb95be8c0d974ff45 Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
This commit is contained in:
Scott Rifenbark
Abraham Arce
parent
ccd043a129
commit
ea38cb456d
555
api-ref/source/api-ref-blockstorage-v2-cgcs-ext.rst
Normal file
555
api-ref/source/api-ref-blockstorage-v2-cgcs-ext.rst
Normal file
@ -0,0 +1,555 @@
|
||||
====================================================
|
||||
Block Storage API v2 StarlingX extensions
|
||||
====================================================
|
||||
|
||||
StarlingX extensions to the OpenStack Block Storage API such as backup
|
||||
status and export/import actions for volumes and snapshots.
|
||||
|
||||
The typical port used for the Block Storage REST API is 8776. However,
|
||||
proper technique would be to look up the cinderv2 service endpoint in
|
||||
keystone.
|
||||
|
||||
-----------
|
||||
Extensions
|
||||
-----------
|
||||
|
||||
The Extensions entity lists all available extensions
|
||||
|
||||
**********************
|
||||
Lists all extensions
|
||||
**********************
|
||||
|
||||
.. rest_method:: GET /v2/{tenant_id}/extensions
|
||||
|
||||
**Normal response codes**
|
||||
|
||||
200
|
||||
|
||||
**Error response codes**
|
||||
|
||||
computeFault (400, 500, ...), serviceUnavailable (503), badRequest (400),
|
||||
unauthorized (401), forbidden (403), badMethod (405), overLimit (413),
|
||||
itemNotFound (404)
|
||||
|
||||
**Request parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"tenant_id", "URI", "csapi:UUID", "The ID for the tenant or account in a multi-tenancy cloud."
|
||||
|
||||
**Response parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"namespace (Optional)", "plain", "xsd:string", "Indicates namespace of the extension."
|
||||
"name (Optional)", "plain", "xsd:string", "Indicates name of the extension."
|
||||
"updated (Optional)", "plain", "xsd:string", "Indicates updated time of the extension."
|
||||
"description (Optional)", "plain", "xsd:string", "Indicates description of the extension."
|
||||
"alias (Optional)", "plain", "xsd:string", "Indicates alias of the extension."
|
||||
"links (Optional)", "plain", "xsd:list", "A list of links for the extension."
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"extensions" : [
|
||||
...
|
||||
{
|
||||
"namespace" : "http://docs.windriver.com/volume/ext/wrs-snapshot/api/v1.0",
|
||||
"name" : "WrsSnapshotExportAction",
|
||||
"updated" : "2014-08-16T00:00:00+00:00",
|
||||
"description" : "Enable snapshot export to file",
|
||||
"alias" : "wrs-snapshot",
|
||||
"links" : []
|
||||
},
|
||||
{
|
||||
"namespace" : "http://docs.windriver.com/volume/ext/wrs-volume/api/v1.0",
|
||||
"name" : "WrsVolumeExport",
|
||||
"updated" : "2014-08-11T00:00:00+00:00",
|
||||
"description" : "Enable volume export/import",
|
||||
"alias" : "wrs-volume",
|
||||
"links" : []
|
||||
},
|
||||
...
|
||||
]
|
||||
}
|
||||
|
||||
This operation does not accept a request body.
|
||||
|
||||
**********************************************
|
||||
Gets information about a specified extension
|
||||
**********************************************
|
||||
|
||||
.. rest_method:: GET /v2/{tenant_id}/extensions/{extension_alias}
|
||||
|
||||
**Normal response codes**
|
||||
|
||||
200
|
||||
|
||||
**Error response codes**
|
||||
|
||||
computeFault (400, 500, ...), serviceUnavailable (503), badRequest (400),
|
||||
unauthorized (401), forbidden (403), badMethod (405), overLimit (413),
|
||||
itemNotFound (404)
|
||||
|
||||
**Request parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"tenant_id", "URI", "csapi:UUID", "The ID for the tenant or account in a multi-tenancy cloud."
|
||||
"extension_alias", "URI", "xsd:string", "The alias for the extension to list."
|
||||
|
||||
**Response parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"namespace (Optional)", "plain", "xsd:string", "Indicates namespace of the extension."
|
||||
"name (Optional)", "plain", "xsd:string", "Indicates name of the extension."
|
||||
"updated (Optional)", "plain", "xsd:string", "Indicates updated time of the extension."
|
||||
"description (Optional)", "plain", "xsd:string", "Indicates description of the extension."
|
||||
"alias (Optional)", "plain", "xsd:string", "Indicates alias of the extension."
|
||||
"links (Optional)", "plain", "xsd:list", "A list of links for the extension."
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"extension" : {
|
||||
"namespace" : "http://docs.windriver.com/volume/ext/wrs-volume/api/v1.0",
|
||||
"name" : "WrsVolumeExport",
|
||||
"updated" : "2014-08-11T00:00:00+00:00",
|
||||
"description" : "Enable volume export/import",
|
||||
"alias" : "wrs-volume",
|
||||
"links" : []
|
||||
}
|
||||
}
|
||||
|
||||
OR
|
||||
|
||||
{
|
||||
"extension" : {
|
||||
"namespace" : "http://docs.windriver.com/volume/ext/wrs-snapshot/api/v1.0",
|
||||
"name" : "WrsSnapshotExportAction",
|
||||
"updated" : "2014-08-16T00:00:00+00:00",
|
||||
"description" : "Enable snapshot export to file",
|
||||
"alias" : "wrs-snapshot",
|
||||
"links" : []
|
||||
}
|
||||
}
|
||||
|
||||
This operation does not accept a request body.
|
||||
|
||||
--------
|
||||
Volumes
|
||||
--------
|
||||
|
||||
StarlingX extensions include export and import actions for performing
|
||||
backup and restores of volumes, and a backup status attribute to
|
||||
indicate the status of the new actions.
|
||||
|
||||
**************************************
|
||||
Get information about system volumes
|
||||
**************************************
|
||||
|
||||
.. rest_method:: GET /v2/{tenant_id}/volumes/detail
|
||||
|
||||
Preconditions
|
||||
|
||||
- The specified volume must exist in all case.
|
||||
|
||||
**Normal response codes**
|
||||
|
||||
200
|
||||
|
||||
**Request parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"tenant_id", "URI", "csapi:UUID", "The ID for the tenant or account in a multi-tenancy cloud."
|
||||
|
||||
**Response parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"wrs-volume:backup_status", "plain", "xsd:string", "Indicates backup status."
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"volumes" : [
|
||||
{
|
||||
"wrs-volume:backup_status" : "Export completed at 2015-02-27 16:35:53.545339",
|
||||
"volume_type" : "None",
|
||||
"status" : "available",
|
||||
"size" : 1,
|
||||
"created_at" : "2015-02-27T16:26:08.164607",
|
||||
"id" : "b7db512f-463e-4720-8fbd-154c0f2bc2ae",
|
||||
"metadata" : {},
|
||||
"attachments" : [],
|
||||
"os-volume-replication:driver_data" : null,
|
||||
"os-vol-mig-status-attr:migstat" : null,
|
||||
"display_name" : null,
|
||||
"availability_zone" : "nova",
|
||||
"display_description" : null,
|
||||
"encrypted" : false,
|
||||
"os-vol-mig-status-attr:name_id" : null,
|
||||
"os-vol-host-attr:host" : "controller@lvm#lvm",
|
||||
"os-volume-replication:extended_status" : null,
|
||||
"snapshot_id" : null,
|
||||
"os-vol-tenant-attr:tenant_id" : "e0741109067649a8899936e9fefda95b",
|
||||
"bootable" : "false",
|
||||
"source_volid" : null
|
||||
},
|
||||
{
|
||||
"wrs-volume:backup_status" : "Import completed at 2015-02-27 15:04:29.135579",
|
||||
"volume_type" : "None",
|
||||
"status" : "available",
|
||||
"size" : 1,
|
||||
"created_at" : "2015-02-27T14:04:34.763953",
|
||||
"id" : "27080551-9d88-4cf0-aa85-c1392dbf38f4",
|
||||
"metadata" : {},
|
||||
"attachments" : [],
|
||||
"os-volume-replication:driver_data" : null,
|
||||
"os-vol-mig-status-attr:migstat" : null,
|
||||
"display_name" : null,
|
||||
"availability_zone" : "nova",
|
||||
"display_description" : null,
|
||||
"encrypted" : false,
|
||||
"os-vol-mig-status-attr:name_id" : null,
|
||||
"os-vol-host-attr:host" : "controller@lvm#lvm",
|
||||
"os-volume-replication:extended_status" : null,
|
||||
"snapshot_id" : null,
|
||||
"os-vol-tenant-attr:tenant_id" : "e0741109067649a8899936e9fefda95b",
|
||||
"bootable" : "false",
|
||||
"source_volid" : null
|
||||
},
|
||||
{
|
||||
"wrs-volume:backup_status" : "Snapshot export completed at 2015-02-27 20:57:29.323714",
|
||||
"volume_type" : "None",
|
||||
"status" : "available",
|
||||
"size" : 1,
|
||||
"created_at" : "2015-02-27T13:44:55.317995",
|
||||
"id" : "2c4f094b-f6d8-4ff6-800e-e5998cb4d6fa",
|
||||
"metadata" : {},
|
||||
"attachments" : [],
|
||||
"os-volume-replication:driver_data" : null,
|
||||
"os-vol-mig-status-attr:migstat" : null,
|
||||
"display_name" : null,
|
||||
"availability_zone" : "nova",
|
||||
"display_description" : null,
|
||||
"encrypted" : false,
|
||||
"os-vol-mig-status-attr:name_id" : null,
|
||||
"os-vol-host-attr:host" : "controller@lvm#lvm",
|
||||
"os-volume-replication:extended_status" : null,
|
||||
"snapshot_id" : null,
|
||||
"os-vol-tenant-attr:tenant_id" : "e0741109067649a8899936e9fefda95b",
|
||||
"bootable" : "false",
|
||||
"source_volid" : null
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
******************************************
|
||||
Get information about a specified volume
|
||||
******************************************
|
||||
|
||||
.. rest_method:: GET /v2/{tenant_id}/volumes/{volume_id}
|
||||
|
||||
Preconditions
|
||||
|
||||
- The specified volume must exist in all case.
|
||||
|
||||
**Normal response codes**
|
||||
|
||||
200
|
||||
|
||||
**Request parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"tenant_id", "URI", "csapi:UUID", "The ID for the tenant or account in a multi-tenancy cloud."
|
||||
"volume_id", "URI", "csapi:UUID", "The ID for the volume to list."
|
||||
|
||||
**Response parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"wrs-volume:backup_status", "plain", "xsd:string", "Indicates backup status."
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"volumes" : [
|
||||
{
|
||||
"wrs-volume:backup_status" : "Import completed at 2015-02-27 15:04:29.135579",
|
||||
"volume_type" : "None",
|
||||
"status" : "available",
|
||||
"size" : 1,
|
||||
"created_at" : "2015-02-27T14:04:34.763953",
|
||||
"id" : "27080551-9d88-4cf0-aa85-c1392dbf38f4",
|
||||
"metadata" : {},
|
||||
"attachments" : [],
|
||||
"os-volume-replication:driver_data" : null,
|
||||
"os-vol-mig-status-attr:migstat" : null,
|
||||
"display_name" : null,
|
||||
"availability_zone" : "nova",
|
||||
"display_description" : null,
|
||||
"encrypted" : false,
|
||||
"os-vol-mig-status-attr:name_id" : null,
|
||||
"os-vol-host-attr:host" : "controller@lvm#lvm",
|
||||
"os-volume-replication:extended_status" : null,
|
||||
"snapshot_id" : null,
|
||||
"os-vol-tenant-attr:tenant_id" : "e0741109067649a8899936e9fefda95b",
|
||||
"bootable" : "false",
|
||||
"source_volid" : null
|
||||
},
|
||||
]
|
||||
}
|
||||
|
||||
******************************************************************
|
||||
Executes the specified action or command on the specified volume
|
||||
******************************************************************
|
||||
|
||||
.. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action
|
||||
|
||||
Preconditions
|
||||
|
||||
- The specified volume must exist in all case.
|
||||
|
||||
**Normal response codes**
|
||||
|
||||
200
|
||||
|
||||
**Request parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"tenant_id", "URI", "csapi:UUID", "The ID for the tenant or account in a multi-tenancy cloud."
|
||||
"volume_id", "URI", "csapi:UUID", "The ID for the volume to list."
|
||||
"wrs-volume:os-volume_export", "plain", "xsd:string", "Export volume to a file"
|
||||
"wrs-volume:os-volume_import", "plain", "xsd:string", "Import a volume from a file <ul><li>file_name: ""VolumeExportName.tgz"". </li></ul>"
|
||||
|
||||
**Response parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"volume_type", "plain", "xsd:string", "Indicates the volume type."
|
||||
"updated_at", "plain", "xsd:string", "Indicates when the action was performed."
|
||||
"status", "plain", "xsd:string", "Indicates the state of the export or import action."
|
||||
"id", "plain", "csapi:UUID", "Indicates the volume UUID."
|
||||
"display_description", "plain", "xsd:string", "Volume descrition if any."
|
||||
"size", "plain", "xsd:int", "Indicates the volume size in Gbyte."
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
'wrs-volume:os-volume_export' : {
|
||||
'volume_type' : null,
|
||||
'updated_at' : '2015-02-27T14:04:35.201969',
|
||||
'status' : 'exporting',
|
||||
'id' : '27080551-9d88-4cf0-aa85-c1392dbf38f4',
|
||||
'display_description' : null,
|
||||
'size' : 1
|
||||
}
|
||||
}
|
||||
or
|
||||
{
|
||||
'wrs-volume:os-volume_import' : {
|
||||
'volume_type' : null,
|
||||
'updated_at' : '2015-02-27T15:03:54.045796',
|
||||
'status' : 'importing',
|
||||
'id' : '27080551-9d88-4cf0-aa85-c1392dbf38f4',
|
||||
'display_description' : null,
|
||||
'size' : 1
|
||||
}
|
||||
}
|
||||
|
||||
----------
|
||||
Snapshots
|
||||
----------
|
||||
|
||||
StarlingX extensions include export actions for performing backup volumes
|
||||
already attached to a VM, and a backup status attribute to indicate the
|
||||
status of the new actions.
|
||||
|
||||
***********************************************
|
||||
Get information about system volume snapshots
|
||||
***********************************************
|
||||
|
||||
.. rest_method:: GET /v2/{tenant_id}/snapshots/detail
|
||||
|
||||
Preconditions
|
||||
|
||||
- The specified volume snapshot must exist in all case.
|
||||
|
||||
**Normal response codes**
|
||||
|
||||
200
|
||||
|
||||
**Request parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"tenant_id", "URI", "csapi:UUID", "The ID for the tenant or account in a multi-tenancy cloud."
|
||||
|
||||
**Response parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"wrs-snapshot:backup_status", "plain", "xsd:string", "Indicates backup status."
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"snapshots" : [
|
||||
{
|
||||
"volume_id" : "f15dcbfb-8b41-4fff-adb8-77a4162a318b",
|
||||
"status" : "available",
|
||||
"display_description" : null,
|
||||
"display_name" : null,
|
||||
"size" : 1,
|
||||
"created_at" : "2015-02-27T13:19:02.380453",
|
||||
"os-extended-snapshot-attributes:project_id" : "e0741109067649a8899936e9fefda95b",
|
||||
"wrs-snapshot:backup_status" : "Export completed at 2015-02-27 13:19:48.914344",
|
||||
"id" : "7b220cb7-212f-411e-a8cd-41e6bdbac724",
|
||||
"metadata" : {},
|
||||
"os-extended-snapshot-attributes:progress" : "100%"
|
||||
},
|
||||
{
|
||||
"volume_id" : "2c4f094b-f6d8-4ff6-800e-e5998cb4d6fa",
|
||||
"status" : "available",
|
||||
"display_description" : null,
|
||||
"display_name" : null,
|
||||
"size" : 1,
|
||||
"created_at" : "2015-02-27T20:56:32.033427",
|
||||
"os-extended-snapshot-attributes:project_id" : "e0741109067649a8899936e9fefda95b",
|
||||
"wrs-snapshot:backup_status" : "Export completed at 2015-02-27 20:57:29.279574",
|
||||
"id" : "0aa45e0c-74ea-433e-b8f3-0dc778d3972b",
|
||||
"metadata" : {},
|
||||
"os-extended-snapshot-attributes:progress" : "100%"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
***********************************************
|
||||
Get information of a specific volume snapshot
|
||||
***********************************************
|
||||
|
||||
.. rest_method:: GET /v2/{tenant_id}/snapshots/{snapshot_id}
|
||||
|
||||
Preconditions
|
||||
|
||||
- The specified volume snapshot must exist in all case.
|
||||
|
||||
**Normal response codes**
|
||||
|
||||
200
|
||||
|
||||
**Request parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"tenant_id", "URI", "csapi:UUID", "The ID for the tenant or account in a multi-tenancy cloud."
|
||||
"snapshot_id", "URI", "csapi:UUID", "The ID for the snapshot to list."
|
||||
|
||||
**Response parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"wrs-snapshot:backup_status", "plain", "xsd:string", "Indicates backup status."
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"snapshot" : {
|
||||
"volume_id" : "2c4f094b-f6d8-4ff6-800e-e5998cb4d6fa",
|
||||
"status" : "available",
|
||||
"display_description" : null,
|
||||
"display_name" : null,
|
||||
"size" : 1,
|
||||
"created_at" : "2015-02-27T20:56:32.033427",
|
||||
"os-extended-snapshot-attributes:project_id" : "e0741109067649a8899936e9fefda95b",
|
||||
"wrs-snapshot:backup_status" : "Export completed at 2015-02-27 20:57:29.279574",
|
||||
"id" : "0aa45e0c-74ea-433e-b8f3-0dc778d3972b",
|
||||
"metadata" : {},
|
||||
"os-extended-snapshot-attributes:progress" : "100%"
|
||||
}
|
||||
}
|
||||
|
||||
***************************************************************************
|
||||
Executes the specified action or command on the specified volume snapshot
|
||||
***************************************************************************
|
||||
|
||||
.. rest_method:: POST /v2/{tenant_id}/snapshots/{snapshot_id}/action
|
||||
|
||||
Preconditions
|
||||
|
||||
- The specified volume snapshot must exist in all case.
|
||||
|
||||
**Normal response codes**
|
||||
|
||||
200
|
||||
|
||||
**Request parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"tenant_id", "URI", "csapi:UUID", "The ID for the tenant or account in a multi-tenancy cloud."
|
||||
"snapshot_id", "URI", "csapi:UUID", "The ID for the snapshot to list."
|
||||
"wrs-snapshot:os-snapshot_export", "plain", "xsd:string", "Export volume snapshot to a file"
|
||||
|
||||
**Response parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"volume_type", "plain", "xsd:string", "Indicates the volume type."
|
||||
"updated_at", "plain", "xsd:string", "Indicates when the action was performed."
|
||||
"status", "plain", "xsd:string", "Indicates the state of the volume snapshot export action."
|
||||
"id", "plain", "csapi:UUID", "Indicates the volume UUID."
|
||||
"display_description", "plain", "xsd:string", "Volume descrition if any."
|
||||
"volume_size", "plain", "xsd:int", "Indicates the volume size in Gbyte."
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"wrs-snapshot:os-export_snapshot" : {
|
||||
"volume_type" : null,
|
||||
"updated_at" : "2015-03-03T15:32:31.386661",
|
||||
"status" : "exporting",
|
||||
"volume_size" : 1,
|
||||
"id" : "9ad36199-c5b3-44bf-9273-c298ab7a0a2b",
|
||||
"display_description" : null
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
1366
api-ref/source/api-ref-compute-v2-cgcs-ext.rst
Normal file
1366
api-ref/source/api-ref-compute-v2-cgcs-ext.rst
Normal file
File diff suppressed because it is too large
Load Diff
390
api-ref/source/api-ref-image-v2-cgcs-ext.rst
Normal file
390
api-ref/source/api-ref-image-v2-cgcs-ext.rst
Normal file
@ -0,0 +1,390 @@
|
||||
====================================================
|
||||
Image API v2 StarlingX extensions
|
||||
====================================================
|
||||
|
||||
StarlingX extensions to the OpenStack Image API to support additional
|
||||
properties on images for customizing migration behaviour, supporting raw
|
||||
cached images in ceph cluster, disabling VM auto-recovery and indicating
|
||||
the backend where the image is stored.
|
||||
|
||||
The typical port used for the Image REST API is 9292. However, proper
|
||||
technique would be to look up the image/glance service endpoint in
|
||||
Keystone.
|
||||
|
||||
-------
|
||||
Images
|
||||
-------
|
||||
|
||||
The Image entity is extended by StarlingX to have additional
|
||||
properties on images for customizing migration behaviour, supporting raw
|
||||
cached images in ceph cluster, disabling VM auto-recovery and indicating
|
||||
the backend where the image is stored.
|
||||
|
||||
******************
|
||||
Creates an image
|
||||
******************
|
||||
|
||||
.. rest_method:: POST /v2/images
|
||||
|
||||
This is an existing OpenStack API. The documentation that follows lists
|
||||
only the fields that are new or modified. For a detailed description of
|
||||
existing and unmodified fields please refer to the standard OpenStack
|
||||
API documentation. NOTE that the extensions listed here are
|
||||
``additional properties`` which are supported in the Image API and
|
||||
implemented in a Stack-specific manner.
|
||||
|
||||
**Normal response codes**
|
||||
|
||||
200
|
||||
|
||||
**Error response codes**
|
||||
|
||||
badMediaType (415), NetworkNotFound (400)
|
||||
|
||||
**Request parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"cache_raw (Optional)", "plain", "xsd:bool", "On systems using Ceph storage, boot image files must be converted to RAW format before they can be used to create volumes. You can accelerate volume creation in StarlingX (and therefore instance launch time) by caching the RAW images as they are created. The cached images are maintained in the Glance image storage space and used for volume creation, eliminating conversion time. The default behaviour is to NOT cache the raw format."
|
||||
"sw_wrs_auto_recovery (Optional)", "plain", "xsd:bool", "Indicates whether auto recovery of failed virutal machine instances is enabled or not. The default is True."
|
||||
"hw_wrs_live_migration_timeout (Optional)", "plain", "xsd:integer", "Indicates the number of seconds to wait for a live migration to complete for a VM created with this image. Note that this can be specified as an extraspec of the flavor as well. If the timeout value is provisioned in both the flavor and the image, the smaller value is used. The default is 800 seconds. The minimum timeout is 120 seconds and the maximum timeout value is 800 seconds. To disable the live migration timeout feature, set this value to 0."
|
||||
"hw_wrs_live_migration_max_downtime (Optional)", "plain", "xsd:integer", "Indicates the maximum amoutn of downtime to tolerate during a live migration of a VM created with this image. Note that this can be specified as an extraspec of the flavor as well. If the max downtime value is provisioned in both the flavor and the image, the value from the flavor overrides the value from the image. The default is 500 milliseconds. The minimum timer value is 100 milliseconds."
|
||||
|
||||
**Response parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"cache_raw (Optional)", "plain", "xsd:bool", "On systems using Ceph storage, boot image files must be converted to RAW format before they can be used to create volumes. You can accelerate volume creation in StarlingX (and therefore instance launch time) by caching the RAW images as they are created. The cached images are maintained in the Glance image storage space and used for volume creation, eliminating conversion time. The default behaviour is to NOT cache the raw format."
|
||||
"store (Optional)", "plain", "xsd:string", "Indicates which Glance backend the image is stored in; either ``file`` for the Controller Filesystem or ``rbd`` for the ceph backend."
|
||||
"sw_wrs_auto_recovery (Optional)", "plain", "xsd:bool", "Indicates whether auto recovery of failed virutal machine instances is enabled or not. The default is ``True``."
|
||||
"hw_wrs_live_migration_timeout (Optional)", "plain", "xsd:integer", "Indicates the number of seconds to wait for a live migration to complete for a VM created with this image. Note that this can be specified as an extraspec of the flavor as well. If the timeout value is provisioned in both the flavor and the image, the smaller value is used. The default is 800 seconds. The minimum timeout is 120 seconds and the maximum timeout value is 800 seconds. To disable the live migration timeout feature, set this value to 0."
|
||||
"hw_wrs_live_migration_max_downtime (Optional)", "plain", "xsd:integer", "Indicates the maximum amoutn of downtime to tolerate during a live migration of a VM created with this image. Note that this can be specified as an extraspec of the flavor as well. If the max downtime value is provisioned in both the flavor and the image, the value from the flavor overrides the value from the image. The default is 500 milliseconds. The minimum timer value is 100 milliseconds."
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"hw_wrs_live_migration_timeout":"400",
|
||||
"name":"cirros",
|
||||
"container_format":"bare",
|
||||
"cache_raw":"True",
|
||||
"visibility":"public",
|
||||
"disk_format":"qcow2",
|
||||
"sw_wrs_auto_recovery":"False",
|
||||
"hw_wrs_live_migration_max_downtime":"350"
|
||||
}
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"hw_wrs_live_migration_timeout":"400",
|
||||
"disk_format":"qcow2",
|
||||
"min_ram":0,
|
||||
"updated_at":"2016-10-25T12:02:09Z",
|
||||
"file":"/v2/images/9d34ff07-6f66-4107-9363-e38b0b559a67/file",
|
||||
"owner":"b27359bcdb3e424db43a3e2255777f37",
|
||||
"id":"9d34ff07-6f66-4107-9363-e38b0b559a67",
|
||||
"size":null,
|
||||
"self":"/v2/images/9d34ff07-6f66-4107-9363-e38b0b559a67",
|
||||
"cache_raw":"True",
|
||||
"container_format":"bare",
|
||||
"schema":"/v2/schemas/image",
|
||||
"status":"queued",
|
||||
"tags":[
|
||||
|
||||
],
|
||||
"visibility":"public",
|
||||
"min_disk":0,
|
||||
"sw_wrs_auto_recovery":"False",
|
||||
"virtual_size":null,
|
||||
"hw_wrs_live_migration_max_downtime":"350",
|
||||
"name":"cirros",
|
||||
"checksum":null,
|
||||
"created_at":"2016-10-25T12:02:09Z",
|
||||
"protected":false
|
||||
}
|
||||
|
||||
******************
|
||||
Lists all images
|
||||
******************
|
||||
|
||||
.. rest_method:: GET /v2/images
|
||||
|
||||
This is an existing OpenStack API. The documentation that follows lists
|
||||
only the fields that are new or modified. For a detailed description of
|
||||
existing and unmodified fields please refer to the standard OpenStack
|
||||
API documentation. NOTE that the extensions listed here are
|
||||
``additional properties`` which are supported in the Image API and
|
||||
implemented in a Stack-specific manner.
|
||||
|
||||
**Normal response codes**
|
||||
|
||||
200
|
||||
|
||||
**Error response codes**
|
||||
|
||||
computeFault (400, 500, ...), serviceUnavailable (503), badRequest (400),
|
||||
unauthorized (401), forbidden (403), badMethod (405), overLimit (413),
|
||||
itemNotFound (404)
|
||||
|
||||
**Response parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"cache_raw (Optional)", "plain", "xsd:bool", "On systems using Ceph storage, boot image files must be converted to RAW format before they can be used to create volumes. You can accelerate volume creation in StarlingX (and therefore instance launch time) by caching the RAW images as they are created. The cached images are maintained in the Glance image storage space and used for volume creation, eliminating conversion time. The default behaviour is to NOT cache the raw format."
|
||||
"store (Optional)", "plain", "xsd:string", "Indicates which Glance backend the image is stored in; either ``file`` for the Controller Filesystem or ``rbd`` for the ceph backend."
|
||||
"sw_wrs_auto_recovery (Optional)", "plain", "xsd:bool", "Indicates whether auto recovery of failed virutal machine instances is enabled or not. The default is ``True``."
|
||||
"hw_wrs_live_migration_timeout (Optional)", "plain", "xsd:integer", "Indicates the number of seconds to wait for a live migration to complete for a VM created with this image. Note that this can be specified as an extraspec of the flavor as well. If the timeout value is provisioned in both the flavor and the image, the smaller value is used. The default is 800 seconds. The minimum timeout is 120 seconds and the maximum timeout value is 800 seconds. To disable the live migration timeout feature, set this value to 0."
|
||||
"hw_wrs_live_migration_max_downtime (Optional)", "plain", "xsd:integer", "Indicates the maximum amoutn of downtime to tolerate during a live migration of a VM created with this image. Note that this can be specified as an extraspec of the flavor as well. If the max downtime value is provisioned in both the flavor and the image, the value from the flavor overrides the value from the image. The default is 500 milliseconds. The minimum timer value is 100 milliseconds."
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"images":[
|
||||
{
|
||||
"status":"active",
|
||||
"virtual_size":null,
|
||||
"name":"sample-guest",
|
||||
"tags":[
|
||||
|
||||
],
|
||||
"container_format":"bare",
|
||||
"created_at":"2016-10-24T22:50:17Z",
|
||||
"size":688914432,
|
||||
"disk_format":"raw",
|
||||
"updated_at":"2016-10-24T22:50:26Z",
|
||||
"visibility":"public",
|
||||
"self":"/v2/images/ac22a842-27c6-40a5-8475-f15f12e94202",
|
||||
"min_disk":0,
|
||||
"protected":false,
|
||||
"id":"ac22a842-27c6-40a5-8475-f15f12e94202",
|
||||
"file":"/v2/images/ac22a842-27c6-40a5-8475-f15f12e94202/file",
|
||||
"checksum":"29514837240a4bb80df0e2362644ae17",
|
||||
"owner":"b27359bcdb3e424db43a3e2255777f37",
|
||||
"direct_url":"rbd://840f16bc-3238-4adb-8700-6b9876c23462/images/ac22a842-27c6-40a5-8475-f15f12e94202/snap",
|
||||
"min_ram":0,
|
||||
"store":"rbd",
|
||||
"schema":"/v2/schemas/image"
|
||||
},
|
||||
{
|
||||
"hw_wrs_live_migration_timeout":"400",
|
||||
"cache_raw":"True",
|
||||
"min_ram":0,
|
||||
"updated_at":"2016-10-25T12:06:19Z",
|
||||
"file":"/v2/images/9d34ff07-6f66-4107-9363-e38b0b559a67/file",
|
||||
"owner":"b27359bcdb3e424db43a3e2255777f37",
|
||||
"id":"9d34ff07-6f66-4107-9363-e38b0b559a67",
|
||||
"size":13287936,
|
||||
"self":"/v2/images/9d34ff07-6f66-4107-9363-e38b0b559a67",
|
||||
"disk_format":"qcow2",
|
||||
"cache_raw_url":"rbd://840f16bc-3238-4adb-8700-6b9876c23462/images/9d34ff07-6f66-4107-9363-e38b0b559a67_raw/snap",
|
||||
"container_format":"bare",
|
||||
"direct_url":"rbd://840f16bc-3238-4adb-8700-6b9876c23462/images/9d34ff07-6f66-4107-9363-e38b0b559a67/snap",
|
||||
"store":"rbd",
|
||||
"schema":"/v2/schemas/image",
|
||||
"status":"active",
|
||||
"cache_raw_size":"41126400",
|
||||
"cache_raw_status":"Cached",
|
||||
"tags":[
|
||||
|
||||
],
|
||||
"visibility":"public",
|
||||
"min_disk":0,
|
||||
"sw_wrs_auto_recovery":"False",
|
||||
"virtual_size":null,
|
||||
"hw_wrs_live_migration_max_downtime":"350",
|
||||
"name":"cirros",
|
||||
"checksum":"ee1eca47dc88f4879d8a229cc70a07c6",
|
||||
"created_at":"2016-10-25T12:02:09Z",
|
||||
"protected":false
|
||||
}
|
||||
],
|
||||
"schema":"/v2/schemas/images",
|
||||
"first":"/v2/images?sort_key=name&sort_dir=asc&limit=20"
|
||||
}
|
||||
|
||||
This operation does not accept a request body.
|
||||
|
||||
***************************************************
|
||||
Shows detailed information about a specific image
|
||||
***************************************************
|
||||
|
||||
.. rest_method:: GET /v2/images/{image_id}
|
||||
|
||||
This is an existing OpenStack API. The documentation that follows lists
|
||||
only the fields that are new or modified. For a detailed description of
|
||||
existing and unmodified fields please refer to the standard OpenStack
|
||||
API documentation. NOTE that the extensions listed here are
|
||||
``additional properties`` which are supported in the Image API and
|
||||
implemented in a Stack-specific manner.
|
||||
|
||||
**Normal response codes**
|
||||
|
||||
200
|
||||
|
||||
**Error response codes**
|
||||
|
||||
computeFault (400, 500, ...), serviceUnavailable (503), badRequest (400),
|
||||
unauthorized (401), forbidden (403), badMethod (405), overLimit (413),
|
||||
itemNotFound (404)
|
||||
|
||||
**Request parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"image_id", "URI", "xsd:string", "The name for the image."
|
||||
|
||||
**Response parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"cache_raw (Optional)", "plain", "xsd:bool", "On systems using Ceph storage, boot image files must be converted to RAW format before they can be used to create volumes. You can accelerate volume creation in StarlingX (and therefore instance launch time) by caching the RAW images as they are created. The cached images are maintained in the Glance image storage space and used for volume creation, eliminating conversion time. The default behaviour is to NOT cache the raw format."
|
||||
"store (Optional)", "plain", "xsd:string", "Indicates which Glance backend the image is stored in; either ``file`` for the Controller Filesystem or ``rbd`` for the ceph backend."
|
||||
"sw_wrs_auto_recovery (Optional)", "plain", "xsd:bool", "Indicates whether auto recovery of failed virutal machine instances is enabled or not. The default is ``True``."
|
||||
"hw_wrs_live_migration_timeout (Optional)", "plain", "xsd:integer", "Indicates the number of seconds to wait for a live migration to complete for a VM created with this image. Note that this can be specified as an extraspec of the flavor as well. If the timeout value is provisioned in both the flavor and the image, the smaller value is used. The default is 800 seconds. The minimum timeout is 120 seconds and the maximum timeout value is 800 seconds. To disable the live migration timeout feature, set this value to 0."
|
||||
"hw_wrs_live_migration_max_downtime (Optional)", "plain", "xsd:integer", "Indicates the maximum amoutn of downtime to tolerate during a live migration of a VM created with this image. Note that this can be specified as an extraspec of the flavor as well. If the max downtime value is provisioned in both the flavor and the image, the value from the flavor overrides the value from the image. The default is 500 milliseconds. The minimum timer value is 100 milliseconds."
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"hw_wrs_live_migration_timeout":"400",
|
||||
"cache_raw":"True",
|
||||
"min_ram":0,
|
||||
"updated_at":"2016-10-25T12:06:19Z",
|
||||
"file":"/v2/images/9d34ff07-6f66-4107-9363-e38b0b559a67/file",
|
||||
"owner":"b27359bcdb3e424db43a3e2255777f37",
|
||||
"id":"9d34ff07-6f66-4107-9363-e38b0b559a67",
|
||||
"size":13287936,
|
||||
"self":"/v2/images/9d34ff07-6f66-4107-9363-e38b0b559a67",
|
||||
"disk_format":"qcow2",
|
||||
"cache_raw_url":"rbd://840f16bc-3238-4adb-8700-6b9876c23462/images/9d34ff07-6f66-4107-9363-e38b0b559a67_raw/snap",
|
||||
"container_format":"bare",
|
||||
"direct_url":"rbd://840f16bc-3238-4adb-8700-6b9876c23462/images/9d34ff07-6f66-4107-9363-e38b0b559a67/snap",
|
||||
"store":"rbd",
|
||||
"schema":"/v2/schemas/image",
|
||||
"status":"active",
|
||||
"cache_raw_size":"41126400",
|
||||
"cache_raw_status":"Cached",
|
||||
"tags":[
|
||||
|
||||
],
|
||||
"visibility":"public",
|
||||
"min_disk":0,
|
||||
"sw_wrs_auto_recovery":"False",
|
||||
"virtual_size":null,
|
||||
"hw_wrs_live_migration_max_downtime":"350",
|
||||
"name":"cirros",
|
||||
"checksum":"ee1eca47dc88f4879d8a229cc70a07c6",
|
||||
"created_at":"2016-10-25T12:02:09Z",
|
||||
"protected":false
|
||||
}
|
||||
|
||||
This operation does not accept a request body.
|
||||
|
||||
***************************
|
||||
Modifies a specific image
|
||||
***************************
|
||||
|
||||
.. rest_method:: PUT /v2/images/{image_id}
|
||||
|
||||
This is an existing OpenStack API. The documentation that follows lists
|
||||
only the fields that are new or modified. For a detailed description of
|
||||
existing and unmodified fields please refer to the standard OpenStack
|
||||
API documentation. NOTE that the extensions listed here are
|
||||
``additional properties`` which are supported in the Image API and
|
||||
implemented in a Stack-specific manner.
|
||||
|
||||
**Normal response codes**
|
||||
|
||||
200
|
||||
|
||||
**Error response codes**
|
||||
|
||||
badMediaType (415), NetworkNotFound (400)
|
||||
|
||||
**Request parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"image_id", "URI", "xsd:string", "The name for the image."
|
||||
"sw_wrs_auto_recovery (Optional)", "plain", "xsd:bool", "Indicates whether auto recovery of failed virutal machine instances is enabled or not. The default is True."
|
||||
"hw_wrs_live_migration_timeout (Optional)", "plain", "xsd:integer", "Indicates the number of seconds to wait for a live migration to complete for a VM created with this image. Note that this can be specified as an extraspec of the flavor as well. If the timeout value is provisioned in both the flavor and the image, the smaller value is used. The default is 800 seconds. The minimum timeout is 120 seconds and the maximum timeout value is 800 seconds. To disable the live migration timeout feature, set this value to 0."
|
||||
"hw_wrs_live_migration_max_downtime (Optional)", "plain", "xsd:integer", "Indicates the maximum amoutn of downtime to tolerate during a live migration of a VM created with this image. Note that this can be specified as an extraspec of the flavor as well. If the max downtime value is provisioned in both the flavor and the image, the value from the flavor overrides the value from the image. The default is 500 milliseconds. The minimum timer value is 100 milliseconds."
|
||||
|
||||
**Response parameters**
|
||||
|
||||
.. csv-table::
|
||||
:header: "Parameter", "Style", "Type", "Description"
|
||||
:widths: 20, 20, 20, 60
|
||||
|
||||
"cache_raw (Optional)", "plain", "xsd:bool", "On systems using Ceph storage, boot image files must be converted to RAW format before they can be used to create volumes. You can accelerate volume creation in StarlingX (and therefore instance launch time) by caching the RAW images as they are created. The cached images are maintained in the Glance image storage space and used for volume creation, eliminating conversion time. The default behaviour is to NOT cache the raw format."
|
||||
"store (Optional)", "plain", "xsd:string", "Indicates which Glance backend the image is stored in; either ``file`` for the Controller Filesystem or ``rbd`` for the ceph backend."
|
||||
"sw_wrs_auto_recovery (Optional)", "plain", "xsd:bool", "Indicates whether auto recovery of failed virutal machine instances is enabled or not. The default is ``True``."
|
||||
"hw_wrs_live_migration_timeout (Optional)", "plain", "xsd:integer", "Indicates the number of seconds to wait for a live migration to complete for a VM created with this image. Note that this can be specified as an extraspec of the flavor as well. If the timeout value is provisioned in both the flavor and the image, the smaller value is used. The default is 800 seconds. The minimum timeout is 120 seconds and the maximum timeout value is 800 seconds. To disable the live migration timeout feature, set this value to 0."
|
||||
"hw_wrs_live_migration_max_downtime (Optional)", "plain", "xsd:integer", "Indicates the maximum amoutn of downtime to tolerate during a live migration of a VM created with this image. Note that this can be specified as an extraspec of the flavor as well. If the max downtime value is provisioned in both the flavor and the image, the value from the flavor overrides the value from the image. The default is 500 milliseconds. The minimum timer value is 100 milliseconds."
|
||||
|
||||
::
|
||||
|
||||
[
|
||||
{
|
||||
"path":"/hw_wrs_live_migration_timeout",
|
||||
"value":"500",
|
||||
"op":"replace"
|
||||
},
|
||||
{
|
||||
"path":"/sw_wrs_auto_recovery",
|
||||
"value":"True",
|
||||
"op":"replace"
|
||||
},
|
||||
{
|
||||
"path":"/hw_wrs_live_migration_max_downtime",
|
||||
"value":"300",
|
||||
"op":"replace"
|
||||
}
|
||||
]
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"hw_wrs_live_migration_timeout":"500",
|
||||
"cache_raw":"True",
|
||||
"min_ram":0,
|
||||
"updated_at":"2016-10-25T12:15:41Z",
|
||||
"file":"/v2/images/9d34ff07-6f66-4107-9363-e38b0b559a67/file",
|
||||
"owner":"b27359bcdb3e424db43a3e2255777f37",
|
||||
"id":"9d34ff07-6f66-4107-9363-e38b0b559a67",
|
||||
"size":13287936,
|
||||
"self":"/v2/images/9d34ff07-6f66-4107-9363-e38b0b559a67",
|
||||
"disk_format":"qcow2",
|
||||
"cache_raw_url":"rbd://840f16bc-3238-4adb-8700-6b9876c23462/images/9d34ff07-6f66-4107-9363-e38b0b559a67_raw/snap",
|
||||
"container_format":"bare",
|
||||
"direct_url":"rbd://840f16bc-3238-4adb-8700-6b9876c23462/images/9d34ff07-6f66-4107-9363-e38b0b559a67/snap",
|
||||
"store":"rbd",
|
||||
"schema":"/v2/schemas/image",
|
||||
"status":"active",
|
||||
"cache_raw_size":"41126400",
|
||||
"cache_raw_status":"Cached",
|
||||
"tags":[
|
||||
|
||||
],
|
||||
"visibility":"public",
|
||||
"min_disk":0,
|
||||
"sw_wrs_auto_recovery":"True",
|
||||
"virtual_size":null,
|
||||
"hw_wrs_live_migration_max_downtime":"300",
|
||||
"name":"cirros",
|
||||
"checksum":"ee1eca47dc88f4879d8a229cc70a07c6",
|
||||
"created_at":"2016-10-25T12:02:09Z",
|
||||
"protected":false
|
||||
}
|
||||
2888
api-ref/source/api-ref-networking-v2-cgcs-ext.rst
Normal file
2888
api-ref/source/api-ref-networking-v2-cgcs-ext.rst
Normal file
File diff suppressed because it is too large
Load Diff
@ -6,3 +6,9 @@ StarlingX Documentation
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
api-ref-blockstorage-v2-cgcs-ext
|
||||
api-ref-compute-v2-cgcs-ext
|
||||
api-ref-image-v2-cgcs-ext
|
||||
api-ref-networking-v2-cgcs-ext
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user