Remove invalid 'unlock-volume' migration arg

There is an optional flag that can be passed in to a
volume migration to tell Cinder to 'lock' a volume so
no other process can abort the migration. This is
reflected correctly with the --lock-volume argument
flag to `openstack volume migrate`, but there is
another --unlock-volume flag that is shown in the help
text for this command that does not do anything and is
not used anywhere.

Since there is no action to "unlock" a volume, this
just causes confusion - including for Cinder developers
that know this API. To avoid confusion, this invalid
flag should just be removed from the command.

Change-Id: I5f111ed58803a1bf5d34e828341d735099247108
This commit is contained in:
Sean McGinnis
2018-04-04 14:56:27 -05:00
parent 06263bd585
commit f00ffebea6
4 changed files with 7 additions and 41 deletions
doc/source/cli/command-objects
openstackclient
tests
unit
volume
releasenotes/notes

@ -226,7 +226,7 @@ Migrate volume to a new host
openstack volume migrate
--host <host>
[--force-host-copy]
[--lock-volume | --unlock-volume]
[--lock-volume]
<volume>
.. option:: --host <host>
@ -245,13 +245,6 @@ Migrate volume to a new host
*Volume version 2 only*
.. option:: --unlock-volume
If specified, the volume state will not be locked and the a
migration can be aborted (default) (possibly by another operation)
*Volume version 2 only*
.. _volume_migrate-volume:
.. describe:: <volume>