Explain that we only start the instance on the new node if it was
originally running.
---
 lib/client/gnt_instance.py |    6 ++++--
 man/gnt-instance.rst       |    8 ++++++--
 2 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/lib/client/gnt_instance.py b/lib/client/gnt_instance.py
index 96eaef5..58e242e 100644
--- a/lib/client/gnt_instance.py
+++ b/lib/client/gnt_instance.py
@@ -1384,8 +1384,10 @@ commands = {
     FailoverInstance, ARGS_ONE_INSTANCE,
     [FORCE_OPT, IGNORE_CONSIST_OPT, SUBMIT_OPT, SHUTDOWN_TIMEOUT_OPT,
      DRY_RUN_OPT, PRIORITY_OPT, DST_NODE_OPT, IALLOCATOR_OPT],
-    "[-f] <instance>", "Stops the instance and starts it on the backup node,"
-    " using the remote mirror (only for mirrored instances)"),
+    "[-f] <instance>", "Stops the instance, changes its primary node and"
+    " (if it was originally running) starts it on the new node"
+    " (the secondary for mirrored instances or any node"
+    " for shared storage)."),
   "migrate": (
     MigrateInstance, ARGS_ONE_INSTANCE,
     [FORCE_OPT, NONLIVE_OPT, MIGRATION_MODE_OPT, CLEANUP_OPT, DRY_RUN_OPT,
diff --git a/man/gnt-instance.rst b/man/gnt-instance.rst
index afc0ad9..7193ef9 100644
--- a/man/gnt-instance.rst
+++ b/man/gnt-instance.rst
@@ -1263,8 +1263,12 @@ FAILOVER
 **failover** [-f] [--ignore-consistency] [--shutdown-timeout=*N*]
 [--submit] {*instance*}
 
-Failover will fail the instance over its secondary node. This works
-only for instances having a drbd disk template.
+Failover will stop the instance (if running), change its primary node,
+and if it was originally running it will start it again (on the new
+primary). This only works for instances with drbd template (in which
+case you can only fail to the secondary node) and for externally
+mirrored templates (shared storage) (which can change to any other
+node).
 
 Normally the failover will check the consistency of the disks before
 failing over the instance. If you are trying to migrate instances off
-- 
1.7.3.1

Reply via email to