Synnefo » snf-ganeti

<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->

  <!-- Please adjust the date whenever revising the manpage. -->

  <!ENTITY dhdate      "<date>June 20, 2007</date>">

  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are

       allowed: see man(7), man(1). -->

  <!ENTITY dhsection   "<manvolnum>8</manvolnum>">

  <!ENTITY dhucpackage "<refentrytitle>gnt-cluster</refentrytitle>">

  <!ENTITY dhpackage   "gnt-cluster">

  <!ENTITY debian      "<productname>Debian</productname>">

  <!ENTITY gnu         "<acronym>GNU</acronym>">

  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">

  <!ENTITY footer SYSTEM "footer.sgml">

]>

<refentry>

  <refentryinfo>

    <copyright>

      <year>2006</year>

      <year>2007</year>

      <holder>Google Inc.</holder>

    </copyright>

    &dhdate;

  </refentryinfo>

  <refmeta>

    &dhucpackage;

    &dhsection;

    <refmiscinfo>ganeti 1.2</refmiscinfo>

  </refmeta>

  <refnamediv>

    <refname>&dhpackage;</refname>

    <refpurpose>ganeti administration, cluster-wide</refpurpose>

  </refnamediv>

  <refsynopsisdiv>

    <cmdsynopsis>

      <command>&dhpackage; </command>

      <arg choice="req">command</arg>

      <arg>arguments...</arg>

    </cmdsynopsis>

  </refsynopsisdiv>

  <refsect1>

    <title>DESCRIPTION</title>

    <para>

      The <command>&dhpackage;</command> is used for cluster-wide

      administration in the ganeti system.

    </para>

  </refsect1>

  <refsect1>

    <title>COMMANDS</title>

    <cmdsynopsis>

      <command>command</command>

      <arg>-n <replaceable>node</replaceable></arg>

      <arg choice="req"><replaceable>command</replaceable></arg>

    </cmdsynopsis>

    <para>

      Executes a command on all nodes. If the option

      <option>-n</option> is not given, the command will be executed

      on all nodes, otherwise it will be executed only on the node(s)

      specified. Use the option multiple times for running it on

      multiple nodes, like:

      <screen>

        # gnt-cluster command -n node1.example.com -n node2.example.com date

      </screen>

    </para>

    <para>The command is constructed by concatenating all other

    command line arguments. For example, to list the contents of the

    <filename class="directory">/etc</filename> directory on all

    nodes, run:

      <screen>

        # gnt-cluster command ls -l /etc

      </screen>

      and the command which will be executed will be

      <computeroutput>"ls -l /etc"</computeroutput>

    </para>

    <cmdsynopsis>

      <command>copyfile</command>

      <arg>-n <replaceable>node</replaceable></arg>

      <arg choice="req"><replaceable>file</replaceable></arg>

    </cmdsynopsis>

    <para>

      Copies a file to all or to some nodes. The argument specifies

      the source file (on the current system), the <option>-n</option>

      argument specifies the target node, or nodes if the option is

      given multiple times. If <option>-n</option> is not given at

      all, the file will be copied to all nodes.

      Example:

      <screen>

        # gnt-cluster -n node1.example.com -n node2.example.com copyfile /tmp/test

      </screen>

      This will copy the file <filename>/tmp/test</filename> from the

      current node to the two named nodes.

    </para>

    <cmdsynopsis>

      <command>destroy</command>

    </cmdsynopsis>

    <para>

      Remove all configuration files related to the cluster, so that a

      <command>gnt-cluster init</command> can be done again afterwards.

    </para>

    <cmdsynopsis>

      <command>getmaster</command>

    </cmdsynopsis>

    <para>

      Displays the current master node.

    </para>

    <cmdsynopsis>

      <command>info</command>

    </cmdsynopsis>

    <para>

      Shows runtime cluster information: cluster name, architecture

      (32 or 64 bit), master node, node list and instance list.

    </para>

    <cmdsynopsis>

      <command>init</command>

      <arg>-s <replaceable>secondary_ip</replaceable></arg>

      <arg>-b <replaceable>bridge</replaceable></arg>

      <arg choice="req"><replaceable>clustername</replaceable></arg>

    </cmdsynopsis>

    <para>

      This commands is only run once initially on the first node of

      the cluster. It will initialize the cluster configuration and

      setup ssh-keys and more.

    </para>

    <para>

      Note that the <replaceable>clustername</replaceable> is not any

      random name. It has to be resolvable to an IP address using DNS,

      and it is best if you give the fully-qualified domain name.

    </para>

    <para>

      The cluster can run in two modes: single-home or dual-homed. In

      the first case, all traffic (both public traffic, inter-node

      traffic and data replication traffic) goes over the same

      interface. In the dual-homed case, the data replication traffic

      goes over the second network. The <option>-s</option> option

      here marks the cluster as dual-homed and its parameter

      represents this node's address on the second network. If you

      initialise the cluster with <option>-s</option>, all nodes added

      must have a secondary IP as well.

    </para>

    <para>

      Note that for Ganeti it doesn't matter if the secondary network

      is actually a separate physical network, or is done using

      tunneling, etc. For performance reasons, it's recommended to use

      a separate network, of course.

    </para>

    <para>

      The <option>-b</option> option specifies the default bridge for

      instances.

    </para>

    <cmdsynopsis>

      <command>masterfailover</command>

    </cmdsynopsis>

    <para>

      Failover the master role to the current node.

    </para>

    <cmdsynopsis>

      <command>rename</command>

      <arg>-f</arg>

      <arg choice="req"><replaceable>name</replaceable></arg>

    </cmdsynopsis>

    <para>

      Renames the cluster and in the process updates the master IP

      address to the one the new name resolves to. At least one of

      either the name or the IP address must be different, otherwise

      the operation will be aborted.

    </para>

    <para>

      Note that since this command can be dangerous (especially when

      run over SSH), the command will require confirmation unless run

      with the <option>-f</option> option.

    </para>

    <cmdsynopsis>

      <command>verify</command>

    </cmdsynopsis>

    <para>

      Verify correctness of cluster configuration. This is safe with

      respect to running instances, and incurs no downtime of the

      instances.

    </para>

    <cmdsynopsis>

      <command>version</command>

    </cmdsynopsis>

    <para>

      Show the cluster version.

    </para>

  </refsect1>

  &footer;

</refentry>

<!-- Keep this comment at the end of the file

Local variables:

mode: sgml

sgml-omittag:t

sgml-shorttag:t

sgml-minimize-attributes:nil

sgml-always-quote-attributes:t

sgml-indent-step:2

sgml-indent-data:t

sgml-parent-document:nil

sgml-default-dtd-file:nil

sgml-exposed-tags:nil

sgml-local-catalogs:nil

sgml-local-ecat-files:nil

End:

-->