code.grnet.gr Git - ganeti-local/blob - man/gnt-debug.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>February 12, 2009</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-debug</refentrytitle>">
  10   <!ENTITY dhpackage   "gnt-debug">
  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       <holder>Google Inc.</holder>
  26     </copyright>
  27     &dhdate;
  28   </refentryinfo>
  29   <refmeta>
  30     &dhucpackage;
  31
  32     &dhsection;
  33     <refmiscinfo>ganeti 2.0</refmiscinfo>
  34   </refmeta>
  35   <refnamediv>
  36     <refname>&dhpackage;</refname>
  37
  38     <refpurpose>debug commands</refpurpose>
  39   </refnamediv>
  40   <refsynopsisdiv>
  41     <cmdsynopsis>
  42       <command>&dhpackage; </command>
  43
  44       <arg choice="req">command</arg>
  45       <arg>arguments...</arg>
  46     </cmdsynopsis>
  47   </refsynopsisdiv>
  48   <refsect1>
  49     <title>DESCRIPTION</title>
  50
  51     <para>
  52       The <command>&dhpackage;</command> is used for debugging the
  53       ganeti system.
  54     </para>
  55
  56   </refsect1>
  57   <refsect1>
  58     <title>COMMANDS</title>
  59
  60     <refsect2>
  61       <title>ALLOCATOR</title>
  62
  63       <cmdsynopsis>
  64         <command>allocator</command>
  65         <arg>--debug</arg>
  66         <arg>--dir <replaceable>DIRECTION</replaceable></arg>
  67         <arg choice="req">--algorithm <replaceable>ALLOCATOR</replaceable>
  68         </arg>
  69         <arg>--mode <replaceable>MODE</replaceable></arg>
  70         <arg>--mem <replaceable>MEMORY</replaceable></arg>
  71         <arg>--disks <replaceable>DISKS</replaceable></arg>
  72         <arg>--disk-template <replaceable>TEMPLATE</replaceable></arg>
  73         <arg>--nics <replaceable>NICS</replaceable></arg>
  74         <arg>--os-type <replaceable>OS</replaceable></arg>
  75         <arg>--vcpus <replaceable>VCPUS</replaceable></arg>
  76         <arg>--tags <replaceable>TAGS</replaceable></arg>
  77         <arg choice="req"><replaceable>instance</replaceable></arg>
  78       </cmdsynopsis>
  79
  80       <para>
  81         Executes a test run of the <emphasis>iallocator</emphasis> framework.
  82       </para>
  83
  84       <para>
  85         The command will build input for a given iallocator script
  86         (named with the <option>--algorithm</option> option), and
  87         either show this input data (if
  88         <replaceable>DIRECTION</replaceable> is
  89         <emphasis>in</emphasis>) or run the iallocator script and show
  90         its output (if <replaceable>DIRECTION</replaceable> is
  91         <emphasis>out</emphasis>).
  92       </para>
  93
  94       <para>
  95         If the <replaceable>MODE</replaceable> is
  96         <emphasis>allocate</emphasis>, then an instance definition is
  97         built from the other arguments and sent to the script,
  98         otherwise (<replaceable>MODE</replaceable> is
  99         <emphasis>relocate</emphasis>) an existing instance name must
 100         be passed as the first argument.
 101       </para>
 102
 103       <para>
 104         This build of ganeti will look for iallocator scripts in the
 105         following directories: <filename
 106         class="directory">@CUSTOM_IALLOCATOR_SEARCH_PATH@</filename>;
 107         for more details about this framework, see the HTML or PDF
 108         documentation.
 109       </para>
 110
 111     <refsect2>
 112       <title>DELAY</title>
 113
 114       <cmdsynopsis>
 115         <command>delay</command>
 116         <arg>--debug</arg>
 117         <arg>--no-master</arg>
 118         <arg choice="opt" rep="repeat">-n <replaceable>NODE</replaceable></arg>
 119         <arg choice="req"><replaceable>duration</replaceable></arg>
 120       </cmdsynopsis>
 121
 122       <para>
 123         Run a test opcode (a sleep) on the master (internally in the
 124         command) and on selected nodes (via an RPC call). This server
 125         no other purpose but to execute a test operation.
 126       </para>
 127
 128       <para>
 129         The <option>-n</option> option can be given multiple times to
 130         select the nodes for the RPC call. By default, the delay will
 131         also be executed on the master, unless the
 132         <option>--no-master</option> option is passed.
 133       </para>
 134
 135       <para>
 136         The <replaceable>delay</replaceable> argument will be
 137         interpreted as a floating point number.
 138       </para>
 139
 140     </refsect2>
 141
 142     <refsect2>
 143       <title>SUBMIT-JOB</title>
 144
 145       <cmdsynopsis>
 146         <command>submit-job</command>
 147
 148         <arg choice="req">opcodes_file</arg>
 149       </cmdsynopsis>
 150
 151       <para>
 152         This command builds a list of opcodes from a JSON-format file
 153         and submits them as a single job to the master daemon. It can
 154         be used to test some options that are not available via the
 155         command line.
 156       </para>
 157
 158     </refsect2>
 159
 160   </refsect1>
 161
 162   &footer;
 163
 164 </refentry>
 165
 166 <!-- Keep this comment at the end of the file
 167 Local variables:
 168 mode: sgml
 169 sgml-omittag:t
 170 sgml-shorttag:t
 171 sgml-minimize-attributes:nil
 172 sgml-always-quote-attributes:t
 173 sgml-indent-step:2
 174 sgml-indent-data:t
 175 sgml-parent-document:nil
 176 sgml-default-dtd-file:nil
 177 sgml-exposed-tags:nil
 178 sgml-local-catalogs:nil
 179 sgml-local-ecat-files:nil
 180 End:
 181 -->