Command doc: backup

Change-Id: Iecd4dbddea637bd6540d94b37253a9ba434c9db3

Author: Steve Martinelli

doc/source/command-objects/backup.rst

@@ -0,0 +1,104 @@
+======
+backup
+======
+
+Volume v1
+
+backup create
+-------------
+
+Create new backup
+
+.. program:: backup create
+.. code:: bash
+
+    os backup create
+        [--container <container>]
+        [--name <name>]
+        [--description <description>]
+        <volume>
+
+.. option:: --container <container>
+
+    Optional backup container name
+
+.. option:: --name <name>
+
+    Name of the backup
+
+.. option:: --description <description>
+
+    Description of the backup
+
+.. _backup_create-backup:
+.. describe:: <volume>
+
+    Volume to backup (name or ID)
+
+backup delete
+-------------
+
+Delete backup(s)
+
+.. program:: backup delete
+.. code:: bash
+
+    os backup delete
+        <backup> [<backup> ...]
+
+.. _backup_delete-backup:
+.. describe:: <backup>
+
+    Backup(s) to delete (ID only)
+
+backup list
+-----------
+
+List backups
+
+.. program:: backup list
+.. code:: bash
+
+    os backup list
+
+.. _backup_list-backup:
+.. option:: --long
+
+    List additional fields in output
+
+backup restore
+--------------
+
+Restore backup
+
+.. program:: backup restore
+.. code:: bash
+
+    os backup restore
+        <backup>
+        <volume>
+
+.. _backup_restore-backup:
+.. describe:: <backup>
+
+    Backup to restore (ID only)
+
+.. describe:: <volume>
+
+    Volume to restore to (name or ID)
+
+backup show
+-----------
+
+Display backup details
+
+.. program:: backup show
+.. code:: bash
+
+    os backup show
+        <backup>
+
+.. _backup_show-backup:
+.. describe:: <backup>
+
+    Backup to display (ID only)

doc/source/commands.rst

@@ -72,7 +72,7 @@ referring to both Compute and Volume quotas.
 * ``access token``: Identity - long-lived OAuth-based token
 * ``availability zone``: (**Compute**) a logical partition of hosts or volume services
 * ``aggregate``: (**Compute**) a grouping of servers
-* ``backup``: Volume - a volume copy
+* ``backup``: (**Volume**) a volume copy
 * ``catalog``: (**Identity**) service catalog
 * ``console log``: (**Compute**) server console text dump
 * ``console url``: (**Compute**) server remote console URL

openstackclient/volume/v1/backup.py

@@ -27,7 +27,7 @@
 
 
 class CreateBackup(show.ShowOne):
-    """Create backup command"""
+    """Create new backup"""
 
     log = logging.getLogger(__name__ + '.CreateBackup')
 
@@ -36,13 +36,13 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'volume',
             metavar='<volume>',
-            help='The name or ID of the volume to backup',
+            help='Volume to backup (name or ID)',
         )
         parser.add_argument(
             '--container',
             metavar='<container>',
             required=False,
-            help='Optional backup container name.',
+            help='Optional backup container name',
         )
         parser.add_argument(
             '--name',
@@ -84,7 +84,7 @@ def get_parser(self, prog_name):
             'backups',
             metavar='<backup>',
             nargs="+",
-            help='Backup(s) to delete (name or ID)',
+            help='Backup(s) to delete (ID only)',
         )
         return parser
 
@@ -99,7 +99,7 @@ def take_action(self, parsed_args):
 
 
 class ListBackup(lister.Lister):
-    """List backup command"""
+    """List backups"""
 
     log = logging.getLogger(__name__ + '.ListBackup')
 
@@ -156,7 +156,7 @@ def _format_volume_id(volume_id):
 
 
 class RestoreBackup(command.Command):
-    """Restore backup command"""
+    """Restore backup"""
 
     log = logging.getLogger(__name__ + '.RestoreBackup')
 
@@ -165,11 +165,11 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'backup',
             metavar='<backup>',
-            help='ID of backup to restore')
+            help='Backup to restore (ID only)')
         parser.add_argument(
             'volume',
-            metavar='<dest-volume>',
-            help='ID of volume to restore to')
+            metavar='<volume>',
+            help='Volume to restore to (name or ID)')
         return parser
 
     def take_action(self, parsed_args):
@@ -184,7 +184,7 @@ def take_action(self, parsed_args):
 
 
 class ShowBackup(show.ShowOne):
-    """Show backup command"""
+    """Display backup details"""
 
     log = logging.getLogger(__name__ + '.ShowBackup')
 
@@ -193,7 +193,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'backup',
             metavar='<backup>',
-            help='Name or ID of backup to display')
+            help='Backup to display (ID only)')
         return parser
 
     def take_action(self, parsed_args):