Skip to content

Commit

Permalink
Added information on migrating volumes
Browse files Browse the repository at this point in the history
Added 'Migrate a volume' section, and migrate option to CLI command page.

Closes-Bug: #1201555

Change-Id: Ic0318f64be443da46cd7f8baf6d9276021e9eaa1
  • Loading branch information
Summer Long committed Oct 16, 2013
1 parent 02c0ded commit d5dc486
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
1 change: 1 addition & 0 deletions doc/common/section_cinder_cli_commands.xml
Expand Up @@ -45,6 +45,7 @@
state.
list List all the volumes.
metadata Set or Delete metadata on a volume.
migrate Migrate the volume to the new host.
quota-class-show List the quotas for a quota class.
quota-class-update Update the quotas for a quota class.
quota-defaults List the default quotas for a tenant.
Expand Down
24 changes: 22 additions & 2 deletions doc/common/section_cinder_cli_manage_volumes.xml
Expand Up @@ -9,9 +9,29 @@
USB hard drive. You can attach a volume to only one instance.
To create and manage volumes, you use a combination of nova
and cinder client commands.</para>
<para os="adminuser">For an example of how to create and manage volumes, see the <link xlink:href="http://docs.openstack.org/user-guide/content/"><citetitle>OpenStack End User Guide</citetitle></link>.</para>
<para os="adminuser">For general user information about how to create and manage volumes, see
the <link xlink:href="http://docs.openstack.org/user-guide/content/"><citetitle>OpenStack End User Guide</citetitle></link>.
</para>
<para os="enduser">This example creates a volume named
<literal>my-new-volume</literal> based on an image.</para>
<literal>my-new-volume</literal> based on an image.</para>
<section xml:id="cli_migrate_volumes" os="adminuser">
<title>Migrate a volume</title>
<para>As an administrator, you can migrate a volume with its data from one location to
another in a manner that is transparent to users and workloads. Only detached volumes
with no snapshots can be migrated.</para>
<para>Possible use cases for migrating data include:
<itemizedlist>
<listitem><para>To bring down a physical storage device for maintenance without interferring with workloads.</para></listitem>
<listitem><para>To modify the properties of a volume.</para></listitem>
<listitem><para>To free up space in a thinly-provisioned back-end.</para></listitem>
</itemizedlist></para>
<para>Migrate a volume, as follows:</para>
<screen><prompt>$</prompt> <userinput>cinder migrate <replaceable>volumeID</replaceable> <replaceable>destinationHost</replaceable> --force-host-copy=<replaceable>True|False</replaceable></userinput></screen>
<para>Where <literal>--force-host-copy=True</literal> forces the generic host-based
migration mechanism and bypasses any driver optimizations.</para>
<note><para>If the volume is in use, has snapshots, the specified host destination cannot accept the
volume, or if the user is not an administrator, the migration will fail.</para></note>
</section>
<section xml:id="cli_list_volumes" os="enduser"><title>Create a volume</title><procedure>
<step>
<para>List images, and note the ID of the image to use for
Expand Down

0 comments on commit d5dc486

Please sign in to comment.