Add master_capab to gnt-node modify
[ganeti-local] / man / gnt-node.sgml
index b16a4a7..39e169f 100644 (file)
@@ -2,7 +2,7 @@
 
   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
   <!-- Please adjust the date whenever revising the manpage. -->
-  <!ENTITY dhdate      "<date>February 12, 2009</date>">
+  <!ENTITY dhdate      "<date>June 08, 2010</date>">
   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
        allowed: see man(7), man(1). -->
   <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
     &dhucpackage;
 
     &dhsection;
-    <refmiscinfo>ganeti 2.0</refmiscinfo>
+    <refmiscinfo>Ganeti 2.2</refmiscinfo>
   </refmeta>
   <refnamediv>
     <refname>&dhpackage;</refname>
 
-    <refpurpose>node administration</refpurpose>
+    <refpurpose>Node administration</refpurpose>
   </refnamediv>
   <refsynopsisdiv>
     <cmdsynopsis>
@@ -50,7 +50,7 @@
 
     <para>
       The <command>&dhpackage;</command> is used for managing the
-      (physical) nodes in the ganeti system.
+      (physical) nodes in the Ganeti system.
     </para>
 
   </refsect1>
@@ -64,6 +64,7 @@
         <command>add</command>
         <arg>--readd</arg>
         <arg>-s <replaceable>secondary_ip</replaceable></arg>
+        <arg>-g <replaceable>nodegroup</replaceable></arg>
         <arg choice="req"><replaceable>nodename</replaceable></arg>
       </cmdsynopsis>
 
@@ -75,7 +76,7 @@
         This command is used to join a new node to the cluster. You
         will have to provide the password for root of the node to be
         able to add the node in the cluster. The command needs to be
-        run on the ganeti master.
+        run on the Ganeti master.
       </para>
 
       <para>
       </para>
 
       <para>
+        The <option>-g</option> is used to add the new node into a specific
+        node group, specified by uuid or name. If only one node group exists
+        you can skip this option, otherwise it's mandatory.
+      </para>
+
+      <para>
         Example:
         <screen>
 # gnt-node add node5.example.com
-# gnt-node add -s 192.168.44.5 node5.example.com
+# gnt-node add -s 192.0.2.5 node5.example.com
+# gnt-node add -g group2 -s 192.0.2.9 node9.group2.example.com
         </screen>
       </para>
     </refsect2>
       <cmdsynopsis>
         <command>evacuate</command>
         <arg>-f</arg>
+        <arg>--early-release</arg>
         <group>
           <arg>--iallocator <replaceable>NAME</replaceable></arg>
           <arg>--new-secondary <replaceable>destination_node</replaceable></arg>
         </group>
-        <arg choice="req"><replaceable>node</replaceable></arg>
+        <arg choice="req" rep="repeat"><replaceable>node</replaceable></arg>
       </cmdsynopsis>
 
       <para>
         This command will move all secondary instances away from the
-        given node. It works only for instances having a drbd disk
+        given node(s). It works only for instances having a drbd disk
         template.
       </para>
 
       </para>
 
       <para>
+        The <option>--early-release</option> changes the code so that
+        the old storage on node being evacuated is removed early
+        (before the resync is completed) and the internal Ganeti locks
+        are also released for both the current secondary and the new
+        secondary, thus allowing more parallelism in the cluster
+        operation. This should be used only when recovering from a
+        disk failure on the current secondary (thus the old storage is
+        already broken) or when the storage on the primary node is
+        known to be fine (thus we won't need the old storage for
+        potential recovery).
+      </para>
+
+      <para>
         Example:
         <screen>
           # gnt-node evacuate -I dumb node3.example.com
         <arg>--units=<replaceable>UNITS</replaceable></arg>
         <arg>-o <replaceable>[+]FIELD,...</replaceable></arg>
         <sbr>
+        <arg>--roman</arg>
+        <sbr>
         <arg rep="repeat">node</arg>
       </cmdsynopsis>
 
       </para>
 
       <para>
+        Passing the <option>--roman</option> option gnt-node list will try to
+        output some of its fields in a latin-friendly way. This is not the
+        default for backwards compatibility.
+      </para>
+
+      <para>
         The <option>-o</option> option takes a comma-separated list of
         output fields. The available fields and their meaning are:
         <variablelist>
               </para>
             </listitem>
           </varlistentry>
+          <varlistentry>
+            <term>master_capable</term>
+            <listitem>
+              <para>whether the node can become a master candidate</para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>vm_capable</term>
+            <listitem>
+              <para>whether the node can host instances</para>
+            </listitem>
+          </varlistentry>
         </variablelist>
       </para>
 
         <command>migrate</command>
         <arg>-f</arg>
         <arg>--non-live</arg>
+        <arg>--migration-mode=live|non-live</arg>
         <arg choice="req"><replaceable>node</replaceable></arg>
       </cmdsynopsis>
 
 
       <para>
         As for the <command>gnt-instance migrate</command> command,
-        the <option>--no-live</option> option can be given to do a
-        non-live migration.
+        the options <option>--no-live</option>
+        and <option>--migration-mode</option> can be given to
+        influence the migration type.
       </para>
 
       <para>
         <arg>--master-candidate=<option>yes|no</option></arg>
         <arg>--drained=<option>yes|no</option></arg>
         <arg>--offline=<option>yes|no</option></arg>
+        <arg>--master-capable=<option>yes|no</option></arg>
+        <arg>--auto-promote</arg>
         <arg choice="req"><replaceable>node</replaceable></arg>
       </cmdsynopsis>
 
         This command changes the role of the node. Each options takes
         either a literal <literal>yes</literal> or
         <literal>no</literal>, and only one option should be given as
-        <literal>yes</literal>. The meaning of the roles are described
-        in the manpage <citerefentry>
+        <literal>yes</literal>. The meaning of the roles and flags are
+        described in the manpage <citerefentry>
         <refentrytitle>ganeti</refentrytitle> <manvolnum>7</manvolnum>
         </citerefentry>.
       </para>
 
       <para>
-        In case a node is demoted from the master candidate role, but
-        there are not enough new nodes for this case, the operation
-        will be refused. To override this check, pass the
-        <option>--force</option> option.
+        In case a node is demoted from the master candidate role, the
+        operation will be refused unless you pass
+        the <option>--auto-promote</option> option. This option will
+        cause the operation to lock all cluster nodes (thus it will
+        not be able to run in parallel with most other jobs), but it
+        allows automated maintenance of the cluster candidate pool. If
+        locking all cluster node is too expensive, another option is
+        to promote manually another node to master candidate before
+        demoting the current one.
       </para>
 
       <para>
@@ -955,7 +1006,7 @@ node2 lvm-pv /dev/sdb1 698.6G   0M 698.6G Y
 
       <cmdsynopsis>
         <command>powercycle</command>
-        <arg><option>--confirm</option></arg>
+        <arg><option>--yes</option></arg>
         <arg><option>--force</option></arg>
         <arg choice="req"><replaceable>node</replaceable></arg>
       </cmdsynopsis>
@@ -964,7 +1015,7 @@ node2 lvm-pv /dev/sdb1 698.6G   0M 698.6G Y
         This commands (tries to) forcefully reboot a node. It is a
         command that can be used if the node environemnt is broken,
         such that the admin can no longer login over ssh, but the
-        ganeti node daemon is still working.
+        Ganeti node daemon is still working.
       </para>
 
       <para>