Makefile: Streamline directory creation
[ganeti-local] / man / ganeti.sgml
index 7caad06..3bb4f42 100644 (file)
             <listitem>
               <para>The node receives the full cluster configuration
               (configuration file and jobs) and can become a master
-              via the <command>gnt-cluster masterfailover</command>
+              via the <command>gnt-cluster master-failover</command>
               command. Nodes that are not in this state cannot
               transition into the master role due to missing
               state.</para>
     </refsect2>
 
     <refsect2>
+      <title>Node flags</title>
+
+      <para>Nodes have two flags which govern which roles they can take:
+        <variablelist>
+          <varlistentry>
+            <term>master_capable</term>
+            <listitem>
+              <para>
+                The node can become a master candidate, and
+                furthermore the master node. When this flag is
+                disabled, the node cannot become a candidate; this can
+                be useful for special networking cases, or less
+                reliable hardware.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>vm_capable</term>
+            <listitem>
+              <para>
+                The node can host instances. When enabled (the default
+                state), the node will participate in instance
+                allocation, capacity calculation, etc. When disabled,
+                the node will be skipped in many cluster checks and
+                operations.
+              </para>
+            </listitem>
+          </varlistentry>
+        </variablelist>
+      </para>
+    </refsect2>
+
+    <refsect2>
       <title>Cluster configuration</title>
 
       <para>The master node keeps and is responsible for the cluster
           <varlistentry>
             <term>canceling</term>
             <listitem>
-              <para>The jos is waiting for locks, but is has been
+              <para>The job is waiting for locks, but is has been
               marked for cancellation. It will not transition to
               <emphasis>running</emphasis>, but to
               <emphasis>canceled</emphasis>.
     </refsect2>
   </refsect1>
 
+  <refsect1>
+    <title>Common options</title>
+
+    <para>
+      Many Ganeti commands provide the following options. The availability for
+      a certain command can be checked by calling the command using the
+      <option>--help</option> option.
+    </para>
+
+    <cmdsynopsis>
+      <command>gnt-<replaceable>...</replaceable> <replaceable>command</replaceable></command>
+      <arg>--dry-run</arg>
+      <arg>--priority <group choice="req">
+        <arg>low</arg>
+        <arg>normal</arg>
+        <arg>high</arg>
+      </group></arg>
+    </cmdsynopsis>
+
+    <para>
+      The <option>--dry-run</option> option can be used to check whether an
+      operation would succeed.
+    </para>
+
+    <para>
+      The option <option>--priority</option> sets the priority for opcodes
+      submitted by the command.
+    </para>
+
+  </refsect1>
+
   &footer;
 
 </refentry>