From 39c5eb9e3fe89bf177e513e447f22b62f5e4785c Mon Sep 17 00:00:00 2001
From: Huanxuan Ao <huanxuan.ao@easystack.cn>
Date: Tue, 9 Aug 2016 10:12:04 +0800
Subject: Rename backup commands in volume v1 and v2

Backup commands are used only in volume service now,
but "backup" is too generic, users may not know the
commands are used for volume from the commands name.
By seeing the command name, users can only see the
"backup" but do not know which object the backup
commands work for. It may confuse users. I think
rename "backup" to "volume backup" can depict resource
relation and will be helpful for users to know the
commands clearly.

So add new commands ``volume backup create/delete/
list/show/restore`` to replace the old commands
``backup create/delete/list/show/restore``. And also
deprecate old commands.

Change-Id: I4f844d9bc48573eb4d17288ce6b8a90cea00d16a
Implements: bp backup-snapshot-renamed-for-volume-resource
Co-Authored-By: Sheel Rana <ranasheel2000@gmail.com>
---
 doc/source/command-objects/backup.rst        |   5 +
 doc/source/command-objects/volume-backup.rst | 132 +++++++++++++++++++++++++++
 2 files changed, 137 insertions(+)
 create mode 100644 doc/source/command-objects/volume-backup.rst

(limited to 'doc/source/command-objects')

diff --git a/doc/source/command-objects/backup.rst b/doc/source/command-objects/backup.rst
index 4abc155f..ac887086 100644
--- a/doc/source/command-objects/backup.rst
+++ b/doc/source/command-objects/backup.rst
@@ -8,6 +8,7 @@ backup create
 -------------
 
 Create new backup
+(Deprecated, please use ``volume backup create`` instead)
 
 .. program:: backup create
 .. code:: bash
@@ -60,6 +61,7 @@ backup delete
 -------------
 
 Delete backup(s)
+(Deprecated, please use ``volume backup delete`` instead)
 
 .. program:: backup delete
 .. code:: bash
@@ -83,6 +85,7 @@ backup list
 -----------
 
 List backups
+(Deprecated, please use ``volume backup list`` instead)
 
 .. program:: backup list
 .. code:: bash
@@ -98,6 +101,7 @@ backup restore
 --------------
 
 Restore backup
+(Deprecated, please use ``volume backup restore`` instead)
 
 .. program:: backup restore
 .. code:: bash
@@ -119,6 +123,7 @@ backup show
 -----------
 
 Display backup details
+(Deprecated, please use ``volume backup show`` instead)
 
 .. program:: backup show
 .. code:: bash
diff --git a/doc/source/command-objects/volume-backup.rst b/doc/source/command-objects/volume-backup.rst
new file mode 100644
index 00000000..3a8f0213
--- /dev/null
+++ b/doc/source/command-objects/volume-backup.rst
@@ -0,0 +1,132 @@
+=============
+volume backup
+=============
+
+Block Storage v1, v2
+
+volume backup create
+--------------------
+
+Create new volume backup
+
+.. program:: volume backup create
+.. code:: bash
+
+    os volume backup create
+        [--container <container>]
+        [--name <name>]
+        [--description <description>]
+        [--snapshot <snapshot>]
+        [--force]
+        [--incremental]
+        <volume>
+
+.. option:: --container <container>
+
+    Optional backup container name
+
+.. option:: --name <name>
+
+    Name of the backup
+
+.. option:: --description <description>
+
+    Description of the backup
+
+.. option:: --snapshot <snapshot>
+
+    Snapshot to backup (name or ID)
+
+    *Volume version 2 only*
+
+.. option:: --force
+
+    Allow to back up an in-use volume
+
+    *Volume version 2 only*
+
+.. option:: --incremental
+
+    Perform an incremental backup
+
+    *Volume version 2 only*
+
+.. _volume_backup_create-backup:
+.. describe:: <volume>
+
+    Volume to backup (name or ID)
+
+volume backup delete
+--------------------
+
+Delete volume backup(s)
+
+.. program:: volume backup delete
+.. code:: bash
+
+    os volume backup delete
+        [--force]
+        <backup> [<backup> ...]
+
+.. option:: --force
+
+    Allow delete in state other than error or available
+
+    *Volume version 2 only*
+
+.. _volume_backup_delete-backup:
+.. describe:: <backup>
+
+    Backup(s) to delete (name or ID)
+
+volume backup list
+------------------
+
+List volume backups
+
+.. program:: volume backup list
+.. code:: bash
+
+    os volume backup list
+
+.. _volume_backup_list-backup:
+.. option:: --long
+
+    List additional fields in output
+
+volume backup restore
+---------------------
+
+Restore volume backup
+
+.. program:: volume backup restore
+.. code:: bash
+
+    os volume backup restore
+        <backup>
+        <volume>
+
+.. _volume_backup_restore-backup:
+.. describe:: <backup>
+
+    Backup to restore (name or ID)
+
+.. describe:: <volume>
+
+    Volume to restore to (name or ID)
+
+volume backup show
+------------------
+
+Display volume backup details
+
+.. program:: volume backup show
+.. code:: bash
+
+    os volume backup show
+        <backup>
+
+.. _volume_backup_show-backup:
+.. describe:: <backup>
+
+    Backup to display (name or ID)
-- 
cgit v1.2.1