diff --git a/api-ref/src/docbkx/ch_blockstorage-api-v2.xml b/api-ref/src/docbkx/ch_blockstorage-api-v2.xml index eb3cbbebb..ce6f2b657 100644 --- a/api-ref/src/docbkx/ch_blockstorage-api-v2.xml +++ b/api-ref/src/docbkx/ch_blockstorage-api-v2.xml @@ -24,25 +24,34 @@
- API extensions + API extensions (extensions)
+
+ Limits (limits) + Shows absolute limits for a tenant. + + An absolute limit value of -1 indicates that the + absolute limit for the item is infinite. + + +
- Volumes + Volumes (volumes) A volume is a detachable block storage device similar to a USB hard drive. You can attach a volume to one instance at a time. - The snapshot_id and source_volid - parameters specify the ID of the snapshot or volume from which - this volume originates. - If the volume was not created from a snapshot or source volume, - these values are null. + The snapshot_id and source_volid + parameters specify the ID of the snapshot or volume from which this + volume originates. If the volume was not created from a snapshot or + source volume, these values are null. When you create, list, update, or delete volumes, the possible status values are: @@ -111,6 +120,7 @@ + @@ -126,8 +136,27 @@
+
+ Volume type access (volumes) + + Creates private volumes. + + + By default, volumes are public. To create a private volume, set + the is_public boolean field to false at + volume creation time. To control access to a private volume, you + add a project to or remove a project from the volume. Private + volume types without projects are only accessible by users with the + administrative role and context. + + + + + + +
- Volume actions + Volume actions (volumes, action) Performs actions for a specified volume. Extends the size, resets statuses for, sets image metadata, or removes image metadata from @@ -143,162 +172,15 @@
-
- Volume types - - - - - - - - - - - - - - -
-
- Snapshots - A snapshot is a point-in-time copy of the data that a - volume contains. - When you create, list, or delete snapshots, these status - values are possible: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Snapshot statuses
StatusDescription
- creatingThe snapshot is being created.
- availableThe snapshot is ready to be used.
- deletingThe snapshot is being deleted.
- errorAn error occurred during snapshot - creation.
- error_deletingAn error occurred during snapshot - deletion.
- - - - - - - - - - - - - - - - - - -
-
- Quality of service (QoS) specifications (qos-specs) - Administrators only, depending on policy settings. - - Creates, lists, shows details for, associates, disassociates, sets keys, - unsets keys, and deletes quality of service (QoS) specifications. - - - - - - - - - - - - - - - - - - - - -
-
- Quota sets extension (os-quota-sets) - Administrators only, depending on policy settings. - - - Shows, updates, and deletes quotas for a tenant. - - - - - - - - - - - - - - - - - - - -
-
- Limits extension (limits) - Shows absolute limits for a tenant. - - An absolute limit value of -1 indicates that the - absolute limit for the item is infinite. - - -
- Backups + Backups (backups) A backup is a full copy of a volume stored in an external service. - The service can be configured. The only supported service for now - is Object Storage. A backup can subsequently be restored from the + The service can be configured. The only supported service is + Object Storage. A backup can subsequently be restored from the external service to either the same volume that the backup was - originally taken from, or to a new volume. Backup and restore - operations can only be carried out on volumes which are in an + originally taken from or to a new volume. Backup and restore + operations can only be carried out on volumes that are in an unattached and available state. When you create, list, or delete backups, these status @@ -350,6 +232,7 @@ + In the event of an error, more information about the error can be found in the fail_reason field for the backup. @@ -371,7 +254,7 @@
- Backup actions + Backup actions (backups, action) Force-deletes a backup. @@ -381,6 +264,155 @@
+
+ Capabilities for storage back ends (capabilities) + + Shows capabilities for a storage back end. + + + + + + +
+
+ Quota sets extension (os-quota-sets) + Administrators only, depending on policy settings. + + + Shows, updates, and deletes quotas for a tenant. + + + + + + + + + + + + + + + + + + + +
+
+ Quality of service (QoS) specifications (qos-specs) + Administrators only, depending on policy settings. + + Creates, lists, shows details for, associates, disassociates, sets keys, + unsets keys, and deletes quality of service (QoS) specifications. + + + + + + + + + + + + + + + + + + + + +
+
+ Volume types (types) + + + + + + + + + + + + + + +
+
+ Volume snapshots (snapshots) + A snapshot is a point-in-time copy of the data that a + volume contains. + When you create, list, or delete snapshots, these status + values are possible: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Snapshot statuses
StatusDescription
+ creatingThe snapshot is being created.
+ availableThe snapshot is ready to be used.
+ deletingThe snapshot is being deleted.
+ errorAn error occurred during snapshot + creation.
+ error_deletingAn error occurred during snapshot + deletion.
+ + + + + + + + + + + + + + + + + + + +
Volume manage extension (os-volume-manage) @@ -396,23 +428,4 @@
-
- Volume type access (volumes) - - Creates private volumes. - - - By default, volumes are public. To create a private volume, set - the is_public boolean field to false at - volume creation time. To control access to a private volume, you - add a project to or remove a project from the volume. Private - volume types without projects are only accessible by users with the - administrative role and context. - - - - - - -
diff --git a/api-ref/src/wadls/volume-api/src/v2/api_samples/backend-capabilities/backend-capabilities-resp.json b/api-ref/src/wadls/volume-api/src/v2/api_samples/backend-capabilities/backend-capabilities-resp.json new file mode 100644 index 000000000..a72a23815 --- /dev/null +++ b/api-ref/src/wadls/volume-api/src/v2/api_samples/backend-capabilities/backend-capabilities-resp.json @@ -0,0 +1,33 @@ +{ + "namespace": "OS::Storage::Capabilities::fake", + "vendor_name": "OpenStack", + "volume_backend_name": "lvm", + "pool_name": "pool", + "driver_version": "2.0.0", + "storage_protocol": "iSCSI", + "display_name": "Capabilities of Cinder LVM driver", + "description": "These are volume type options provided by Cinder LVM driver, blah, blah.", + "visibility": "public", + "properties": { + "compression": { + "title": "Compression", + "description": "Enables compression.", + "type": "boolean" + }, + "qos": { + "title": "QoS", + "description": "Enables QoS.", + "type": "boolean" + }, + "replication": { + "title": "Replication", + "description": "Enables replication.", + "type": "boolean" + }, + "thin_provisioning": { + "title": "Thin Provisioning", + "description": "Sets thin provisioning.", + "type": "boolean" + } + } +} diff --git a/api-ref/src/wadls/volume-api/src/v2/common.ent b/api-ref/src/wadls/volume-api/src/v2/common.ent index 0c0bfaa9e..1ffdd2c04 100644 --- a/api-ref/src/wadls/volume-api/src/v2/common.ent +++ b/api-ref/src/wadls/volume-api/src/v2/common.ent @@ -729,7 +729,119 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> - The attaching mountpoint. + The attaching mount point. '> + + + + The storage name space, such as OS::Storage::Capabilities::foo. + + + + + + + The vendor name. + + + + + + + Volume back-end storage name. + + + + + + + The pool name. + + + + + + + The driver version. + + + + + + + The storage protocol, such as Fibre Channel, iSCSI, NFS, and so on. + + + + + + + The display name. + + + + + + + The storage description. + + + + + + + Enables public or private visibility. Set to True to + make the back end publicly visible. + + + + + + + A set of storage properties, such as QoS, IOPS, and so on. + + +'> diff --git a/api-ref/src/wadls/volume-api/src/v2/os-backend-capabilities-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/os-backend-capabilities-v2.wadl new file mode 100644 index 000000000..18c0004c3 --- /dev/null +++ b/api-ref/src/wadls/volume-api/src/v2/os-backend-capabilities-v2.wadl @@ -0,0 +1,62 @@ + + + + %common; + + %common_project; +]> + + + + + + + The unique identifier of the tenant or + account. + + + + + + The name of the host that hosts the storage back end. + + + + + + + + + + + Shows capabilities for a specified storage back end. + + + + + + + + + + + + &backendParametersResponse; + + + +