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

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.2//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 08, 2010</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-os</refentrytitle>">
  10   <!ENTITY dhpackage   "gnt-os">
  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       <year>2008</year>
  24       <year>2009</year>
  25       <year>2010</year>
  26       <holder>Google Inc.</holder>
  27     </copyright>
  28     &dhdate;
  29   </refentryinfo>
  30   <refmeta>
  31     &dhucpackage;
  32
  33     &dhsection;
  34     <refmiscinfo>Ganeti 2.2</refmiscinfo>
  35   </refmeta>
  36   <refnamediv>
  37     <refname>&dhpackage;</refname>
  38
  39     <refpurpose>Instance operating system administration</refpurpose>
  40   </refnamediv>
  41   <refsynopsisdiv>
  42     <cmdsynopsis>
  43       <command>&dhpackage; </command>
  44
  45       <arg choice="req">command</arg>
  46       <arg>arguments...</arg>
  47     </cmdsynopsis>
  48   </refsynopsisdiv>
  49   <refsect1>
  50     <title>DESCRIPTION</title>
  51
  52     <para>
  53       The <command>&dhpackage;</command> is used for managing the list
  54       of available operating system flavours for the instances in the
  55       Ganeti cluster.
  56     </para>
  57
  58   </refsect1>
  59   <refsect1>
  60     <title>COMMANDS</title>
  61
  62     <cmdsynopsis>
  63       <command>list</command>
  64     </cmdsynopsis>
  65
  66     <para>
  67       Gives the list of available/supported OS to use in the
  68       instances. When creating the instance you can give the OS-name
  69       as an option.
  70     </para>
  71
  72     <cmdsynopsis>
  73       <command>diagnose</command>
  74     </cmdsynopsis>
  75
  76     <para>
  77       This command will help you see why an installed OS is not
  78       available in the cluster. The <command>list</command> command
  79       shows only the OS-es that the cluster sees available on all
  80       nodes. It could be that some OS is missing from a node, or is
  81       only partially installed, and this command will show the details
  82       of all the OSes and the reasons they are or are not valid.
  83     </para>
  84
  85     <cmdsynopsis>
  86       <command>info</command>
  87     </cmdsynopsis>
  88
  89     <para>
  90       This command will list detailed information about each OS
  91       available in the cluster, including its validity status, the
  92       supported API versions, the supported parameters (if any) and
  93       their documentations, etc.
  94     </para>
  95
  96     <cmdsynopsis>
  97       <command>modify</command>
  98       <arg>-H <replaceable>HYPERVISOR</replaceable><arg>:<arg choice="plain" rep="repeat">option=<replaceable>value</replaceable></arg></arg></arg>
  99       <arg choice="req"><replaceable>OS</replaceable></arg>
 100     </cmdsynopsis>
 101
 102     <para>
 103       This command will allow you to modify OS parameters. At the moment
 104       we just support per-os-hypervisor settings. You can run modify
 105       <option>-H</option> with the same syntax as in
 106       <command>gnt-cluster init</command> to override default hypervisor
 107       parameters of the cluster for specified
 108       <replaceable>OS</replaceable> argument.
 109     </para>
 110
 111     <para>
 112       Note: The <replaceable>OS</replaceable> doesn't have to exists.
 113       This allows preseeding the settings for
 114       <replaceable>OS</replaceable>es not yet known to
 115       <command>gnt-os</command>.
 116     </para>
 117
 118   </refsect1>
 119
 120   &footer;
 121
 122 </refentry>
 123
 124 <!-- Keep this comment at the end of the file
 125 Local variables:
 126 mode: sgml
 127 sgml-omittag:t
 128 sgml-shorttag:t
 129 sgml-minimize-attributes:nil
 130 sgml-always-quote-attributes:t
 131 sgml-indent-step:2
 132 sgml-indent-data:t
 133 sgml-parent-document:nil
 134 sgml-default-dtd-file:nil
 135 sgml-exposed-tags:nil
 136 sgml-local-catalogs:nil
 137 sgml-local-ecat-files:nil
 138 End:
 139 -->