Improve the man pages

[ganeti-local] / man / gnt-instance.sgml

diff --git a/man/gnt-instance.sgml b/man/gnt-instance.sgml
index 692ac83..8f03ff6 100644 (file)
--- a/man/gnt-instance.sgml
+++ b/man/gnt-instance.sgml
@@ -74,10 +74,11 @@
               <arg>plain</arg>
               <arg>local_raid1</arg>
               <arg>remote_raid1</arg>
+              <arg>drbd</arg>
             </group>
           </arg>
           <sbr>
-          <arg choice="req">-n <replaceable>node</replaceable></arg>
+          <arg choice="req">-n <replaceable>node<optional>:secondary-node</optional></replaceable></arg>
           <arg choice="req"><replaceable>instance</replaceable></arg>
         </cmdsynopsis>
         <para>
@@ -156,9 +157,22 @@
               <listitem>
                 <para>
                   Disk devices will be md raid1 arrays with one
-                  component (so it's not actually raid1): a drbd device
-                  between the instance's primary node and the node given
-                  by the option <option>--secondary-node</option>.
+                  component (so it's not actually raid1): a drbd
+                  (0.7.x) device between the instance's primary node
+                  and the node given by the second value of the
+                  <option>--node</option> option.
+                </para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>drbd</term>
+              <listitem>
+                <para>
+                  Disk devices will be drbd (version 8.x) on top of
+                  lvm volumes. They are equivalent in functionality to
+                  <replaceable>remote_raid1</replaceable>, but are
+                  recommended for new instances (if you have drbd 8.x
+                  installed).
                 </para>
               </listitem>
             </varlistentry>
@@ -166,9 +180,8 @@
         </para>
 
         <para>
-          The <option>--secondary-node</option> option is used with
-          the remote raid disk template type and specifies the remote
-          node.
+          The optional second value of the <option>--node</option> is used for
+          the remote raid template type and specifies the remote node.
         </para>
 
         <para>
@@ -177,18 +190,15 @@
           option.
         </para>
 
-
         <para>
           Example:
           <screen>
 # gnt-instance add -t plain -s 30g -m 512 -o debian-etch \
   -n node1.example.com instance1.example.com
-# gnt-instance add -t remote_raid1 --secondary-node node3.example.com \
-  -s 30g -m 512 -o debian-etch \
-  -n node1.example.com instance2.example.com
+# gnt-instance add -t remote_raid1 -s 30g -m 512 -o debian-etch \
+  -n node1.example.com:node2.example.com instance2.example.com
           </screen>
         </para>
-
       </refsect3>
 
       <refsect3>
@@ -275,7 +285,7 @@
             <varlistentry>
               <term>snodes</term>
               <listitem>
-                <simpara>comma-separated list of secondary-nodes for the
+                <simpara>comma-separated list of secondary nodes for the
                   instance; usually this will be just one node</simpara>
               </listitem>
             </varlistentry>
@@ -469,8 +479,8 @@
         </cmdsynopsis>
 
         <para>
-          Starts one or more instances, depending on the
-          <option>--by-*</option> mode. The four available modes are:
+          Starts one or more instances, depending on the following
+          options. The four available modes are:
           <variablelist>
             <varlistentry>
               <term><option>--instance</option></term>
@@ -514,10 +524,9 @@
         </para>
 
         <para>
-          Note that although you can pass more than one
-          <option>--by-</option> option, the last one wins, so in
-          order to guarantee the desired result, don't pass more than
-          one such option.
+          Note that although you can pass more than one selection
+          option, the last one wins, so in order to guarantee the
+          desired result, don't pass more than one such option.
         </para>
 
         <para>
@@ -534,8 +543,8 @@
           <screen>
 # gnt-instance start instance1.example.com
 # gnt-instance start --extra single test1.example.com
-# gnt-instance start --by-node node1.example.com node2.example.com
-# gnt-instance start --by-cluster
+# gnt-instance start --node node1.example.com node2.example.com
+# gnt-instance start --all
           </screen>
         </para>
       </refsect3>
@@ -578,7 +587,7 @@
           Example:
           <screen>
 # gnt-instance shutdown instance1.example.com
-# gnt-instance shutdown --by-cluster
+# gnt-instance shutdown --all
           </screen>
         </para>
       </refsect3>
@@ -633,7 +642,7 @@
           <command>startup</command> command and they influence the
           actual instances being rebooted.
         </para>
-        
+
         <para>
           Use the <option>--force-multiple</option> to keep
           gnt-instance from asking for confirmation when more than one
@@ -813,7 +822,10 @@ node1.example.com:sdb:/dev/md1
           disks before failing over the instance. If you are trying to
           migrate instances off a dead node, this will fail. Use the
           <option>--ignore-consistency</option> option for this
-          purpose.
+          purpose. Note that this option can be dangerous as errors in
+          shutting down the instance will be ignored, resulting in
+          possibly having the instance running on two machines in
+          parallel (on disconnected DRBD drives).
         </para>
 
         <para>