root / man / gnt-instance.sgml @ ca9c49d5
History | View | Annotate | Download (40 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 | bdb7d4e8 | Michael Hanselmann | |
70 | a8083063 | Iustin Pop | <arg>-b <replaceable>bridge</replaceable></arg> |
71 | f3a55c90 | Alexander Schreiber | <arg>--mac <replaceable>MAC-address</replaceable></arg> |
72 | bdb7d4e8 | Michael Hanselmann | <sbr> |
73 | bdb7d4e8 | Michael Hanselmann | |
74 | 25c5878d | Alexander Schreiber | <arg>--hvm-boot-order <replaceable>boot-order</replaceable></arg> |
75 | ca9c49d5 | Iustin Pop | <arg>--hvm-acpi <replaceable>ACPI-support</replaceable></arg> |
76 | ca9c49d5 | Iustin Pop | <arg>--hvm-pae <replaceable>PAE-support</replaceable></arg> |
77 | ca9c49d5 | Iustin Pop | <arg>--hvm-cdrom-image-path |
78 | ca9c49d5 | Iustin Pop | <replaceable>cdrom-image-path</replaceable></arg> |
79 | ca9c49d5 | Iustin Pop | <arg>--vnc-bind-address |
80 | ca9c49d5 | Iustin Pop | <replaceable>vnc-bind-address</replaceable></arg> |
81 | ca9c49d5 | Iustin Pop | |
82 | a8083063 | Iustin Pop | <sbr> |
83 | bdb7d4e8 | Michael Hanselmann | |
84 | bdb7d4e8 | Michael Hanselmann | <arg>--kernel<group choice="req"> |
85 | 00f98619 | Iustin Pop | <arg>default</arg> |
86 | 00f98619 | Iustin Pop | <arg><replaceable>kernel_path</replaceable></arg> |
87 | 00f98619 | Iustin Pop | </group></arg> |
88 | 00f98619 | Iustin Pop | <sbr> |
89 | bdb7d4e8 | Michael Hanselmann | |
90 | bdb7d4e8 | Michael Hanselmann | <arg>--initrd<group choice="req"> |
91 | 00f98619 | Iustin Pop | <arg>default</arg> |
92 | 00f98619 | Iustin Pop | <arg>none</arg> |
93 | 00f98619 | Iustin Pop | <arg><replaceable>initrd_path</replaceable></arg> |
94 | bdb7d4e8 | Michael Hanselmann | </group></arg> |
95 | 00f98619 | Iustin Pop | <sbr> |
96 | bdb7d4e8 | Michael Hanselmann | |
97 | 495beb42 | Manuel Franceschini | <arg>--file-storage-dir <replaceable>dir_path</replaceable></arg> |
98 | bdb7d4e8 | Michael Hanselmann | <arg>--file-driver<group choice="req"> |
99 | 495beb42 | Manuel Franceschini | <arg>loop</arg> |
100 | 495beb42 | Manuel Franceschini | <arg>blktap</arg> |
101 | 495beb42 | Manuel Franceschini | </group></arg> |
102 | 495beb42 | Manuel Franceschini | <sbr> |
103 | bdb7d4e8 | Michael Hanselmann | |
104 | bdb7d4e8 | Michael Hanselmann | <arg choice="req">-t<group choice="req"> |
105 | a8083063 | Iustin Pop | <arg>diskless</arg> |
106 | 495beb42 | Manuel Franceschini | <arg>file</arg> |
107 | a8083063 | Iustin Pop | <arg>plain</arg> |
108 | f69dab6d | Iustin Pop | <arg>drbd</arg> |
109 | bdb7d4e8 | Michael Hanselmann | </group></arg> |
110 | b9ac33e9 | Iustin Pop | <sbr> |
111 | bdb7d4e8 | Michael Hanselmann | |
112 | 4677a909 | Michael Hanselmann | <arg choice="req">-n <replaceable>node<optional>:secondary-node</optional></replaceable></arg> |
113 | bdb7d4e8 | Michael Hanselmann | <arg choice="req">-o <replaceable>os-type</replaceable></arg> |
114 | bdb7d4e8 | Michael Hanselmann | <sbr> |
115 | bdb7d4e8 | Michael Hanselmann | |
116 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
117 | a8083063 | Iustin Pop | </cmdsynopsis> |
118 | 00f98619 | Iustin Pop | |
119 | a8083063 | Iustin Pop | <para> |
120 | a8083063 | Iustin Pop | Creates a new instance on the specified |
121 | a8083063 | Iustin Pop | host. <replaceable>instance</replaceable> must be in DNS and |
122 | a8083063 | Iustin Pop | resolve to a IP in the same network as the nodes in the |
123 | a8083063 | Iustin Pop | cluster. |
124 | a8083063 | Iustin Pop | </para> |
125 | a8083063 | Iustin Pop | |
126 | a8083063 | Iustin Pop | <para> |
127 | a8083063 | Iustin Pop | The <option>-s</option> option specifies the disk size for |
128 | b9ac33e9 | Iustin Pop | the instance, in mebibytes (defaults to |
129 | b9ac33e9 | Iustin Pop | <constant>20480MiB</constant> = |
130 | b9ac33e9 | Iustin Pop | <constant>20GiB</constant>). You can also use one of the |
131 | b9ac33e9 | Iustin Pop | suffixes <literal>m</literal>, <literal>g</literal> or |
132 | b9ac33e9 | Iustin Pop | <literal>t</literal> to specificy the exact the units used; |
133 | b9ac33e9 | Iustin Pop | these suffixes map to mebibytes, gibibytes and tebibytes. |
134 | a8083063 | Iustin Pop | </para> |
135 | a8083063 | Iustin Pop | |
136 | a8083063 | Iustin Pop | <para> |
137 | b9ac33e9 | Iustin Pop | The <option>--swap-size</option> option specifies the swap |
138 | b9ac33e9 | Iustin Pop | disk size (in mebibytes) for the instance (the one presented |
139 | b9ac33e9 | Iustin Pop | as <filename class="devicefile">/dev/sdb</filename>). The |
140 | b9ac33e9 | Iustin Pop | default is <constant>4096MiB</constant>. As for the disk |
141 | b9ac33e9 | Iustin Pop | size, you can specify other suffixes. |
142 | a8083063 | Iustin Pop | </para> |
143 | a8083063 | Iustin Pop | |
144 | a8083063 | Iustin Pop | <para> |
145 | a8083063 | Iustin Pop | The <option>-m</option> option specifies the memory size for |
146 | b9ac33e9 | Iustin Pop | the instance, in mebibytes (defaults to 128 MiB). Again, you |
147 | b9ac33e9 | Iustin Pop | can use other suffixes (e.g. <userinput>2g</userinput>). |
148 | b9ac33e9 | Iustin Pop | </para> |
149 | b9ac33e9 | Iustin Pop | |
150 | b9ac33e9 | Iustin Pop | <para> |
151 | b9ac33e9 | Iustin Pop | The <option>-o</option> options specifies the operating |
152 | b9ac33e9 | Iustin Pop | system to be installed. The available operating systems can |
153 | b9ac33e9 | Iustin Pop | be listed with <command>gnt-os list</command>. |
154 | a8083063 | Iustin Pop | </para> |
155 | a8083063 | Iustin Pop | |
156 | a8083063 | Iustin Pop | <para> |
157 | a8083063 | Iustin Pop | The <option>-b</option> option specifies the bridge to which the |
158 | a8083063 | Iustin Pop | instance will be connected. (defaults to the cluster-wide default |
159 | 7e84d392 | Michael Hanselmann | bridge specified at cluster initialization time). |
160 | a8083063 | Iustin Pop | </para> |
161 | a8083063 | Iustin Pop | |
162 | a8083063 | Iustin Pop | <para> |
163 | f3a55c90 | Alexander Schreiber | The <option>--mac</option> option specifies the MAC address |
164 | f3a55c90 | Alexander Schreiber | of the ethernet interface for the instance. If this option |
165 | f3a55c90 | Alexander Schreiber | is not specified, a new MAC address is generated randomly with |
166 | f3a55c90 | Alexander Schreiber | the configured MAC prefix. The randomly generated MAC |
167 | f3a55c90 | Alexander Schreiber | address is guaranteed to be unique among the instances of |
168 | f3a55c90 | Alexander Schreiber | this cluster. |
169 | f3a55c90 | Alexander Schreiber | </para> |
170 | f3a55c90 | Alexander Schreiber | |
171 | f3a55c90 | Alexander Schreiber | <para> |
172 | 25c5878d | Alexander Schreiber | The <option>--hvm-boot-order</option> option specifies the |
173 | 25c5878d | Alexander Schreiber | boot device order for Xen HVM instances. The boot order is a |
174 | 25c5878d | Alexander Schreiber | string of letters listing the boot devices, with valid |
175 | 25c5878d | Alexander Schreiber | device letters being: |
176 | 25c5878d | Alexander Schreiber | </para> |
177 | 25c5878d | Alexander Schreiber | |
178 | 25c5878d | Alexander Schreiber | <para> |
179 | 25c5878d | Alexander Schreiber | <variablelist> |
180 | 25c5878d | Alexander Schreiber | <varlistentry> |
181 | 25c5878d | Alexander Schreiber | <term>a</term> |
182 | 25c5878d | Alexander Schreiber | <listitem> |
183 | 25c5878d | Alexander Schreiber | <para> |
184 | 25c5878d | Alexander Schreiber | floppy drive |
185 | 25c5878d | Alexander Schreiber | </para> |
186 | 25c5878d | Alexander Schreiber | </listitem> |
187 | 25c5878d | Alexander Schreiber | </varlistentry> |
188 | 25c5878d | Alexander Schreiber | <varlistentry> |
189 | 25c5878d | Alexander Schreiber | <term>c</term> |
190 | 25c5878d | Alexander Schreiber | <listitem> |
191 | 25c5878d | Alexander Schreiber | <para> |
192 | 25c5878d | Alexander Schreiber | hard disk |
193 | 25c5878d | Alexander Schreiber | </para> |
194 | 25c5878d | Alexander Schreiber | </listitem> |
195 | 25c5878d | Alexander Schreiber | </varlistentry> |
196 | 25c5878d | Alexander Schreiber | <varlistentry> |
197 | 25c5878d | Alexander Schreiber | <term>d</term> |
198 | 25c5878d | Alexander Schreiber | <listitem> |
199 | 25c5878d | Alexander Schreiber | <para> |
200 | 25c5878d | Alexander Schreiber | CDROM drive |
201 | 25c5878d | Alexander Schreiber | </para> |
202 | 25c5878d | Alexander Schreiber | </listitem> |
203 | 25c5878d | Alexander Schreiber | </varlistentry> |
204 | 25c5878d | Alexander Schreiber | <varlistentry> |
205 | 25c5878d | Alexander Schreiber | <term>n</term> |
206 | 25c5878d | Alexander Schreiber | <listitem> |
207 | 25c5878d | Alexander Schreiber | <para> |
208 | 25c5878d | Alexander Schreiber | network boot (PXE) |
209 | 25c5878d | Alexander Schreiber | </para> |
210 | 25c5878d | Alexander Schreiber | </listitem> |
211 | 25c5878d | Alexander Schreiber | </varlistentry> |
212 | 25c5878d | Alexander Schreiber | </variablelist> |
213 | 25c5878d | Alexander Schreiber | </para> |
214 | 25c5878d | Alexander Schreiber | |
215 | 25c5878d | Alexander Schreiber | <para> |
216 | 25c5878d | Alexander Schreiber | The option is only relevant for Xen HVM instances and |
217 | 25c5878d | Alexander Schreiber | ignored by all other instances types. |
218 | 25c5878d | Alexander Schreiber | </para> |
219 | 25c5878d | Alexander Schreiber | |
220 | 25c5878d | Alexander Schreiber | <para> |
221 | ca9c49d5 | Iustin Pop | The <option>--hvm-acpi</option> option specifies if Xen |
222 | ca9c49d5 | Iustin Pop | should enable ACPI support for this HVM instance. Valid |
223 | ca9c49d5 | Iustin Pop | values are true or false. |
224 | ca9c49d5 | Iustin Pop | </para> |
225 | ca9c49d5 | Iustin Pop | |
226 | ca9c49d5 | Iustin Pop | <para> |
227 | ca9c49d5 | Iustin Pop | The <option>--hvm-pae</option> option specifies if Xen |
228 | ca9c49d5 | Iustin Pop | should enabled PAE support for this HVM instance. Valid |
229 | ca9c49d5 | Iustin Pop | values are true or false. |
230 | ca9c49d5 | Iustin Pop | </para> |
231 | ca9c49d5 | Iustin Pop | |
232 | ca9c49d5 | Iustin Pop | <para> |
233 | ca9c49d5 | Iustin Pop | The <option>--hvm-cdrom-image-path</option> specifies the |
234 | ca9c49d5 | Iustin Pop | path to the file xen uses to emulate a virtual CDROM drive |
235 | ca9c49d5 | Iustin Pop | for this HVM instance. Valid values are either an |
236 | ca9c49d5 | Iustin Pop | absolute path to an existing file or None, which disables |
237 | ca9c49d5 | Iustin Pop | virtual CDROM support for this instance. |
238 | ca9c49d5 | Iustin Pop | </para> |
239 | ca9c49d5 | Iustin Pop | |
240 | ca9c49d5 | Iustin Pop | <para> |
241 | ca9c49d5 | Iustin Pop | The <option>--vnc-bind-address</option> specifies the |
242 | ca9c49d5 | Iustin Pop | address that the VNC listener for this instance should bind |
243 | ca9c49d5 | Iustin Pop | to. Valid values are IPv4 addresses. Use the address 0.0.0.0 |
244 | ca9c49d5 | Iustin Pop | to bind to all available interfaces. |
245 | ca9c49d5 | Iustin Pop | </para> |
246 | ca9c49d5 | Iustin Pop | |
247 | ca9c49d5 | Iustin Pop | <para> |
248 | 00f98619 | Iustin Pop | The <option>--kernel</option> options allows the instance to |
249 | 00f98619 | Iustin Pop | use a custom kernel (if a filename is passed) or to use the |
250 | 00f98619 | Iustin Pop | default kernel (<filename>@CUSTOM_XEN_KERNEL@</filename>), if the |
251 | 00f98619 | Iustin Pop | string <constant>default</constant> is passed. |
252 | 00f98619 | Iustin Pop | </para> |
253 | 00f98619 | Iustin Pop | |
254 | 00f98619 | Iustin Pop | <para> |
255 | 00f98619 | Iustin Pop | The <option>--initrd</option> option is similar: it allows |
256 | 00f98619 | Iustin Pop | the instance to use a custom initrd (if a filename is |
257 | 00f98619 | Iustin Pop | passed) or to use the default initrd |
258 | 00f98619 | Iustin Pop | (<filename>@CUSTOM_XEN_INITRD@</filename>), if the string |
259 | 00f98619 | Iustin Pop | <constant>default</constant> is passed, or to disable the |
260 | 00f98619 | Iustin Pop | use of an initrd, if the string <constant>none</constant> is |
261 | 00f98619 | Iustin Pop | passed. Note that in the case the instance is set to use the |
262 | 00f98619 | Iustin Pop | default initrd and it doesn't exist, it will be silently |
263 | 00f98619 | Iustin Pop | ignored; if the instance is set to use a custom initrd and |
264 | 00f98619 | Iustin Pop | it doesn't exist, this will be treated as an error and will |
265 | 00f98619 | Iustin Pop | prevent the startup of the instance. |
266 | 00f98619 | Iustin Pop | </para> |
267 | 00f98619 | Iustin Pop | |
268 | 00f98619 | Iustin Pop | <para> |
269 | a8083063 | Iustin Pop | The <option>-t</option> options specifies the disk layout type for |
270 | a8083063 | Iustin Pop | the instance. The available choices are: |
271 | a8083063 | Iustin Pop | <variablelist> |
272 | a8083063 | Iustin Pop | <varlistentry> |
273 | a8083063 | Iustin Pop | <term>diskless</term> |
274 | a8083063 | Iustin Pop | <listitem> |
275 | a8083063 | Iustin Pop | <para> |
276 | a8083063 | Iustin Pop | This creates an instance with no disks. Its useful for |
277 | a8083063 | Iustin Pop | testing only (or other special cases). |
278 | a8083063 | Iustin Pop | </para> |
279 | a8083063 | Iustin Pop | </listitem> |
280 | a8083063 | Iustin Pop | </varlistentry> |
281 | a8083063 | Iustin Pop | <varlistentry> |
282 | 495beb42 | Manuel Franceschini | <term>file</term> |
283 | 495beb42 | Manuel Franceschini | <listitem> |
284 | 495beb42 | Manuel Franceschini | <para>Disk devices will be regular files.</para> |
285 | 495beb42 | Manuel Franceschini | </listitem> |
286 | 495beb42 | Manuel Franceschini | </varlistentry> |
287 | 495beb42 | Manuel Franceschini | <varlistentry> |
288 | a8083063 | Iustin Pop | <term>plain</term> |
289 | a8083063 | Iustin Pop | <listitem> |
290 | a8083063 | Iustin Pop | <para>Disk devices will be logical volumes.</para> |
291 | a8083063 | Iustin Pop | </listitem> |
292 | a8083063 | Iustin Pop | </varlistentry> |
293 | a8083063 | Iustin Pop | <varlistentry> |
294 | f69dab6d | Iustin Pop | <term>drbd</term> |
295 | f69dab6d | Iustin Pop | <listitem> |
296 | f69dab6d | Iustin Pop | <para> |
297 | f69dab6d | Iustin Pop | Disk devices will be drbd (version 8.x) on top of |
298 | f9193417 | Iustin Pop | lvm volumes. |
299 | a8083063 | Iustin Pop | </para> |
300 | a8083063 | Iustin Pop | </listitem> |
301 | a8083063 | Iustin Pop | </varlistentry> |
302 | a8083063 | Iustin Pop | </variablelist> |
303 | a8083063 | Iustin Pop | </para> |
304 | a8083063 | Iustin Pop | |
305 | a8083063 | Iustin Pop | <para> |
306 | 4677a909 | Michael Hanselmann | The optional second value of the <option>--node</option> is used for |
307 | bd028152 | Iustin Pop | the drbd template type and specifies the remote node. |
308 | a8083063 | Iustin Pop | </para> |
309 | a8083063 | Iustin Pop | |
310 | a8083063 | Iustin Pop | <para> |
311 | a8083063 | Iustin Pop | If you do not want gnt-instance to wait for the disk mirror |
312 | a8083063 | Iustin Pop | to be synced, use the <option>--no-wait-for-sync</option> |
313 | a8083063 | Iustin Pop | option. |
314 | a8083063 | Iustin Pop | </para> |
315 | a8083063 | Iustin Pop | |
316 | a8083063 | Iustin Pop | <para> |
317 | 495beb42 | Manuel Franceschini | The <option>--file-storage-dir</option> specifies the relative path |
318 | 495beb42 | Manuel Franceschini | under the cluster-wide file storage directory to store file-based |
319 | 495beb42 | Manuel Franceschini | disks. It is useful for having different subdirectories for |
320 | 495beb42 | Manuel Franceschini | different instances. The full path of the directory where the disk |
321 | 495beb42 | Manuel Franceschini | files are stored will consist of cluster-wide file storage directory |
322 | 495beb42 | Manuel Franceschini | + optional subdirectory + instance name. Example: |
323 | 495beb42 | Manuel Franceschini | /srv/ganeti/file-storage/mysubdir/instance1.example.com. This option |
324 | 495beb42 | Manuel Franceschini | is only relevant for instances using the file storage backend. |
325 | 495beb42 | Manuel Franceschini | </para> |
326 | 495beb42 | Manuel Franceschini | |
327 | 495beb42 | Manuel Franceschini | <para> |
328 | 495beb42 | Manuel Franceschini | The <option>--file-driver</option> specifies the driver to use for |
329 | 495beb42 | Manuel Franceschini | file-based disks. Note that currently these drivers work with the |
330 | 495beb42 | Manuel Franceschini | xen hypervisor only. This option is only relevant for instances using |
331 | 495beb42 | Manuel Franceschini | the file storage backend. The available choices are: |
332 | 495beb42 | Manuel Franceschini | <variablelist> |
333 | 495beb42 | Manuel Franceschini | <varlistentry> |
334 | 495beb42 | Manuel Franceschini | <term>loop</term> |
335 | 495beb42 | Manuel Franceschini | <listitem> |
336 | 495beb42 | Manuel Franceschini | <para>Kernel loopback driver.</para> |
337 | 495beb42 | Manuel Franceschini | </listitem> |
338 | 495beb42 | Manuel Franceschini | </varlistentry> |
339 | 495beb42 | Manuel Franceschini | <varlistentry> |
340 | 495beb42 | Manuel Franceschini | <term>blktap</term> |
341 | 495beb42 | Manuel Franceschini | <listitem> |
342 | 495beb42 | Manuel Franceschini | <para>blktap driver.</para> |
343 | 495beb42 | Manuel Franceschini | </listitem> |
344 | 495beb42 | Manuel Franceschini | </varlistentry> |
345 | 495beb42 | Manuel Franceschini | <variablelist> |
346 | 495beb42 | Manuel Franceschini | </para> |
347 | 495beb42 | Manuel Franceschini | |
348 | 495beb42 | Manuel Franceschini | <para> |
349 | 495beb42 | Manuel Franceschini | The loop driver uses loopback devices to access the filesystem |
350 | 495beb42 | Manuel Franceschini | within the file. However, running I/O intensive applications |
351 | 495beb42 | Manuel Franceschini | in your instance using the loop driver might result in slowdowns. |
352 | 495beb42 | Manuel Franceschini | Furthermore, if you use the loopback driver consider increasing |
353 | 495beb42 | Manuel Franceschini | the maximum amount of loopback devices (on most systems it's 8) |
354 | 495beb42 | Manuel Franceschini | using the max_loop param. |
355 | 495beb42 | Manuel Franceschini | </para> |
356 | 495beb42 | Manuel Franceschini | |
357 | 495beb42 | Manuel Franceschini | <para> |
358 | 495beb42 | Manuel Franceschini | In order to be able to use the blktap driver you should check |
359 | 495beb42 | Manuel Franceschini | if the 'blktapctrl' user space disk agent is running (usually |
360 | 495beb42 | Manuel Franceschini | automatically started via xend). This user-level disk I/O |
361 | 495beb42 | Manuel Franceschini | interface has the advantage of better performance. Especially |
362 | 495beb42 | Manuel Franceschini | if you use a network file system (e.g. NFS) to store your instances |
363 | 495beb42 | Manuel Franceschini | this is the recommended choice. |
364 | bd028152 | Iustin Pop | </para> |
365 | 495beb42 | Manuel Franceschini | |
366 | 495beb42 | Manuel Franceschini | <para> |
367 | a8083063 | Iustin Pop | Example: |
368 | a8083063 | Iustin Pop | <screen> |
369 | 495beb42 | Manuel Franceschini | # gnt-instance add -t file -s 30g -m 512 -o debian-etch \ |
370 | 495beb42 | Manuel Franceschini | -n node1.example.com --file-storage-dir=mysubdir instance1.example.com |
371 | b9ac33e9 | Iustin Pop | # gnt-instance add -t plain -s 30g -m 512 -o debian-etch \ |
372 | b9ac33e9 | Iustin Pop | -n node1.example.com instance1.example.com |
373 | f9193417 | Iustin Pop | # gnt-instance add -t drbd -s 30g -m 512 -o debian-etch \ |
374 | 4677a909 | Michael Hanselmann | -n node1.example.com:node2.example.com instance2.example.com |
375 | a8083063 | Iustin Pop | </screen> |
376 | a8083063 | Iustin Pop | </para> |
377 | a8083063 | Iustin Pop | </refsect3> |
378 | a8083063 | Iustin Pop | |
379 | a8083063 | Iustin Pop | <refsect3> |
380 | a8083063 | Iustin Pop | <title>REMOVE</title> |
381 | a8083063 | Iustin Pop | |
382 | a8083063 | Iustin Pop | <cmdsynopsis> |
383 | a8083063 | Iustin Pop | <command>remove</command> |
384 | 1d67656e | Iustin Pop | <arg>--ignore-failures</arg> |
385 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
386 | a8083063 | Iustin Pop | </cmdsynopsis> |
387 | a8083063 | Iustin Pop | |
388 | a8083063 | Iustin Pop | <para> |
389 | a8083063 | Iustin Pop | Remove an instance. This will remove all data from the |
390 | a8083063 | Iustin Pop | instance and there is <emphasis>no way back</emphasis>. If |
391 | a8083063 | Iustin Pop | you are not sure if you use an instance again, use |
392 | a8083063 | Iustin Pop | <command>shutdown</command> first and leave it in the |
393 | a8083063 | Iustin Pop | shutdown state for a while. |
394 | 1d67656e | Iustin Pop | |
395 | 1d67656e | Iustin Pop | </para> |
396 | 1d67656e | Iustin Pop | |
397 | 1d67656e | Iustin Pop | <para> |
398 | 1d67656e | Iustin Pop | The <option>--ignore-failures</option> option will cause the |
399 | 1d67656e | Iustin Pop | removal to proceed even in the presence of errors during the |
400 | 1d67656e | Iustin Pop | removal of the instance (e.g. during the shutdown or the |
401 | 1d67656e | Iustin Pop | disk removal). If this option is not given, the command will |
402 | 1d67656e | Iustin Pop | stop at the first error. |
403 | a8083063 | Iustin Pop | </para> |
404 | a8083063 | Iustin Pop | |
405 | a8083063 | Iustin Pop | <para> |
406 | a8083063 | Iustin Pop | Example: |
407 | a8083063 | Iustin Pop | <screen> |
408 | a8083063 | Iustin Pop | # gnt-instance remove instance1.example.com |
409 | a8083063 | Iustin Pop | </screen> |
410 | a8083063 | Iustin Pop | </para> |
411 | a8083063 | Iustin Pop | </refsect3> |
412 | a8083063 | Iustin Pop | |
413 | a8083063 | Iustin Pop | <refsect3> |
414 | a8083063 | Iustin Pop | <title>LIST</title> |
415 | a8083063 | Iustin Pop | |
416 | a8083063 | Iustin Pop | <cmdsynopsis> |
417 | a8083063 | Iustin Pop | <command>list</command> |
418 | a8083063 | Iustin Pop | <arg>--no-headers</arg> |
419 | a8083063 | Iustin Pop | <arg>--separator=<replaceable>SEPARATOR</replaceable></arg> |
420 | 48c4dfa8 | Iustin Pop | <arg>-o <replaceable>[+]FIELD,...</replaceable></arg> |
421 | a8083063 | Iustin Pop | </cmdsynopsis> |
422 | a8083063 | Iustin Pop | |
423 | a8083063 | Iustin Pop | <para> |
424 | a8083063 | Iustin Pop | Shows the currently configured instances with memory usage, |
425 | a8083063 | Iustin Pop | disk usage, the node they are running on, and the CPU time, |
426 | a8083063 | Iustin Pop | counted in seconds, used by each instance since its latest |
427 | a8083063 | Iustin Pop | restart. |
428 | a8083063 | Iustin Pop | </para> |
429 | a8083063 | Iustin Pop | |
430 | a8083063 | Iustin Pop | <para> |
431 | a8083063 | Iustin Pop | The <option>--no-headers</option> option will skip the |
432 | a8083063 | Iustin Pop | initial header line. The <option>--separator</option> option |
433 | a8083063 | Iustin Pop | takes an argument which denotes what will be used between |
434 | a8083063 | Iustin Pop | the output fields. Both these options are to help scripting. |
435 | a8083063 | Iustin Pop | </para> |
436 | a8083063 | Iustin Pop | |
437 | a8083063 | Iustin Pop | <para> |
438 | a8083063 | Iustin Pop | The <option>-o</option> option takes a comma-separated list |
439 | a8083063 | Iustin Pop | of output fields. The available fields and their meaning |
440 | a8083063 | Iustin Pop | are: |
441 | a8083063 | Iustin Pop | <variablelist> |
442 | a8083063 | Iustin Pop | <varlistentry> |
443 | a8083063 | Iustin Pop | <term>name</term> |
444 | a8083063 | Iustin Pop | <listitem> |
445 | a8083063 | Iustin Pop | <simpara>the instance name</simpara> |
446 | a8083063 | Iustin Pop | </listitem> |
447 | a8083063 | Iustin Pop | </varlistentry> |
448 | a8083063 | Iustin Pop | <varlistentry> |
449 | a8083063 | Iustin Pop | <term>os</term> |
450 | a8083063 | Iustin Pop | <listitem> |
451 | a8083063 | Iustin Pop | <simpara>the OS of the instance</simpara> |
452 | a8083063 | Iustin Pop | </listitem> |
453 | a8083063 | Iustin Pop | </varlistentry> |
454 | a8083063 | Iustin Pop | <varlistentry> |
455 | a8083063 | Iustin Pop | <term>pnode</term> |
456 | a8083063 | Iustin Pop | <listitem> |
457 | a8083063 | Iustin Pop | <simpara>the primary node of the instance</simpara> |
458 | a8083063 | Iustin Pop | </listitem> |
459 | a8083063 | Iustin Pop | </varlistentry> |
460 | a8083063 | Iustin Pop | <varlistentry> |
461 | a8083063 | Iustin Pop | <term>snodes</term> |
462 | a8083063 | Iustin Pop | <listitem> |
463 | 4677a909 | Michael Hanselmann | <simpara>comma-separated list of secondary nodes for the |
464 | a8083063 | Iustin Pop | instance; usually this will be just one node</simpara> |
465 | a8083063 | Iustin Pop | </listitem> |
466 | a8083063 | Iustin Pop | </varlistentry> |
467 | a8083063 | Iustin Pop | <varlistentry> |
468 | a8083063 | Iustin Pop | <term>admin_state</term> |
469 | a8083063 | Iustin Pop | <listitem> |
470 | a8083063 | Iustin Pop | <simpara>the desired state of the instance (either "yes" |
471 | a8083063 | Iustin Pop | or "no" denoting the instance should run or |
472 | a8083063 | Iustin Pop | not)</simpara> |
473 | a8083063 | Iustin Pop | </listitem> |
474 | a8083063 | Iustin Pop | </varlistentry> |
475 | a8083063 | Iustin Pop | <varlistentry> |
476 | a8083063 | Iustin Pop | <term>admin_ram</term> |
477 | a8083063 | Iustin Pop | <listitem> |
478 | a8083063 | Iustin Pop | <simpara>the desired memory for the instance</simpara> |
479 | a8083063 | Iustin Pop | </listitem> |
480 | a8083063 | Iustin Pop | </varlistentry> |
481 | a8083063 | Iustin Pop | <varlistentry> |
482 | a8083063 | Iustin Pop | <term>disk_template</term> |
483 | a8083063 | Iustin Pop | <listitem> |
484 | a8083063 | Iustin Pop | <simpara>the disk template of the instance</simpara> |
485 | a8083063 | Iustin Pop | </listitem> |
486 | a8083063 | Iustin Pop | </varlistentry> |
487 | a8083063 | Iustin Pop | <varlistentry> |
488 | a8083063 | Iustin Pop | <term>oper_state</term> |
489 | a8083063 | Iustin Pop | <listitem> |
490 | d8052456 | Iustin Pop | <simpara>the actual state of the instance; can be |
491 | d8052456 | Iustin Pop | one of the values "running", "stopped", "(node |
492 | d8052456 | Iustin Pop | down)"</simpara> |
493 | d8052456 | Iustin Pop | </listitem> |
494 | d8052456 | Iustin Pop | </varlistentry> |
495 | d8052456 | Iustin Pop | <varlistentry> |
496 | d8052456 | Iustin Pop | <term>status</term> |
497 | d8052456 | Iustin Pop | <listitem> |
498 | d8052456 | Iustin Pop | <simpara>combined form of admin_state and oper_stat; |
499 | d8052456 | Iustin Pop | this can be one of: |
500 | d8052456 | Iustin Pop | <computeroutput>ERROR_nodedown</computeroutput> if the |
501 | d8052456 | Iustin Pop | node of the instance is down, |
502 | d8052456 | Iustin Pop | <computeroutput>ERROR_down</computeroutput> if the |
503 | d8052456 | Iustin Pop | instance should run but is down, |
504 | d8052456 | Iustin Pop | <computeroutput>ERROR_up</computeroutput> if the |
505 | d8052456 | Iustin Pop | instance should be stopped but is actually running, |
506 | d8052456 | Iustin Pop | <computeroutput>ADMIN_down</computeroutput> if the |
507 | d8052456 | Iustin Pop | instance has been stopped (and is stopped) and |
508 | d8052456 | Iustin Pop | <computeroutput>running</computeroutput> if the |
509 | d8052456 | Iustin Pop | instance is set to be running (and is |
510 | d8052456 | Iustin Pop | running)</simpara> |
511 | a8083063 | Iustin Pop | </listitem> |
512 | a8083063 | Iustin Pop | </varlistentry> |
513 | a8083063 | Iustin Pop | <varlistentry> |
514 | a8083063 | Iustin Pop | <term>oper_ram</term> |
515 | a8083063 | Iustin Pop | <listitem> |
516 | a8083063 | Iustin Pop | <simpara>the actual memory usage of the instance as seen |
517 | a8083063 | Iustin Pop | by the hypervisor</simpara> |
518 | a8083063 | Iustin Pop | </listitem> |
519 | a8083063 | Iustin Pop | </varlistentry> |
520 | a8083063 | Iustin Pop | <varlistentry> |
521 | a8083063 | Iustin Pop | <term>ip</term> |
522 | a8083063 | Iustin Pop | <listitem> |
523 | a8083063 | Iustin Pop | <simpara>the ip address ganeti recognizes as associated with |
524 | a8083063 | Iustin Pop | the instance interface</simpara> |
525 | a8083063 | Iustin Pop | </listitem> |
526 | a8083063 | Iustin Pop | </varlistentry> |
527 | a8083063 | Iustin Pop | <varlistentry> |
528 | a8083063 | Iustin Pop | <term>mac</term> |
529 | a8083063 | Iustin Pop | <listitem> |
530 | a8083063 | Iustin Pop | <simpara>the instance interface MAC address</simpara> |
531 | a8083063 | Iustin Pop | </listitem> |
532 | a8083063 | Iustin Pop | </varlistentry> |
533 | a8083063 | Iustin Pop | <varlistentry> |
534 | a8083063 | Iustin Pop | <term>bridge</term> |
535 | a8083063 | Iustin Pop | <listitem> |
536 | a8083063 | Iustin Pop | <simpara>bridge the instance is connected to |
537 | a8083063 | Iustin Pop | </simpara> |
538 | a8083063 | Iustin Pop | </listitem> |
539 | a8083063 | Iustin Pop | </varlistentry> |
540 | d8a4b51d | Iustin Pop | <varlistentry> |
541 | d8a4b51d | Iustin Pop | <term>sda_size</term> |
542 | d8a4b51d | Iustin Pop | <listitem> |
543 | d8a4b51d | Iustin Pop | <simpara>the size of the instance's first disk</simpara> |
544 | d8a4b51d | Iustin Pop | </listitem> |
545 | d8a4b51d | Iustin Pop | </varlistentry> |
546 | d8a4b51d | Iustin Pop | <varlistentry> |
547 | d8a4b51d | Iustin Pop | <term>sdb_size</term> |
548 | d8a4b51d | Iustin Pop | <listitem> |
549 | d8a4b51d | Iustin Pop | <simpara>the size of the instance's second disk</simpara> |
550 | d8a4b51d | Iustin Pop | </listitem> |
551 | d8a4b51d | Iustin Pop | </varlistentry> |
552 | d8a4b51d | Iustin Pop | <varlistentry> |
553 | d8a4b51d | Iustin Pop | <term>vcpus</term> |
554 | d8a4b51d | Iustin Pop | <listitem> |
555 | d8a4b51d | Iustin Pop | <simpara>the number of VCPUs allocated to the |
556 | d8a4b51d | Iustin Pop | instance</simpara> |
557 | d8a4b51d | Iustin Pop | </listitem> |
558 | d8a4b51d | Iustin Pop | </varlistentry> |
559 | a8083063 | Iustin Pop | </variablelist> |
560 | a8083063 | Iustin Pop | </para> |
561 | a8083063 | Iustin Pop | |
562 | a8083063 | Iustin Pop | <para> |
563 | 48c4dfa8 | Iustin Pop | If the value of the option starts with the character |
564 | 48c4dfa8 | Iustin Pop | <constant>+</constant>, the new fields will be added to the |
565 | 48c4dfa8 | Iustin Pop | default list. This allows to quickly see the default list |
566 | 48c4dfa8 | Iustin Pop | plus a few other fields, instead of retyping the entire list |
567 | 48c4dfa8 | Iustin Pop | of fields. |
568 | 48c4dfa8 | Iustin Pop | </para> |
569 | 48c4dfa8 | Iustin Pop | |
570 | 48c4dfa8 | Iustin Pop | <para> |
571 | a8083063 | Iustin Pop | There is a subtle grouping about the available output |
572 | 872c949f | Iustin Pop | fields: all fields except for <option>oper_state</option>, |
573 | 872c949f | Iustin Pop | <option>oper_ram</option> and <option>status</option> are |
574 | 872c949f | Iustin Pop | configuration value and not run-time values. So if you don't |
575 | 872c949f | Iustin Pop | select any of the these fields, the query will be satisfied |
576 | a8083063 | Iustin Pop | instantly from the cluster configuration, without having to |
577 | a8083063 | Iustin Pop | ask the remote nodes for the data. This can be helpful for |
578 | a8083063 | Iustin Pop | big clusters when you only want some data and it makes sense |
579 | a8083063 | Iustin Pop | to specify a reduced set of output fields. |
580 | a8083063 | Iustin Pop | </para> |
581 | a8083063 | Iustin Pop | |
582 | a8083063 | Iustin Pop | <para>The default output field list is: |
583 | a8083063 | Iustin Pop | <simplelist type="inline"> |
584 | a8083063 | Iustin Pop | <member>name</member> |
585 | a8083063 | Iustin Pop | <member>os</member> |
586 | a8083063 | Iustin Pop | <member>pnode</member> |
587 | a8083063 | Iustin Pop | <member>admin_state</member> |
588 | a8083063 | Iustin Pop | <member>oper_state</member> |
589 | a8083063 | Iustin Pop | <member>oper_ram</member> |
590 | a8083063 | Iustin Pop | </simplelist>. |
591 | a8083063 | Iustin Pop | </para> |
592 | a8083063 | Iustin Pop | </refsect3> |
593 | a8083063 | Iustin Pop | |
594 | a8083063 | Iustin Pop | <refsect3> |
595 | a8083063 | Iustin Pop | <title>INFO</title> |
596 | a8083063 | Iustin Pop | |
597 | a8083063 | Iustin Pop | <cmdsynopsis> |
598 | a8083063 | Iustin Pop | <command>info</command> |
599 | a8083063 | Iustin Pop | <arg rep="repeat"><replaceable>instance</replaceable></arg> |
600 | a8083063 | Iustin Pop | </cmdsynopsis> |
601 | a8083063 | Iustin Pop | |
602 | a8083063 | Iustin Pop | <para> |
603 | a8083063 | Iustin Pop | Show detailed information about the (given) instances. This |
604 | a8083063 | Iustin Pop | is different from <command>list</command> as it shows |
605 | a8083063 | Iustin Pop | detailed data about the instance's disks (especially useful |
606 | bd028152 | Iustin Pop | for drbd disk template). |
607 | a8083063 | Iustin Pop | </para> |
608 | a8083063 | Iustin Pop | </refsect3> |
609 | a8083063 | Iustin Pop | |
610 | a8083063 | Iustin Pop | <refsect3> |
611 | a8083063 | Iustin Pop | <title>MODIFY</title> |
612 | a8083063 | Iustin Pop | |
613 | a8083063 | Iustin Pop | <cmdsynopsis> |
614 | a8083063 | Iustin Pop | <command>modify</command> |
615 | a8083063 | Iustin Pop | <arg choice="opt">-m <replaceable>memsize</replaceable></arg> |
616 | a8083063 | Iustin Pop | <arg choice="opt">-p <replaceable>vcpus</replaceable></arg> |
617 | a8083063 | Iustin Pop | <arg choice="opt">-i <replaceable>ip</replaceable></arg> |
618 | a8083063 | Iustin Pop | <arg choice="opt">-b <replaceable>bridge</replaceable></arg> |
619 | 61854511 | Iustin Pop | <arg choice="opt">--mac <replaceable>MAC-address</replaceable></arg> |
620 | 25c5878d | Alexander Schreiber | <arg>--hvm-boot-order <replaceable>boot-order</replaceable></arg> |
621 | ca9c49d5 | Iustin Pop | <arg>--hvm-acpi <replaceable>ACPI-support</replaceable></arg> |
622 | ca9c49d5 | Iustin Pop | <arg>--hvm-pae <replaceable>PAE-support</replaceable></arg> |
623 | ca9c49d5 | Iustin Pop | <arg>--hvm-cdrom-image-path |
624 | ca9c49d5 | Iustin Pop | <replaceable>cdrom-image-path</replaceable></arg> |
625 | ca9c49d5 | Iustin Pop | <arg>--vnc-bind-address |
626 | ca9c49d5 | Iustin Pop | <replaceable>vnc-bind-address</replaceable></arg> |
627 | ca9c49d5 | Iustin Pop | |
628 | 00f98619 | Iustin Pop | <sbr> |
629 | 00f98619 | Iustin Pop | <arg>--kernel <group choice="req"> |
630 | 00f98619 | Iustin Pop | <arg>default</arg> |
631 | 00f98619 | Iustin Pop | <arg><replaceable>kernel_path</replaceable></arg> |
632 | 00f98619 | Iustin Pop | </group></arg> |
633 | 00f98619 | Iustin Pop | <sbr> |
634 | 00f98619 | Iustin Pop | <arg>--initrd <group choice="req"> |
635 | 00f98619 | Iustin Pop | <arg>default</arg> |
636 | 00f98619 | Iustin Pop | <arg>none</arg> |
637 | 00f98619 | Iustin Pop | <arg><replaceable>initrd_path</replaceable></arg> |
638 | 00f98619 | Iustin Pop | </group> </arg> |
639 | 00f98619 | Iustin Pop | <sbr> |
640 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
641 | a8083063 | Iustin Pop | </cmdsynopsis> |
642 | a8083063 | Iustin Pop | |
643 | a8083063 | Iustin Pop | <para> |
644 | f3a55c90 | Alexander Schreiber | Modify the memory size, number of vcpus, ip address, MAC |
645 | f3a55c90 | Alexander Schreiber | address and/or bridge for an instance. |
646 | a8083063 | Iustin Pop | </para> |
647 | a8083063 | Iustin Pop | |
648 | a8083063 | Iustin Pop | <para> |
649 | a8083063 | Iustin Pop | The memory size is given in MiB. Note that you need to give |
650 | a8083063 | Iustin Pop | at least one of the arguments, otherwise the command |
651 | a8083063 | Iustin Pop | complains. |
652 | a8083063 | Iustin Pop | </para> |
653 | a8083063 | Iustin Pop | |
654 | a8083063 | Iustin Pop | <para> |
655 | 25c5878d | Alexander Schreiber | The <option>--kernel</option>, <option>--initrd</option> |
656 | 25c5878d | Alexander Schreiber | and <option>--hvm-boot-order</option> |
657 | 00f98619 | Iustin Pop | options are described in the <command>add</command> command. |
658 | 00f98619 | Iustin Pop | </para> |
659 | 00f98619 | Iustin Pop | |
660 | 00f98619 | Iustin Pop | <para> |
661 | 25c5878d | Alexander Schreiber | Additionally, the HVM boot order can be reset to the default |
662 | 25c5878d | Alexander Schreiber | values by using <option>--hvm-boot-order=default</option>. |
663 | 25c5878d | Alexander Schreiber | </para> |
664 | 25c5878d | Alexander Schreiber | |
665 | 25c5878d | Alexander Schreiber | <para> |
666 | ca9c49d5 | Iustin Pop | The <option>--hvm-acpi</option> option specifies if Xen |
667 | ca9c49d5 | Iustin Pop | should enable ACPI support for this HVM instance. Valid |
668 | ca9c49d5 | Iustin Pop | values are true or false. |
669 | ca9c49d5 | Iustin Pop | </para> |
670 | ca9c49d5 | Iustin Pop | |
671 | ca9c49d5 | Iustin Pop | <para> |
672 | ca9c49d5 | Iustin Pop | The <option>--hvm-pae</option> option specifies if Xen |
673 | ca9c49d5 | Iustin Pop | should enabled PAE support for this HVM instance. Valid |
674 | ca9c49d5 | Iustin Pop | values are true or false. |
675 | ca9c49d5 | Iustin Pop | </para> |
676 | ca9c49d5 | Iustin Pop | |
677 | ca9c49d5 | Iustin Pop | <para> |
678 | ca9c49d5 | Iustin Pop | The <option>--hvm-cdrom-image-path</option> specifies the |
679 | ca9c49d5 | Iustin Pop | path to the file xen uses to emulate a virtual CDROM drive |
680 | ca9c49d5 | Iustin Pop | for this HVM instance. Valid values are either an |
681 | ca9c49d5 | Iustin Pop | absolute path to an existing file or None, which disables |
682 | ca9c49d5 | Iustin Pop | virtual CDROM support for this instance. |
683 | ca9c49d5 | Iustin Pop | </para> |
684 | ca9c49d5 | Iustin Pop | |
685 | ca9c49d5 | Iustin Pop | <para> |
686 | ca9c49d5 | Iustin Pop | The <option>--vnc-bind-address</option> specifies the |
687 | ca9c49d5 | Iustin Pop | address that the VNC listener for this instance should bind |
688 | ca9c49d5 | Iustin Pop | to. Valid values are IPv4 addresses. Use the address 0.0.0.0 |
689 | ca9c49d5 | Iustin Pop | to bind to all available interfaces. |
690 | ca9c49d5 | Iustin Pop | </para> |
691 | ca9c49d5 | Iustin Pop | |
692 | ca9c49d5 | Iustin Pop | <para> |
693 | a8083063 | Iustin Pop | All the changes take effect at the next restart. If the |
694 | a8083063 | Iustin Pop | instance is running, there is no effect on the instance. |
695 | a8083063 | Iustin Pop | </para> |
696 | a8083063 | Iustin Pop | </refsect3> |
697 | a8083063 | Iustin Pop | |
698 | d0834de3 | Michael Hanselmann | <refsect3> |
699 | d0834de3 | Michael Hanselmann | <title>REINSTALL</title> |
700 | d0834de3 | Michael Hanselmann | |
701 | d0834de3 | Michael Hanselmann | <cmdsynopsis> |
702 | d0834de3 | Michael Hanselmann | <command>reinstall</command> |
703 | d0834de3 | Michael Hanselmann | <arg choice="opt">-o <replaceable>os-type</replaceable></arg> |
704 | d0834de3 | Michael Hanselmann | <arg choice="opt">-f <replaceable>force</replaceable></arg> |
705 | d0834de3 | Michael Hanselmann | <arg choice="req"><replaceable>instance</replaceable></arg> |
706 | d0834de3 | Michael Hanselmann | </cmdsynopsis> |
707 | d0834de3 | Michael Hanselmann | |
708 | d0834de3 | Michael Hanselmann | <para> |
709 | d0834de3 | Michael Hanselmann | Reinstalls the operating system on the given instance. The instance |
710 | d0834de3 | Michael Hanselmann | must be stopped when running this command. If the |
711 | d0834de3 | Michael Hanselmann | <option>--os-type</option> is specified, the operating system is |
712 | d0834de3 | Michael Hanselmann | changed. |
713 | d0834de3 | Michael Hanselmann | </para> |
714 | d0834de3 | Michael Hanselmann | </refsect3> |
715 | d0834de3 | Michael Hanselmann | |
716 | decd5f45 | Iustin Pop | <refsect3> |
717 | decd5f45 | Iustin Pop | <title>RENAME</title> |
718 | decd5f45 | Iustin Pop | |
719 | decd5f45 | Iustin Pop | <cmdsynopsis> |
720 | decd5f45 | Iustin Pop | <command>rename</command> |
721 | decd5f45 | Iustin Pop | <arg>--no-ip-check</arg> |
722 | decd5f45 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
723 | decd5f45 | Iustin Pop | <arg choice="req"><replaceable>new_name</replaceable></arg> |
724 | decd5f45 | Iustin Pop | </cmdsynopsis> |
725 | decd5f45 | Iustin Pop | |
726 | decd5f45 | Iustin Pop | <para> |
727 | decd5f45 | Iustin Pop | Renames the given instance. The instance must be stopped |
728 | decd5f45 | Iustin Pop | when running this command. The requirements for the new name |
729 | decd5f45 | Iustin Pop | are the same as for adding an instance: the new name must be |
730 | decd5f45 | Iustin Pop | resolvable and the IP it resolves to must not be reachable |
731 | decd5f45 | Iustin Pop | (in order to prevent duplicate IPs the next time the |
732 | decd5f45 | Iustin Pop | instance is started). The IP test can be skipped if the |
733 | decd5f45 | Iustin Pop | <option>--no-ip-check</option> option is passed. |
734 | decd5f45 | Iustin Pop | </para> |
735 | decd5f45 | Iustin Pop | </refsect3> |
736 | decd5f45 | Iustin Pop | |
737 | a8083063 | Iustin Pop | </refsect2> |
738 | a8083063 | Iustin Pop | |
739 | a8083063 | Iustin Pop | <refsect2> |
740 | a8083063 | Iustin Pop | <title>Starting/stopping/connecting to console</title> |
741 | a8083063 | Iustin Pop | |
742 | a8083063 | Iustin Pop | <refsect3> |
743 | a8083063 | Iustin Pop | <title>STARTUP</title> |
744 | a8083063 | Iustin Pop | |
745 | a8083063 | Iustin Pop | <cmdsynopsis> |
746 | a8083063 | Iustin Pop | <command>startup</command> |
747 | a8083063 | Iustin Pop | <arg>--extra=<replaceable>PARAMS</replaceable></arg> |
748 | 3bd5f059 | Michael Hanselmann | <arg>--force</arg> |
749 | 312ac745 | Iustin Pop | <sbr> |
750 | 312ac745 | Iustin Pop | <group choice="opt"> |
751 | 312ac745 | Iustin Pop | <arg>--instance</arg> |
752 | 312ac745 | Iustin Pop | <arg>--node</arg> |
753 | 312ac745 | Iustin Pop | <arg>--primary</arg> |
754 | 312ac745 | Iustin Pop | <arg>--secondary</arg> |
755 | 312ac745 | Iustin Pop | <arg>--all</arg> |
756 | 312ac745 | Iustin Pop | </group> |
757 | 312ac745 | Iustin Pop | <sbr> |
758 | 312ac745 | Iustin Pop | <arg choice="opt" |
759 | 312ac745 | Iustin Pop | rep="repeat"><replaceable>name</replaceable></arg> |
760 | a8083063 | Iustin Pop | </cmdsynopsis> |
761 | a8083063 | Iustin Pop | |
762 | a8083063 | Iustin Pop | <para> |
763 | bcee9cb4 | Iustin Pop | Starts one or more instances, depending on the following |
764 | bcee9cb4 | Iustin Pop | options. The four available modes are: |
765 | 312ac745 | Iustin Pop | <variablelist> |
766 | 312ac745 | Iustin Pop | <varlistentry> |
767 | 312ac745 | Iustin Pop | <term><option>--instance</option></term> |
768 | 312ac745 | Iustin Pop | <listitem> |
769 | 312ac745 | Iustin Pop | <simpara>will start the instances given as arguments |
770 | 312ac745 | Iustin Pop | (at least one argument required); this is the default |
771 | 312ac745 | Iustin Pop | selection</simpara> |
772 | 312ac745 | Iustin Pop | </listitem> |
773 | 312ac745 | Iustin Pop | </varlistentry> |
774 | 312ac745 | Iustin Pop | <varlistentry> |
775 | 312ac745 | Iustin Pop | <term>--node</term> |
776 | 312ac745 | Iustin Pop | <listitem> |
777 | 312ac745 | Iustin Pop | <simpara>will start the instances who have the given |
778 | 312ac745 | Iustin Pop | node as either primary or secondary</simpara> |
779 | 312ac745 | Iustin Pop | </listitem> |
780 | 312ac745 | Iustin Pop | </varlistentry> |
781 | 312ac745 | Iustin Pop | <varlistentry> |
782 | 312ac745 | Iustin Pop | <term><option>--primary</option></term> |
783 | 312ac745 | Iustin Pop | <listitem> |
784 | 312ac745 | Iustin Pop | <simpara>will start all instances whose primary node |
785 | 312ac745 | Iustin Pop | is in the list of nodes passed as arguments (at least |
786 | 312ac745 | Iustin Pop | one node required)</simpara> |
787 | 312ac745 | Iustin Pop | </listitem> |
788 | 312ac745 | Iustin Pop | </varlistentry> |
789 | 312ac745 | Iustin Pop | <varlistentry> |
790 | 312ac745 | Iustin Pop | <term><option>--secondary</option></term> |
791 | 312ac745 | Iustin Pop | <listitem> |
792 | 312ac745 | Iustin Pop | <simpara>will start all instances whose secondary node |
793 | 312ac745 | Iustin Pop | is in the list of nodes passed as arguments (at least |
794 | 312ac745 | Iustin Pop | one node required)</simpara> |
795 | 312ac745 | Iustin Pop | </listitem> |
796 | 312ac745 | Iustin Pop | </varlistentry> |
797 | 312ac745 | Iustin Pop | <varlistentry> |
798 | 312ac745 | Iustin Pop | <term>--all</term> |
799 | 312ac745 | Iustin Pop | <listitem> |
800 | 312ac745 | Iustin Pop | <simpara>will start all instances in the cluster (no |
801 | 312ac745 | Iustin Pop | arguments accepted)</simpara> |
802 | 312ac745 | Iustin Pop | </listitem> |
803 | 312ac745 | Iustin Pop | </varlistentry> |
804 | 312ac745 | Iustin Pop | </variablelist> |
805 | 312ac745 | Iustin Pop | </para> |
806 | 312ac745 | Iustin Pop | |
807 | 312ac745 | Iustin Pop | <para> |
808 | bcee9cb4 | Iustin Pop | Note that although you can pass more than one selection |
809 | bcee9cb4 | Iustin Pop | option, the last one wins, so in order to guarantee the |
810 | bcee9cb4 | Iustin Pop | desired result, don't pass more than one such option. |
811 | a8083063 | Iustin Pop | </para> |
812 | a8083063 | Iustin Pop | |
813 | a8083063 | Iustin Pop | <para> |
814 | a8083063 | Iustin Pop | The <option>--extra</option> option is used to pass |
815 | a8083063 | Iustin Pop | additional argument to the instance's kernel for this start |
816 | a8083063 | Iustin Pop | only. Currently there is no way to specify a persistent set |
817 | a8083063 | Iustin Pop | of arguments (beside the one hardcoded). Note that this may |
818 | a8083063 | Iustin Pop | not apply to all virtualization types. |
819 | a8083063 | Iustin Pop | </para> |
820 | a8083063 | Iustin Pop | |
821 | 3bd5f059 | Michael Hanselmann | <para> |
822 | 3bd5f059 | Michael Hanselmann | Use <option>--force</option> to start even if secondary disks are |
823 | 3bd5f059 | Michael Hanselmann | failing. |
824 | 3bd5f059 | Michael Hanselmann | </para> |
825 | a8083063 | Iustin Pop | |
826 | a8083063 | Iustin Pop | <para> |
827 | a8083063 | Iustin Pop | Example: |
828 | a8083063 | Iustin Pop | <screen> |
829 | a8083063 | Iustin Pop | # gnt-instance start instance1.example.com |
830 | a8083063 | Iustin Pop | # gnt-instance start --extra single test1.example.com |
831 | bcee9cb4 | Iustin Pop | # gnt-instance start --node node1.example.com node2.example.com |
832 | bcee9cb4 | Iustin Pop | # gnt-instance start --all |
833 | a8083063 | Iustin Pop | </screen> |
834 | a8083063 | Iustin Pop | </para> |
835 | a8083063 | Iustin Pop | </refsect3> |
836 | a8083063 | Iustin Pop | |
837 | a8083063 | Iustin Pop | <refsect3> |
838 | a8083063 | Iustin Pop | <title>SHUTDOWN</title> |
839 | a8083063 | Iustin Pop | |
840 | a8083063 | Iustin Pop | <cmdsynopsis> |
841 | a8083063 | Iustin Pop | <command>shutdown</command> |
842 | 312ac745 | Iustin Pop | <sbr> |
843 | 312ac745 | Iustin Pop | <group choice="opt"> |
844 | 312ac745 | Iustin Pop | <arg>--instance</arg> |
845 | 312ac745 | Iustin Pop | <arg>--node</arg> |
846 | 312ac745 | Iustin Pop | <arg>--primary</arg> |
847 | 312ac745 | Iustin Pop | <arg>--secondary</arg> |
848 | 312ac745 | Iustin Pop | <arg>--all</arg> |
849 | 312ac745 | Iustin Pop | </group> |
850 | 312ac745 | Iustin Pop | <sbr> |
851 | 312ac745 | Iustin Pop | |
852 | 312ac745 | Iustin Pop | <arg choice="opt" |
853 | 312ac745 | Iustin Pop | rep="repeat"><replaceable>name</replaceable></arg> |
854 | a8083063 | Iustin Pop | </cmdsynopsis> |
855 | a8083063 | Iustin Pop | |
856 | a8083063 | Iustin Pop | <para> |
857 | 312ac745 | Iustin Pop | Stops one or more instances. If the instance cannot be |
858 | 312ac745 | Iustin Pop | cleanly stopped during a hardcoded interval (currently 2 |
859 | 312ac745 | Iustin Pop | minutes), it will forcibly stop the instance (equivalent to |
860 | 312ac745 | Iustin Pop | switching off the power on a physical machine). |
861 | 312ac745 | Iustin Pop | </para> |
862 | 312ac745 | Iustin Pop | |
863 | 312ac745 | Iustin Pop | <para> |
864 | 312ac745 | Iustin Pop | The <option>--instance</option>, <option>--node</option>, |
865 | 312ac745 | Iustin Pop | <option>--primary</option>, <option>--secondary</option> and |
866 | 312ac745 | Iustin Pop | <option>--all</option> options are similar as for the |
867 | 312ac745 | Iustin Pop | <command>startup</command> command and they influence the |
868 | 86b8c6ae | Alexander Schreiber | actual instances being shutdown. |
869 | a8083063 | Iustin Pop | </para> |
870 | a8083063 | Iustin Pop | |
871 | a8083063 | Iustin Pop | <para> |
872 | a8083063 | Iustin Pop | Example: |
873 | a8083063 | Iustin Pop | <screen> |
874 | a8083063 | Iustin Pop | # gnt-instance shutdown instance1.example.com |
875 | bcee9cb4 | Iustin Pop | # gnt-instance shutdown --all |
876 | a8083063 | Iustin Pop | </screen> |
877 | a8083063 | Iustin Pop | </para> |
878 | a8083063 | Iustin Pop | </refsect3> |
879 | a8083063 | Iustin Pop | |
880 | a8083063 | Iustin Pop | <refsect3> |
881 | 579d4337 | Alexander Schreiber | <title>REBOOT</title> |
882 | 579d4337 | Alexander Schreiber | |
883 | 579d4337 | Alexander Schreiber | <cmdsynopsis> |
884 | 579d4337 | Alexander Schreiber | <command>reboot</command> |
885 | 579d4337 | Alexander Schreiber | <sbr> |
886 | 579d4337 | Alexander Schreiber | <arg>--extra=<replaceable>PARAMS</replaceable></arg> |
887 | 579d4337 | Alexander Schreiber | <sbr> |
888 | 579d4337 | Alexander Schreiber | <arg>--type=<replaceable>REBOOT-TYPE</replaceable></arg> |
889 | 579d4337 | Alexander Schreiber | <sbr> |
890 | 579d4337 | Alexander Schreiber | <arg>--ignore-secondaries</arg> |
891 | 579d4337 | Alexander Schreiber | <sbr> |
892 | 579d4337 | Alexander Schreiber | <arg>--force-multiple</arg> |
893 | 579d4337 | Alexander Schreiber | <sbr> |
894 | 579d4337 | Alexander Schreiber | <group choice="opt"> |
895 | 579d4337 | Alexander Schreiber | <arg>--instance</arg> |
896 | 579d4337 | Alexander Schreiber | <arg>--node</arg> |
897 | 579d4337 | Alexander Schreiber | <arg>--primary</arg> |
898 | 579d4337 | Alexander Schreiber | <arg>--secondary</arg> |
899 | 579d4337 | Alexander Schreiber | <arg>--all</arg> |
900 | 579d4337 | Alexander Schreiber | </group> |
901 | 579d4337 | Alexander Schreiber | <sbr> |
902 | 579d4337 | Alexander Schreiber | |
903 | 579d4337 | Alexander Schreiber | <arg choice="opt" |
904 | 579d4337 | Alexander Schreiber | rep="repeat"><replaceable>name</replaceable></arg> |
905 | 579d4337 | Alexander Schreiber | </cmdsynopsis> |
906 | 579d4337 | Alexander Schreiber | |
907 | 579d4337 | Alexander Schreiber | <para> |
908 | 579d4337 | Alexander Schreiber | Reboots one or more instances. The type of reboot depends on |
909 | 579d4337 | Alexander Schreiber | the value of <option>--type</option>. A soft reboot does a |
910 | 579d4337 | Alexander Schreiber | hypervisor reboot, a hard reboot does a instance stop, |
911 | 579d4337 | Alexander Schreiber | recreates the hypervisor config for the instance and |
912 | 579d4337 | Alexander Schreiber | starts the instance. A full reboot does the equivalent |
913 | 579d4337 | Alexander Schreiber | of <command>gnt-instance shutdown && gnt-instance |
914 | 579d4337 | Alexander Schreiber | startup</command>. The default is soft reboot. |
915 | 579d4337 | Alexander Schreiber | </para> |
916 | 579d4337 | Alexander Schreiber | |
917 | 579d4337 | Alexander Schreiber | <para> |
918 | 579d4337 | Alexander Schreiber | For the hard reboot the option |
919 | 579d4337 | Alexander Schreiber | <option>--ignore-secondaries</option> ignores errors for the |
920 | 579d4337 | Alexander Schreiber | secondary node while re-assembling the instance disks. |
921 | 579d4337 | Alexander Schreiber | </para> |
922 | 579d4337 | Alexander Schreiber | |
923 | 579d4337 | Alexander Schreiber | <para> |
924 | 579d4337 | Alexander Schreiber | The <option>--instance</option>, <option>--node</option>, |
925 | 579d4337 | Alexander Schreiber | <option>--primary</option>, <option>--secondary</option> and |
926 | 579d4337 | Alexander Schreiber | <option>--all</option> options are similar as for the |
927 | 579d4337 | Alexander Schreiber | <command>startup</command> command and they influence the |
928 | 579d4337 | Alexander Schreiber | actual instances being rebooted. |
929 | 579d4337 | Alexander Schreiber | </para> |
930 | 36c87212 | Iustin Pop | |
931 | 579d4337 | Alexander Schreiber | <para> |
932 | 3bd5f059 | Michael Hanselmann | Use the <option>--force-multiple</option> option to keep |
933 | 579d4337 | Alexander Schreiber | gnt-instance from asking for confirmation when more than one |
934 | 579d4337 | Alexander Schreiber | instance is affected. |
935 | 579d4337 | Alexander Schreiber | </para> |
936 | 579d4337 | Alexander Schreiber | |
937 | 579d4337 | Alexander Schreiber | <para> |
938 | 579d4337 | Alexander Schreiber | Example: |
939 | 579d4337 | Alexander Schreiber | <screen> |
940 | 579d4337 | Alexander Schreiber | # gnt-instance reboot instance1.example.com |
941 | 579d4337 | Alexander Schreiber | # gnt-instance reboot --type=full instance1.example.com |
942 | 579d4337 | Alexander Schreiber | </screen> |
943 | 579d4337 | Alexander Schreiber | </para> |
944 | 579d4337 | Alexander Schreiber | </refsect3> |
945 | 579d4337 | Alexander Schreiber | |
946 | 579d4337 | Alexander Schreiber | <refsect3> |
947 | a8083063 | Iustin Pop | <title>CONSOLE</title> |
948 | a8083063 | Iustin Pop | <cmdsynopsis> |
949 | a8083063 | Iustin Pop | <command>console</command> |
950 | 51c6e7b5 | Michael Hanselmann | <arg choice="opt">--show-cmd</arg> |
951 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
952 | a8083063 | Iustin Pop | </cmdsynopsis> |
953 | a8083063 | Iustin Pop | |
954 | a8083063 | Iustin Pop | <para> |
955 | a8083063 | Iustin Pop | Connects to the console of the given instance. If the instance |
956 | 51c6e7b5 | Michael Hanselmann | is not up, an error is returned. Use the <option>--show-cmd</option> |
957 | 51c6e7b5 | Michael Hanselmann | option to display the command instead of executing it. |
958 | a8083063 | Iustin Pop | </para> |
959 | a8083063 | Iustin Pop | |
960 | a8083063 | Iustin Pop | <para> |
961 | a8083063 | Iustin Pop | Example: |
962 | a8083063 | Iustin Pop | <screen> |
963 | a8083063 | Iustin Pop | # gnt-instance console instance1.example.com |
964 | a8083063 | Iustin Pop | </screen> |
965 | a8083063 | Iustin Pop | </para> |
966 | a8083063 | Iustin Pop | </refsect3> |
967 | a8083063 | Iustin Pop | |
968 | a8083063 | Iustin Pop | </refsect2> |
969 | a8083063 | Iustin Pop | |
970 | a8083063 | Iustin Pop | <refsect2> |
971 | a8083063 | Iustin Pop | <title>Disk management</title> |
972 | a8083063 | Iustin Pop | |
973 | a8083063 | Iustin Pop | <refsect3> |
974 | a8083063 | Iustin Pop | <title>REPLACE-DISKS</title> |
975 | a8083063 | Iustin Pop | |
976 | a8083063 | Iustin Pop | <cmdsynopsis> |
977 | a8083063 | Iustin Pop | <command>replace-disks</command> |
978 | 6536dfa1 | Guido Trotter | <arg choice="opt">-s</arg> |
979 | a8083063 | Iustin Pop | <arg choice="req">--new-secondary <replaceable>NODE</replaceable></arg> |
980 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
981 | a8083063 | Iustin Pop | </cmdsynopsis> |
982 | a8083063 | Iustin Pop | |
983 | 0b0dea6a | Iustin Pop | <cmdsynopsis> |
984 | 0b0dea6a | Iustin Pop | <command>replace-disks</command> |
985 | 0b0dea6a | Iustin Pop | <group> |
986 | 0b0dea6a | Iustin Pop | <arg choice="req">-s</arg> |
987 | 0b0dea6a | Iustin Pop | <arg choice="req">-p</arg> |
988 | 0b0dea6a | Iustin Pop | </group> |
989 | 0b0dea6a | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
990 | 0b0dea6a | Iustin Pop | </cmdsynopsis> |
991 | 0b0dea6a | Iustin Pop | |
992 | a8083063 | Iustin Pop | <para> |
993 | 0b0dea6a | Iustin Pop | This command is a generalized form for adding and replacing |
994 | bd028152 | Iustin Pop | disks. It is currently only valid for the mirrored (DRBD) |
995 | bd028152 | Iustin Pop | disk template. |
996 | a8083063 | Iustin Pop | </para> |
997 | 0b0dea6a | Iustin Pop | |
998 | 0b0dea6a | Iustin Pop | <para> |
999 | bd028152 | Iustin Pop | The first form will do a secondary node change, while the |
1000 | bd028152 | Iustin Pop | second form will replace the disks on either the primary |
1001 | 0b0dea6a | Iustin Pop | (<option>-p</option>) or the secondary (<option>-s</option>) |
1002 | 0b0dea6a | Iustin Pop | node of the instance only, without changing the node. |
1003 | 0b0dea6a | Iustin Pop | </para> |
1004 | 0b0dea6a | Iustin Pop | |
1005 | a8083063 | Iustin Pop | </refsect3> |
1006 | a8083063 | Iustin Pop | |
1007 | a8083063 | Iustin Pop | <refsect3> |
1008 | a8083063 | Iustin Pop | <title>ACTIVATE-DISKS</title> |
1009 | a8083063 | Iustin Pop | |
1010 | a8083063 | Iustin Pop | <cmdsynopsis> |
1011 | a8083063 | Iustin Pop | <command>activate-disks</command> |
1012 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
1013 | a8083063 | Iustin Pop | </cmdsynopsis> |
1014 | a8083063 | Iustin Pop | <para> |
1015 | a8083063 | Iustin Pop | Activates the block devices of the given instance. If |
1016 | a8083063 | Iustin Pop | successful, the command will show the location and name of |
1017 | a8083063 | Iustin Pop | the block devices: |
1018 | a8083063 | Iustin Pop | <screen> |
1019 | bd028152 | Iustin Pop | node1.example.com:sda:/dev/drbd0 |
1020 | bd028152 | Iustin Pop | node1.example.com:sdb:/dev/drbd1 |
1021 | a8083063 | Iustin Pop | </screen> |
1022 | a8083063 | Iustin Pop | |
1023 | a8083063 | Iustin Pop | In this example, <emphasis>node1.example.com</emphasis> is |
1024 | a8083063 | Iustin Pop | the name of the node on which the devices have been |
1025 | a8083063 | Iustin Pop | activated. The <emphasis>sda</emphasis> and |
1026 | a8083063 | Iustin Pop | <emphasis>sdb</emphasis> are the names of the block devices |
1027 | bd028152 | Iustin Pop | inside the instance. <emphasis>/dev/drbd0</emphasis> and |
1028 | bd028152 | Iustin Pop | <emphasis>/dev/drbd1</emphasis> are the names of the block |
1029 | a8083063 | Iustin Pop | devices as visible on the node. |
1030 | a8083063 | Iustin Pop | </para> |
1031 | a8083063 | Iustin Pop | |
1032 | a8083063 | Iustin Pop | <para> |
1033 | a8083063 | Iustin Pop | Note that it is safe to run this command while the instance |
1034 | a8083063 | Iustin Pop | is already running. |
1035 | a8083063 | Iustin Pop | </para> |
1036 | a8083063 | Iustin Pop | </refsect3> |
1037 | a8083063 | Iustin Pop | |
1038 | a8083063 | Iustin Pop | <refsect3> |
1039 | a8083063 | Iustin Pop | <title>DEACTIVATE-DISKS</title> |
1040 | a8083063 | Iustin Pop | |
1041 | a8083063 | Iustin Pop | <cmdsynopsis> |
1042 | a8083063 | Iustin Pop | <command>deactivate-disks</command> |
1043 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
1044 | a8083063 | Iustin Pop | </cmdsynopsis> |
1045 | a8083063 | Iustin Pop | <para> |
1046 | a8083063 | Iustin Pop | De-activates the block devices of the given instance. Note |
1047 | bd028152 | Iustin Pop | that if you run this command for an instance with a drbd |
1048 | bd028152 | Iustin Pop | disk template, while it is running, it will not be able to |
1049 | bd028152 | Iustin Pop | shutdown the block devices on the primary node, but it will |
1050 | bd028152 | Iustin Pop | shutdown the block devices on the secondary nodes, thus |
1051 | bd028152 | Iustin Pop | breaking the replication. |
1052 | a8083063 | Iustin Pop | </para> |
1053 | a8083063 | Iustin Pop | |
1054 | a8083063 | Iustin Pop | </refsect3> |
1055 | a8083063 | Iustin Pop | |
1056 | a8083063 | Iustin Pop | </refsect2> |
1057 | a8083063 | Iustin Pop | |
1058 | a8083063 | Iustin Pop | <refsect2> |
1059 | a8083063 | Iustin Pop | <title>Recovery</title> |
1060 | a8083063 | Iustin Pop | |
1061 | a8083063 | Iustin Pop | <refsect3> |
1062 | a8083063 | Iustin Pop | <title>FAILOVER</title> |
1063 | a8083063 | Iustin Pop | |
1064 | a8083063 | Iustin Pop | <cmdsynopsis> |
1065 | a8083063 | Iustin Pop | <command>failover</command> |
1066 | a8083063 | Iustin Pop | <arg>-f</arg> |
1067 | a8083063 | Iustin Pop | <arg>--ignore-consistency</arg> |
1068 | 80de0e3f | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
1069 | a8083063 | Iustin Pop | </cmdsynopsis> |
1070 | a8083063 | Iustin Pop | |
1071 | a8083063 | Iustin Pop | <para> |
1072 | 80de0e3f | Iustin Pop | Failover will fail the instance over its secondary |
1073 | bd028152 | Iustin Pop | node. This works only for instances having a drbd disk |
1074 | bd028152 | Iustin Pop | template. |
1075 | a8083063 | Iustin Pop | </para> |
1076 | a8083063 | Iustin Pop | |
1077 | a8083063 | Iustin Pop | <para> |
1078 | a8083063 | Iustin Pop | Normally the failover will check the consistency of the |
1079 | 80de0e3f | Iustin Pop | disks before failing over the instance. If you are trying to |
1080 | a8083063 | Iustin Pop | migrate instances off a dead node, this will fail. Use the |
1081 | a8083063 | Iustin Pop | <option>--ignore-consistency</option> option for this |
1082 | 24a40d57 | Iustin Pop | purpose. Note that this option can be dangerous as errors in |
1083 | 24a40d57 | Iustin Pop | shutting down the instance will be ignored, resulting in |
1084 | 24a40d57 | Iustin Pop | possibly having the instance running on two machines in |
1085 | 24a40d57 | Iustin Pop | parallel (on disconnected DRBD drives). |
1086 | a8083063 | Iustin Pop | </para> |
1087 | a8083063 | Iustin Pop | |
1088 | a8083063 | Iustin Pop | <para> |
1089 | a8083063 | Iustin Pop | Example: |
1090 | a8083063 | Iustin Pop | <screen> |
1091 | a8083063 | Iustin Pop | # gnt-instance failover instance1.example.com |
1092 | a8083063 | Iustin Pop | </screen> |
1093 | a8083063 | Iustin Pop | </para> |
1094 | a8083063 | Iustin Pop | </refsect3> |
1095 | a8083063 | Iustin Pop | |
1096 | a8083063 | Iustin Pop | </refsect2> |
1097 | a8083063 | Iustin Pop | |
1098 | cc425644 | Iustin Pop | <refsect2> |
1099 | cc425644 | Iustin Pop | <title>TAGS</title> |
1100 | cc425644 | Iustin Pop | |
1101 | cc425644 | Iustin Pop | <refsect3> |
1102 | cc425644 | Iustin Pop | <title>ADD-TAGS</title> |
1103 | cc425644 | Iustin Pop | |
1104 | cc425644 | Iustin Pop | <cmdsynopsis> |
1105 | cc425644 | Iustin Pop | <command>add-tags</command> |
1106 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
1107 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>instancename</replaceable></arg> |
1108 | cc425644 | Iustin Pop | <arg choice="req" |
1109 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
1110 | cc425644 | Iustin Pop | </cmdsynopsis> |
1111 | cc425644 | Iustin Pop | |
1112 | cc425644 | Iustin Pop | <para> |
1113 | cc425644 | Iustin Pop | Add tags to the given instance. If any of the tags contains |
1114 | cc425644 | Iustin Pop | invalid characters, the entire operation will abort. |
1115 | cc425644 | Iustin Pop | </para> |
1116 | 810c50b7 | Iustin Pop | <para> |
1117 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
1118 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
1119 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
1120 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
1121 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
1122 | 810c50b7 | Iustin Pop | </para> |
1123 | cc425644 | Iustin Pop | </refsect3> |
1124 | cc425644 | Iustin Pop | |
1125 | cc425644 | Iustin Pop | <refsect3> |
1126 | cc425644 | Iustin Pop | <title>LIST-TAGS</title> |
1127 | cc425644 | Iustin Pop | |
1128 | cc425644 | Iustin Pop | <cmdsynopsis> |
1129 | cc425644 | Iustin Pop | <command>list-tags</command> |
1130 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>instancename</replaceable></arg> |
1131 | cc425644 | Iustin Pop | </cmdsynopsis> |
1132 | cc425644 | Iustin Pop | |
1133 | cc425644 | Iustin Pop | <para>List the tags of the given instance.</para> |
1134 | cc425644 | Iustin Pop | </refsect3> |
1135 | cc425644 | Iustin Pop | |
1136 | cc425644 | Iustin Pop | <refsect3> |
1137 | cc425644 | Iustin Pop | <title>REMOVE-TAGS</title> |
1138 | cc425644 | Iustin Pop | <cmdsynopsis> |
1139 | cc425644 | Iustin Pop | <command>remove-tags</command> |
1140 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
1141 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>instancename</replaceable></arg> |
1142 | cc425644 | Iustin Pop | <arg choice="req" |
1143 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
1144 | cc425644 | Iustin Pop | </cmdsynopsis> |
1145 | cc425644 | Iustin Pop | |
1146 | cc425644 | Iustin Pop | <para> |
1147 | cc425644 | Iustin Pop | Remove tags from the given instance. If any of the tags are |
1148 | cc425644 | Iustin Pop | not existing on the node, the entire operation will abort. |
1149 | cc425644 | Iustin Pop | </para> |
1150 | 810c50b7 | Iustin Pop | |
1151 | 810c50b7 | Iustin Pop | <para> |
1152 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
1153 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
1154 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
1155 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
1156 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
1157 | 810c50b7 | Iustin Pop | </para> |
1158 | cc425644 | Iustin Pop | </refsect3> |
1159 | cc425644 | Iustin Pop | |
1160 | cc425644 | Iustin Pop | </refsect2> |
1161 | cc425644 | Iustin Pop | |
1162 | a8083063 | Iustin Pop | </refsect1> |
1163 | a8083063 | Iustin Pop | |
1164 | a8083063 | Iustin Pop | &footer; |
1165 | a8083063 | Iustin Pop | |
1166 | a8083063 | Iustin Pop | </refentry> |
1167 | a8083063 | Iustin Pop | |
1168 | a8083063 | Iustin Pop | <!-- Keep this comment at the end of the file |
1169 | a8083063 | Iustin Pop | Local variables: |
1170 | a8083063 | Iustin Pop | mode: sgml |
1171 | a8083063 | Iustin Pop | sgml-omittag:t |
1172 | a8083063 | Iustin Pop | sgml-shorttag:t |
1173 | a8083063 | Iustin Pop | sgml-minimize-attributes:nil |
1174 | a8083063 | Iustin Pop | sgml-always-quote-attributes:t |
1175 | a8083063 | Iustin Pop | sgml-indent-step:2 |
1176 | a8083063 | Iustin Pop | sgml-indent-data:t |
1177 | a8083063 | Iustin Pop | sgml-parent-document:nil |
1178 | a8083063 | Iustin Pop | sgml-default-dtd-file:nil |
1179 | a8083063 | Iustin Pop | sgml-exposed-tags:nil |
1180 | a8083063 | Iustin Pop | sgml-local-catalogs:nil |
1181 | a8083063 | Iustin Pop | sgml-local-ecat-files:nil |
1182 | a8083063 | Iustin Pop | End: |
1183 | a8083063 | Iustin Pop | --> |