<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!-- Please adjust the date whenever revising the manpage. -->
- <!ENTITY dhdate "<date>June 20, 2007</date>">
+ <!ENTITY dhdate "<date>February 12, 2009</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>8</manvolnum>">
<copyright>
<year>2006</year>
<year>2007</year>
+ <year>2008</year>
+ <year>2009</year>
<holder>Google Inc.</holder>
</copyright>
&dhdate;
&dhucpackage;
&dhsection;
- <refmiscinfo>ganeti 1.2</refmiscinfo>
+ <refmiscinfo>ganeti 2.0</refmiscinfo>
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<cmdsynopsis>
<command>add</command>
+ <arg>--readd</arg>
<arg>-s <replaceable>secondary_ip</replaceable></arg>
<arg choice="req"><replaceable>nodename</replaceable></arg>
</cmdsynopsis>
</para>
<para>
+ In case you're readding a node after hardware failure, you can
+ use the <option>--readd</option> parameter. In this case, you
+ don't need to pass the secondary IP again, it will reused from
+ the cluster. Also, the <literal>drained</literal> and
+ <literal>offline</literal> flags of the node will be cleared
+ before re-adding it.
+ </para>
+
+ <para>
Example:
<screen>
# gnt-node add node5.example.com
<cmdsynopsis>
<command>add-tags</command>
+ <arg choice="opt">--from <replaceable>file</replaceable></arg>
<arg choice="req"><replaceable>nodename</replaceable></arg>
<arg choice="req"
rep="repeat"><replaceable>tag</replaceable></arg>
Add tags to the given node. If any of the tags contains
invalid characters, the entire operation will abort.
</para>
+
+ <para>
+ If the <option>--from</option> option is given, the list of
+ tags will be extended with the contents of that file (each
+ line becomes a tag). In this case, there is not need to pass
+ tags on the command line (if you do, both sources will be
+ used). A file name of - will be interpreted as stdin.
+ </para>
+ </refsect2>
+
+ <refsect2>
+ <title>EVACUATE</title>
+
+ <cmdsynopsis>
+ <command>evacuate</command>
+ <arg>-f</arg>
+ <group>
+ <arg>--iallocator <replaceable>NAME</replaceable></arg>
+ <arg>--new-secondary <replaceable>destination_node</replaceable></arg>
+ </group>
+ <arg choice="req"><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
+ template.
+ </para>
+
+ <para>
+ The new location for the instances can be specified in two ways:
+ <itemizedlist>
+ <listitem>
+ <simpara>as a single node for all instances, via the
+ <option>--new-secondary</option> option</simpara>
+ </listitem>
+ <listitem>
+ <simpara>or via the <option>--iallocator</option> option,
+ giving a script name as parameter, so each instance will
+ be in turn placed on the (per the script) optimal
+ node</simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ Example:
+ <screen>
+ # gnt-node evacuate -I dumb node3.example.com
+ </screen>
+ </para>
+ </refsect2>
+
+ <refsect2>
+ <title>FAILOVER</title>
+
+ <cmdsynopsis>
+ <command>failover</command>
+ <arg>-f</arg>
+ <arg>--ignore-consistency</arg>
+ <arg choice="req"><replaceable>node</replaceable></arg>
+ </cmdsynopsis>
+
+ <para>
+ This command will fail over all instances having the given
+ node as primary to their secondary nodes. This works only for
+ instances having a drbd disk template.
+ </para>
+
+ <para>
+ Normally the failover will check the consistency of the 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.
+ </para>
+
+ <para>
+ Example:
+ <screen>
+ # gnt-node failover node1.example.com
+ </screen>
+ </para>
</refsect2>
<refsect2>
<cmdsynopsis>
<command>list</command>
+ <arg>--sync</arg>
+ <sbr>
<arg>--no-headers</arg>
<arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
- <arg>-o <replaceable>FIELD,...</replaceable></arg>
+ <sbr>
+ <arg>--units=<replaceable>UNITS</replaceable></arg>
+ <arg>-o <replaceable>[+]FIELD,...</replaceable></arg>
+ <sbr>
+ <arg rep="repeat">node</arg>
</cmdsynopsis>
<para>
- Lists the nodes in the cluster. If you give the
- <option>--ip-info</option> option, the output contains just
- the node name, primary ip and secondary ip. In case the
- secondary ip is the same as the primary one, it will be listed
- as <emphasis>"-"</emphasis>.
+ Lists the nodes in the cluster.
</para>
<para>
</para>
<para>
+ The units used to display the numeric values in the output
+ varies, depending on the options given. By default, the values
+ will be formatted in the most appropriate unit. If the
+ <option>--separator</option> option is given, then the values
+ are shown in mebibytes to allow parsing by scripts. In both
+ cases, the <option>--units</option> option can be used to
+ enforce a given output unit.
+ </para>
+
+ <para>
+ By default, the query of nodes will be done in parallel with
+ any running jobs. This might give inconsistent results for the
+ free disk/memory. The <option>--sync</option> can be used to
+ grab locks for all the nodes and ensure consistent view of the
+ cluster (but this might stall the query for a long time).
+ </para>
+
+ <para>
The <option>-o</option> option takes a comma-separated list of
output fields. The available fields and their meaning are:
<variablelist>
</listitem>
</varlistentry>
<varlistentry>
- <term>pinst</term>
+ <term>pinst_cnt</term>
<listitem>
<simpara>the number of instances having this node as
primary</simpara>
</listitem>
</varlistentry>
<varlistentry>
- <term>sinst</term>
+ <term>pinst_list</term>
+ <listitem>
+ <simpara>the list of instances having this node as
+ primary, comma separated</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>sinst_cnt</term>
<listitem>
<simpara>the number of instances having this node as a
secondary node</simpara>
</listitem>
</varlistentry>
<varlistentry>
+ <term>sinst_list</term>
+ <listitem>
+ <simpara>the list of instances having this node as a
+ secondary node, comma separated</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term>pip</term>
<listitem>
<simpara>the primary ip of this node (used for cluster
allocations</simpara>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>bootid</term>
+ <listitem>
+ <simpara>the node bootid value; this is a linux specific
+ feature that assigns a new UUID to the node at each boot
+ and can be use to detect node reboots (by tracking
+ changes in this value)</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>tags</term>
+ <listitem>
+ <simpara>comma-separated list of the node's
+ tags</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>serial_no</term>
+ <listitem>
+ <simpara>the so called 'serial number' of the instance;
+ this is a numeric field that is incremented each time
+ the instance is modified, and it can be used to detect
+ modifications</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ctotal</term>
+ <listitem>
+ <simpara>the toal number of logical processors</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>cnodes</term>
+ <listitem>
+ <simpara>the number of NUMA domains on the node, if the
+ hypervisor can export this information</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>csockets</term>
+ <listitem>
+ <simpara>the number of physical CPU sockets, if the
+ hypervisor can export this information</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>master_candidate</term>
+ <listitem>
+ <simpara>whether the node is a master candidate or not</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>drained</term>
+ <listitem>
+ <simpara>whether the node is drained or not</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>offline</term>
+ <listitem>
+ <simpara>whether the node is offline or not</simpara>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
<para>
+ If the value of the option starts with the character
+ <constant>+</constant>, the new fields will be added to the
+ default list. This allows to quickly see the default list plus
+ a few other fields, instead of retyping the entire list of
+ fields.
+ </para>
+
+ <para>
Note that some of this fields are known from the configuration
- of the cluster (<simplelist type="inline">
+ of the cluster (e.g. <simplelist type="inline">
<member>name</member> <member>pinst</member>
<member>sinst</member> <member>pip</member>
<member>sip</member> </simplelist> and thus the master does
details, the mtotal, mnode and mfree may have slighly varying
meanings. For example, some solutions share the node memory
with the pool of memory used for instances
- (<acronym>UML</acronym>), whereas others have separate memory
+ (<acronym>KVM</acronym>), whereas others have separate memory
for the node and for the instances (Xen).
</para>
+
+ <para>
+ If no node names are given, then all nodes are
+ queried. Otherwise, only the given nodes will be listed.
+ </para>
</refsect2>
<refsect2>
</refsect2>
<refsect2>
+ <title>MIGRATE</title>
+ <cmdsynopsis>
+ <command>migrate</command>
+ <arg>-f</arg>
+ <arg>--non-live</arg>
+ <arg choice="req"><replaceable>node</replaceable></arg>
+ </cmdsynopsis>
+
+ <para>
+ This command will migrate all instances having the given
+ node as primary to their secondary nodes. This works only for
+ instances having a drbd disk template.
+ </para>
+
+ <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.
+ </para>
+
+ <para>
+ Example:
+ <screen>
+ # gnt-node migrate node1.example.com
+ </screen>
+ </para>
+
+ </refsect2>
+
+ <refsect2>
+ <title>MODIFY</title>
+ <cmdsynopsis>
+ <command>modify</command>
+ <arg>-f</arg>
+ <arg>--submit</arg>
+ <arg>--master-candidate=<option>yes|no</option></arg>
+ <arg>--drained=<option>yes|no</option></arg>
+ <arg>--offline=<option>yes|no</option></arg>
+ <arg choice="req"><replaceable>node</replaceable></arg>
+ </cmdsynopsis>
+
+ <para>
+ 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>
+ <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.
+ </para>
+
+ <para>
+ Example (setting a node offline, which will demote it from
+ master candidate role if is in that role):
+ <screen>
+# gnt-node modify --offline=yes node1.example.com
+ </screen>
+ </para>
+
+ <para>Example (setting the node back to online and master candidate):
+ <screen>
+# gnt-node modify --offline=no --master-candidate=yes node1.example.com
+ </screen>
+ </para>
+
+ </refsect2>
+
+ <refsect2>
<title>REMOVE</title>
<cmdsynopsis>
<title>REMOVE-TAGS</title>
<cmdsynopsis>
<command>remove-tags</command>
+ <arg choice="opt">--from <replaceable>file</replaceable></arg>
<arg choice="req"><replaceable>nodename</replaceable></arg>
<arg choice="req"
rep="repeat"><replaceable>tag</replaceable></arg>
Remove tags from the given node. If any of the tags are not
existing on the node, the entire operation will abort.
</para>
+
+ <para>
+ If the <option>--from</option> option is given, the list of
+ tags will be extended with the contents of that file (each
+ line becomes a tag). In this case, there is not need to pass
+ tags on the command line (if you do, both sources will be
+ used). A file name of - will be interpreted as stdin.
+ </para>
</refsect2>
<refsect2>
<cmdsynopsis>
<command>volumes</command>
+ <arg>--no-headers</arg>
+ <arg>--human-readable</arg>
+ <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
+ <arg>--output=<replaceable>FIELDS</replaceable></arg>
+ <sbr>
<arg rep="repeat"><replaceable>node</replaceable></arg>
</cmdsynopsis>
</para>
<para>
+ The <option>--no-headers</option> option will skip the initial
+ header line. The <option>--separator</option> option takes an
+ argument which denotes what will be used between the output
+ fields. Both these options are to help scripting.
+ </para>
+
+ <para>
+ The units used to display the numeric values in the output
+ varies, depending on the options given. By default, the values
+ will be formatted in the most appropriate unit. If the
+ <option>--separator</option> option is given, then the values
+ are shown in mebibytes to allow parsing by scripts. In both
+ cases, the <option>--units</option> option can be used to
+ enforce a given output unit.
+ </para>
+
+ <para>
+ The <option>-o</option> option takes a comma-separated list of
+ output fields. The available fields and their meaning are:
+ <variablelist>
+ <varlistentry>
+ <term>node</term>
+ <listitem>
+ <simpara>the node name on which the volume exists</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>phys</term>
+ <listitem>
+ <simpara>the physical drive (on which the LVM physical
+ volume lives)</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>vg</term>
+ <listitem>
+ <simpara>the volume group name</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>name</term>
+ <listitem>
+ <simpara>the logical volume name</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>size</term>
+ <listitem>
+ <simpara>the logical volume size</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>instance</term>
+ <listitem>
+ <simpara>The name of the instance to which this volume
+ belongs, or (in case it's an orphan volume) the
+ character <quote>-</quote></simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ <para>
Example:
<screen>
# gnt-node volumes node5.example.com
</para>
</refsect2>
+ <refsect2>
+ <title>POWERCYCLE</title>
+
+ <cmdsynopsis>
+ <command>powercycle</command>
+ <arg><option>--confirm</option></arg>
+ <arg><option>--force</option></arg>
+ <arg choice="req"><replaceable>node</replaceable></arg>
+ </cmdsynopsis>
+
+ <para>
+ 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.
+ </para>
+
+ <para>
+ Note that this command is not guaranteed to work; it depends
+ on the hypervisor how effective is the reboot attempt. For
+ Linux, this command require that the kernel option
+ <literal>CONFIG_MAGIC_SYSRQ</literal> is enabled.
+ </para>
+
+ <para>
+ The <option>--yes</option> option can be used to skip
+ confirmation, while the <option>--force</option> option is
+ needed if the target node is the master node.
+ </para>
+
</refsect1>
&footer;
projects / ganeti-local / blobdiff