From fbf51eea48751cf92104cb451c3f62aea2213758 Mon Sep 17 00:00:00 2001 From: Gorka Eguileor Date: Thu, 1 Feb 2018 14:09:23 +0100 Subject: [PATCH] Add backup cancellation admin doc We support backup cancellation on many backup drivers but we have no admin documentation. This patch adds a brief explanation of the backup cancellation mechanism as well as some considerations that are good to keep in mind. Change-Id: I0c38442f01905e0ca0d61e65ee7ea0972ab4ec71 --- .../admin/blockstorage-volume-backups.rst | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/doc/source/admin/blockstorage-volume-backups.rst b/doc/source/admin/blockstorage-volume-backups.rst index e2a32a27ef2..8cc6a5f4a8b 100644 --- a/doc/source/admin/blockstorage-volume-backups.rst +++ b/doc/source/admin/blockstorage-volume-backups.rst @@ -173,3 +173,33 @@ Run this command to create a backup of a snapshot: Where ``VOLUME`` is the name or ID of the volume, ``SNAPSHOT_ID`` is the ID of the volume's snapshot. + +Cancelling +---------- + +Since Liberty it is possible to cancel an ongoing backup operation on any of +the Chunked Backup type of drivers such as Swift, NFS, Google, GlusterFS, and +Posix. + +To issue a backup cancellation on a backup we must request a force delete on +the backup. + +.. code-block:: console + + $ openstack volume backup delete --force BACKUP_ID + +.. note:: + + The policy on force delete defaults to admin only. + +Even if the backup is immediately deleted, and therefore no longer appears in +the listings, the cancellation may take a little bit longer, so please check +the status of the source resource to see when it stops being "backing-up". + +.. note:: + + Before Pike the "backing-up" status would always be stored in the volume, + even when backing up a snapshot, so when backing up a snapshot any delete + operation on the snapshot that followed a cancellation could result in an + error if the snapshot was still mapped. Polling on the volume to stop being + "backing-up" prior to the deletion is required to ensure success.