Documentation for auto_balance

The man pages for gnt-instance and gnt-backup are updated with this
parameter.

Reviewed-by: ultrotter

diff --git a/man/gnt-backup.sgml b/man/gnt-backup.sgml
index bf7156d..a5b3360 100644 (file)
--- a/man/gnt-backup.sgml
+++ b/man/gnt-backup.sgml
@@ -131,6 +131,8 @@
           </group></arg>
         <sbr>
 
+        <arg>--auto_balance <replaceable>AUTO_BALANCE</replaceable></arg>
+
         <arg choice="req"><replaceable>instance</replaceable></arg>
       </cmdsynopsis>
       <para>
@@ -252,6 +254,14 @@
       </para>
 
       <para>
+        The <option>--auto-balance</option> option specifies whether
+        the memory size of the instance will be considered in cluster
+        verify checks; in the future, it might be used for automated
+        cluster operations, but currently it is not used anywhere
+        else. It default to true.
+      </para>
+
+      <para>
         To pass an IPv4 address to the hypervisor, specify the
         <option>--ip</option> option. Note that this IP address will not be
         used by the OS scripts and changing it later will change the address

diff --git a/man/gnt-instance.sgml b/man/gnt-instance.sgml
index 04e58c9..647e62b 100644 (file)
--- a/man/gnt-instance.sgml
+++ b/man/gnt-instance.sgml
@@ -115,6 +115,8 @@
             </group></arg>
           <sbr>
 
+          <arg>--auto_balance <replaceable>AUTO_BALANCE</replaceable></arg>
+
           <arg>--no-wait-for-sync</arg>
           <arg>--no-start</arg>
           <arg>--no-ip-check</arg>
@@ -322,6 +324,14 @@
         </para>
 
         <para>
+          The <option>--auto-balance</option> option specifies whether
+          the memory size of the instance will be considered in
+          cluster verify checks; in the future, it might be used for
+          automated cluster operations, but currently it is not used
+          anywhere else. It defaults to true.
+        </para>
+
+        <para>
           The <option>-t</option> options specifies the disk layout type for
           the instance. The available choices are:
           <variablelist>
@@ -690,6 +700,7 @@
               <arg><replaceable>initrd_path</replaceable></arg>
             </group> </arg>
           <sbr>
+          <arg>--auto_balance <replaceable>AUTO_BALANCE</replaceable></arg>
           <arg choice="req"><replaceable>instance</replaceable></arg>
         </cmdsynopsis>
 
@@ -728,37 +739,45 @@
         </para>
 
         <para>
-          The <option>--hvm-cdrom-image-path</option> specifies the
-          path to the file xen uses to emulate a virtual CDROM drive
-          for this HVM instance. Valid values are either an
+          The <option>--hvm-cdrom-image-path</option> option specifies
+          the path to the file xen uses to emulate a virtual CDROM
+          drive for this HVM instance. Valid values are either an
           absolute path to an existing file or None, which disables
           virtual CDROM support for this instance.
         </para>
 
         <para>
-          The <option>--hvm-nic-type</option> specifies the NIC type
-          Xen should use for this HVM instance. Valid choices are
-          rtl8139, ne2k_pci, ne2k_isa and paravirtual with rtl8139
-          as the default. The paravirtual setting is intended for use
+          The <option>--hvm-nic-type</option> option specifies the NIC
+          type Xen should use for this HVM instance. Valid choices are
+          rtl8139, ne2k_pci, ne2k_isa and paravirtual with rtl8139 as
+          the default. The paravirtual setting is intended for use
           with the GPL PV drivers inside HVM Windows instances.
         </para>
 
         <para>
-          The <option>--hvm-disk-type</option> specifies the disk type
-          Xen should use for the HVM instance. Valid choices are ioemu
-          and paravirtual with ioemu as the default. The paravirtual
-          setting is intended for use with the GPL PV drivers inside
-          HVM Windows instances.
+          The <option>--hvm-disk-type</option> option specifies the
+          disk type Xen should use for the HVM instance. Valid choices
+          are ioemu and paravirtual with ioemu as the default. The
+          paravirtual setting is intended for use with the GPL PV
+          drivers inside HVM Windows instances.
         </para>
 
         <para>
-          The <option>--vnc-bind-address</option> specifies the
+          The <option>--vnc-bind-address</option> option specifies the
           address that the VNC listener for this instance should bind
           to. Valid values are IPv4 addresses. Use the address 0.0.0.0
           to bind to all available interfaces.
         </para>
 
         <para>
+          The <option>--auto-balance</option> option specifies whether
+          the memory size of the instance will be considered in
+          cluster verify checks; in the future, it might be used for
+          automated cluster operations, but currently it is not used
+          anywhere else.
+        </para>
+
+        <para>
           All the changes take effect at the next restart. If the
           instance is running, there is no effect on the instance.
         </para>