Statistics
| Branch: | Tag: | Revision:

root / man / gnt-debug.sgml @ d04aaa2f

History | View | Annotate | Download (5.3 kB)

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