openstack
/
python-openstackclient
Code Issues Proposed changes

Add warning message for --state option of set command in volume 

There are some set commands can set object state, it maybe
a danger behavor for users, so add explanation and warning
in the help message of the "--state" option to talk users
be caution when using (cinderclient have done this too)

Change-Id: I6a902887ea98879999c9972f36b1b7ef332173c3
This commit is contained in:
Huanxuan Ao 2016-09-25 15:44:03 +08:00
parent 559215d59d
commit 3ebc7520a6
6 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/command-objects/snapshot.rst
View File

@ -123,8 +123,9 @@ Set snapshot properties
.. option:: --state <state>
New snapshot state.
Valid values are "available", "error", "creating",
"deleting", and "error_deleting".
("available", "error", "creating", "deleting", or "error_deleting") (admin only)
(This option simply changes the state of the snapshot in the database with
no regard to actual status, exercise caution when using)
*Volume version 2 only*

2
doc/source/command-objects/volume-backup.rst
View File

@ -140,6 +140,8 @@ Set volume backup properties
.. option:: --state <state>
New backup state ("available" or "error") (admin only)
(This option simply changes the state of the backup in the database with
no regard to actual status, exercise caution when using)
.. _backup_set-volume-backup:
.. describe:: <backup>

4
doc/source/command-objects/volume.rst
View File

@ -235,7 +235,9 @@ Set volume properties
New volume state
("available", "error", "creating", "deleting", "in-use",
"attaching", "detaching", "error_deleting" or "maintenance")
"attaching", "detaching", "error_deleting" or "maintenance") (admin only)
(This option simply changes the state of the volume in the database with
no regard to actual status, exercise caution when using)
*Volume version 2 only*

5
openstackclient/volume/v2/backup.py
View File

@ -305,7 +305,10 @@ class SetVolumeBackup(command.Command):
'--state',
metavar='<state>',
choices=['available', 'error'],
help=_('New backup state ("available" or "error") (admin only)'),
help=_('New backup state ("available" or "error") (admin only) '
'(This option simply changes the state of the backup '
'in the database with no regard to actual status, '
'exercise caution when using)'),
)
return parser

7
openstackclient/volume/v2/snapshot.py
View File

@ -230,8 +230,11 @@ class SetSnapshot(command.Command):
metavar='<state>',
choices=['available', 'error', 'creating', 'deleting',
'error-deleting'],
help=_('New snapshot state. Valid values are available, '
'error, creating, deleting, and error-deleting.'),
help=_('New snapshot state. ("available", "error", "creating", '
'"deleting", or "error_deleting") (admin only) '
'(This option simply changes the state of the snapshot '
'in the database with no regard to actual status, '
'exercise caution when using)'),
)
return parser

5
openstackclient/volume/v2/volume.py
View File

@ -402,7 +402,10 @@ class SetVolume(command.Command):
'maintenance'],
help=_('New volume state ("available", "error", "creating", '
'"deleting", "in-use", "attaching", "detaching", '
'"error_deleting" or "maintenance")'),
'"error_deleting" or "maintenance") (admin only) '
'(This option simply changes the state of the volume '
'in the database with no regard to actual status, '
'exercise caution when using)'),
)
bootable_group = parser.add_mutually_exclusive_group()
bootable_group.add_argument(