Synnefo » snf-ganeti

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

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

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

  <!ENTITY dhdate      "<date>June 08, 2010</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-os</refentrytitle>">

  <!ENTITY dhpackage   "gnt-os">

  <!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>

      <year>2008</year>

      <year>2009</year>

      <year>2010</year>

      <holder>Google Inc.</holder>

    </copyright>

    &dhdate;

  </refentryinfo>

  <refmeta>

    &dhucpackage;

    &dhsection;

    <refmiscinfo>Ganeti 2.2</refmiscinfo>

  </refmeta>

  <refnamediv>

    <refname>&dhpackage;</refname>

    <refpurpose>Instance operating system administration</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 managing the list

      of available operating system flavours for the instances in the

      Ganeti cluster.

    </para>

  </refsect1>

  <refsect1>

    <title>COMMANDS</title>

    <cmdsynopsis>

      <command>list</command>

    </cmdsynopsis>

    <para>

      Gives the list of available/supported OS to use in the

      instances. When creating the instance you can give the OS-name

      as an option.

    </para>

    <cmdsynopsis>

      <command>diagnose</command>

    </cmdsynopsis>

    <para>

      This command will help you see why an installed OS is not

      available in the cluster. The <command>list</command> command

      shows only the OS-es that the cluster sees available on all

      nodes. It could be that some OS is missing from a node, or is

      only partially installed, and this command will show the details

      of all the OSes and the reasons they are or are not valid.

    </para>

    <cmdsynopsis>

      <command>info</command>

    </cmdsynopsis>

    <para>

      This command will list detailed information about each OS

      available in the cluster, including its validity status, the

      supported API versions, the supported parameters (if any) and

      their documentations, etc.

    </para>

    <cmdsynopsis>

      <command>modify</command>

      <arg>-H <replaceable>HYPERVISOR</replaceable><arg>:<arg choice="plain" rep="repeat">option=<replaceable>value</replaceable></arg></arg></arg>

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

    </cmdsynopsis>

    <para>

      This command will allow you to modify OS parameters. At the moment

      we just support per-os-hypervisor settings. You can run modify

      <option>-H</option> with the same syntax as in

      <command>gnt-cluster init</command> to override default hypervisor

      parameters of the cluster for specified

      <replaceable>OS</replaceable> argument.

    </para>

    <para>

      Note: The <replaceable>OS</replaceable> doesn't have to exists.

      This allows preseeding the settings for

      <replaceable>OS</replaceable>es not yet known to

      <command>gnt-os</command>.

    </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:

-->