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     <cmdsynopsis>
  59       <command>command</command>
  60       <arg>-n <replaceable>node</replaceable></arg>
  61       <arg choice="req"><replaceable>command</replaceable></arg>
  62     </cmdsynopsis>
  63
  64     <para>
  65       Executes a command on all nodes. If the option
  66       <option>-n</option> is not given, the command will be executed
  67       on all nodes, otherwise it will be executed only on the node(s)
  68       specified. Use the option multiple times for running it on
  69       multiple nodes, like:
  70
  71       <screen>
  72         # gnt-cluster command -n node1.example.com -n node2.example.com date
  73       </screen>
  74
  75     </para>
  76
  77     <para>The command is constructed by concatenating all other
  78     command line arguments. For example, to list the contents of the
  79     <filename class="directory">/etc</filename> directory on all
  80     nodes, run:
  81
  82       <screen>
  83         # gnt-cluster command ls -l /etc
  84       </screen>
  85
  86       and the command which will be executed will be
  87       <computeroutput>"ls -l /etc"</computeroutput>
  88     </para>
  89
  90
  91     <cmdsynopsis>
  92       <command>copyfile</command>
  93       <arg>-n <replaceable>node</replaceable></arg>
  94       <arg choice="req"><replaceable>file</replaceable></arg>
  95     </cmdsynopsis>
  96
  97     <para>
  98       Copies a file to all or to some nodes. The argument specifies
  99       the source file (on the current system), the <option>-n</option>
 100       argument specifies the target node, or nodes if the option is
 101       given multiple times. If <option>-n</option> is not given at
 102       all, the file will be copied to all nodes.
 103
 104       Example:
 105       <screen>
 106         # gnt-cluster -n node1.example.com -n node2.example.com copyfile /tmp/test
 107       </screen>
 108
 109       This will copy the file <filename>/tmp/test</filename> from the
 110       current node to the two named nodes.
 111     </para>
 112
 113     <cmdsynopsis>
 114       <command>getmaster</command>
 115     </cmdsynopsis>
 116
 117     <para>
 118       Displays the current master node.
 119     </para>
 120
 121     <cmdsynopsis>
 122       <command>info</command>
 123     </cmdsynopsis>
 124
 125     <para>
 126       Shows runtime cluster information: cluster name, architecture
 127       (32 or 64 bit), master node, node list and instance list.
 128     </para>
 129
 130     <cmdsynopsis>
 131       <command>init</command>
 132       <arg>-s <replaceable>secondary_ip</replaceable></arg>
 133       <arg>-b <replaceable>bridge</replaceable></arg>
 134       <arg choice="req"><replaceable>clustername</replaceable></arg>
 135     </cmdsynopsis>
 136     <para>
 137       This commands is only run once initially on the first node of
 138       the cluster. It will initialize the cluster configuration and
 139       setup ssh-keys and more.
 140     </para>
 141
 142     <para>
 143       Note that the <replaceable>clustername</replaceable> is not any
 144       random name. It has to be resolvable to an IP address using DNS,
 145       and it is best if you give the fully-qualified domain name.
 146     </para>
 147
 148     <para>
 149       The cluster can run in two modes: single-home or dual-homed. In
 150       the first case, all traffic (both public traffic, inter-node
 151       traffic and data replication traffic) goes over the same
 152       interface. In the dual-homed case, the data replication traffic
 153       goes over the second network. The <option>-s</option> option
 154       here marks the cluster as dual-homed and its parameter
 155       represents this node's address on the second network. If you
 156       initialise the cluster with <option>-s</option>, all nodes added
 157       must have a secondary IP as well.
 158     </para>
 159
 160     <para>
 161       Note that for Ganeti it doesn't matter if the secondary network
 162       is actually a separate physical network, or is done using
 163       tunneling, etc. For performance reasons, it's recommended to use
 164       a separate network, of course.
 165     </para>
 166
 167     <para>
 168       The <option>-b</option> option specifies the default bridge for
 169       instances.
 170     </para>
 171
 172     <cmdsynopsis>
 173       <command>masterfailover</command>
 174     </cmdsynopsis>
 175
 176     <para>
 177       Failover the master role to the current node.
 178     </para>
 179
 180     <cmdsynopsis>
 181       <command>destroy</command>
 182     </cmdsynopsis>
 183
 184     <para>
 185       Remove all configuration files related to the cluster, so that a
 186       <command>gnt-cluster init</command> can be done again afterwards.
 187     </para>
 188
 189     <cmdsynopsis>
 190       <command>verify</command>
 191     </cmdsynopsis>
 192
 193     <para>
 194       Verify correctness of cluster configuration. This is safe with
 195       respect to running instances, and incurs no downtime of the
 196       instances.
 197     </para>
 198
 199     <cmdsynopsis>
 200       <command>version</command>
 201     </cmdsynopsis>
 202
 203     <para>
 204       Show the cluster version.
 205     </para>
 206
 207   </refsect1>
 208
 209   &footer;
 210
 211 </refentry>
 212
 213 <!-- Keep this comment at the end of the file
 214 Local variables:
 215 mode: sgml
 216 sgml-omittag:t
 217 sgml-shorttag:t
 218 sgml-minimize-attributes:nil
 219 sgml-always-quote-attributes:t
 220 sgml-indent-step:2
 221 sgml-indent-data:t
 222 sgml-parent-document:nil
 223 sgml-default-dtd-file:nil
 224 sgml-exposed-tags:nil
 225 sgml-local-catalogs:nil
 226 sgml-local-ecat-files:nil
 227 End:
 228 -->