root / man / gnt-debug.sgml @ 7c60f7a2
History | View | Annotate | Download (6.3 kB)
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 |
</refsect2> |
111 |
|
112 |
<refsect2> |
113 |
<title>DELAY</title> |
114 |
|
115 |
<cmdsynopsis> |
116 |
<command>delay</command> |
117 |
<arg>--debug</arg> |
118 |
<arg>--no-master</arg> |
119 |
<arg choice="opt" rep="repeat">-n <replaceable>NODE</replaceable></arg> |
120 |
<arg choice="req"><replaceable>duration</replaceable></arg> |
121 |
</cmdsynopsis> |
122 |
|
123 |
<para> |
124 |
Run a test opcode (a sleep) on the master (internally in the |
125 |
command) and on selected nodes (via an RPC call). This server |
126 |
no other purpose but to execute a test operation. |
127 |
</para> |
128 |
|
129 |
<para> |
130 |
The <option>-n</option> option can be given multiple times to |
131 |
select the nodes for the RPC call. By default, the delay will |
132 |
also be executed on the master, unless the |
133 |
<option>--no-master</option> option is passed. |
134 |
</para> |
135 |
|
136 |
<para> |
137 |
The <replaceable>delay</replaceable> argument will be |
138 |
interpreted as a floating point number. |
139 |
</para> |
140 |
|
141 |
</refsect2> |
142 |
|
143 |
<refsect2> |
144 |
<title>SUBMIT-JOB</title> |
145 |
|
146 |
<cmdsynopsis> |
147 |
<command>submit-job</command> |
148 |
<arg choice="opt">--verbose</arg> |
149 |
<arg choice="opt">--timing-stats</arg> |
150 |
<arg choice="opt">--job-repeat <option>N</option></arg> |
151 |
<arg choice="opt">--op-repeat <option>N</option></arg> |
152 |
<arg choice="req" rep="repeat">opcodes_file</arg> |
153 |
</cmdsynopsis> |
154 |
|
155 |
<para> |
156 |
This command builds a list of opcodes from JSON-format files |
157 |
and submits for each file a job to the master daemon. It can |
158 |
be used to test some options that are not available via the |
159 |
command line. |
160 |
</para> |
161 |
|
162 |
<para> |
163 |
The <option>verbose</option> option will job the job IDs of |
164 |
the submitted jobs and the progress in waiting for the jobs; |
165 |
the <option>timing-stats</option> option will show some |
166 |
overall statistics with the number of total opcodes and jobs |
167 |
submitted, and time time for each stage (submit, exec, total). |
168 |
</para> |
169 |
|
170 |
<para> |
171 |
The <option>job-repeat</option> and <option>op-repeat</option> |
172 |
options allow to submit multiple copies of the passed |
173 |
arguments; the job repeat will cause N copies of each job |
174 |
(input file) to be submitted (equivalent to passing the |
175 |
arguments N times) while the op repeat will cause each job to |
176 |
contain multiple copies of the opcodes (equivalent to each |
177 |
file containing N copies of the opcodes). |
178 |
</para> |
179 |
|
180 |
</refsect2> |
181 |
|
182 |
</refsect1> |
183 |
|
184 |
&footer; |
185 |
|
186 |
</refentry> |
187 |
|
188 |
<!-- Keep this comment at the end of the file |
189 |
Local variables: |
190 |
mode: sgml |
191 |
sgml-omittag:t |
192 |
sgml-shorttag:t |
193 |
sgml-minimize-attributes:nil |
194 |
sgml-always-quote-attributes:t |
195 |
sgml-indent-step:2 |
196 |
sgml-indent-data:t |
197 |
sgml-parent-document:nil |
198 |
sgml-default-dtd-file:nil |
199 |
sgml-exposed-tags:nil |
200 |
sgml-local-catalogs:nil |
201 |
sgml-local-ecat-files:nil |
202 |
End: |
203 |
--> |