root / man / gnt-instance.sgml @ 017778ac
History | View | Annotate | Download (21.4 kB)
1 | a8083063 | Iustin Pop | <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ |
---|---|---|---|
2 | a8083063 | Iustin Pop | |
3 | a8083063 | Iustin Pop | <!-- Fill in your name for FIRSTNAME and SURNAME. --> |
4 | a8083063 | Iustin Pop | <!-- Please adjust the date whenever revising the manpage. --> |
5 | a8083063 | Iustin Pop | <!ENTITY dhdate "<date>May 16, 2007</date>"> |
6 | a8083063 | Iustin Pop | <!-- SECTION should be 1-8, maybe w/ subsection other parameters are |
7 | a8083063 | Iustin Pop | allowed: see man(7), man(1). --> |
8 | a8083063 | Iustin Pop | <!ENTITY dhsection "<manvolnum>8</manvolnum>"> |
9 | a8083063 | Iustin Pop | <!ENTITY dhucpackage "<refentrytitle>gnt-instance</refentrytitle>"> |
10 | a8083063 | Iustin Pop | <!ENTITY dhpackage "gnt-instance"> |
11 | a8083063 | Iustin Pop | |
12 | a8083063 | Iustin Pop | <!ENTITY debian "<productname>Debian</productname>"> |
13 | a8083063 | Iustin Pop | <!ENTITY gnu "<acronym>GNU</acronym>"> |
14 | a8083063 | Iustin Pop | <!ENTITY gpl "&gnu; <acronym>GPL</acronym>"> |
15 | a8083063 | Iustin Pop | <!ENTITY footer SYSTEM "footer.sgml"> |
16 | a8083063 | Iustin Pop | ]> |
17 | a8083063 | Iustin Pop | |
18 | a8083063 | Iustin Pop | <refentry> |
19 | a8083063 | Iustin Pop | <refentryinfo> |
20 | a8083063 | Iustin Pop | <copyright> |
21 | a8083063 | Iustin Pop | <year>2006</year> |
22 | a8083063 | Iustin Pop | <year>2007</year> |
23 | a8083063 | Iustin Pop | <holder>Google Inc.</holder> |
24 | a8083063 | Iustin Pop | </copyright> |
25 | a8083063 | Iustin Pop | &dhdate; |
26 | a8083063 | Iustin Pop | </refentryinfo> |
27 | a8083063 | Iustin Pop | <refmeta> |
28 | a8083063 | Iustin Pop | &dhucpackage; |
29 | a8083063 | Iustin Pop | |
30 | a8083063 | Iustin Pop | &dhsection; |
31 | a8083063 | Iustin Pop | <refmiscinfo>ganeti 1.2</refmiscinfo> |
32 | a8083063 | Iustin Pop | </refmeta> |
33 | a8083063 | Iustin Pop | <refnamediv> |
34 | a8083063 | Iustin Pop | <refname>&dhpackage;</refname> |
35 | a8083063 | Iustin Pop | |
36 | a8083063 | Iustin Pop | <refpurpose>ganeti instance administration</refpurpose> |
37 | a8083063 | Iustin Pop | </refnamediv> |
38 | a8083063 | Iustin Pop | <refsynopsisdiv> |
39 | a8083063 | Iustin Pop | <cmdsynopsis> |
40 | a8083063 | Iustin Pop | <command>&dhpackage; </command> |
41 | a8083063 | Iustin Pop | |
42 | a8083063 | Iustin Pop | <arg choice="req">command</arg> |
43 | a8083063 | Iustin Pop | <arg>arguments...</arg> |
44 | a8083063 | Iustin Pop | </cmdsynopsis> |
45 | a8083063 | Iustin Pop | </refsynopsisdiv> |
46 | a8083063 | Iustin Pop | <refsect1> |
47 | a8083063 | Iustin Pop | <title>DESCRIPTION</title> |
48 | a8083063 | Iustin Pop | |
49 | a8083063 | Iustin Pop | <para> |
50 | a8083063 | Iustin Pop | The <command>&dhpackage;</command> is used for instance |
51 | a8083063 | Iustin Pop | administration in the ganeti system. |
52 | a8083063 | Iustin Pop | </para> |
53 | a8083063 | Iustin Pop | |
54 | a8083063 | Iustin Pop | </refsect1> |
55 | a8083063 | Iustin Pop | <refsect1> |
56 | a8083063 | Iustin Pop | <title>COMMANDS</title> |
57 | a8083063 | Iustin Pop | |
58 | a8083063 | Iustin Pop | <refsect2> |
59 | a8083063 | Iustin Pop | <title>Creation/removal/querying</title> |
60 | a8083063 | Iustin Pop | |
61 | a8083063 | Iustin Pop | <refsect3> |
62 | a8083063 | Iustin Pop | <title>ADD</title> |
63 | a8083063 | Iustin Pop | <cmdsynopsis> |
64 | a8083063 | Iustin Pop | <command>add</command> |
65 | a8083063 | Iustin Pop | <arg>-s <replaceable>disksize</replaceable></arg> |
66 | b9ac33e9 | Iustin Pop | <arg>--swap-size <replaceable>disksize</replaceable></arg> |
67 | a8083063 | Iustin Pop | <arg>-m <replaceable>memsize</replaceable></arg> |
68 | b9ac33e9 | Iustin Pop | <sbr> |
69 | b9ac33e9 | Iustin Pop | <arg>-o <replaceable>os-type</replaceable></arg> |
70 | a8083063 | Iustin Pop | <arg>-b <replaceable>bridge</replaceable></arg> |
71 | a8083063 | Iustin Pop | <sbr> |
72 | a8083063 | Iustin Pop | <arg choice="req">-t<group> |
73 | a8083063 | Iustin Pop | <arg>diskless</arg> |
74 | a8083063 | Iustin Pop | <arg>plain</arg> |
75 | a8083063 | Iustin Pop | <arg>local_raid1</arg> |
76 | a8083063 | Iustin Pop | <arg>remote_raid1</arg> |
77 | a8083063 | Iustin Pop | </group> |
78 | a8083063 | Iustin Pop | </arg> |
79 | b9ac33e9 | Iustin Pop | <sbr> |
80 | b9ac33e9 | Iustin Pop | <arg choice="req">-n <replaceable>node</replaceable></arg> |
81 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
82 | a8083063 | Iustin Pop | </cmdsynopsis> |
83 | a8083063 | Iustin Pop | <para> |
84 | a8083063 | Iustin Pop | Creates a new instance on the specified |
85 | a8083063 | Iustin Pop | host. <replaceable>instance</replaceable> must be in DNS and |
86 | a8083063 | Iustin Pop | resolve to a IP in the same network as the nodes in the |
87 | a8083063 | Iustin Pop | cluster. |
88 | a8083063 | Iustin Pop | </para> |
89 | a8083063 | Iustin Pop | |
90 | a8083063 | Iustin Pop | <para> |
91 | a8083063 | Iustin Pop | The <option>-s</option> option specifies the disk size for |
92 | b9ac33e9 | Iustin Pop | the instance, in mebibytes (defaults to |
93 | b9ac33e9 | Iustin Pop | <constant>20480MiB</constant> = |
94 | b9ac33e9 | Iustin Pop | <constant>20GiB</constant>). You can also use one of the |
95 | b9ac33e9 | Iustin Pop | suffixes <literal>m</literal>, <literal>g</literal> or |
96 | b9ac33e9 | Iustin Pop | <literal>t</literal> to specificy the exact the units used; |
97 | b9ac33e9 | Iustin Pop | these suffixes map to mebibytes, gibibytes and tebibytes. |
98 | a8083063 | Iustin Pop | </para> |
99 | a8083063 | Iustin Pop | |
100 | a8083063 | Iustin Pop | <para> |
101 | b9ac33e9 | Iustin Pop | The <option>--swap-size</option> option specifies the swap |
102 | b9ac33e9 | Iustin Pop | disk size (in mebibytes) for the instance (the one presented |
103 | b9ac33e9 | Iustin Pop | as <filename class="devicefile">/dev/sdb</filename>). The |
104 | b9ac33e9 | Iustin Pop | default is <constant>4096MiB</constant>. As for the disk |
105 | b9ac33e9 | Iustin Pop | size, you can specify other suffixes. |
106 | a8083063 | Iustin Pop | </para> |
107 | a8083063 | Iustin Pop | |
108 | a8083063 | Iustin Pop | <para> |
109 | a8083063 | Iustin Pop | The <option>-m</option> option specifies the memory size for |
110 | b9ac33e9 | Iustin Pop | the instance, in mebibytes (defaults to 128 MiB). Again, you |
111 | b9ac33e9 | Iustin Pop | can use other suffixes (e.g. <userinput>2g</userinput>). |
112 | b9ac33e9 | Iustin Pop | </para> |
113 | b9ac33e9 | Iustin Pop | |
114 | b9ac33e9 | Iustin Pop | <para> |
115 | b9ac33e9 | Iustin Pop | The <option>-o</option> options specifies the operating |
116 | b9ac33e9 | Iustin Pop | system to be installed. The available operating systems can |
117 | b9ac33e9 | Iustin Pop | be listed with <command>gnt-os list</command>. |
118 | a8083063 | Iustin Pop | </para> |
119 | a8083063 | Iustin Pop | |
120 | a8083063 | Iustin Pop | <para> |
121 | a8083063 | Iustin Pop | The <option>-b</option> option specifies the bridge to which the |
122 | a8083063 | Iustin Pop | instance will be connected. (defaults to the cluster-wide default |
123 | 7e84d392 | Michael Hanselmann | bridge specified at cluster initialization time). |
124 | a8083063 | Iustin Pop | </para> |
125 | a8083063 | Iustin Pop | |
126 | a8083063 | Iustin Pop | <para> |
127 | a8083063 | Iustin Pop | The <option>-t</option> options specifies the disk layout type for |
128 | a8083063 | Iustin Pop | the instance. The available choices are: |
129 | a8083063 | Iustin Pop | <variablelist> |
130 | a8083063 | Iustin Pop | <varlistentry> |
131 | a8083063 | Iustin Pop | <term>diskless</term> |
132 | a8083063 | Iustin Pop | <listitem> |
133 | a8083063 | Iustin Pop | <para> |
134 | a8083063 | Iustin Pop | This creates an instance with no disks. Its useful for |
135 | a8083063 | Iustin Pop | testing only (or other special cases). |
136 | a8083063 | Iustin Pop | </para> |
137 | a8083063 | Iustin Pop | </listitem> |
138 | a8083063 | Iustin Pop | </varlistentry> |
139 | a8083063 | Iustin Pop | <varlistentry> |
140 | a8083063 | Iustin Pop | <term>plain</term> |
141 | a8083063 | Iustin Pop | <listitem> |
142 | a8083063 | Iustin Pop | <para>Disk devices will be logical volumes.</para> |
143 | a8083063 | Iustin Pop | </listitem> |
144 | a8083063 | Iustin Pop | </varlistentry> |
145 | a8083063 | Iustin Pop | <varlistentry> |
146 | a8083063 | Iustin Pop | <term>local_raid1</term> |
147 | a8083063 | Iustin Pop | <listitem> |
148 | a8083063 | Iustin Pop | <para> |
149 | a8083063 | Iustin Pop | Disk devices will be md raid1 arrays over two local |
150 | a8083063 | Iustin Pop | logical volumes. |
151 | a8083063 | Iustin Pop | </para> |
152 | a8083063 | Iustin Pop | </listitem> |
153 | a8083063 | Iustin Pop | </varlistentry> |
154 | a8083063 | Iustin Pop | <varlistentry> |
155 | a8083063 | Iustin Pop | <term>remote_raid1</term> |
156 | a8083063 | Iustin Pop | <listitem> |
157 | a8083063 | Iustin Pop | <para> |
158 | a8083063 | Iustin Pop | Disk devices will be md raid1 arrays with one |
159 | a8083063 | Iustin Pop | component (so it's not actually raid1): a drbd device |
160 | a8083063 | Iustin Pop | between the instance's primary node and the node given |
161 | a8083063 | Iustin Pop | by the option <option>--secondary-node</option>. |
162 | a8083063 | Iustin Pop | </para> |
163 | a8083063 | Iustin Pop | </listitem> |
164 | a8083063 | Iustin Pop | </varlistentry> |
165 | a8083063 | Iustin Pop | </variablelist> |
166 | a8083063 | Iustin Pop | </para> |
167 | a8083063 | Iustin Pop | |
168 | a8083063 | Iustin Pop | <para> |
169 | a8083063 | Iustin Pop | The <option>--secondary-node</option> option is used with |
170 | a8083063 | Iustin Pop | the remote raid disk template type and specifies the remote |
171 | a8083063 | Iustin Pop | node. |
172 | a8083063 | Iustin Pop | </para> |
173 | a8083063 | Iustin Pop | |
174 | a8083063 | Iustin Pop | <para> |
175 | a8083063 | Iustin Pop | If you do not want gnt-instance to wait for the disk mirror |
176 | a8083063 | Iustin Pop | to be synced, use the <option>--no-wait-for-sync</option> |
177 | a8083063 | Iustin Pop | option. |
178 | a8083063 | Iustin Pop | </para> |
179 | a8083063 | Iustin Pop | |
180 | a8083063 | Iustin Pop | |
181 | a8083063 | Iustin Pop | <para> |
182 | a8083063 | Iustin Pop | Example: |
183 | a8083063 | Iustin Pop | <screen> |
184 | b9ac33e9 | Iustin Pop | # gnt-instance add -t plain -s 30g -m 512 -o debian-etch \ |
185 | b9ac33e9 | Iustin Pop | -n node1.example.com instance1.example.com |
186 | a8083063 | Iustin Pop | # gnt-instance add -t remote_raid1 --secondary-node node3.example.com \ |
187 | b9ac33e9 | Iustin Pop | -s 30g -m 512 -o debian-etch \ |
188 | b9ac33e9 | Iustin Pop | -n node1.example.com instance2.example.com |
189 | a8083063 | Iustin Pop | </screen> |
190 | a8083063 | Iustin Pop | </para> |
191 | a8083063 | Iustin Pop | |
192 | a8083063 | Iustin Pop | </refsect3> |
193 | a8083063 | Iustin Pop | |
194 | a8083063 | Iustin Pop | <refsect3> |
195 | a8083063 | Iustin Pop | <title>REMOVE</title> |
196 | a8083063 | Iustin Pop | |
197 | a8083063 | Iustin Pop | <cmdsynopsis> |
198 | a8083063 | Iustin Pop | <command>remove</command> |
199 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
200 | a8083063 | Iustin Pop | </cmdsynopsis> |
201 | a8083063 | Iustin Pop | |
202 | a8083063 | Iustin Pop | <para> |
203 | a8083063 | Iustin Pop | Remove an instance. This will remove all data from the |
204 | a8083063 | Iustin Pop | instance and there is <emphasis>no way back</emphasis>. If |
205 | a8083063 | Iustin Pop | you are not sure if you use an instance again, use |
206 | a8083063 | Iustin Pop | <command>shutdown</command> first and leave it in the |
207 | a8083063 | Iustin Pop | shutdown state for a while. |
208 | a8083063 | Iustin Pop | </para> |
209 | a8083063 | Iustin Pop | |
210 | a8083063 | Iustin Pop | <para> |
211 | a8083063 | Iustin Pop | Example: |
212 | a8083063 | Iustin Pop | <screen> |
213 | a8083063 | Iustin Pop | # gnt-instance remove instance1.example.com |
214 | a8083063 | Iustin Pop | </screen> |
215 | a8083063 | Iustin Pop | </para> |
216 | a8083063 | Iustin Pop | </refsect3> |
217 | a8083063 | Iustin Pop | |
218 | a8083063 | Iustin Pop | <refsect3> |
219 | a8083063 | Iustin Pop | <title>LIST</title> |
220 | a8083063 | Iustin Pop | |
221 | a8083063 | Iustin Pop | <cmdsynopsis> |
222 | a8083063 | Iustin Pop | <command>list</command> |
223 | a8083063 | Iustin Pop | <arg>--no-headers</arg> |
224 | a8083063 | Iustin Pop | <arg>--separator=<replaceable>SEPARATOR</replaceable></arg> |
225 | a8083063 | Iustin Pop | <arg>-o <replaceable>FIELD,...</replaceable></arg> |
226 | a8083063 | Iustin Pop | </cmdsynopsis> |
227 | a8083063 | Iustin Pop | |
228 | a8083063 | Iustin Pop | <para> |
229 | a8083063 | Iustin Pop | Shows the currently configured instances with memory usage, |
230 | a8083063 | Iustin Pop | disk usage, the node they are running on, and the CPU time, |
231 | a8083063 | Iustin Pop | counted in seconds, used by each instance since its latest |
232 | a8083063 | Iustin Pop | restart. |
233 | a8083063 | Iustin Pop | </para> |
234 | a8083063 | Iustin Pop | |
235 | a8083063 | Iustin Pop | <para> |
236 | a8083063 | Iustin Pop | The <option>--no-headers</option> option will skip the |
237 | a8083063 | Iustin Pop | initial header line. The <option>--separator</option> option |
238 | a8083063 | Iustin Pop | takes an argument which denotes what will be used between |
239 | a8083063 | Iustin Pop | the output fields. Both these options are to help scripting. |
240 | a8083063 | Iustin Pop | </para> |
241 | a8083063 | Iustin Pop | |
242 | a8083063 | Iustin Pop | <para> |
243 | a8083063 | Iustin Pop | The <option>-o</option> option takes a comma-separated list |
244 | a8083063 | Iustin Pop | of output fields. The available fields and their meaning |
245 | a8083063 | Iustin Pop | are: |
246 | a8083063 | Iustin Pop | <variablelist> |
247 | a8083063 | Iustin Pop | <varlistentry> |
248 | a8083063 | Iustin Pop | <term>name</term> |
249 | a8083063 | Iustin Pop | <listitem> |
250 | a8083063 | Iustin Pop | <simpara>the instance name</simpara> |
251 | a8083063 | Iustin Pop | </listitem> |
252 | a8083063 | Iustin Pop | </varlistentry> |
253 | a8083063 | Iustin Pop | <varlistentry> |
254 | a8083063 | Iustin Pop | <term>os</term> |
255 | a8083063 | Iustin Pop | <listitem> |
256 | a8083063 | Iustin Pop | <simpara>the OS of the instance</simpara> |
257 | a8083063 | Iustin Pop | </listitem> |
258 | a8083063 | Iustin Pop | </varlistentry> |
259 | a8083063 | Iustin Pop | <varlistentry> |
260 | a8083063 | Iustin Pop | <term>pnode</term> |
261 | a8083063 | Iustin Pop | <listitem> |
262 | a8083063 | Iustin Pop | <simpara>the primary node of the instance</simpara> |
263 | a8083063 | Iustin Pop | </listitem> |
264 | a8083063 | Iustin Pop | </varlistentry> |
265 | a8083063 | Iustin Pop | <varlistentry> |
266 | a8083063 | Iustin Pop | <term>snodes</term> |
267 | a8083063 | Iustin Pop | <listitem> |
268 | a8083063 | Iustin Pop | <simpara>comma-separated list of secondary-nodes for the |
269 | a8083063 | Iustin Pop | instance; usually this will be just one node</simpara> |
270 | a8083063 | Iustin Pop | </listitem> |
271 | a8083063 | Iustin Pop | </varlistentry> |
272 | a8083063 | Iustin Pop | <varlistentry> |
273 | a8083063 | Iustin Pop | <term>admin_state</term> |
274 | a8083063 | Iustin Pop | <listitem> |
275 | a8083063 | Iustin Pop | <simpara>the desired state of the instance (either "yes" |
276 | a8083063 | Iustin Pop | or "no" denoting the instance should run or |
277 | a8083063 | Iustin Pop | not)</simpara> |
278 | a8083063 | Iustin Pop | </listitem> |
279 | a8083063 | Iustin Pop | </varlistentry> |
280 | a8083063 | Iustin Pop | <varlistentry> |
281 | a8083063 | Iustin Pop | <term>admin_ram</term> |
282 | a8083063 | Iustin Pop | <listitem> |
283 | a8083063 | Iustin Pop | <simpara>the desired memory for the instance</simpara> |
284 | a8083063 | Iustin Pop | </listitem> |
285 | a8083063 | Iustin Pop | </varlistentry> |
286 | a8083063 | Iustin Pop | <varlistentry> |
287 | a8083063 | Iustin Pop | <term>disk_template</term> |
288 | a8083063 | Iustin Pop | <listitem> |
289 | a8083063 | Iustin Pop | <simpara>the disk template of the instance</simpara> |
290 | a8083063 | Iustin Pop | </listitem> |
291 | a8083063 | Iustin Pop | </varlistentry> |
292 | a8083063 | Iustin Pop | <varlistentry> |
293 | a8083063 | Iustin Pop | <term>oper_state</term> |
294 | a8083063 | Iustin Pop | <listitem> |
295 | a8083063 | Iustin Pop | <simpara>the actual state of the instance; can take of |
296 | a8083063 | Iustin Pop | the values "running", "stopped", "(node down)"</simpara> |
297 | a8083063 | Iustin Pop | </listitem> |
298 | a8083063 | Iustin Pop | </varlistentry> |
299 | a8083063 | Iustin Pop | <varlistentry> |
300 | a8083063 | Iustin Pop | <term>oper_ram</term> |
301 | a8083063 | Iustin Pop | <listitem> |
302 | a8083063 | Iustin Pop | <simpara>the actual memory usage of the instance as seen |
303 | a8083063 | Iustin Pop | by the hypervisor</simpara> |
304 | a8083063 | Iustin Pop | </listitem> |
305 | a8083063 | Iustin Pop | </varlistentry> |
306 | a8083063 | Iustin Pop | <varlistentry> |
307 | a8083063 | Iustin Pop | <term>ip</term> |
308 | a8083063 | Iustin Pop | <listitem> |
309 | a8083063 | Iustin Pop | <simpara>the ip address ganeti recognizes as associated with |
310 | a8083063 | Iustin Pop | the instance interface</simpara> |
311 | a8083063 | Iustin Pop | </listitem> |
312 | a8083063 | Iustin Pop | </varlistentry> |
313 | a8083063 | Iustin Pop | <varlistentry> |
314 | a8083063 | Iustin Pop | <term>mac</term> |
315 | a8083063 | Iustin Pop | <listitem> |
316 | a8083063 | Iustin Pop | <simpara>the instance interface MAC address</simpara> |
317 | a8083063 | Iustin Pop | </listitem> |
318 | a8083063 | Iustin Pop | </varlistentry> |
319 | a8083063 | Iustin Pop | <varlistentry> |
320 | a8083063 | Iustin Pop | <term>bridge</term> |
321 | a8083063 | Iustin Pop | <listitem> |
322 | a8083063 | Iustin Pop | <simpara>bridge the instance is connected to |
323 | a8083063 | Iustin Pop | </simpara> |
324 | a8083063 | Iustin Pop | </listitem> |
325 | a8083063 | Iustin Pop | </varlistentry> |
326 | a8083063 | Iustin Pop | </variablelist> |
327 | a8083063 | Iustin Pop | </para> |
328 | a8083063 | Iustin Pop | |
329 | a8083063 | Iustin Pop | <para> |
330 | a8083063 | Iustin Pop | There is a subtle grouping about the available output |
331 | a8083063 | Iustin Pop | fields: all fields except for <option>oper_state</option> |
332 | a8083063 | Iustin Pop | and <option>oper_ram</option> are configuration value and |
333 | a8083063 | Iustin Pop | not run-time values. So if you don't select any of the |
334 | a8083063 | Iustin Pop | <option>oper_*</option> fields, the query will be satisfied |
335 | a8083063 | Iustin Pop | instantly from the cluster configuration, without having to |
336 | a8083063 | Iustin Pop | ask the remote nodes for the data. This can be helpful for |
337 | a8083063 | Iustin Pop | big clusters when you only want some data and it makes sense |
338 | a8083063 | Iustin Pop | to specify a reduced set of output fields. |
339 | a8083063 | Iustin Pop | </para> |
340 | a8083063 | Iustin Pop | |
341 | a8083063 | Iustin Pop | <para>The default output field list is: |
342 | a8083063 | Iustin Pop | <simplelist type="inline"> |
343 | a8083063 | Iustin Pop | <member>name</member> |
344 | a8083063 | Iustin Pop | <member>os</member> |
345 | a8083063 | Iustin Pop | <member>pnode</member> |
346 | a8083063 | Iustin Pop | <member>admin_state</member> |
347 | a8083063 | Iustin Pop | <member>oper_state</member> |
348 | a8083063 | Iustin Pop | <member>oper_ram</member> |
349 | a8083063 | Iustin Pop | </simplelist>. |
350 | a8083063 | Iustin Pop | </para> |
351 | a8083063 | Iustin Pop | </refsect3> |
352 | a8083063 | Iustin Pop | |
353 | a8083063 | Iustin Pop | <refsect3> |
354 | a8083063 | Iustin Pop | <title>INFO</title> |
355 | a8083063 | Iustin Pop | |
356 | a8083063 | Iustin Pop | <cmdsynopsis> |
357 | a8083063 | Iustin Pop | <command>info</command> |
358 | a8083063 | Iustin Pop | <arg rep="repeat"><replaceable>instance</replaceable></arg> |
359 | a8083063 | Iustin Pop | </cmdsynopsis> |
360 | a8083063 | Iustin Pop | |
361 | a8083063 | Iustin Pop | <para> |
362 | a8083063 | Iustin Pop | Show detailed information about the (given) instances. This |
363 | a8083063 | Iustin Pop | is different from <command>list</command> as it shows |
364 | a8083063 | Iustin Pop | detailed data about the instance's disks (especially useful |
365 | a8083063 | Iustin Pop | for remote raid templates). |
366 | a8083063 | Iustin Pop | </para> |
367 | a8083063 | Iustin Pop | </refsect3> |
368 | a8083063 | Iustin Pop | |
369 | a8083063 | Iustin Pop | <refsect3> |
370 | a8083063 | Iustin Pop | <title>MODIFY</title> |
371 | a8083063 | Iustin Pop | |
372 | a8083063 | Iustin Pop | <cmdsynopsis> |
373 | a8083063 | Iustin Pop | <command>modify</command> |
374 | a8083063 | Iustin Pop | <arg choice="opt">-m <replaceable>memsize</replaceable></arg> |
375 | a8083063 | Iustin Pop | <arg choice="opt">-p <replaceable>vcpus</replaceable></arg> |
376 | a8083063 | Iustin Pop | <arg choice="opt">-i <replaceable>ip</replaceable></arg> |
377 | a8083063 | Iustin Pop | <arg choice="opt">-b <replaceable>bridge</replaceable></arg> |
378 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
379 | a8083063 | Iustin Pop | </cmdsynopsis> |
380 | a8083063 | Iustin Pop | |
381 | a8083063 | Iustin Pop | <para> |
382 | a8083063 | Iustin Pop | Modify the memory size, number of vcpus, ip address and/or bridge |
383 | a8083063 | Iustin Pop | for an instance. |
384 | a8083063 | Iustin Pop | </para> |
385 | a8083063 | Iustin Pop | |
386 | a8083063 | Iustin Pop | <para> |
387 | a8083063 | Iustin Pop | The memory size is given in MiB. Note that you need to give |
388 | a8083063 | Iustin Pop | at least one of the arguments, otherwise the command |
389 | a8083063 | Iustin Pop | complains. |
390 | a8083063 | Iustin Pop | </para> |
391 | a8083063 | Iustin Pop | |
392 | a8083063 | Iustin Pop | <para> |
393 | a8083063 | Iustin Pop | All the changes take effect at the next restart. If the |
394 | a8083063 | Iustin Pop | instance is running, there is no effect on the instance. |
395 | a8083063 | Iustin Pop | </para> |
396 | a8083063 | Iustin Pop | </refsect3> |
397 | a8083063 | Iustin Pop | |
398 | d0834de3 | Michael Hanselmann | <refsect3> |
399 | d0834de3 | Michael Hanselmann | <title>REINSTALL</title> |
400 | d0834de3 | Michael Hanselmann | |
401 | d0834de3 | Michael Hanselmann | <cmdsynopsis> |
402 | d0834de3 | Michael Hanselmann | <command>reinstall</command> |
403 | d0834de3 | Michael Hanselmann | <arg choice="opt">-o <replaceable>os-type</replaceable></arg> |
404 | d0834de3 | Michael Hanselmann | <arg choice="opt">-f <replaceable>force</replaceable></arg> |
405 | d0834de3 | Michael Hanselmann | <arg choice="req"><replaceable>instance</replaceable></arg> |
406 | d0834de3 | Michael Hanselmann | </cmdsynopsis> |
407 | d0834de3 | Michael Hanselmann | |
408 | d0834de3 | Michael Hanselmann | <para> |
409 | d0834de3 | Michael Hanselmann | Reinstalls the operating system on the given instance. The instance |
410 | d0834de3 | Michael Hanselmann | must be stopped when running this command. If the |
411 | d0834de3 | Michael Hanselmann | <option>--os-type</option> is specified, the operating system is |
412 | d0834de3 | Michael Hanselmann | changed. |
413 | d0834de3 | Michael Hanselmann | </para> |
414 | d0834de3 | Michael Hanselmann | </refsect3> |
415 | d0834de3 | Michael Hanselmann | |
416 | a8083063 | Iustin Pop | </refsect2> |
417 | a8083063 | Iustin Pop | |
418 | a8083063 | Iustin Pop | <refsect2> |
419 | a8083063 | Iustin Pop | <title>Starting/stopping/connecting to console</title> |
420 | a8083063 | Iustin Pop | |
421 | a8083063 | Iustin Pop | <refsect3> |
422 | a8083063 | Iustin Pop | <title>STARTUP</title> |
423 | a8083063 | Iustin Pop | |
424 | a8083063 | Iustin Pop | <cmdsynopsis> |
425 | a8083063 | Iustin Pop | <command>startup</command> |
426 | a8083063 | Iustin Pop | <arg>--extra=<replaceable>PARAMS</replaceable></arg> |
427 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
428 | a8083063 | Iustin Pop | </cmdsynopsis> |
429 | a8083063 | Iustin Pop | |
430 | a8083063 | Iustin Pop | <para> |
431 | a8083063 | Iustin Pop | Starts an instance. The node where to start the instance is |
432 | a8083063 | Iustin Pop | taken from the configuration. |
433 | a8083063 | Iustin Pop | </para> |
434 | a8083063 | Iustin Pop | |
435 | a8083063 | Iustin Pop | <para> |
436 | a8083063 | Iustin Pop | The <option>--extra</option> option is used to pass |
437 | a8083063 | Iustin Pop | additional argument to the instance's kernel for this start |
438 | a8083063 | Iustin Pop | only. Currently there is no way to specify a persistent set |
439 | a8083063 | Iustin Pop | of arguments (beside the one hardcoded). Note that this may |
440 | a8083063 | Iustin Pop | not apply to all virtualization types. |
441 | a8083063 | Iustin Pop | </para> |
442 | a8083063 | Iustin Pop | |
443 | a8083063 | Iustin Pop | |
444 | a8083063 | Iustin Pop | <para> |
445 | a8083063 | Iustin Pop | Example: |
446 | a8083063 | Iustin Pop | <screen> |
447 | a8083063 | Iustin Pop | # gnt-instance start instance1.example.com |
448 | a8083063 | Iustin Pop | # gnt-instance start --extra single test1.example.com |
449 | a8083063 | Iustin Pop | </screen> |
450 | a8083063 | Iustin Pop | </para> |
451 | a8083063 | Iustin Pop | </refsect3> |
452 | a8083063 | Iustin Pop | |
453 | a8083063 | Iustin Pop | <refsect3> |
454 | a8083063 | Iustin Pop | <title>SHUTDOWN</title> |
455 | a8083063 | Iustin Pop | |
456 | a8083063 | Iustin Pop | <cmdsynopsis> |
457 | a8083063 | Iustin Pop | <command>shutdown</command> |
458 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
459 | a8083063 | Iustin Pop | </cmdsynopsis> |
460 | a8083063 | Iustin Pop | |
461 | a8083063 | Iustin Pop | <para> |
462 | a8083063 | Iustin Pop | Stops the instance. If the instance cannot be cleanly |
463 | a8083063 | Iustin Pop | stopped during a hardcoded interval (currently 2 minutes), |
464 | a8083063 | Iustin Pop | it will forcibly stop the instance (equivalent to switching |
465 | a8083063 | Iustin Pop | off the power on a physical machine). |
466 | a8083063 | Iustin Pop | </para> |
467 | a8083063 | Iustin Pop | |
468 | a8083063 | Iustin Pop | <para> |
469 | a8083063 | Iustin Pop | Example: |
470 | a8083063 | Iustin Pop | <screen> |
471 | a8083063 | Iustin Pop | # gnt-instance shutdown instance1.example.com |
472 | a8083063 | Iustin Pop | </screen> |
473 | a8083063 | Iustin Pop | </para> |
474 | a8083063 | Iustin Pop | </refsect3> |
475 | a8083063 | Iustin Pop | |
476 | a8083063 | Iustin Pop | <refsect3> |
477 | a8083063 | Iustin Pop | <title>CONSOLE</title> |
478 | a8083063 | Iustin Pop | <cmdsynopsis> |
479 | a8083063 | Iustin Pop | <command>console</command> |
480 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
481 | a8083063 | Iustin Pop | </cmdsynopsis> |
482 | a8083063 | Iustin Pop | |
483 | a8083063 | Iustin Pop | <para> |
484 | a8083063 | Iustin Pop | Connects to the console of the given instance. If the instance |
485 | a8083063 | Iustin Pop | is not up, an error is returned. |
486 | a8083063 | Iustin Pop | </para> |
487 | a8083063 | Iustin Pop | |
488 | a8083063 | Iustin Pop | <para> |
489 | a8083063 | Iustin Pop | Example: |
490 | a8083063 | Iustin Pop | <screen> |
491 | a8083063 | Iustin Pop | # gnt-instance console instance1.example.com |
492 | a8083063 | Iustin Pop | </screen> |
493 | a8083063 | Iustin Pop | </para> |
494 | a8083063 | Iustin Pop | </refsect3> |
495 | a8083063 | Iustin Pop | |
496 | a8083063 | Iustin Pop | </refsect2> |
497 | a8083063 | Iustin Pop | |
498 | a8083063 | Iustin Pop | <refsect2> |
499 | a8083063 | Iustin Pop | <title>Disk management</title> |
500 | a8083063 | Iustin Pop | |
501 | a8083063 | Iustin Pop | <refsect3> |
502 | a8083063 | Iustin Pop | <title>REPLACE-DISKS</title> |
503 | a8083063 | Iustin Pop | |
504 | a8083063 | Iustin Pop | <cmdsynopsis> |
505 | a8083063 | Iustin Pop | <command>replace-disks</command> |
506 | a8083063 | Iustin Pop | <arg choice="req">--new-secondary <replaceable>NODE</replaceable></arg> |
507 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
508 | a8083063 | Iustin Pop | </cmdsynopsis> |
509 | a8083063 | Iustin Pop | |
510 | a8083063 | Iustin Pop | <para> |
511 | a8083063 | Iustin Pop | This command does a full add and replace for both disks of |
512 | a8083063 | Iustin Pop | an instance. It basically does an |
513 | a8083063 | Iustin Pop | <command>addmirror</command> and |
514 | a8083063 | Iustin Pop | <command>removemirror</command> for both disks of the |
515 | a8083063 | Iustin Pop | instance. |
516 | a8083063 | Iustin Pop | </para> |
517 | a8083063 | Iustin Pop | |
518 | a8083063 | Iustin Pop | <para> |
519 | a8083063 | Iustin Pop | If you also want to replace the secondary node during this |
520 | a8083063 | Iustin Pop | process (for example to fix a broken secondary node), you |
521 | a8083063 | Iustin Pop | can do so using the <option>--new-secondary</option> option. |
522 | a8083063 | Iustin Pop | </para> |
523 | a8083063 | Iustin Pop | </refsect3> |
524 | a8083063 | Iustin Pop | |
525 | a8083063 | Iustin Pop | <refsect3> |
526 | a8083063 | Iustin Pop | <title>ADD-MIRROR</title> |
527 | a8083063 | Iustin Pop | <cmdsynopsis> |
528 | a8083063 | Iustin Pop | <command>add-mirror</command> |
529 | a8083063 | Iustin Pop | <arg choice="req">-b <replaceable>sdX</replaceable></arg> |
530 | a8083063 | Iustin Pop | <arg choice="req">-n <replaceable>node</replaceable></arg> |
531 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
532 | a8083063 | Iustin Pop | </cmdsynopsis> |
533 | a8083063 | Iustin Pop | <para> |
534 | a8083063 | Iustin Pop | Adds a new mirror to the disk layout of the instance, if the |
535 | a8083063 | Iustin Pop | instance has a remote raid disk layout. |
536 | a8083063 | Iustin Pop | |
537 | a8083063 | Iustin Pop | The new mirror member will be between the instance's primary |
538 | a8083063 | Iustin Pop | node and the node given with the <option>-n</option> option. |
539 | a8083063 | Iustin Pop | </para> |
540 | a8083063 | Iustin Pop | </refsect3> |
541 | a8083063 | Iustin Pop | |
542 | a8083063 | Iustin Pop | <refsect3> |
543 | a8083063 | Iustin Pop | <title>REMOVE-MIRROR</title> |
544 | a8083063 | Iustin Pop | |
545 | a8083063 | Iustin Pop | <cmdsynopsis> |
546 | a8083063 | Iustin Pop | <command>removemirror</command> |
547 | a8083063 | Iustin Pop | <arg choice="req">-b <replaceable>sdX</replaceable></arg> |
548 | a8083063 | Iustin Pop | <arg choice="req">-p <replaceable>id</replaceable></arg> |
549 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
550 | a8083063 | Iustin Pop | </cmdsynopsis> |
551 | a8083063 | Iustin Pop | <para> |
552 | a8083063 | Iustin Pop | Removes a mirror componenent from the disk layout of the |
553 | a8083063 | Iustin Pop | instance, if the instance has a remote raid disk layout. |
554 | a8083063 | Iustin Pop | </para> |
555 | a8083063 | Iustin Pop | |
556 | a8083063 | Iustin Pop | <para> |
557 | a8083063 | Iustin Pop | You need to specifiy on which disk to act on using the |
558 | a8083063 | Iustin Pop | <option>-b</option> option (either <filename>sda</filename> |
559 | a8083063 | Iustin Pop | or <filename>sdb</filename>) and the mirror component, which |
560 | a8083063 | Iustin Pop | is identified by the <option>-p</option> option. You can |
561 | a8083063 | Iustin Pop | find the list of valid identifiers with the |
562 | a8083063 | Iustin Pop | <command>info</command> command. |
563 | a8083063 | Iustin Pop | </para> |
564 | a8083063 | Iustin Pop | |
565 | a8083063 | Iustin Pop | <refsect3> |
566 | a8083063 | Iustin Pop | <title>ACTIVATE-DISKS</title> |
567 | a8083063 | Iustin Pop | |
568 | a8083063 | Iustin Pop | <cmdsynopsis> |
569 | a8083063 | Iustin Pop | <command>activate-disks</command> |
570 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
571 | a8083063 | Iustin Pop | </cmdsynopsis> |
572 | a8083063 | Iustin Pop | <para> |
573 | a8083063 | Iustin Pop | Activates the block devices of the given instance. If |
574 | a8083063 | Iustin Pop | successful, the command will show the location and name of |
575 | a8083063 | Iustin Pop | the block devices: |
576 | a8083063 | Iustin Pop | <screen> |
577 | a8083063 | Iustin Pop | node1.example.com:sda:/dev/md0 |
578 | a8083063 | Iustin Pop | node1.example.com:sdb:/dev/md1 |
579 | a8083063 | Iustin Pop | </screen> |
580 | a8083063 | Iustin Pop | |
581 | a8083063 | Iustin Pop | In this example, <emphasis>node1.example.com</emphasis> is |
582 | a8083063 | Iustin Pop | the name of the node on which the devices have been |
583 | a8083063 | Iustin Pop | activated. The <emphasis>sda</emphasis> and |
584 | a8083063 | Iustin Pop | <emphasis>sdb</emphasis> are the names of the block devices |
585 | a8083063 | Iustin Pop | inside the instance. <emphasis>/dev/md0</emphasis> and |
586 | a8083063 | Iustin Pop | <emphasis>/dev/md1</emphasis> are the names of the block |
587 | a8083063 | Iustin Pop | devices as visible on the node. |
588 | a8083063 | Iustin Pop | </para> |
589 | a8083063 | Iustin Pop | |
590 | a8083063 | Iustin Pop | <para> |
591 | a8083063 | Iustin Pop | Note that it is safe to run this command while the instance |
592 | a8083063 | Iustin Pop | is already running. |
593 | a8083063 | Iustin Pop | </para> |
594 | a8083063 | Iustin Pop | </refsect3> |
595 | a8083063 | Iustin Pop | |
596 | a8083063 | Iustin Pop | <refsect3> |
597 | a8083063 | Iustin Pop | <title>DEACTIVATE-DISKS</title> |
598 | a8083063 | Iustin Pop | |
599 | a8083063 | Iustin Pop | <cmdsynopsis> |
600 | a8083063 | Iustin Pop | <command>deactivate-disks</command> |
601 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
602 | a8083063 | Iustin Pop | </cmdsynopsis> |
603 | a8083063 | Iustin Pop | <para> |
604 | a8083063 | Iustin Pop | De-activates the block devices of the given instance. Note |
605 | a8083063 | Iustin Pop | that if you run this command for a remote raid instance |
606 | a8083063 | Iustin Pop | type, while it is running, it will not be able to shutdown |
607 | a8083063 | Iustin Pop | the block devices on the primary node, but it will shutdown |
608 | a8083063 | Iustin Pop | the block devices on the secondary nodes, thus breaking the |
609 | a8083063 | Iustin Pop | replication. |
610 | a8083063 | Iustin Pop | </para> |
611 | a8083063 | Iustin Pop | |
612 | a8083063 | Iustin Pop | </refsect3> |
613 | a8083063 | Iustin Pop | |
614 | a8083063 | Iustin Pop | </refsect2> |
615 | a8083063 | Iustin Pop | |
616 | a8083063 | Iustin Pop | <refsect2> |
617 | a8083063 | Iustin Pop | <title>Recovery</title> |
618 | a8083063 | Iustin Pop | |
619 | a8083063 | Iustin Pop | <refsect3> |
620 | a8083063 | Iustin Pop | <title>FAILOVER</title> |
621 | a8083063 | Iustin Pop | |
622 | a8083063 | Iustin Pop | <cmdsynopsis> |
623 | a8083063 | Iustin Pop | <command>failover</command> |
624 | a8083063 | Iustin Pop | <arg>-f</arg> |
625 | a8083063 | Iustin Pop | <arg>--ignore-consistency</arg> |
626 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
627 | a8083063 | Iustin Pop | </cmdsynopsis> |
628 | a8083063 | Iustin Pop | |
629 | a8083063 | Iustin Pop | <para> |
630 | a8083063 | Iustin Pop | Failover will fail the instance over its secondary |
631 | a8083063 | Iustin Pop | node. This works only for instances having a remote raid |
632 | a8083063 | Iustin Pop | disk layout. |
633 | a8083063 | Iustin Pop | </para> |
634 | a8083063 | Iustin Pop | |
635 | a8083063 | Iustin Pop | <para> |
636 | a8083063 | Iustin Pop | Normally the failover will check the consistency of the |
637 | a8083063 | Iustin Pop | disks before failing over the instance. If you are trying to |
638 | a8083063 | Iustin Pop | migrate instances off a dead node, this will fail. Use the |
639 | a8083063 | Iustin Pop | <option>--ignore-consistency</option> option for this |
640 | a8083063 | Iustin Pop | purpose. |
641 | a8083063 | Iustin Pop | </para> |
642 | a8083063 | Iustin Pop | |
643 | a8083063 | Iustin Pop | <para> |
644 | a8083063 | Iustin Pop | Example: |
645 | a8083063 | Iustin Pop | <screen> |
646 | a8083063 | Iustin Pop | # gnt-instance failover instance1.example.com |
647 | a8083063 | Iustin Pop | </screen> |
648 | a8083063 | Iustin Pop | </para> |
649 | a8083063 | Iustin Pop | </refsect3> |
650 | a8083063 | Iustin Pop | |
651 | a8083063 | Iustin Pop | </refsect2> |
652 | a8083063 | Iustin Pop | |
653 | a8083063 | Iustin Pop | </refsect1> |
654 | a8083063 | Iustin Pop | |
655 | a8083063 | Iustin Pop | &footer; |
656 | a8083063 | Iustin Pop | |
657 | a8083063 | Iustin Pop | </refentry> |
658 | a8083063 | Iustin Pop | |
659 | a8083063 | Iustin Pop | <!-- Keep this comment at the end of the file |
660 | a8083063 | Iustin Pop | Local variables: |
661 | a8083063 | Iustin Pop | mode: sgml |
662 | a8083063 | Iustin Pop | sgml-omittag:t |
663 | a8083063 | Iustin Pop | sgml-shorttag:t |
664 | a8083063 | Iustin Pop | sgml-minimize-attributes:nil |
665 | a8083063 | Iustin Pop | sgml-always-quote-attributes:t |
666 | a8083063 | Iustin Pop | sgml-indent-step:2 |
667 | a8083063 | Iustin Pop | sgml-indent-data:t |
668 | a8083063 | Iustin Pop | sgml-parent-document:nil |
669 | a8083063 | Iustin Pop | sgml-default-dtd-file:nil |
670 | a8083063 | Iustin Pop | sgml-exposed-tags:nil |
671 | a8083063 | Iustin Pop | sgml-local-catalogs:nil |
672 | a8083063 | Iustin Pop | sgml-local-ecat-files:nil |
673 | a8083063 | Iustin Pop | End: |
674 | a8083063 | Iustin Pop | --> |