code.grnet.gr Git - ganeti-local/blob - man/gnt-cluster.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-cluster</refentrytitle>">
  10   <!ENTITY dhpackage   "gnt-cluster">
  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>ganeti administration, cluster-wide</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 cluster-wide
  51       administration in the ganeti system.
  52     </para>
  53
  54   </refsect1>
  55   <refsect1>
  56     <title>COMMANDS</title>
  57
  58     <refsect2>
  59       <title>ADD-TAGS</title>
  60
  61       <cmdsynopsis>
  62         <command>add-tags</command>
  63         <arg choice="req"
  64         rep="repeat"><replaceable>tag</replaceable></arg>
  65       </cmdsynopsis>
  66
  67       <para>
  68         Add tags to the cluster. If any of the tags contains invalid
  69         characters, the entire operation will abort.
  70       </para>
  71     </refsect2>
  72
  73     <refsect2>
  74       <title>COMMAND</title>
  75
  76       <cmdsynopsis>
  77         <command>command</command>
  78         <arg>-n <replaceable>node</replaceable></arg>
  79         <arg choice="req"><replaceable>command</replaceable></arg>
  80       </cmdsynopsis>
  81
  82       <para>
  83         Executes a command on all nodes. If the option
  84         <option>-n</option> is not given, the command will be executed
  85         on all nodes, otherwise it will be executed only on the
  86         node(s) specified. Use the option multiple times for running
  87         it on multiple nodes, like:
  88
  89         <screen>
  90           # gnt-cluster command -n node1.example.com -n node2.example.com date
  91         </screen>
  92
  93       </para>
  94
  95       <para>
  96         The command is constructed by concatenating all other command
  97         line arguments. For example, to list the contents of the
  98         <filename class="directory">/etc</filename> directory on all
  99         nodes, run:
 100
 101         <screen>
 102           # gnt-cluster command ls -l /etc
 103         </screen>
 104
 105         and the command which will be executed will be
 106         <computeroutput>"ls -l /etc"</computeroutput>
 107       </para>
 108     </refsect2>
 109
 110     <refsect2>
 111       <title>COPYFILE</title>
 112
 113       <cmdsynopsis>
 114         <command>copyfile</command>
 115         <arg>-n <replaceable>node</replaceable></arg>
 116         <arg choice="req"><replaceable>file</replaceable></arg>
 117       </cmdsynopsis>
 118
 119       <para>
 120         Copies a file to all or to some nodes. The argument specifies
 121         the source file (on the current system), the
 122         <option>-n</option> argument specifies the target node, or
 123         nodes if the option is given multiple times. If
 124         <option>-n</option> is not given at all, the file will be
 125         copied to all nodes.
 126
 127         Example:
 128         <screen>
 129           # gnt-cluster -n node1.example.com -n node2.example.com copyfile /tmp/test
 130         </screen>
 131
 132         This will copy the file <filename>/tmp/test</filename> from
 133         the current node to the two named nodes.
 134       </para>
 135     </refsect2>
 136
 137     <refsect2>
 138       <title>DESTROY</title>
 139
 140       <cmdsynopsis>
 141         <command>destroy</command>
 142       </cmdsynopsis>
 143
 144       <para>
 145         Remove all configuration files related to the cluster, so that
 146         a <command>gnt-cluster init</command> can be done again
 147         afterwards.
 148       </para>
 149     </refsect2>
 150
 151     <refsect2>
 152       <title>GETMASTER</title>
 153
 154       <cmdsynopsis>
 155         <command>getmaster</command>
 156       </cmdsynopsis>
 157
 158       <para>
 159         Displays the current master node.
 160       </para>
 161     </refsect2>
 162
 163     <refsect2>
 164       <title>INFO</title>
 165
 166       <cmdsynopsis>
 167         <command>info</command>
 168       </cmdsynopsis>
 169
 170       <para>
 171         Shows runtime cluster information: cluster name, architecture
 172         (32 or 64 bit), master node, node list and instance list.
 173       </para>
 174     </refsect2>
 175
 176     <refsect2>
 177       <title>INIT</title>
 178
 179       <cmdsynopsis>
 180         <command>init</command>
 181         <arg>-s <replaceable>secondary_ip</replaceable></arg>
 182         <arg>-b <replaceable>bridge</replaceable></arg>
 183         <arg choice="req"><replaceable>clustername</replaceable></arg>
 184       </cmdsynopsis>
 185
 186       <para>
 187         This commands is only run once initially on the first node of
 188         the cluster. It will initialize the cluster configuration and
 189         setup ssh-keys and more.
 190       </para>
 191
 192       <para>
 193         Note that the <replaceable>clustername</replaceable> is not
 194         any random name. It has to be resolvable to an IP address
 195         using DNS, and it is best if you give the fully-qualified
 196         domain name.
 197       </para>
 198
 199       <para>
 200         The cluster can run in two modes: single-home or
 201         dual-homed. In the first case, all traffic (both public
 202         traffic, inter-node traffic and data replication traffic) goes
 203         over the same interface. In the dual-homed case, the data
 204         replication traffic goes over the second network. The
 205         <option>-s</option> option here marks the cluster as
 206         dual-homed and its parameter represents this node's address on
 207         the second network. If you initialise the cluster with
 208         <option>-s</option>, all nodes added must have a secondary IP
 209         as well.
 210       </para>
 211
 212       <para>
 213         Note that for Ganeti it doesn't matter if the secondary
 214
 215         network is actually a separate physical network, or is done
 216         using tunneling, etc. For performance reasons, it's
 217         recommended to use a separate network, of course.
 218       </para>
 219
 220       <para>
 221         The <option>-b</option> option specifies the default bridge
 222         for instances.
 223       </para>
 224     </refsect2>
 225
 226     <refsect2>
 227       <title>LIST-TAGS</title>
 228
 229       <cmdsynopsis>
 230         <command>list-tags</command>
 231       </cmdsynopsis>
 232
 233       <para>List the tags of the cluster.</para>
 234     </refsect2>
 235
 236     <refsect2>
 237       <title>MASTERFAILOVER</title>
 238
 239       <cmdsynopsis>
 240         <command>masterfailover</command>
 241       </cmdsynopsis>
 242
 243       <para>
 244         Failover the master role to the current node.
 245       </para>
 246     </refsect2>
 247
 248     <refsect2>
 249       <title>REMOVE-TAGS</title>
 250
 251       <cmdsynopsis>
 252         <command>remove-tags</command>
 253         <arg choice="req"
 254         rep="repeat"><replaceable>tag</replaceable></arg>
 255       </cmdsynopsis>
 256
 257       <para>
 258         Remove tags from the cluster. If any of the tags are not
 259         existing on the cluster, the entire operation will abort.
 260       </para>
 261     </refsect2>
 262
 263     <refsect2>
 264       <title>RENAME</title>
 265
 266       <cmdsynopsis>
 267         <command>rename</command>
 268         <arg>-f</arg>
 269         <arg choice="req"><replaceable>name</replaceable></arg>
 270       </cmdsynopsis>
 271
 272       <para>
 273         Renames the cluster and in the process updates the master IP
 274         address to the one the new name resolves to. At least one of
 275         either the name or the IP address must be different, otherwise
 276         the operation will be aborted.
 277       </para>
 278
 279       <para>
 280         Note that since this command can be dangerous (especially when
 281         run over SSH), the command will require confirmation unless
 282         run with the <option>-f</option> option.
 283       </para>
 284     </refsect2>
 285
 286     <refsect2>
 287       <title>VERIFY</title>
 288
 289       <cmdsynopsis>
 290         <command>verify</command>
 291       </cmdsynopsis>
 292
 293       <para>
 294         Verify correctness of cluster configuration. This is safe with
 295         respect to running instances, and incurs no downtime of the
 296         instances.
 297       </para>
 298     </refsect2>
 299
 300     <refsect2>
 301       <title>VERSION</title>
 302
 303       <cmdsynopsis>
 304         <command>version</command>
 305       </cmdsynopsis>
 306
 307       <para>
 308         Show the cluster version.
 309       </para>
 310     </refsect2>
 311
 312   </refsect1>
 313
 314   &footer;
 315
 316 </refentry>
 317
 318 <!-- Keep this comment at the end of the file
 319 Local variables:
 320 mode: sgml
 321 sgml-omittag:t
 322 sgml-shorttag:t
 323 sgml-minimize-attributes:nil
 324 sgml-always-quote-attributes:t
 325 sgml-indent-step:2
 326 sgml-indent-data:t
 327 sgml-parent-document:nil
 328 sgml-default-dtd-file:nil
 329 sgml-exposed-tags:nil
 330 sgml-local-catalogs:nil
 331 sgml-local-ecat-files:nil
 332 End:
 333 -->