openstack/cinder
Code Issues Proposed changes

Clarify volume migration CLI reference

Browse Source 
Wording for the volume migration was not very clear. This reworks
that text to be a little more concise. It also removes an OSC arg
that does not actually do anything.

Change-Id: Id75bd6b4445fcf8042d87578f5f692958a859c0b
This commit is contained in:
Sean McGinnis 2018-04-04 15:12:29 -05:00
parent fb4d9008a0
commit 8a6bd1f957
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/source/cli/cli-manage-volumes.rst
View File

@ -418,15 +418,22 @@ in the following example:
.. code-block:: console .. code-block:: console
$ openstack volume migrate [-h] --host <host> [--force-host-copy] $ openstack volume migrate [-h] --host <host> [--force-host-copy]
[--lock-volume | --unlock-volume] [--lock-volume] <volume>
<volume>
In this example, ``--force-host-copy`` forces the generic The arguments for this command are:
host-based migration mechanism and bypasses any driver optimizations.
``--lock-volume | --unlock-volume`` applies to the available volume. host
To determine whether the termination of volume migration caused by other The destination host in the format `host@backend-name#pool`.
commands. ``--lock-volume`` locks the volume state and does not allow the
migration to be aborted. volume
The ID of the volume to migrate.
*force-host-copy*
Disables any driver optimizations and forces the data to be copied by the
host.
*lock-volume*
Prevents other processes from aborting the migration.
.. note:: .. note::