root / man / gnt-instance.rst @ 031d2db1
History | View | Annotate | Download (72.5 kB)
1 |
gnt-instance(8) Ganeti | Version @GANETI_VERSION@ |
---|---|
2 |
================================================= |
3 |
|
4 |
Name |
5 |
---- |
6 |
|
7 |
gnt-instance - Ganeti instance administration |
8 |
|
9 |
Synopsis |
10 |
-------- |
11 |
|
12 |
**gnt-instance** {command} [arguments...] |
13 |
|
14 |
DESCRIPTION |
15 |
----------- |
16 |
|
17 |
The **gnt-instance** command is used for instance administration in |
18 |
the Ganeti system. |
19 |
|
20 |
COMMANDS |
21 |
-------- |
22 |
|
23 |
Creation/removal/querying |
24 |
~~~~~~~~~~~~~~~~~~~~~~~~~ |
25 |
|
26 |
ADD |
27 |
^^^ |
28 |
|
29 |
| **add** |
30 |
| {-t|\--disk-template {diskless \| file \| plain \| drbd \| rbd}} |
31 |
| {\--disk=*N*: {size=*VAL*[,spindles=*VAL*] \| adopt=*LV*}[,options...] |
32 |
| \| {size=*VAL*,provider=*PROVIDER*}[,param=*value*... ][,options...] |
33 |
| \| {-s|\--os-size} *SIZE*} |
34 |
| [\--no-ip-check] [\--no-name-check] [\--no-conflicts-check] |
35 |
| [\--no-start] [\--no-install] |
36 |
| [\--net=*N* [:options...] \| \--no-nics] |
37 |
| [{-B|\--backend-parameters} *BEPARAMS*] |
38 |
| [{-H|\--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]] |
39 |
| [{-O|\--os-parameters} *param*=*value*... ] |
40 |
| [\--file-storage-dir *dir\_path*] [\--file-driver {loop \| blktap}] |
41 |
| {{-n|\--node} *node[:secondary-node]* \| {-I|\--iallocator} *name*} |
42 |
| {{-o|\--os-type} *os-type*} |
43 |
| [\--submit] [\--print-job-id] |
44 |
| [\--ignore-ipolicy] |
45 |
| {*instance*} |
46 |
|
47 |
Creates a new instance on the specified host. The *instance* argument |
48 |
must be in DNS, but depending on the bridge/routing setup, need not be |
49 |
in the same network as the nodes in the cluster. |
50 |
|
51 |
The ``disk`` option specifies the parameters for the disks of the |
52 |
instance. The numbering of disks starts at zero, and at least one disk |
53 |
needs to be passed. For each disk, either the size or the adoption |
54 |
source needs to be given. The size is interpreted (when no unit is |
55 |
given) in mebibytes. You can also use one of the suffixes *m*, *g* or |
56 |
*t* to specify the exact the units used; these suffixes map to |
57 |
mebibytes, gibibytes and tebibytes. Each disk can also take these |
58 |
parameters (all optional): |
59 |
|
60 |
spindles |
61 |
How many spindles (physical disks on the node) the disk should span. |
62 |
|
63 |
mode |
64 |
The access mode. Either ``ro`` (read-only) or the default ``rw`` |
65 |
(read-write). |
66 |
|
67 |
name |
68 |
This option specifies a name for the disk, which can be used as a disk |
69 |
identifier. An instance can not have two disks with the same name. |
70 |
|
71 |
vg |
72 |
The LVM volume group. This works only for LVM and DRBD devices. |
73 |
|
74 |
metavg |
75 |
This options specifies a different VG for the metadata device. This |
76 |
works only for DRBD devices |
77 |
|
78 |
When creating ExtStorage disks, also arbitrary parameters can be passed, |
79 |
to the ExtStorage provider. Those parameters are passed as additional |
80 |
comma separated options. Therefore, an ExtStorage disk provided by |
81 |
provider ``pvdr1`` with parameters ``param1``, ``param2`` would be |
82 |
passed as ``--disk 0:size=10G,provider=pvdr1,param1=val1,param2=val2``. |
83 |
|
84 |
When using the ``adopt`` key in the disk definition, Ganeti will |
85 |
reuse those volumes (instead of creating new ones) as the |
86 |
instance's disks. Ganeti will rename these volumes to the standard |
87 |
format, and (without installing the OS) will use them as-is for the |
88 |
instance. This allows migrating instances from non-managed mode |
89 |
(e.g. plain KVM with LVM) to being managed via Ganeti. Please note that |
90 |
this works only for the \`plain' disk template (see below for |
91 |
template details). |
92 |
|
93 |
Alternatively, a single-disk instance can be created via the ``-s`` |
94 |
option which takes a single argument, the size of the disk. This is |
95 |
similar to the Ganeti 1.2 version (but will only create one disk). |
96 |
|
97 |
The minimum disk specification is therefore ``--disk 0:size=20G`` (or |
98 |
``-s 20G`` when using the ``-s`` option), and a three-disk instance |
99 |
can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk |
100 |
2:size=100G``. |
101 |
|
102 |
The minimum information needed to specify an ExtStorage disk are the |
103 |
``size`` and the ``provider``. For example: |
104 |
``--disk 0:size=20G,provider=pvdr1``. |
105 |
|
106 |
The ``--no-ip-check`` skips the checks that are done to see if the |
107 |
instance's IP is not already alive (i.e. reachable from the master |
108 |
node). |
109 |
|
110 |
The ``--no-name-check`` skips the check for the instance name via |
111 |
the resolver (e.g. in DNS or /etc/hosts, depending on your setup). |
112 |
Since the name check is used to compute the IP address, if you pass |
113 |
this option you must also pass the ``--no-ip-check`` option. |
114 |
|
115 |
If you don't want the instance to automatically start after |
116 |
creation, this is possible via the ``--no-start`` option. This will |
117 |
leave the instance down until a subsequent **gnt-instance start** |
118 |
command. |
119 |
|
120 |
The NICs of the instances can be specified via the ``--net`` |
121 |
option. By default, one NIC is created for the instance, with a |
122 |
random MAC, and set up according the the cluster level NIC |
123 |
parameters. Each NIC can take these parameters (all optional): |
124 |
|
125 |
mac |
126 |
either a value or 'generate' to generate a new unique MAC |
127 |
|
128 |
ip |
129 |
specifies the IP address assigned to the instance from the Ganeti |
130 |
side (this is not necessarily what the instance will use, but what |
131 |
the node expects the instance to use). Note that if an IP in the |
132 |
range of a network configured with **gnt-network**\(8) is used, |
133 |
and the NIC is not already connected to it, this network has to be |
134 |
passed in the **network** parameter if this NIC is meant to be |
135 |
connected to the said network. ``--no-conflicts-check`` can be used |
136 |
to override this check. The special value **pool** causes Ganeti to |
137 |
select an IP from the the network the NIC is or will be connected to. |
138 |
One can pick an externally reserved IP of a network along with |
139 |
``--no-conflict-check``. Note that this IP cannot be assigned to |
140 |
any other instance until it gets released. |
141 |
|
142 |
mode |
143 |
specifies the connection mode for this NIC: routed, bridged or |
144 |
openvswitch. |
145 |
|
146 |
link |
147 |
in bridged or openvswitch mode specifies the interface to attach |
148 |
this NIC to, in routed mode it's intended to differentiate between |
149 |
different routing tables/instance groups (but the meaning is |
150 |
dependent on the network script, see **gnt-cluster**\(8) for more |
151 |
details). Note that openvswitch support is also hypervisor |
152 |
dependent. |
153 |
|
154 |
network |
155 |
derives the mode and the link from the settings of the network |
156 |
which is identified by its name. If the network option is chosen, |
157 |
link and mode must not be specified. Note that the mode and link |
158 |
depend on the network-to-nodegroup connection, thus allowing |
159 |
different nodegroups to be connected to the same network in |
160 |
different ways. |
161 |
|
162 |
name |
163 |
this option specifies a name for the NIC, which can be used as a NIC |
164 |
identifier. An instance can not have two NICs with the same name. |
165 |
|
166 |
vlan |
167 |
in openvswitch mode specifies the VLANs that the NIC will be |
168 |
connected to. To connect as an access port use ``n`` or ``.n`` with |
169 |
**n** being the VLAN ID. To connect as an trunk port use ``:n[:n]``. |
170 |
A hybrid port can be created with ``.n:n[:n]`` |
171 |
|
172 |
Of these "mode" and "link" are NIC parameters, and inherit their |
173 |
default at cluster level. Alternatively, if no network is desired for |
174 |
the instance, you can prevent the default of one NIC with the |
175 |
``--no-nics`` option. |
176 |
|
177 |
The ``-o (--os-type)`` option specifies the operating system to be |
178 |
installed. The available operating systems can be listed with |
179 |
**gnt-os list**. Passing ``--no-install`` will however skip the OS |
180 |
installation, allowing a manual import if so desired. Note that the |
181 |
no-installation mode will automatically disable the start-up of the |
182 |
instance (without an OS, it most likely won't be able to start-up |
183 |
successfully). |
184 |
|
185 |
The ``-B (--backend-parameters)`` option specifies the backend |
186 |
parameters for the instance. If no such parameters are specified, the |
187 |
values are inherited from the cluster. Possible parameters are: |
188 |
|
189 |
maxmem |
190 |
the maximum memory size of the instance; as usual, suffixes can be |
191 |
used to denote the unit, otherwise the value is taken in mebibytes |
192 |
|
193 |
minmem |
194 |
the minimum memory size of the instance; as usual, suffixes can be |
195 |
used to denote the unit, otherwise the value is taken in mebibytes |
196 |
|
197 |
vcpus |
198 |
the number of VCPUs to assign to the instance (if this value makes |
199 |
sense for the hypervisor) |
200 |
|
201 |
auto\_balance |
202 |
whether the instance is considered in the N+1 cluster checks |
203 |
(enough redundancy in the cluster to survive a node failure) |
204 |
|
205 |
always\_failover |
206 |
``True`` or ``False``, whether the instance must be failed over |
207 |
(shut down and rebooted) always or it may be migrated (briefly |
208 |
suspended) |
209 |
|
210 |
Note that before 2.6 Ganeti had a ``memory`` parameter, which was the |
211 |
only value of memory an instance could have. With the |
212 |
``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum |
213 |
memory is always available for an instance, but allows more memory to be |
214 |
used (up to the maximum memory) should it be free. |
215 |
|
216 |
The ``-H (--hypervisor-parameters)`` option specified the hypervisor |
217 |
to use for the instance (must be one of the enabled hypervisors on the |
218 |
cluster) and optionally custom parameters for this instance. If not |
219 |
other options are used (i.e. the invocation is just -H *NAME*) the |
220 |
instance will inherit the cluster options. The defaults below show the |
221 |
cluster defaults at cluster creation time. |
222 |
|
223 |
The possible hypervisor options are as follows: |
224 |
|
225 |
boot\_order |
226 |
Valid for the Xen HVM and KVM hypervisors. |
227 |
|
228 |
A string value denoting the boot order. This has different meaning |
229 |
for the Xen HVM hypervisor and for the KVM one. |
230 |
|
231 |
For Xen HVM, The boot order is a string of letters listing the boot |
232 |
devices, with valid device letters being: |
233 |
|
234 |
a |
235 |
floppy drive |
236 |
|
237 |
c |
238 |
hard disk |
239 |
|
240 |
d |
241 |
CDROM drive |
242 |
|
243 |
n |
244 |
network boot (PXE) |
245 |
|
246 |
The default is not to set an HVM boot order, which is interpreted |
247 |
as 'dc'. |
248 |
|
249 |
For KVM the boot order is either "floppy", "cdrom", "disk" or |
250 |
"network". Please note that older versions of KVM couldn't netboot |
251 |
from virtio interfaces. This has been fixed in more recent versions |
252 |
and is confirmed to work at least with qemu-kvm 0.11.1. Also note |
253 |
that if you have set the ``kernel_path`` option, that will be used |
254 |
for booting, and this setting will be silently ignored. |
255 |
|
256 |
blockdev\_prefix |
257 |
Valid for the Xen HVM and PVM hypervisors. |
258 |
|
259 |
Relevant to non-pvops guest kernels, in which the disk device names |
260 |
are given by the host. Allows one to specify 'xvd', which helps run |
261 |
Red Hat based installers, driven by anaconda. |
262 |
|
263 |
floppy\_image\_path |
264 |
Valid for the KVM hypervisor. |
265 |
|
266 |
The path to a floppy disk image to attach to the instance. This |
267 |
is useful to install Windows operating systems on Virt/IO disks |
268 |
because you can specify here the floppy for the drivers at |
269 |
installation time. |
270 |
|
271 |
cdrom\_image\_path |
272 |
Valid for the Xen HVM and KVM hypervisors. |
273 |
|
274 |
The path to a CDROM image to attach to the instance. |
275 |
|
276 |
cdrom2\_image\_path |
277 |
Valid for the KVM hypervisor. |
278 |
|
279 |
The path to a second CDROM image to attach to the instance. |
280 |
**NOTE**: This image can't be used to boot the system. To do that |
281 |
you have to use the 'cdrom\_image\_path' option. |
282 |
|
283 |
nic\_type |
284 |
Valid for the Xen HVM and KVM hypervisors. |
285 |
|
286 |
This parameter determines the way the network cards are presented |
287 |
to the instance. The possible options are: |
288 |
|
289 |
- rtl8139 (default for Xen HVM) (HVM & KVM) |
290 |
- ne2k\_isa (HVM & KVM) |
291 |
- ne2k\_pci (HVM & KVM) |
292 |
- i82551 (KVM) |
293 |
- i82557b (KVM) |
294 |
- i82559er (KVM) |
295 |
- pcnet (KVM) |
296 |
- e1000 (KVM) |
297 |
- paravirtual (default for KVM) (HVM & KVM) |
298 |
|
299 |
vif\_type |
300 |
Valid for the Xen HVM hypervisor. |
301 |
|
302 |
This parameter specifies the vif type of the nic configuration |
303 |
of the instance. Unsetting the value leads to no type being specified |
304 |
in the configuration. Note that this parameter only takes effect when |
305 |
the 'nic_type' is not set. The possible options are: |
306 |
|
307 |
- ioemu |
308 |
- vif |
309 |
|
310 |
disk\_type |
311 |
Valid for the Xen HVM and KVM hypervisors. |
312 |
|
313 |
This parameter determines the way the disks are presented to the |
314 |
instance. The possible options are: |
315 |
|
316 |
- ioemu [default] (HVM & KVM) |
317 |
- ide (HVM & KVM) |
318 |
- scsi (KVM) |
319 |
- sd (KVM) |
320 |
- mtd (KVM) |
321 |
- pflash (KVM) |
322 |
|
323 |
|
324 |
cdrom\_disk\_type |
325 |
Valid for the KVM hypervisor. |
326 |
|
327 |
This parameter determines the way the cdroms disks are presented |
328 |
to the instance. The default behavior is to get the same value of |
329 |
the earlier parameter (disk_type). The possible options are: |
330 |
|
331 |
- paravirtual |
332 |
- ide |
333 |
- scsi |
334 |
- sd |
335 |
- mtd |
336 |
- pflash |
337 |
|
338 |
|
339 |
vnc\_bind\_address |
340 |
Valid for the Xen HVM and KVM hypervisors. |
341 |
|
342 |
Specifies the address that the VNC listener for this instance |
343 |
should bind to. Valid values are IPv4 addresses. Use the address |
344 |
0.0.0.0 to bind to all available interfaces (this is the default) |
345 |
or specify the address of one of the interfaces on the node to |
346 |
restrict listening to that interface. |
347 |
|
348 |
vnc\_tls |
349 |
Valid for the KVM hypervisor. |
350 |
|
351 |
A boolean option that controls whether the VNC connection is |
352 |
secured with TLS. |
353 |
|
354 |
vnc\_x509\_path |
355 |
Valid for the KVM hypervisor. |
356 |
|
357 |
If ``vnc_tls`` is enabled, this options specifies the path to the |
358 |
x509 certificate to use. |
359 |
|
360 |
vnc\_x509\_verify |
361 |
Valid for the KVM hypervisor. |
362 |
|
363 |
spice\_bind |
364 |
Valid for the KVM hypervisor. |
365 |
|
366 |
Specifies the address or interface on which the SPICE server will |
367 |
listen. Valid values are: |
368 |
|
369 |
- IPv4 addresses, including 0.0.0.0 and 127.0.0.1 |
370 |
- IPv6 addresses, including :: and ::1 |
371 |
- names of network interfaces |
372 |
|
373 |
If a network interface is specified, the SPICE server will be bound |
374 |
to one of the addresses of that interface. |
375 |
|
376 |
spice\_ip\_version |
377 |
Valid for the KVM hypervisor. |
378 |
|
379 |
Specifies which version of the IP protocol should be used by the |
380 |
SPICE server. |
381 |
|
382 |
It is mainly intended to be used for specifying what kind of IP |
383 |
addresses should be used if a network interface with both IPv4 and |
384 |
IPv6 addresses is specified via the ``spice_bind`` parameter. In |
385 |
this case, if the ``spice_ip_version`` parameter is not used, the |
386 |
default IP version of the cluster will be used. |
387 |
|
388 |
spice\_password\_file |
389 |
Valid for the KVM hypervisor. |
390 |
|
391 |
Specifies a file containing the password that must be used when |
392 |
connecting via the SPICE protocol. If the option is not specified, |
393 |
passwordless connections are allowed. |
394 |
|
395 |
spice\_image\_compression |
396 |
Valid for the KVM hypervisor. |
397 |
|
398 |
Configures the SPICE lossless image compression. Valid values are: |
399 |
|
400 |
- auto_glz |
401 |
- auto_lz |
402 |
- quic |
403 |
- glz |
404 |
- lz |
405 |
- off |
406 |
|
407 |
spice\_jpeg\_wan\_compression |
408 |
Valid for the KVM hypervisor. |
409 |
|
410 |
Configures how SPICE should use the jpeg algorithm for lossy image |
411 |
compression on slow links. Valid values are: |
412 |
|
413 |
- auto |
414 |
- never |
415 |
- always |
416 |
|
417 |
spice\_zlib\_glz\_wan\_compression |
418 |
Valid for the KVM hypervisor. |
419 |
|
420 |
Configures how SPICE should use the zlib-glz algorithm for lossy image |
421 |
compression on slow links. Valid values are: |
422 |
|
423 |
- auto |
424 |
- never |
425 |
- always |
426 |
|
427 |
spice\_streaming\_video |
428 |
Valid for the KVM hypervisor. |
429 |
|
430 |
Configures how SPICE should detect video streams. Valid values are: |
431 |
|
432 |
- off |
433 |
- all |
434 |
- filter |
435 |
|
436 |
spice\_playback\_compression |
437 |
Valid for the KVM hypervisor. |
438 |
|
439 |
Configures whether SPICE should compress audio streams or not. |
440 |
|
441 |
spice\_use\_tls |
442 |
Valid for the KVM hypervisor. |
443 |
|
444 |
Specifies that the SPICE server must use TLS to encrypt all the |
445 |
traffic with the client. |
446 |
|
447 |
spice\_tls\_ciphers |
448 |
Valid for the KVM hypervisor. |
449 |
|
450 |
Specifies a list of comma-separated ciphers that SPICE should use |
451 |
for TLS connections. For the format, see man **cipher**\(1). |
452 |
|
453 |
spice\_use\_vdagent |
454 |
Valid for the KVM hypervisor. |
455 |
|
456 |
Enables or disables passing mouse events via SPICE vdagent. |
457 |
|
458 |
cpu\_type |
459 |
Valid for the KVM hypervisor. |
460 |
|
461 |
This parameter determines the emulated cpu for the instance. If this |
462 |
parameter is empty (which is the default configuration), it will not |
463 |
be passed to KVM. |
464 |
|
465 |
Be aware of setting this parameter to ``"host"`` if you have nodes |
466 |
with different CPUs from each other. Live migration may stop working |
467 |
in this situation. |
468 |
|
469 |
For more information please refer to the KVM manual. |
470 |
|
471 |
acpi |
472 |
Valid for the Xen HVM and KVM hypervisors. |
473 |
|
474 |
A boolean option that specifies if the hypervisor should enable |
475 |
ACPI support for this instance. By default, ACPI is disabled. |
476 |
|
477 |
pae |
478 |
Valid for the Xen HVM and KVM hypervisors. |
479 |
|
480 |
A boolean option that specifies if the hypervisor should enable |
481 |
PAE support for this instance. The default is false, disabling PAE |
482 |
support. |
483 |
|
484 |
viridian |
485 |
Valid for the Xen HVM hypervisor. |
486 |
|
487 |
A boolean option that specifies if the hypervisor should enable |
488 |
viridian (Hyper-V) for this instance. The default is false, |
489 |
disabling viridian support. |
490 |
|
491 |
use\_localtime |
492 |
Valid for the Xen HVM and KVM hypervisors. |
493 |
|
494 |
A boolean option that specifies if the instance should be started |
495 |
with its clock set to the localtime of the machine (when true) or |
496 |
to the UTC (When false). The default is false, which is useful for |
497 |
Linux/Unix machines; for Windows OSes, it is recommended to enable |
498 |
this parameter. |
499 |
|
500 |
kernel\_path |
501 |
Valid for the Xen PVM and KVM hypervisors. |
502 |
|
503 |
This option specifies the path (on the node) to the kernel to boot |
504 |
the instance with. Xen PVM instances always require this, while for |
505 |
KVM if this option is empty, it will cause the machine to load the |
506 |
kernel from its disks (and the boot will be done accordingly to |
507 |
``boot_order``). |
508 |
|
509 |
kernel\_args |
510 |
Valid for the Xen PVM and KVM hypervisors. |
511 |
|
512 |
This options specifies extra arguments to the kernel that will be |
513 |
loaded. device. This is always used for Xen PVM, while for KVM it |
514 |
is only used if the ``kernel_path`` option is also specified. |
515 |
|
516 |
The default setting for this value is simply ``"ro"``, which |
517 |
mounts the root disk (initially) in read-only one. For example, |
518 |
setting this to single will cause the instance to start in |
519 |
single-user mode. |
520 |
|
521 |
initrd\_path |
522 |
Valid for the Xen PVM and KVM hypervisors. |
523 |
|
524 |
This option specifies the path (on the node) to the initrd to boot |
525 |
the instance with. Xen PVM instances can use this always, while |
526 |
for KVM if this option is only used if the ``kernel_path`` option |
527 |
is also specified. You can pass here either an absolute filename |
528 |
(the path to the initrd) if you want to use an initrd, or use the |
529 |
format no\_initrd\_path for no initrd. |
530 |
|
531 |
root\_path |
532 |
Valid for the Xen PVM and KVM hypervisors. |
533 |
|
534 |
This options specifies the name of the root device. This is always |
535 |
needed for Xen PVM, while for KVM it is only used if the |
536 |
``kernel_path`` option is also specified. |
537 |
|
538 |
Please note, that if this setting is an empty string and the |
539 |
hypervisor is Xen it will not be written to the Xen configuration |
540 |
file |
541 |
|
542 |
serial\_console |
543 |
Valid for the KVM hypervisor. |
544 |
|
545 |
This boolean option specifies whether to emulate a serial console |
546 |
for the instance. Note that some versions of KVM have a bug that |
547 |
will make an instance hang when configured to use the serial console |
548 |
unless a connection is made to it within about 2 seconds of the |
549 |
instance's startup. For such case it's recommended to disable this |
550 |
option, which is enabled by default. |
551 |
|
552 |
serial\_speed |
553 |
Valid for the KVM hypervisor. |
554 |
|
555 |
This integer option specifies the speed of the serial console. |
556 |
Common values are 9600, 19200, 38400, 57600 and 115200: choose the |
557 |
one which works on your system. (The default is 38400 for historical |
558 |
reasons, but newer versions of kvm/qemu work with 115200) |
559 |
|
560 |
disk\_cache |
561 |
Valid for the KVM hypervisor. |
562 |
|
563 |
The disk cache mode. It can be either default to not pass any |
564 |
cache option to KVM, or one of the KVM cache modes: none (for |
565 |
direct I/O), writethrough (to use the host cache but report |
566 |
completion to the guest only when the host has committed the |
567 |
changes to disk) or writeback (to use the host cache and report |
568 |
completion as soon as the data is in the host cache). Note that |
569 |
there are special considerations for the cache mode depending on |
570 |
version of KVM used and disk type (always raw file under Ganeti), |
571 |
please refer to the KVM documentation for more details. |
572 |
|
573 |
security\_model |
574 |
Valid for the KVM hypervisor. |
575 |
|
576 |
The security model for kvm. Currently one of *none*, *user* or |
577 |
*pool*. Under *none*, the default, nothing is done and instances |
578 |
are run as the Ganeti daemon user (normally root). |
579 |
|
580 |
Under *user* kvm will drop privileges and become the user |
581 |
specified by the security\_domain parameter. |
582 |
|
583 |
Under *pool* a global cluster pool of users will be used, making |
584 |
sure no two instances share the same user on the same node. (this |
585 |
mode is not implemented yet) |
586 |
|
587 |
security\_domain |
588 |
Valid for the KVM hypervisor. |
589 |
|
590 |
Under security model *user* the username to run the instance |
591 |
under. It must be a valid username existing on the host. |
592 |
|
593 |
Cannot be set under security model *none* or *pool*. |
594 |
|
595 |
kvm\_flag |
596 |
Valid for the KVM hypervisor. |
597 |
|
598 |
If *enabled* the -enable-kvm flag is passed to kvm. If *disabled* |
599 |
-disable-kvm is passed. If unset no flag is passed, and the |
600 |
default running mode for your kvm binary will be used. |
601 |
|
602 |
mem\_path |
603 |
Valid for the KVM hypervisor. |
604 |
|
605 |
This option passes the -mem-path argument to kvm with the path (on |
606 |
the node) to the mount point of the hugetlbfs file system, along |
607 |
with the -mem-prealloc argument too. |
608 |
|
609 |
use\_chroot |
610 |
Valid for the KVM hypervisor. |
611 |
|
612 |
This boolean option determines whether to run the KVM instance in a |
613 |
chroot directory. |
614 |
|
615 |
If it is set to ``true``, an empty directory is created before |
616 |
starting the instance and its path is passed via the -chroot flag |
617 |
to kvm. The directory is removed when the instance is stopped. |
618 |
|
619 |
It is set to ``false`` by default. |
620 |
|
621 |
migration\_downtime |
622 |
Valid for the KVM hypervisor. |
623 |
|
624 |
The maximum amount of time (in ms) a KVM instance is allowed to be |
625 |
frozen during a live migration, in order to copy dirty memory |
626 |
pages. Default value is 30ms, but you may need to increase this |
627 |
value for busy instances. |
628 |
|
629 |
This option is only effective with kvm versions >= 87 and qemu-kvm |
630 |
versions >= 0.11.0. |
631 |
|
632 |
cpu\_mask |
633 |
Valid for the Xen, KVM and LXC hypervisors. |
634 |
|
635 |
The processes belonging to the given instance are only scheduled |
636 |
on the specified CPUs. |
637 |
|
638 |
The format of the mask can be given in three forms. First, the word |
639 |
"all", which signifies the common case where all VCPUs can live on |
640 |
any CPU, based on the hypervisor's decisions. |
641 |
|
642 |
Second, a comma-separated list of CPU IDs or CPU ID ranges. The |
643 |
ranges are defined by a lower and higher boundary, separated by a |
644 |
dash, and the boundaries are inclusive. In this form, all VCPUs of |
645 |
the instance will be mapped on the selected list of CPUs. Example: |
646 |
``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs |
647 |
0, 1, 2 and 5. |
648 |
|
649 |
The last form is used for explicit control of VCPU-CPU pinnings. In |
650 |
this form, the list of VCPU mappings is given as a colon (:) |
651 |
separated list, whose elements are the possible values for the |
652 |
second or first form above. In this form, the number of elements in |
653 |
the colon-separated list _must_ equal the number of VCPUs of the |
654 |
instance. |
655 |
|
656 |
Example: |
657 |
|
658 |
.. code-block:: bash |
659 |
|
660 |
# Map the entire instance to CPUs 0-2 |
661 |
gnt-instance modify -H cpu_mask=0-2 my-inst |
662 |
|
663 |
# Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs) |
664 |
gnt-instance modify -H cpu_mask=1:3 my-inst |
665 |
|
666 |
# Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU |
667 |
gnt-instance modify -H cpu_mask=1-2:all my-inst |
668 |
|
669 |
# Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to |
670 |
# CPU 0 (backslashes for escaping the comma) |
671 |
gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst |
672 |
|
673 |
# Pin entire VM to CPU 0 |
674 |
gnt-instance modify -H cpu_mask=0 my-inst |
675 |
|
676 |
# Turn off CPU pinning (default setting) |
677 |
gnt-instance modify -H cpu_mask=all my-inst |
678 |
|
679 |
cpu\_cap |
680 |
Valid for the Xen hypervisor. |
681 |
|
682 |
Set the maximum amount of cpu usage by the VM. The value is a percentage |
683 |
between 0 and (100 * number of VCPUs). Default cap is 0: unlimited. |
684 |
|
685 |
cpu\_weight |
686 |
Valid for the Xen hypervisor. |
687 |
|
688 |
Set the cpu time ratio to be allocated to the VM. Valid values are |
689 |
between 1 and 65535. Default weight is 256. |
690 |
|
691 |
usb\_mouse |
692 |
Valid for the KVM hypervisor. |
693 |
|
694 |
This option specifies the usb mouse type to be used. It can be |
695 |
"mouse" or "tablet". When using VNC it's recommended to set it to |
696 |
"tablet". |
697 |
|
698 |
keymap |
699 |
Valid for the KVM hypervisor. |
700 |
|
701 |
This option specifies the keyboard mapping to be used. It is only |
702 |
needed when using the VNC console. For example: "fr" or "en-gb". |
703 |
|
704 |
reboot\_behavior |
705 |
Valid for Xen PVM, Xen HVM and KVM hypervisors. |
706 |
|
707 |
Normally if an instance reboots, the hypervisor will restart it. If |
708 |
this option is set to ``exit``, the hypervisor will treat a reboot |
709 |
as a shutdown instead. |
710 |
|
711 |
It is set to ``reboot`` by default. |
712 |
|
713 |
cpu\_cores |
714 |
Valid for the KVM hypervisor. |
715 |
|
716 |
Number of emulated CPU cores. |
717 |
|
718 |
cpu\_threads |
719 |
Valid for the KVM hypervisor. |
720 |
|
721 |
Number of emulated CPU threads. |
722 |
|
723 |
cpu\_sockets |
724 |
Valid for the KVM hypervisor. |
725 |
|
726 |
Number of emulated CPU sockets. |
727 |
|
728 |
soundhw |
729 |
Valid for the KVM and XEN hypervisors. |
730 |
|
731 |
Comma separated list of emulated sounds cards, or "all" to enable |
732 |
all the available ones. |
733 |
|
734 |
cpuid |
735 |
Valid for the XEN hypervisor. |
736 |
|
737 |
Modify the values returned by CPUID_ instructions run within instances. |
738 |
|
739 |
This allows you to enable migration between nodes with different CPU |
740 |
attributes like cores, threads, hyperthreading or SS4 support by hiding |
741 |
the extra features where needed. |
742 |
|
743 |
See the XEN documentation for syntax and more information. |
744 |
|
745 |
.. _CPUID: http://en.wikipedia.org/wiki/CPUID |
746 |
|
747 |
usb\_devices |
748 |
Valid for the KVM hypervisor. |
749 |
|
750 |
Comma separated list of usb devices. These can be emulated devices |
751 |
or passthrough ones, and each one gets passed to kvm with its own |
752 |
``-usbdevice`` option. See the **qemu**\(1) manpage for the syntax |
753 |
of the possible components. |
754 |
|
755 |
vga |
756 |
Valid for the KVM hypervisor. |
757 |
|
758 |
Emulated vga mode, passed the the kvm -vga option. |
759 |
|
760 |
kvm\_extra |
761 |
Valid for the KVM hypervisor. |
762 |
|
763 |
Any other option to the KVM hypervisor, useful tweaking anything |
764 |
that Ganeti doesn't support. Note that values set with this |
765 |
parameter are split on a space character and currently don't support |
766 |
quoting. |
767 |
|
768 |
machine\_version |
769 |
Valid for the KVM hypervisor. |
770 |
|
771 |
Use in case an instance must be booted with an exact type of |
772 |
machine version (due to e.g. outdated drivers). In case it's not set |
773 |
the default version supported by your version of kvm is used. |
774 |
|
775 |
kvm\_path |
776 |
Valid for the KVM hypervisor. |
777 |
|
778 |
Path to the userspace KVM (or qemu) program. |
779 |
|
780 |
vnet\_hdr |
781 |
Valid for the KVM hypervisor. |
782 |
|
783 |
This boolean option determines whether the tap devices used by the |
784 |
KVM paravirtual nics (virtio-net) will get created with VNET_HDR |
785 |
(IFF_VNET_HDR) support. |
786 |
|
787 |
If set to false, it effectively disables offloading on the virio-net |
788 |
interfaces, which prevents host kernel tainting and log flooding, |
789 |
when dealing with broken or malicious virtio-net drivers. |
790 |
|
791 |
It is set to ``true`` by default. |
792 |
|
793 |
The ``-O (--os-parameters)`` option allows customisation of the OS |
794 |
parameters. The actual parameter names and values depends on the OS |
795 |
being used, but the syntax is the same key=value. For example, setting |
796 |
a hypothetical ``dhcp`` parameter to yes can be achieved by:: |
797 |
|
798 |
gnt-instance add -O dhcp=yes ... |
799 |
|
800 |
The ``-I (--iallocator)`` option specifies the instance allocator plugin |
801 |
to use (``.`` means the default allocator). If you pass in this option |
802 |
the allocator will select nodes for this instance automatically, so you |
803 |
don't need to pass them with the ``-n`` option. For more information |
804 |
please refer to the instance allocator documentation. |
805 |
|
806 |
The ``-t (--disk-template)`` options specifies the disk layout type |
807 |
for the instance. If no disk template is specified, the default disk |
808 |
template is used. The default disk template is the first in the list |
809 |
of enabled disk templates, which can be adjusted cluster-wide with |
810 |
``gnt-cluster modify``. The available choices for disk templates are: |
811 |
|
812 |
diskless |
813 |
This creates an instance with no disks. Its useful for testing only |
814 |
(or other special cases). |
815 |
|
816 |
file |
817 |
Disk devices will be regular files. |
818 |
|
819 |
sharedfile |
820 |
Disk devices will be regulare files on a shared directory. |
821 |
|
822 |
plain |
823 |
Disk devices will be logical volumes. |
824 |
|
825 |
drbd |
826 |
Disk devices will be drbd (version 8.x) on top of lvm volumes. |
827 |
|
828 |
rbd |
829 |
Disk devices will be rbd volumes residing inside a RADOS cluster. |
830 |
|
831 |
blockdev |
832 |
Disk devices will be adopted pre-existent block devices. |
833 |
|
834 |
ext |
835 |
Disk devices will be provided by external shared storage, |
836 |
through the ExtStorage Interface using ExtStorage providers. |
837 |
|
838 |
The optional second value of the ``-n (--node)`` is used for the drbd |
839 |
template type and specifies the remote node. |
840 |
|
841 |
If you do not want gnt-instance to wait for the disk mirror to be |
842 |
synced, use the ``--no-wait-for-sync`` option. |
843 |
|
844 |
The ``--file-storage-dir`` specifies the relative path under the |
845 |
cluster-wide file storage directory to store file-based disks. It is |
846 |
useful for having different subdirectories for different |
847 |
instances. The full path of the directory where the disk files are |
848 |
stored will consist of cluster-wide file storage directory + optional |
849 |
subdirectory + instance name. This option is only relevant for |
850 |
instances using the file storage backend. |
851 |
|
852 |
The ``--file-driver`` specifies the driver to use for file-based |
853 |
disks. Note that currently these drivers work with the xen hypervisor |
854 |
only. This option is only relevant for instances using the file |
855 |
storage backend. The available choices are: |
856 |
|
857 |
loop |
858 |
Kernel loopback driver. This driver uses loopback devices to |
859 |
access the filesystem within the file. However, running I/O |
860 |
intensive applications in your instance using the loop driver |
861 |
might result in slowdowns. Furthermore, if you use the loopback |
862 |
driver consider increasing the maximum amount of loopback devices |
863 |
(on most systems it's 8) using the max\_loop param. |
864 |
|
865 |
blktap |
866 |
The blktap driver (for Xen hypervisors). In order to be able to |
867 |
use the blktap driver you should check if the 'blktapctrl' user |
868 |
space disk agent is running (usually automatically started via |
869 |
xend). This user-level disk I/O interface has the advantage of |
870 |
better performance. Especially if you use a network file system |
871 |
(e.g. NFS) to store your instances this is the recommended choice. |
872 |
|
873 |
If ``--ignore-ipolicy`` is given any instance policy violations occuring |
874 |
during this operation are ignored. |
875 |
|
876 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
877 |
options. |
878 |
|
879 |
Example:: |
880 |
|
881 |
# gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \ |
882 |
-n node1.example.com --file-storage-dir=mysubdir instance1.example.com |
883 |
# gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \ |
884 |
-o debian-etch -n node1.example.com instance1.example.com |
885 |
# gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \ |
886 |
-B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com |
887 |
# gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \ |
888 |
-n node1.example.com:node2.example.com instance2.example.com |
889 |
# gnt-instance add -t rbd --disk 0:size=30g -B maxmem=512 -o debian-etch \ |
890 |
-n node1.example.com instance1.example.com |
891 |
# gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1 -B maxmem=512 \ |
892 |
-o debian-etch -n node1.example.com instance1.example.com |
893 |
# gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1,param1=val1 \ |
894 |
--disk 1:size=40g,provider=pvdr2,param2=val2,param3=val3 -B maxmem=512 \ |
895 |
-o debian-etch -n node1.example.com instance1.example.com |
896 |
|
897 |
|
898 |
BATCH-CREATE |
899 |
^^^^^^^^^^^^ |
900 |
|
901 |
| **batch-create** |
902 |
| [{-I|\--iallocator} *instance allocator*] |
903 |
| {instances\_file.json} |
904 |
|
905 |
This command (similar to the Ganeti 1.2 **batcher** tool) submits |
906 |
multiple instance creation jobs based on a definition file. This |
907 |
file can contain all options which are valid when adding an instance |
908 |
with the exception of the ``iallocator`` field. The IAllocator is, |
909 |
for optimization purposes, only allowed to be set for the whole batch |
910 |
operation using the ``--iallocator`` parameter. |
911 |
|
912 |
The instance file must be a valid-formed JSON file, containing an |
913 |
array of dictionaries with instance creation parameters. All parameters |
914 |
(except ``iallocator``) which are valid for the instance creation |
915 |
OP code are allowed. The most important ones are: |
916 |
|
917 |
instance\_name |
918 |
The FQDN of the new instance. |
919 |
|
920 |
disk\_template |
921 |
The disk template to use for the instance, the same as in the |
922 |
**add** command. |
923 |
|
924 |
disks |
925 |
Array of disk specifications. Each entry describes one disk as a |
926 |
dictionary of disk parameters. |
927 |
|
928 |
beparams |
929 |
A dictionary of backend parameters. |
930 |
|
931 |
hypervisor |
932 |
The hypervisor for the instance. |
933 |
|
934 |
hvparams |
935 |
A dictionary with the hypervisor options. If not passed, the default |
936 |
hypervisor options will be inherited. |
937 |
|
938 |
nics |
939 |
List of NICs that will be created for the instance. Each entry |
940 |
should be a dict, with mac, ip, mode and link as possible keys. |
941 |
Please don't provide the "mac, ip, mode, link" parent keys if you |
942 |
use this method for specifying NICs. |
943 |
|
944 |
pnode, snode |
945 |
The primary and optionally the secondary node to use for the |
946 |
instance (in case an iallocator script is not used). If those |
947 |
parameters are given, they have to be given consistently for all |
948 |
instances in the batch operation. |
949 |
|
950 |
start |
951 |
whether to start the instance |
952 |
|
953 |
ip\_check |
954 |
Skip the check for already-in-use instance; see the description in |
955 |
the **add** command for details. |
956 |
|
957 |
name\_check |
958 |
Skip the name check for instances; see the description in the |
959 |
**add** command for details. |
960 |
|
961 |
file\_storage\_dir, file\_driver |
962 |
Configuration for the file disk type, see the **add** command for |
963 |
details. |
964 |
|
965 |
|
966 |
A simple definition for one instance can be (with most of the |
967 |
parameters taken from the cluster defaults):: |
968 |
|
969 |
[ |
970 |
{ |
971 |
"mode": "create", |
972 |
"instance_name": "instance1.example.com", |
973 |
"disk_template": "drbd", |
974 |
"os_type": "debootstrap", |
975 |
"disks": [{"size":"1024"}], |
976 |
"nics": [{}], |
977 |
"hypervisor": "xen-pvm" |
978 |
}, |
979 |
{ |
980 |
"mode": "create", |
981 |
"instance_name": "instance2.example.com", |
982 |
"disk_template": "drbd", |
983 |
"os_type": "debootstrap", |
984 |
"disks": [{"size":"4096", "mode": "rw", "vg": "xenvg"}], |
985 |
"nics": [{}], |
986 |
"hypervisor": "xen-hvm", |
987 |
"hvparams": {"acpi": true}, |
988 |
"beparams": {"maxmem": 512, "minmem": 256} |
989 |
} |
990 |
] |
991 |
|
992 |
The command will display the job id for each submitted instance, as |
993 |
follows:: |
994 |
|
995 |
# gnt-instance batch-create instances.json |
996 |
Submitted jobs 37, 38 |
997 |
|
998 |
|
999 |
Note: If the allocator is used for computing suitable nodes for the |
1000 |
instances, it will only take into account disk information for the |
1001 |
default disk template. That means, even if other disk templates are |
1002 |
specified for the instances, storage space information of these disk |
1003 |
templates will not be considered in the allocation computation. |
1004 |
|
1005 |
|
1006 |
REMOVE |
1007 |
^^^^^^ |
1008 |
|
1009 |
| **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit] |
1010 |
| [\--print-job-id] [\--force] {*instance*} |
1011 |
|
1012 |
Remove an instance. This will remove all data from the instance and |
1013 |
there is *no way back*. If you are not sure if you use an instance |
1014 |
again, use **shutdown** first and leave it in the shutdown state for a |
1015 |
while. |
1016 |
|
1017 |
The ``--ignore-failures`` option will cause the removal to proceed |
1018 |
even in the presence of errors during the removal of the instance |
1019 |
(e.g. during the shutdown or the disk removal). If this option is not |
1020 |
given, the command will stop at the first error. |
1021 |
|
1022 |
The ``--shutdown-timeout`` is used to specify how much time to wait |
1023 |
before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the |
1024 |
kvm process for KVM, etc.). By default two minutes are given to each |
1025 |
instance to stop. |
1026 |
|
1027 |
The ``--force`` option is used to skip the interactive confirmation. |
1028 |
|
1029 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1030 |
options. |
1031 |
|
1032 |
Example:: |
1033 |
|
1034 |
# gnt-instance remove instance1.example.com |
1035 |
|
1036 |
|
1037 |
LIST |
1038 |
^^^^ |
1039 |
|
1040 |
| **list** |
1041 |
| [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v] |
1042 |
| [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...] |
1043 |
|
1044 |
Shows the currently configured instances with memory usage, disk |
1045 |
usage, the node they are running on, and their run status. |
1046 |
|
1047 |
The ``--no-headers`` option will skip the initial header line. The |
1048 |
``--separator`` option takes an argument which denotes what will be |
1049 |
used between the output fields. Both these options are to help |
1050 |
scripting. |
1051 |
|
1052 |
The units used to display the numeric values in the output varies, |
1053 |
depending on the options given. By default, the values will be |
1054 |
formatted in the most appropriate unit. If the ``--separator`` option |
1055 |
is given, then the values are shown in mebibytes to allow parsing by |
1056 |
scripts. In both cases, the ``--units`` option can be used to enforce |
1057 |
a given output unit. |
1058 |
|
1059 |
The ``-v`` option activates verbose mode, which changes the display of |
1060 |
special field states (see **ganeti**\(7)). |
1061 |
|
1062 |
The ``-o (--output)`` option takes a comma-separated list of output |
1063 |
fields. The available fields and their meaning are: |
1064 |
|
1065 |
@QUERY_FIELDS_INSTANCE@ |
1066 |
|
1067 |
If the value of the option starts with the character ``+``, the new |
1068 |
field(s) will be added to the default list. This allows one to quickly |
1069 |
see the default list plus a few other fields, instead of retyping the |
1070 |
entire list of fields. |
1071 |
|
1072 |
There is a subtle grouping about the available output fields: all |
1073 |
fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and |
1074 |
``status`` are configuration value and not run-time values. So if you |
1075 |
don't select any of the these fields, the query will be satisfied |
1076 |
instantly from the cluster configuration, without having to ask the |
1077 |
remote nodes for the data. This can be helpful for big clusters when |
1078 |
you only want some data and it makes sense to specify a reduced set of |
1079 |
output fields. |
1080 |
|
1081 |
If exactly one argument is given and it appears to be a query filter |
1082 |
(see **ganeti**\(7)), the query result is filtered accordingly. For |
1083 |
ambiguous cases (e.g. a single field name as a filter) the ``--filter`` |
1084 |
(``-F``) option forces the argument to be treated as a filter (e.g. |
1085 |
``gnt-instance list -F admin_state``). |
1086 |
|
1087 |
The default output field list is: ``name``, ``os``, ``pnode``, |
1088 |
``admin_state``, ``oper_state``, ``oper_ram``. |
1089 |
|
1090 |
|
1091 |
LIST-FIELDS |
1092 |
^^^^^^^^^^^ |
1093 |
|
1094 |
**list-fields** [field...] |
1095 |
|
1096 |
Lists available fields for instances. |
1097 |
|
1098 |
|
1099 |
INFO |
1100 |
^^^^ |
1101 |
|
1102 |
**info** [-s \| \--static] [\--roman] {\--all \| *instance*} |
1103 |
|
1104 |
Show detailed information about the given instance(s). This is |
1105 |
different from **list** as it shows detailed data about the instance's |
1106 |
disks (especially useful for the drbd disk template). |
1107 |
|
1108 |
If the option ``-s`` is used, only information available in the |
1109 |
configuration file is returned, without querying nodes, making the |
1110 |
operation faster. |
1111 |
|
1112 |
Use the ``--all`` to get info about all instances, rather than |
1113 |
explicitly passing the ones you're interested in. |
1114 |
|
1115 |
The ``--roman`` option can be used to cause envy among people who like |
1116 |
ancient cultures, but are stuck with non-latin-friendly cluster |
1117 |
virtualization technologies. |
1118 |
|
1119 |
MODIFY |
1120 |
^^^^^^ |
1121 |
|
1122 |
| **modify** |
1123 |
| [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*] |
1124 |
| [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*] |
1125 |
| [{-m|\--runtime-memory} *SIZE*] |
1126 |
| [\--net add[:options...] \| |
1127 |
| \--net [*N*:]add[,options...] \| |
1128 |
| \--net [*ID*:]remove \| |
1129 |
| \--net *ID*:modify[,options...]] |
1130 |
| [\--disk add:size=*SIZE*[,options...] \| |
1131 |
| \--disk *N*:add,size=*SIZE*[,options...] \| |
1132 |
| \--disk *N*:add,size=*SIZE*,provider=*PROVIDER*[,options...][,param=*value*... ] \| |
1133 |
| \--disk *ID*:modify[,options...] |
1134 |
| \--disk [*ID*:]remove] |
1135 |
| [{-t|\--disk-template} plain \| {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync] |
1136 |
| [\--new-primary=*node*] |
1137 |
| [\--os-type=*OS* [\--force-variant]] |
1138 |
| [{-O|\--os-parameters} *param*=*value*... ] |
1139 |
| [\--offline \| \--online] |
1140 |
| [\--submit] [\--print-job-id] |
1141 |
| [\--ignore-ipolicy] |
1142 |
| [\--hotplug] |
1143 |
| {*instance*} |
1144 |
|
1145 |
Modifies the memory size, number of vcpus, ip address, MAC address |
1146 |
and/or NIC parameters for an instance. It can also add and remove |
1147 |
disks and NICs to/from the instance. Note that you need to give at |
1148 |
least one of the arguments, otherwise the command complains. |
1149 |
|
1150 |
The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)`` |
1151 |
and ``-O (--os-parameters)`` options specifies hypervisor, backend and |
1152 |
OS parameter options in the form of name=value[,...]. For details |
1153 |
which options can be specified, see the **add** command. |
1154 |
|
1155 |
The ``-t (--disk-template)`` option will change the disk template of |
1156 |
the instance. Currently only conversions between the plain and drbd |
1157 |
disk templates are supported, and the instance must be stopped before |
1158 |
attempting the conversion. When changing from the plain to the drbd |
1159 |
disk template, a new secondary node must be specified via the ``-n`` |
1160 |
option. The option ``--no-wait-for-sync`` can be used when converting |
1161 |
to the ``drbd`` template in order to make the instance available for |
1162 |
startup before DRBD has finished resyncing. |
1163 |
|
1164 |
The ``-m (--runtime-memory)`` option will change an instance's runtime |
1165 |
memory to the given size (in MB if a different suffix is not specified), |
1166 |
by ballooning it up or down to the new value. |
1167 |
|
1168 |
The ``--disk add:size=*SIZE*,[options..]`` option adds a disk to the |
1169 |
instance, and ``--disk *N*:add:size=*SIZE*,[options..]`` will add a disk |
1170 |
to the the instance at a specific index. The available options are the |
1171 |
same as in the **add** command(``spindles``, ``mode``, ``name``, ``vg``, |
1172 |
``metavg``). Per default, gnt-instance waits for the disk mirror to sync. |
1173 |
If you do not want this behavior, use the ``--no-wait-for-sync`` option. |
1174 |
When adding an ExtStorage disk, the ``provider=*PROVIDER*`` option is |
1175 |
also mandatory and specifies the ExtStorage provider. Also, for |
1176 |
ExtStorage disks arbitrary parameters can be passed as additional comma |
1177 |
separated options, same as in the **add** command. The ``--disk remove`` |
1178 |
option will remove the last disk of the instance. Use |
1179 |
``--disk `` *ID*``:remove`` to remove a disk by its identifier. *ID* |
1180 |
can be the index of the disk, the disks's name or the disks's UUID. The |
1181 |
``--disk *ID*:modify[,options...]`` will change the options of the disk. |
1182 |
Available options are: |
1183 |
|
1184 |
mode |
1185 |
The access mode. Either ``ro`` (read-only) or the default ``rw`` (read-write). |
1186 |
|
1187 |
name |
1188 |
This option specifies a name for the disk, which can be used as a disk |
1189 |
identifier. An instance can not have two disks with the same name. |
1190 |
|
1191 |
The ``--net *N*:add[,options..]`` will add a new network interface to |
1192 |
the instance. The available options are the same as in the **add** |
1193 |
command (``mac``, ``ip``, ``link``, ``mode``, ``network``). The |
1194 |
``--net *ID*,remove`` will remove the intances' NIC with *ID* identifier, |
1195 |
which can be the index of the NIC, the NIC's name or the NIC's UUID. |
1196 |
The ``--net *ID*:modify[,options..]`` option will change the parameters of |
1197 |
the instance network interface with the *ID* identifier. |
1198 |
|
1199 |
The option ``-o (--os-type)`` will change the OS name for the instance |
1200 |
(without reinstallation). In case an OS variant is specified that is |
1201 |
not found, then by default the modification is refused, unless |
1202 |
``--force-variant`` is passed. An invalid OS will also be refused, |
1203 |
unless the ``--force`` option is given. |
1204 |
|
1205 |
The option ``--new-primary`` will set the new primary node of an instance |
1206 |
assuming the disks have already been moved manually. Unless the ``--force`` |
1207 |
option is given, it is verified that the instance is no longer running |
1208 |
on its current primary node. |
1209 |
|
1210 |
The ``--online`` and ``--offline`` options are used to transition an |
1211 |
instance into and out of the ``offline`` state. An instance can be |
1212 |
turned offline only if it was previously down. The ``--online`` option |
1213 |
fails if the instance was not in the ``offline`` state, otherwise it |
1214 |
changes instance's state to ``down``. These modifications take effect |
1215 |
immediately. |
1216 |
|
1217 |
If ``--ignore-ipolicy`` is given any instance policy violations occuring |
1218 |
during this operation are ignored. |
1219 |
|
1220 |
If ``--hotplug`` is given any disk and NIC modifications will take |
1221 |
effect without the need of actual reboot. Please note that this feature |
1222 |
is currently supported only for KVM hypervisor and there are some |
1223 |
restrictions: a) KVM versions >= 1.0 support it b) instances with chroot |
1224 |
or uid pool security model do not support disk hotplug c) RBD disks with |
1225 |
userspace access mode can not be hotplugged (yet) d) if hotplug fails |
1226 |
(for any reason) a warning is printed but execution is continued e) |
1227 |
for existing NIC modification interactive verification is needed unless |
1228 |
``--force`` option is passed. |
1229 |
|
1230 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1231 |
options. |
1232 |
|
1233 |
Most of the changes take effect at the next restart. If the instance is |
1234 |
running, there is no effect on the instance. |
1235 |
|
1236 |
REINSTALL |
1237 |
^^^^^^^^^ |
1238 |
|
1239 |
| **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*] |
1240 |
| [\--force-multiple] |
1241 |
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all] |
1242 |
| [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] [\--print-job-id] |
1243 |
| {*instance*...} |
1244 |
|
1245 |
Reinstalls the operating system on the given instance(s). The |
1246 |
instance(s) must be stopped when running this command. If the ``-o |
1247 |
(--os-type)`` is specified, the operating system is changed. |
1248 |
|
1249 |
The ``--select-os`` option switches to an interactive OS reinstall. |
1250 |
The user is prompted to select the OS template from the list of |
1251 |
available OS templates. OS parameters can be overridden using ``-O |
1252 |
(--os-parameters)`` (more documentation for this option under the |
1253 |
**add** command). |
1254 |
|
1255 |
Since this is a potentially dangerous command, the user will be |
1256 |
required to confirm this action, unless the ``-f`` flag is passed. |
1257 |
When multiple instances are selected (either by passing multiple |
1258 |
arguments or by using the ``--node``, ``--primary``, ``--secondary`` |
1259 |
or ``--all`` options), the user must pass the ``--force-multiple`` |
1260 |
options to skip the interactive confirmation. |
1261 |
|
1262 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1263 |
options. |
1264 |
|
1265 |
RENAME |
1266 |
^^^^^^ |
1267 |
|
1268 |
| **rename** [\--no-ip-check] [\--no-name-check] [\--submit] [\--print-job-id] |
1269 |
| {*instance*} {*new\_name*} |
1270 |
|
1271 |
Renames the given instance. The instance must be stopped when running |
1272 |
this command. The requirements for the new name are the same as for |
1273 |
adding an instance: the new name must be resolvable and the IP it |
1274 |
resolves to must not be reachable (in order to prevent duplicate IPs |
1275 |
the next time the instance is started). The IP test can be skipped if |
1276 |
the ``--no-ip-check`` option is passed. |
1277 |
|
1278 |
Note that you can rename an instance to its same name, to force |
1279 |
re-executing the os-specific rename script for that instance, if |
1280 |
needed. |
1281 |
|
1282 |
The ``--no-name-check`` skips the check for the new instance name via |
1283 |
the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and |
1284 |
that the resolved name matches the provided name. Since the name check |
1285 |
is used to compute the IP address, if you pass this option you must also |
1286 |
pass the ``--no-ip-check`` option. |
1287 |
|
1288 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1289 |
options. |
1290 |
|
1291 |
Starting/stopping/connecting to console |
1292 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1293 |
|
1294 |
STARTUP |
1295 |
^^^^^^^ |
1296 |
|
1297 |
| **startup** |
1298 |
| [\--force] [\--ignore-offline] |
1299 |
| [\--force-multiple] [\--no-remember] |
1300 |
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \| |
1301 |
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags] |
1302 |
| [{-H|\--hypervisor-parameters} ``key=value...``] |
1303 |
| [{-B|\--backend-parameters} ``key=value...``] |
1304 |
| [\--submit] [\--print-job-id] [\--paused] |
1305 |
| {*name*...} |
1306 |
|
1307 |
Starts one or more instances, depending on the following options. The |
1308 |
four available modes are: |
1309 |
|
1310 |
\--instance |
1311 |
will start the instances given as arguments (at least one argument |
1312 |
required); this is the default selection |
1313 |
|
1314 |
\--node |
1315 |
will start the instances who have the given node as either primary |
1316 |
or secondary |
1317 |
|
1318 |
\--primary |
1319 |
will start all instances whose primary node is in the list of nodes |
1320 |
passed as arguments (at least one node required) |
1321 |
|
1322 |
\--secondary |
1323 |
will start all instances whose secondary node is in the list of |
1324 |
nodes passed as arguments (at least one node required) |
1325 |
|
1326 |
\--all |
1327 |
will start all instances in the cluster (no arguments accepted) |
1328 |
|
1329 |
\--tags |
1330 |
will start all instances in the cluster with the tags given as |
1331 |
arguments |
1332 |
|
1333 |
\--node-tags |
1334 |
will start all instances in the cluster on nodes with the tags |
1335 |
given as arguments |
1336 |
|
1337 |
\--pri-node-tags |
1338 |
will start all instances in the cluster on primary nodes with the |
1339 |
tags given as arguments |
1340 |
|
1341 |
\--sec-node-tags |
1342 |
will start all instances in the cluster on secondary nodes with the |
1343 |
tags given as arguments |
1344 |
|
1345 |
Note that although you can pass more than one selection option, the |
1346 |
last one wins, so in order to guarantee the desired result, don't pass |
1347 |
more than one such option. |
1348 |
|
1349 |
Use ``--force`` to start even if secondary disks are failing. |
1350 |
``--ignore-offline`` can be used to ignore offline primary nodes and |
1351 |
mark the instance as started even if the primary is not available. |
1352 |
|
1353 |
The ``--force-multiple`` will skip the interactive confirmation in the |
1354 |
case the more than one instance will be affected. |
1355 |
|
1356 |
The ``--no-remember`` option will perform the startup but not change |
1357 |
the state of the instance in the configuration file (if it was stopped |
1358 |
before, Ganeti will still think it needs to be stopped). This can be |
1359 |
used for testing, or for a one shot-start where you don't want the |
1360 |
watcher to restart the instance if it crashes. |
1361 |
|
1362 |
The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)`` |
1363 |
options specify temporary hypervisor and backend parameters that can |
1364 |
be used to start an instance with modified parameters. They can be |
1365 |
useful for quick testing without having to modify an instance back and |
1366 |
forth, e.g.:: |
1367 |
|
1368 |
# gnt-instance start -H kernel_args="single" instance1 |
1369 |
# gnt-instance start -B maxmem=2048 instance2 |
1370 |
|
1371 |
|
1372 |
The first form will start the instance instance1 in single-user mode, |
1373 |
and the instance instance2 with 2GB of RAM (this time only, unless |
1374 |
that is the actual instance memory size already). Note that the values |
1375 |
override the instance parameters (and not extend them): an instance |
1376 |
with "kernel\_args=ro" when started with -H kernel\_args=single will |
1377 |
result in "single", not "ro single". |
1378 |
|
1379 |
The ``--paused`` option is only valid for Xen and kvm hypervisors. This |
1380 |
pauses the instance at the start of bootup, awaiting ``gnt-instance |
1381 |
console`` to unpause it, allowing the entire boot process to be |
1382 |
monitored for debugging. |
1383 |
|
1384 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1385 |
options. |
1386 |
|
1387 |
Example:: |
1388 |
|
1389 |
# gnt-instance start instance1.example.com |
1390 |
# gnt-instance start --node node1.example.com node2.example.com |
1391 |
# gnt-instance start --all |
1392 |
|
1393 |
|
1394 |
SHUTDOWN |
1395 |
^^^^^^^^ |
1396 |
|
1397 |
| **shutdown** |
1398 |
| [\--timeout=*N*] |
1399 |
| [\--force] [\--force-multiple] [\--ignore-offline] [\--no-remember] |
1400 |
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \| |
1401 |
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags] |
1402 |
| [\--submit] [\--print-job-id] |
1403 |
| {*name*...} |
1404 |
|
1405 |
Stops one or more instances. If the instance cannot be cleanly stopped |
1406 |
during a hardcoded interval (currently 2 minutes), it will forcibly |
1407 |
stop the instance (equivalent to switching off the power on a physical |
1408 |
machine). |
1409 |
|
1410 |
The ``--timeout`` is used to specify how much time to wait before |
1411 |
forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm |
1412 |
process for KVM, etc.). By default two minutes are given to each |
1413 |
instance to stop. |
1414 |
|
1415 |
The ``--instance``, ``--node``, ``--primary``, ``--secondary``, |
1416 |
``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and |
1417 |
``--sec-node-tags`` options are similar as for the **startup** command |
1418 |
and they influence the actual instances being shutdown. |
1419 |
|
1420 |
``--ignore-offline`` can be used to ignore offline primary nodes and |
1421 |
force the instance to be marked as stopped. This option should be used |
1422 |
with care as it can lead to an inconsistent cluster state. |
1423 |
|
1424 |
Use ``--force`` to be able to shutdown an instance even when it's marked |
1425 |
as offline. This is useful is an offline instance ends up in the |
1426 |
``ERROR_up`` state, for example. |
1427 |
|
1428 |
The ``--no-remember`` option will perform the shutdown but not change |
1429 |
the state of the instance in the configuration file (if it was running |
1430 |
before, Ganeti will still thinks it needs to be running). This can be |
1431 |
useful for a cluster-wide shutdown, where some instances are marked as |
1432 |
up and some as down, and you don't want to change the running state: |
1433 |
you just need to disable the watcher, shutdown all instances with |
1434 |
``--no-remember``, and when the watcher is activated again it will |
1435 |
restore the correct runtime state for all instances. |
1436 |
|
1437 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1438 |
options. |
1439 |
|
1440 |
Example:: |
1441 |
|
1442 |
# gnt-instance shutdown instance1.example.com |
1443 |
# gnt-instance shutdown --all |
1444 |
|
1445 |
|
1446 |
REBOOT |
1447 |
^^^^^^ |
1448 |
|
1449 |
| **reboot** |
1450 |
| [{-t|\--type} *REBOOT-TYPE*] |
1451 |
| [\--ignore-secondaries] |
1452 |
| [\--shutdown-timeout=*N*] |
1453 |
| [\--force-multiple] |
1454 |
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \| |
1455 |
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags] |
1456 |
| [\--submit] [\--print-job-id] |
1457 |
| [*name*...] |
1458 |
|
1459 |
Reboots one or more instances. The type of reboot depends on the value |
1460 |
of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot |
1461 |
does a instance stop, recreates the hypervisor config for the instance |
1462 |
and starts the instance. A full reboot does the equivalent of |
1463 |
**gnt-instance shutdown && gnt-instance startup**. The default is |
1464 |
hard reboot. |
1465 |
|
1466 |
For the hard reboot the option ``--ignore-secondaries`` ignores errors |
1467 |
for the secondary node while re-assembling the instance disks. |
1468 |
|
1469 |
The ``--instance``, ``--node``, ``--primary``, ``--secondary``, |
1470 |
``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and |
1471 |
``--sec-node-tags`` options are similar as for the **startup** command |
1472 |
and they influence the actual instances being rebooted. |
1473 |
|
1474 |
The ``--shutdown-timeout`` is used to specify how much time to wait |
1475 |
before forcing the shutdown (xm destroy in xen, killing the kvm |
1476 |
process, for kvm). By default two minutes are given to each instance |
1477 |
to stop. |
1478 |
|
1479 |
The ``--force-multiple`` will skip the interactive confirmation in the |
1480 |
case the more than one instance will be affected. |
1481 |
|
1482 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1483 |
options. |
1484 |
|
1485 |
Example:: |
1486 |
|
1487 |
# gnt-instance reboot instance1.example.com |
1488 |
# gnt-instance reboot --type=full instance1.example.com |
1489 |
|
1490 |
|
1491 |
CONSOLE |
1492 |
^^^^^^^ |
1493 |
|
1494 |
**console** [\--show-cmd] {*instance*} |
1495 |
|
1496 |
Connects to the console of the given instance. If the instance is not |
1497 |
up, an error is returned. Use the ``--show-cmd`` option to display the |
1498 |
command instead of executing it. |
1499 |
|
1500 |
For HVM instances, this will attempt to connect to the serial console |
1501 |
of the instance. To connect to the virtualized "physical" console of a |
1502 |
HVM instance, use a VNC client with the connection info from the |
1503 |
**info** command. |
1504 |
|
1505 |
For Xen/kvm instances, if the instance is paused, this attempts to |
1506 |
unpause the instance after waiting a few seconds for the connection to |
1507 |
the console to be made. |
1508 |
|
1509 |
Example:: |
1510 |
|
1511 |
# gnt-instance console instance1.example.com |
1512 |
|
1513 |
|
1514 |
Disk management |
1515 |
~~~~~~~~~~~~~~~ |
1516 |
|
1517 |
REPLACE-DISKS |
1518 |
^^^^^^^^^^^^^ |
1519 |
|
1520 |
| **replace-disks** [\--submit] [\--print-job-id] [\--early-release] |
1521 |
| [\--ignore-ipolicy] {-p} [\--disks *idx*] {*instance*} |
1522 |
|
1523 |
| **replace-disks** [\--submit] [\--print-job-id] [\--early-release] |
1524 |
| [\--ignore-ipolicy] {-s} [\--disks *idx*] {*instance*} |
1525 |
|
1526 |
| **replace-disks** [\--submit] [\--print-job-id] [\--early-release] |
1527 |
| [\--ignore-ipolicy] |
1528 |
| {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*} |
1529 |
|
1530 |
| **replace-disks** [\--submit] [\--print-job-id] [\--early-release] |
1531 |
| [\--ignore-ipolicy] {-a\|\--auto} {*instance*} |
1532 |
|
1533 |
This command is a generalized form for replacing disks. It is |
1534 |
currently only valid for the mirrored (DRBD) disk template. |
1535 |
|
1536 |
The first form (when passing the ``-p`` option) will replace the disks |
1537 |
on the primary, while the second form (when passing the ``-s`` option |
1538 |
will replace the disks on the secondary node. For these two cases (as |
1539 |
the node doesn't change), it is possible to only run the replace for a |
1540 |
subset of the disks, using the option ``--disks`` which takes a list |
1541 |
of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only |
1542 |
the first and third disks. |
1543 |
|
1544 |
The third form (when passing either the ``--iallocator`` or the |
1545 |
``--new-secondary`` option) is designed to change secondary node of the |
1546 |
instance. Specifying ``--iallocator`` makes the new secondary be |
1547 |
selected automatically by the specified allocator plugin (use ``.`` to |
1548 |
indicate the default allocator), otherwise the new secondary node will |
1549 |
be the one chosen manually via the ``--new-secondary`` option. |
1550 |
|
1551 |
Note that it is not possible to select an offline or drained node as a |
1552 |
new secondary. |
1553 |
|
1554 |
The fourth form (when using ``--auto``) will automatically determine |
1555 |
which disks of an instance are faulty and replace them within the same |
1556 |
node. The ``--auto`` option works only when an instance has only |
1557 |
faulty disks on either the primary or secondary node; it doesn't work |
1558 |
when both sides have faulty disks. |
1559 |
|
1560 |
The ``--early-release`` changes the code so that the old storage on |
1561 |
secondary node(s) is removed early (before the resync is completed) |
1562 |
and the internal Ganeti locks for the current (and new, if any) |
1563 |
secondary node are also released, thus allowing more parallelism in |
1564 |
the cluster operation. This should be used only when recovering from a |
1565 |
disk failure on the current secondary (thus the old storage is already |
1566 |
broken) or when the storage on the primary node is known to be fine |
1567 |
(thus we won't need the old storage for potential recovery). |
1568 |
|
1569 |
The ``--ignore-ipolicy`` let the command ignore instance policy |
1570 |
violations if replace-disks changes groups and the instance would |
1571 |
violate the new groups instance policy. |
1572 |
|
1573 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1574 |
options. |
1575 |
|
1576 |
ACTIVATE-DISKS |
1577 |
^^^^^^^^^^^^^^ |
1578 |
|
1579 |
| **activate-disks** [\--submit] [\--print-job-id] [\--ignore-size] |
1580 |
| [\--wait-for-sync] {*instance*} |
1581 |
|
1582 |
Activates the block devices of the given instance. If successful, the |
1583 |
command will show the location and name of the block devices:: |
1584 |
|
1585 |
node1.example.com:disk/0:/dev/drbd0 |
1586 |
node1.example.com:disk/1:/dev/drbd1 |
1587 |
|
1588 |
|
1589 |
In this example, *node1.example.com* is the name of the node on which |
1590 |
the devices have been activated. The *disk/0* and *disk/1* are the |
1591 |
Ganeti-names of the instance disks; how they are visible inside the |
1592 |
instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the |
1593 |
actual block devices as visible on the node. |
1594 |
|
1595 |
The ``--ignore-size`` option can be used to activate disks ignoring |
1596 |
the currently configured size in Ganeti. This can be used in cases |
1597 |
where the configuration has gotten out of sync with the real-world |
1598 |
(e.g. after a partially-failed grow-disk operation or due to rounding |
1599 |
in LVM devices). This should not be used in normal cases, but only |
1600 |
when activate-disks fails without it. |
1601 |
|
1602 |
The ``--wait-for-sync`` option will ensure that the command returns only |
1603 |
after the instance's disks are synchronised (mostly for DRBD); this can |
1604 |
be useful to ensure consistency, as otherwise there are no commands that |
1605 |
can wait until synchronisation is done. However when passing this |
1606 |
option, the command will have additional output, making it harder to |
1607 |
parse the disk information. |
1608 |
|
1609 |
Note that it is safe to run this command while the instance is already |
1610 |
running. |
1611 |
|
1612 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1613 |
options. |
1614 |
|
1615 |
DEACTIVATE-DISKS |
1616 |
^^^^^^^^^^^^^^^^ |
1617 |
|
1618 |
**deactivate-disks** [-f] [\--submit] [\--print-job-id] {*instance*} |
1619 |
|
1620 |
De-activates the block devices of the given instance. Note that if you |
1621 |
run this command for an instance with a drbd disk template, while it |
1622 |
is running, it will not be able to shutdown the block devices on the |
1623 |
primary node, but it will shutdown the block devices on the secondary |
1624 |
nodes, thus breaking the replication. |
1625 |
|
1626 |
The ``-f``/``--force`` option will skip checks that the instance is |
1627 |
down; in case the hypervisor is confused and we can't talk to it, |
1628 |
normally Ganeti will refuse to deactivate the disks, but with this |
1629 |
option passed it will skip this check and directly try to deactivate |
1630 |
the disks. This can still fail due to the instance actually running or |
1631 |
other issues. |
1632 |
|
1633 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1634 |
options. |
1635 |
|
1636 |
GROW-DISK |
1637 |
^^^^^^^^^ |
1638 |
|
1639 |
| **grow-disk** [\--no-wait-for-sync] [\--submit] [\--print-job-id] |
1640 |
| [\--absolute] |
1641 |
| {*instance*} {*disk*} {*amount*} |
1642 |
|
1643 |
Grows an instance's disk. This is only possible for instances having a |
1644 |
plain, drbd, file, sharedfile, rbd or ext disk template. For the ext |
1645 |
template to work, the ExtStorage provider should also support growing. |
1646 |
This means having a ``grow`` script that actually grows the volume of |
1647 |
the external shared storage. |
1648 |
|
1649 |
Note that this command only change the block device size; it will not |
1650 |
grow the actual filesystems, partitions, etc. that live on that |
1651 |
disk. Usually, you will need to: |
1652 |
|
1653 |
#. use **gnt-instance grow-disk** |
1654 |
|
1655 |
#. reboot the instance (later, at a convenient time) |
1656 |
|
1657 |
#. use a filesystem resizer, such as **ext2online**\(8) or |
1658 |
**xfs\_growfs**\(8) to resize the filesystem, or use **fdisk**\(8) to |
1659 |
change the partition table on the disk |
1660 |
|
1661 |
The *disk* argument is the index of the instance disk to grow. The |
1662 |
*amount* argument is given as a number which can have a suffix (like the |
1663 |
disk size in instance create); if the suffix is missing, the value will |
1664 |
be interpreted as mebibytes. |
1665 |
|
1666 |
By default, the *amount* value represents the desired increase in the |
1667 |
disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If |
1668 |
the optional ``--absolute`` parameter is passed, then the *amount* |
1669 |
argument doesn't represent the delta, but instead the desired final disk |
1670 |
size (e.g. an amount of 8G will take a disk of size 4G to 8G). |
1671 |
|
1672 |
For instances with a drbd template, note that the disk grow operation |
1673 |
might complete on one node but fail on the other; this will leave the |
1674 |
instance with different-sized LVs on the two nodes, but this will not |
1675 |
create problems (except for unused space). |
1676 |
|
1677 |
If you do not want gnt-instance to wait for the new disk region to be |
1678 |
synced, use the ``--no-wait-for-sync`` option. |
1679 |
|
1680 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1681 |
options. |
1682 |
|
1683 |
Example (increase the first disk for instance1 by 16GiB):: |
1684 |
|
1685 |
# gnt-instance grow-disk instance1.example.com 0 16g |
1686 |
|
1687 |
Example for increasing the disk size to a certain size:: |
1688 |
|
1689 |
# gnt-instance grow-disk --absolute instance1.example.com 0 32g |
1690 |
|
1691 |
Also note that disk shrinking is not supported; use **gnt-backup |
1692 |
export** and then **gnt-backup import** to reduce the disk size of an |
1693 |
instance. |
1694 |
|
1695 |
RECREATE-DISKS |
1696 |
^^^^^^^^^^^^^^ |
1697 |
|
1698 |
| **recreate-disks** [\--submit] [\--print-job-id] |
1699 |
| [{-n node1:[node2] \| {-I\|\--iallocator *name*}}] |
1700 |
| [\--disk=*N*[:[size=*VAL*][,spindles=*VAL*][,mode=*ro\|rw*]]] {*instance*} |
1701 |
|
1702 |
Recreates all or a subset of disks of the given instance. |
1703 |
|
1704 |
Note that this functionality should only be used for missing disks; if |
1705 |
any of the given disks already exists, the operation will fail. While |
1706 |
this is suboptimal, recreate-disks should hopefully not be needed in |
1707 |
normal operation and as such the impact of this is low. |
1708 |
|
1709 |
If only a subset should be recreated, any number of ``disk`` options can |
1710 |
be specified. It expects a disk index and an optional list of disk |
1711 |
parameters to change. Only ``size``, ``spindles``, and ``mode`` can be |
1712 |
changed while recreating disks. To recreate all disks while changing |
1713 |
parameters on a subset only, a ``--disk`` option must be given for every |
1714 |
disk of the instance. |
1715 |
|
1716 |
Optionally the instance's disks can be recreated on different |
1717 |
nodes. This can be useful if, for example, the original nodes of the |
1718 |
instance have gone down (and are marked offline), so we can't recreate |
1719 |
on the same nodes. To do this, pass the new node(s) via ``-n`` option, |
1720 |
with a syntax similar to the **add** command. The number of nodes |
1721 |
passed must equal the number of nodes that the instance currently |
1722 |
has. Note that changing nodes is only allowed when all disks are |
1723 |
replaced, e.g. when no ``--disk`` option is passed. |
1724 |
|
1725 |
Another method of choosing which nodes to place the instance on is by |
1726 |
using the specified iallocator, passing the ``--iallocator`` option. |
1727 |
The primary and secondary nodes will be chosen by the specified |
1728 |
iallocator plugin, or by the default allocator if ``.`` is specified. |
1729 |
|
1730 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1731 |
options. |
1732 |
|
1733 |
Recovery/moving |
1734 |
~~~~~~~~~~~~~~~ |
1735 |
|
1736 |
FAILOVER |
1737 |
^^^^^^^^ |
1738 |
|
1739 |
| **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy] |
1740 |
| [\--shutdown-timeout=*N*] |
1741 |
| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] |
1742 |
| [\--cleanup] |
1743 |
| [\--submit] [\--print-job-id] |
1744 |
| {*instance*} |
1745 |
|
1746 |
Failover will stop the instance (if running), change its primary node, |
1747 |
and if it was originally running it will start it again (on the new |
1748 |
primary). This works for instances with drbd template (in which case you |
1749 |
can only fail to the secondary node) and for externally mirrored |
1750 |
templates (sharedfile, blockdev, rbd and ext) (in which case you can |
1751 |
fail to any other node). |
1752 |
|
1753 |
If the instance's disk template is of type sharedfile, blockdev, rbd or |
1754 |
ext, then you can explicitly specify the target node (which can be any |
1755 |
node) using the ``-n`` or ``--target-node`` option, or specify an |
1756 |
iallocator plugin using the ``-I`` or ``--iallocator`` option. If you |
1757 |
omit both, the default iallocator will be used to specify the target |
1758 |
node. |
1759 |
|
1760 |
If the instance's disk template is of type drbd, the target node is |
1761 |
automatically selected as the drbd's secondary node. Changing the |
1762 |
secondary node is possible with a replace-disks operation. |
1763 |
|
1764 |
Normally the failover will check the consistency of the disks before |
1765 |
failing over the instance. If you are trying to migrate instances off |
1766 |
a dead node, this will fail. Use the ``--ignore-consistency`` option |
1767 |
for this purpose. Note that this option can be dangerous as errors in |
1768 |
shutting down the instance will be ignored, resulting in possibly |
1769 |
having the instance running on two machines in parallel (on |
1770 |
disconnected DRBD drives). |
1771 |
|
1772 |
The ``--shutdown-timeout`` is used to specify how much time to wait |
1773 |
before forcing the shutdown (xm destroy in xen, killing the kvm |
1774 |
process, for kvm). By default two minutes are given to each instance |
1775 |
to stop. |
1776 |
|
1777 |
If ``--ignore-ipolicy`` is given any instance policy violations occuring |
1778 |
during this operation are ignored. |
1779 |
|
1780 |
If the ``--cleanup`` option is passed, the operation changes from |
1781 |
performin a failover to attempting recovery from a failed previous failover. |
1782 |
In this mode, Ganeti checks if the instance runs on the correct node (and |
1783 |
updates its configuration if not) and ensures the instances' disks |
1784 |
are configured correctly. |
1785 |
|
1786 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1787 |
options. |
1788 |
|
1789 |
Example:: |
1790 |
|
1791 |
# gnt-instance failover instance1.example.com |
1792 |
|
1793 |
For externally mirrored templates also ``-n`` is available:: |
1794 |
|
1795 |
# gnt-instance failover -n node3.example.com instance1.example.com |
1796 |
|
1797 |
|
1798 |
MIGRATE |
1799 |
^^^^^^^ |
1800 |
|
1801 |
| **migrate** [-f] [\--allow-failover] [\--non-live] |
1802 |
| [\--migration-mode=live\|non-live] [\--ignore-ipolicy] |
1803 |
| [\--no-runtime-changes] [\--submit] [\--print-job-id] |
1804 |
| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*} |
1805 |
|
1806 |
| **migrate** [-f] \--cleanup [\--submit] [\--print-job-id] {*instance*} |
1807 |
|
1808 |
Migrate will move the instance to its secondary node without shutdown. |
1809 |
As with failover, it works for instances having the drbd disk template |
1810 |
or an externally mirrored disk template type such as sharedfile, |
1811 |
blockdev, rbd or ext. |
1812 |
|
1813 |
If the instance's disk template is of type sharedfile, blockdev, rbd or |
1814 |
ext, then you can explicitly specify the target node (which can be any |
1815 |
node) using the ``-n`` or ``--target-node`` option, or specify an |
1816 |
iallocator plugin using the ``-I`` or ``--iallocator`` option. If you |
1817 |
omit both, the default iallocator will be used to specify the target |
1818 |
node. Alternatively, the default iallocator can be requested by |
1819 |
specifying ``.`` as the name of the plugin. |
1820 |
|
1821 |
If the instance's disk template is of type drbd, the target node is |
1822 |
automatically selected as the drbd's secondary node. Changing the |
1823 |
secondary node is possible with a replace-disks operation. |
1824 |
|
1825 |
The migration command needs a perfectly healthy instance for drbd |
1826 |
instances, as we rely on the dual-master capability of drbd8 and the |
1827 |
disks of the instance are not allowed to be degraded. |
1828 |
|
1829 |
The ``--non-live`` and ``--migration-mode=non-live`` options will |
1830 |
switch (for the hypervisors that support it) between a "fully live" |
1831 |
(i.e. the interruption is as minimal as possible) migration and one in |
1832 |
which the instance is frozen, its state saved and transported to the |
1833 |
remote node, and then resumed there. This all depends on the |
1834 |
hypervisor support for two different methods. In any case, it is not |
1835 |
an error to pass this parameter (it will just be ignored if the |
1836 |
hypervisor doesn't support it). The option ``--migration-mode=live`` |
1837 |
option will request a fully-live migration. The default, when neither |
1838 |
option is passed, depends on the hypervisor parameters (and can be |
1839 |
viewed with the **gnt-cluster info** command). |
1840 |
|
1841 |
If the ``--cleanup`` option is passed, the operation changes from |
1842 |
migration to attempting recovery from a failed previous migration. In |
1843 |
this mode, Ganeti checks if the instance runs on the correct node (and |
1844 |
updates its configuration if not) and ensures the instances' disks |
1845 |
are configured correctly. In this mode, the ``--non-live`` option is |
1846 |
ignored. |
1847 |
|
1848 |
The option ``-f`` will skip the prompting for confirmation. |
1849 |
|
1850 |
If ``--allow-failover`` is specified it tries to fallback to failover if |
1851 |
it already can determine that a migration won't work (e.g. if the |
1852 |
instance is shut down). Please note that the fallback will not happen |
1853 |
during execution. If a migration fails during execution it still fails. |
1854 |
|
1855 |
If ``--ignore-ipolicy`` is given any instance policy violations occuring |
1856 |
during this operation are ignored. |
1857 |
|
1858 |
The ``--no-runtime-changes`` option forbids migrate to alter an |
1859 |
instance's runtime before migrating it (eg. ballooning an instance |
1860 |
down because the target node doesn't have enough available memory). |
1861 |
|
1862 |
If an instance has the backend parameter ``always_failover`` set to |
1863 |
true, then the migration is automatically converted into a failover. |
1864 |
|
1865 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1866 |
options. |
1867 |
|
1868 |
Example (and expected output):: |
1869 |
|
1870 |
# gnt-instance migrate instance1 |
1871 |
Instance instance1 will be migrated. Note that migration |
1872 |
might impact the instance if anything goes wrong (e.g. due to bugs in |
1873 |
the hypervisor). Continue? |
1874 |
y/[n]/?: y |
1875 |
Migrating instance instance1.example.com |
1876 |
* checking disk consistency between source and target |
1877 |
* switching node node2.example.com to secondary mode |
1878 |
* changing into standalone mode |
1879 |
* changing disks into dual-master mode |
1880 |
* wait until resync is done |
1881 |
* preparing node2.example.com to accept the instance |
1882 |
* migrating instance to node2.example.com |
1883 |
* switching node node1.example.com to secondary mode |
1884 |
* wait until resync is done |
1885 |
* changing into standalone mode |
1886 |
* changing disks into single-master mode |
1887 |
* wait until resync is done |
1888 |
* done |
1889 |
# |
1890 |
|
1891 |
|
1892 |
MOVE |
1893 |
^^^^ |
1894 |
|
1895 |
| **move** [-f] [\--ignore-consistency] |
1896 |
| [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--print-job-id] |
1897 |
| [\--ignore-ipolicy] |
1898 |
| {*instance*} |
1899 |
|
1900 |
Move will move the instance to an arbitrary node in the cluster. This |
1901 |
works only for instances having a plain or file disk template. |
1902 |
|
1903 |
Note that since this operation is done via data copy, it will take a |
1904 |
long time for big disks (similar to replace-disks for a drbd |
1905 |
instance). |
1906 |
|
1907 |
The ``--shutdown-timeout`` is used to specify how much time to wait |
1908 |
before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the |
1909 |
kvm process for KVM, etc.). By default two minutes are given to each |
1910 |
instance to stop. |
1911 |
|
1912 |
The ``--ignore-consistency`` option will make Ganeti ignore any errors |
1913 |
in trying to shutdown the instance on its node; useful if the |
1914 |
hypervisor is broken and you want to recover the data. |
1915 |
|
1916 |
If ``--ignore-ipolicy`` is given any instance policy violations occuring |
1917 |
during this operation are ignored. |
1918 |
|
1919 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1920 |
options. |
1921 |
|
1922 |
Example:: |
1923 |
|
1924 |
# gnt-instance move -n node3.example.com instance1.example.com |
1925 |
|
1926 |
|
1927 |
CHANGE-GROUP |
1928 |
^^^^^^^^^^^^ |
1929 |
|
1930 |
| **change-group** [\--submit] [\--print-job-id] |
1931 |
| [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*} |
1932 |
|
1933 |
This command moves an instance to another node group. The move is |
1934 |
calculated by an iallocator, either given on the command line or as a |
1935 |
cluster default. Note that the iallocator does only consider disk |
1936 |
information of the default disk template, even if the instances' |
1937 |
disk templates differ from that. |
1938 |
|
1939 |
If no specific destination groups are specified using ``--to``, all |
1940 |
groups except the one containing the instance are considered. |
1941 |
|
1942 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
1943 |
options. |
1944 |
|
1945 |
Example:: |
1946 |
|
1947 |
# gnt-instance change-group -I hail --to rack2 inst1.example.com |
1948 |
|
1949 |
|
1950 |
Tags |
1951 |
~~~~ |
1952 |
|
1953 |
ADD-TAGS |
1954 |
^^^^^^^^ |
1955 |
|
1956 |
**add-tags** [\--from *file*] {*instancename*} {*tag*...} |
1957 |
|
1958 |
Add tags to the given instance. If any of the tags contains invalid |
1959 |
characters, the entire operation will abort. |
1960 |
|
1961 |
If the ``--from`` option is given, the list of tags will be extended |
1962 |
with the contents of that file (each line becomes a tag). In this |
1963 |
case, there is not need to pass tags on the command line (if you do, |
1964 |
both sources will be used). A file name of ``-`` will be interpreted |
1965 |
as stdin. |
1966 |
|
1967 |
LIST-TAGS |
1968 |
^^^^^^^^^ |
1969 |
|
1970 |
**list-tags** {*instancename*} |
1971 |
|
1972 |
List the tags of the given instance. |
1973 |
|
1974 |
REMOVE-TAGS |
1975 |
^^^^^^^^^^^ |
1976 |
|
1977 |
**remove-tags** [\--from *file*] {*instancename*} {*tag*...} |
1978 |
|
1979 |
Remove tags from the given instance. If any of the tags are not |
1980 |
existing on the node, the entire operation will abort. |
1981 |
|
1982 |
If the ``--from`` option is given, the list of tags to be removed will |
1983 |
be extended with the contents of that file (each line becomes a tag). |
1984 |
In this case, there is not need to pass tags on the command line (if |
1985 |
you do, tags from both sources will be removed). A file name of ``-`` |
1986 |
will be interpreted as stdin. |
1987 |
|
1988 |
.. vim: set textwidth=72 : |
1989 |
.. Local Variables: |
1990 |
.. mode: rst |
1991 |
.. fill-column: 72 |
1992 |
.. End: |