code.grnet.gr Git - ganeti-local/blob - man/gnt-node.sgml

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2
   3   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
   4   <!-- Please adjust the date whenever revising the manpage. -->
   5   <!ENTITY dhdate      "<date>June 20, 2007</date>">
   6   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
   7        allowed: see man(7), man(1). -->
   8   <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
   9   <!ENTITY dhucpackage "<refentrytitle>gnt-node</refentrytitle>">
  10   <!ENTITY dhpackage   "gnt-node">
  11
  12   <!ENTITY debian      "<productname>Debian</productname>">
  13   <!ENTITY gnu         "<acronym>GNU</acronym>">
  14   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  15   <!ENTITY footer SYSTEM "footer.sgml">
  16 ]>
  17
  18 <refentry>
  19   <refentryinfo>
  20     <copyright>
  21       <year>2006</year>
  22       <year>2007</year>
  23       <holder>Google Inc.</holder>
  24     </copyright>
  25     &dhdate;
  26   </refentryinfo>
  27   <refmeta>
  28     &dhucpackage;
  29
  30     &dhsection;
  31     <refmiscinfo>ganeti 1.2</refmiscinfo>
  32   </refmeta>
  33   <refnamediv>
  34     <refname>&dhpackage;</refname>
  35
  36     <refpurpose>node administration</refpurpose>
  37   </refnamediv>
  38   <refsynopsisdiv>
  39     <cmdsynopsis>
  40       <command>&dhpackage; </command>
  41
  42       <arg choice="req">command</arg>
  43       <arg>arguments...</arg>
  44     </cmdsynopsis>
  45   </refsynopsisdiv>
  46   <refsect1>
  47     <title>DESCRIPTION</title>
  48
  49     <para>
  50       The <command>&dhpackage;</command> is used for managing the
  51       (physical) nodes in the ganeti system.
  52     </para>
  53
  54   </refsect1>
  55   <refsect1>
  56     <title>COMMANDS</title>
  57
  58     <refsect2>
  59       <title>ADD</title>
  60
  61       <cmdsynopsis>
  62         <command>add</command>
  63         <arg>-s <replaceable>secondary_ip</replaceable></arg>
  64         <arg choice="req"><replaceable>nodename</replaceable></arg>
  65       </cmdsynopsis>
  66
  67       <para>
  68         Adds the given node to the cluster.
  69       </para>
  70
  71       <para>
  72         This command is used to join a new node to the cluster. You
  73         will have to provide the password for root of the node to be
  74         able to add the node in the cluster. The command needs to be
  75         run on the ganeti master.
  76       </para>
  77
  78       <para>
  79         Note that the command is potentially destructive, as it will
  80         forcibly join the specified host the cluster, not paying
  81         attention to its current status (it could be already in a
  82         cluster, etc.)
  83       </para>
  84
  85       <para>
  86         The <option>-s</option> is used in dual-home clusters and
  87         specifies the new node's IP in the secondary network. See the
  88         discussion in <citerefentry>
  89         <refentrytitle>gnt-cluster</refentrytitle>
  90         <manvolnum>8</manvolnum> </citerefentry> for more
  91         informations.
  92       </para>
  93
  94       <para>
  95         Example:
  96         <screen>
  97 # gnt-node add node5.example.com
  98 # gnt-node add -s 192.168.44.5 node5.example.com
  99         </screen>
 100       </para>
 101     </refsect2>
 102
 103     <refsect2>
 104       <title>INFO</title>
 105
 106       <cmdsynopsis>
 107         <command>info</command>
 108         <arg rep="repeat"><replaceable>node</replaceable></arg>
 109       </cmdsynopsis>
 110
 111       <para>
 112         Show detailed information about the nodes in the cluster. If you
 113         don't give any arguments, all nodes will be shows, otherwise the
 114         output will be restricted to the given names.
 115       </para>
 116     </refsect2>
 117
 118     <refsect2>
 119       <title>LIST</title>
 120
 121       <cmdsynopsis>
 122         <command>list</command>
 123         <arg>--no-headers</arg>
 124         <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
 125         <arg>-o <replaceable>FIELD,...</replaceable></arg>
 126       </cmdsynopsis>
 127
 128       <para>
 129         Lists the nodes in the cluster. If you give the
 130         <option>--ip-info</option> option, the output contains just
 131         the node name, primary ip and secondary ip. In case the
 132         secondary ip is the same as the primary one, it will be listed
 133         as <emphasis>"-"</emphasis>.
 134       </para>
 135
 136       <para>
 137         The <option>--no-headers</option> option will skip the initial
 138         header line. The <option>--separator</option> option takes an
 139         argument which denotes what will be used between the output
 140         fields. Both these options are to help scripting.
 141       </para>
 142
 143       <para>
 144         The <option>-o</option> option takes a comma-separated list of
 145         output fields. The available fields and their meaning are:
 146         <variablelist>
 147           <varlistentry>
 148             <term>name</term>
 149             <listitem>
 150               <simpara>the node name</simpara>
 151             </listitem>
 152           </varlistentry>
 153           <varlistentry>
 154             <term>pinst</term>
 155             <listitem>
 156               <simpara>the number of instances having this node as
 157               primary</simpara>
 158             </listitem>
 159           </varlistentry>
 160           <varlistentry>
 161             <term>sinst</term>
 162             <listitem>
 163               <simpara>the number of instances having this node as a
 164               secondary node</simpara>
 165             </listitem>
 166           </varlistentry>
 167           <varlistentry>
 168             <term>pip</term>
 169             <listitem>
 170               <simpara>the primary ip of this node (used for cluster
 171               communication)</simpara>
 172             </listitem>
 173           </varlistentry>
 174           <varlistentry>
 175             <term>sip</term>
 176             <listitem>
 177               <simpara>
 178                 the secondary ip of this node (used for data
 179                 replication in dual-ip clusters, see <citerefentry>
 180                 <refentrytitle>gnt-cluster</refentrytitle>
 181                 <manvolnum>8</manvolnum>
 182                 </citerefentry>
 183               </simpara>
 184             </listitem>
 185           </varlistentry>
 186           <varlistentry>
 187             <term>dtotal</term>
 188             <listitem>
 189               <simpara>total disk space in the volume group used for
 190               instance disk allocations</simpara>
 191             </listitem>
 192           </varlistentry>
 193           <varlistentry>
 194             <term>dfree</term>
 195             <listitem>
 196               <simpara>available disk space in the volume group</simpara>
 197             </listitem>
 198           </varlistentry>
 199           <varlistentry>
 200             <term>mtotal</term>
 201             <listitem>
 202               <simpara>total memory on the physical node</simpara>
 203             </listitem>
 204           </varlistentry>
 205           <varlistentry>
 206             <term>mnode</term>
 207             <listitem>
 208               <simpara>the memory used by the node itself</simpara>
 209             </listitem>
 210           </varlistentry>
 211           <varlistentry>
 212             <term>mfree</term>
 213             <listitem>
 214               <simpara>memory available for instance
 215               allocations</simpara>
 216             </listitem>
 217           </varlistentry>
 218         </variablelist>
 219       </para>
 220
 221       <para>
 222         Note that some of this fields are known from the configuration
 223         of the cluster (<simplelist type="inline">
 224         <member>name</member> <member>pinst</member>
 225         <member>sinst</member> <member>pip</member>
 226         <member>sip</member> </simplelist> and thus the master does
 227         not need to contact the node for this data (making the listing
 228         fast if only fields from this set are selected), whereas the
 229         other fields are "live" fields and we need to make a query to
 230         the cluster nodes.
 231       </para>
 232
 233       <para>
 234         Depending on the virtualization type and implementation
 235         details, the mtotal, mnode and mfree may have slighly varying
 236         meanings. For example, some solutions share the node memory
 237         with the pool of memory used for instances
 238         (<acronym>UML</acronym>), whereas others have separate memory
 239         for the node and for the instances (Xen).
 240       </para>
 241     </refsect2>
 242
 243     <refsect2>
 244       <title>REMOVE</title>
 245
 246       <cmdsynopsis>
 247         <command>remove</command>
 248         <arg choice="req"><replaceable>nodename</replaceable></arg>
 249       </cmdsynopsis>
 250
 251       <para>
 252         Removes a node from the cluster. Instances must be removed or
 253         migrated to another cluster before.
 254       </para>
 255
 256       <para>
 257         Example:
 258         <screen>
 259 # gnt-node remove node5.example.com
 260         </screen>
 261       </para>
 262     </refsect2>
 263
 264   </refsect1>
 265
 266   &footer;
 267
 268 </refentry>
 269
 270 <!-- Keep this comment at the end of the file
 271 Local variables:
 272 mode: sgml
 273 sgml-omittag:t
 274 sgml-shorttag:t
 275 sgml-minimize-attributes:nil
 276 sgml-always-quote-attributes:t
 277 sgml-indent-step:2
 278 sgml-indent-data:t
 279 sgml-parent-document:nil
 280 sgml-default-dtd-file:nil
 281 sgml-exposed-tags:nil
 282 sgml-local-catalogs:nil
 283 sgml-local-ecat-files:nil
 284 End:
 285 -->