Cleanup replace-disks modes and options
[ganeti-local] / man / gnt-instance.sgml
index 5e314aa..e6d190e 100644 (file)
 
         <cmdsynopsis>
           <command>replace-disks</command>
+          <arg choice="req">-p</arg>
+          <arg choice="req"><replaceable>instance</replaceable></arg>
+        </cmdsynopsis>
 
-          <group choice="req">
-            <arg>--iallocator <replaceable>name</replaceable></arg>
-            <arg>--new-secondary <replaceable>NODE</replaceable></arg>
-          </group>
-          <sbr>
+        <cmdsynopsis>
+          <command>replace-disks</command>
 
-          <arg choice="opt">-s</arg>
+          <arg choice="req">-s</arg>
           <arg choice="req"><replaceable>instance</replaceable></arg>
         </cmdsynopsis>
 
         <cmdsynopsis>
           <command>replace-disks</command>
 
-          <group>
-          <arg choice="req">-s</arg>
-          <arg choice="req">-p</arg>
+          <group choice="req">
+            <arg>--iallocator <replaceable>name</replaceable></arg>
+            <arg>--new-secondary <replaceable>NODE</replaceable></arg>
           </group>
+
           <arg choice="req"><replaceable>instance</replaceable></arg>
         </cmdsynopsis>
 
         </para>
 
         <para>
-          The first form will do a secondary node change, while the
-          second form will replace the disks on either the primary
-          (<option>-p</option>) or the secondary (<option>-s</option>)
-          node of the instance only, without changing the node.
+          The first form (when passing the <option>-p</option> option)
+          will replace the disks on the primary, while the second form
+          (when passing the <option>-s</option> option will replace
+          the disks on the secondary node.
         </para>
 
         <para>
-          Specifying <option>--iallocator</option> enables secondary node
-          replacement and and makes the new secondary be selected automatically
-          by the specified allocator plugin.
+          The third form (when passing either the
+          <option>--iallocator</option> or the
+          <option>--new-secondary</option> option) is designed to
+          change secondary node of the instance.  Specifying
+          <option>--iallocator</option> makes the new secondary be
+          selected automatically by the specified allocator plugin,
+          otherwise the new secondary node will be the one chosen
+          manually via the <option>--new-secondary</option> option.
         </para>
       </refsect3>
 
@@ -1176,6 +1182,7 @@ node1.example.com:sdb:/dev/drbd1
         <title>GROW-DISK</title>
         <cmdsynopsis>
           <command>grow-disk</command>
+          <arg>--no-wait-for-sync</arg>
           <arg choice="req"><replaceable>instance</replaceable></arg>
           <arg choice="req"><replaceable>disk</replaceable></arg>
           <arg choice="req"><replaceable>amount</replaceable></arg>
@@ -1232,7 +1239,14 @@ node1.example.com:sdb:/dev/drbd1
           create problems (except for unused space).
         </para>
 
-        <para>Example (increasing sda for instance1 with 16GiB):
+        <para>
+          If you do not want gnt-instance to wait for the new disk
+          region to be synced, use the
+          <option>--no-wait-for-sync</option> option.
+        </para>
+
+
+        <para>Example (increase sda for instance1 by 16GiB):
           <screen>
 # gnt-instance grow-disk instance1.example.com sda 16g
           </screen>