From 69c6aee4e633c88be458c38667bdc747302d93e5 Mon Sep 17 00:00:00 2001
From: Maria Zlatkova <mzlatkova@mirantis.com>
Date: Tue, 24 Mar 2015 13:25:39 +0200
Subject: [PATCH] Conversion to RST: cli_nova_migrate

Adds cli_nova_migrate.rst
Adds cli_nova_migrate.rst into the cli.rst toctree

Change-Id: I99abbea82d16a9c5539e37ac9f830266dff3a2be
---
 doc/playground-user-guide/source/cli.rst      |  1 +
 .../source/cli_nova_migrate.rst               | 78 +++++++++++++++++++
 2 files changed, 79 insertions(+)
 create mode 100644 doc/playground-user-guide/source/cli_nova_migrate.rst

diff --git a/doc/playground-user-guide/source/cli.rst b/doc/playground-user-guide/source/cli.rst
index 9674324ba2..e334ad2790 100644
--- a/doc/playground-user-guide/source/cli.rst
+++ b/doc/playground-user-guide/source/cli.rst
@@ -95,3 +95,4 @@ service with its package name and description.
    manage_projects_users_and_roles.rst
    nova_cli_manage_projects_security.rst
    cli_manage_services.rst
+   cli_nova_migrate.rst
diff --git a/doc/playground-user-guide/source/cli_nova_migrate.rst b/doc/playground-user-guide/source/cli_nova_migrate.rst
new file mode 100644
index 0000000000..1825f62809
--- /dev/null
+++ b/doc/playground-user-guide/source/cli_nova_migrate.rst
@@ -0,0 +1,78 @@
+.. meta::
+   :scope: admin_only
+
+.. highlight: bash
+   :linenothreshold: 5
+
+===============================================
+Migrate single instance to another compute host
+===============================================
+
+When you want to move an instance from one compute host to another,
+you can use the ``nova migrate`` command. The scheduler chooses the
+destination compute host based on its settings. This process does
+not assume that the instance has shared storage available on the
+target host.
+
+#. To list the VMs you want to migrate, run::
+
+   $ nova list
+
+#. After selecting a VM from the list, run this command where :guilabel:`VM_ID`
+   is set to the ID in the list returned in the previous step::
+
+   $ nova show VM_ID
+
+#. Now, use the ``nova migrate`` command::
+
+   $ nova migrate VM_ID
+
+#. To migrate of an instance and watch the status, use this example script:
+
+   .. code-block:: bash
+     :linenos:
+
+     #!/bin/bash
+
+     # Provide usage
+     usage() {
+     echo "Usage: $0 VM_ID"
+     exit 1
+     }
+
+     [[ $# -eq 0 ]] && usage
+
+     # Migrate the VM to an alternate hypervisor
+     echo -n "Migrating instance to alternate host"
+     $VM_ID=$1
+     nova migrate $VM_ID
+     VM_OUTPUT=`nova show $VM_ID`
+     VM_STATUS=`echo "$VM_OUTPUT" | grep status | awk '{print $4}'`
+     while [[ "$VM_STATUS" != "VERIFY_RESIZE" ]]; do
+     echo -n "."
+     sleep 2
+     VM_OUTPUT=`nova show $VM_ID`
+     VM_STATUS=`echo "$VM_OUTPUT" | grep status | awk '{print $4}'`
+     done
+     nova resize-confirm $VM_ID
+     echo " instance migrated and resized."
+     echo;
+
+     # Show the details for the VM
+     echo "Updated instance details:"
+     nova show $VM_ID
+
+     # Pause to allow users to examine VM details
+     read -p "Pausing, press <enter> to exit."
+
+.. note::
+   If you see this error, it means you are either
+   trying the command with the wrong credentials,
+   such as a non-admin user, or the ``policy.json``
+   file prevents migration for your user:
+
+   ``ERROR (Forbidden): Policy doesn't allow compute_extension:admin_actions:migrate
+   to be performed. (HTTP 403)``
+
+The instance is booted from a new host, but preserves its configuration
+including its ID, name, any metadata, IP address, and other properties.