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