Add --cleanup to instance failover manpage
authorMichele Tartara <mtartara@google.com>
Tue, 30 Jul 2013 13:02:14 +0000 (13:02 +0000)
committerMichele Tartara <mtartara@google.com>
Tue, 30 Jul 2013 13:13:22 +0000 (13:13 +0000)
Describe the new parameter in the manpage of gnt-instance.

Signed-off-by: Michele Tartara <mtartara@google.com>
Reviewed-by: Guido Trotter <ultrotter@google.com>

man/gnt-instance.rst

index d2c646d..c1e8996 100644 (file)
@@ -1673,7 +1673,7 @@ FAILOVER
 | **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
 | [\--shutdown-timeout=*N*]
 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
-| [\--submit]
+| [\--submit] [\--cleanup]
 | {*instance*}
 
 Failover will stop the instance (if running), change its primary node,
@@ -1710,6 +1710,12 @@ to stop.
 If ``--ignore-ipolicy`` is given any instance policy violations occuring
 during this operation are ignored.
 
+If the ``--cleanup`` option is passed, the operation changes from
+performin a failover to attempting recovery from a failed previous failover.
+In this mode, Ganeti checks if the instance runs on the correct node (and
+updates its configuration if not) and ensures the instances' disks
+are configured correctly.
+
 See **ganeti**\(7) for a description of ``--submit`` and other common
 options.