openstack/cinder
Code Issues Proposed changes

api-ref: cleanup status conditions for backup/restore APIs

Browse Source 
The description for the backups API in both the v2 and v3
reference had a generic statement that only available volumes
can be backed up and restored, which is misleading since it
is possible to backup an in-use volume if the force parameter
is used.

This change drops the generic statement from the high-level
description and opts for per-API descriptions about the status
preconditions for backup and restore operations.

The v3 restore reference already mentioned the status precondition
so the only change to that is fixing the bullet list formatting.

Change-Id: Ib6c61af9ced2527884569fa15a848a215dd985b8
Closes-Bug: #1799499
This commit is contained in:
Matt Riedemann 2018-10-23 12:54:36 -04:00
parent 7b84c0842b
commit 6b852e859f
2 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api-ref/source/v2/ext-backups.inc
View File

@ -7,9 +7,7 @@ A backup is a full copy of a volume stored in an external service.
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 that are in an unattached and
available state.
taken from or to a new volume.
When you create, list, or delete backups, these status values are
possible:
@ -186,6 +184,8 @@ Restores a Block Storage backup to an existing or new Block Storage volume.
You must specify either the UUID or name of the volume. If you
specify both the UUID and name, the UUID takes priority.
If specifying ``volume_id`` the status of the volume must be ``available``.
Response codes
--------------
@ -238,6 +238,9 @@ Create backup
Creates a Block Storage backup from a volume.
The status of the volume must be ``available`` or if the ``force`` flag is
used, backups of ``in-use`` volumes may also be created.
Response codes
--------------

11
api-ref/source/v3/ext-backups.inc
View File

@ -7,9 +7,7 @@ A backup is a full copy of a volume stored in an external service.
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 that are in an unattached and
available state.
taken from or to a new volume.
When you create, list, or delete backups, these status values are
possible:
@ -204,8 +202,8 @@ The name parameter will work only if a new volume is created.
If UUID is specified, the backup will be restored to the specified volume.
The specified volume has the following requirements:
* the specified volume status is ``available``.
* the size of specified volume must be equal to or greater than the size of backup.
* the specified volume status is ``available``.
* the size of specified volume must be equal to or greater than the size of backup.
If no existing volume UUID is provided, the backup will be restored to a
new volume matching the size and name of the originally backed up volume.
@ -265,6 +263,9 @@ Create a backup
Creates a Block Storage backup from a volume or snapshot.
The status of the volume must be ``available`` or if the ``force`` flag is
used, backups of ``in-use`` volumes may also be created.
Response codes
--------------