root / man / gnt-instance.rst @ 3ef02bec
History | View | Annotate | Download (52.9 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}} |
31 |
| {--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*] |
32 |
| \| {-s|--os-size} *SIZE*} |
33 |
| [--no-ip-check] [--no-name-check] [--no-start] [--no-install] |
34 |
| [--net=*N* [:options...] \| --no-nics] |
35 |
| [{-B|--backend-parameters} *BEPARAMS*] |
36 |
| [{-H|--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]] |
37 |
| [{-O|--os-parameters} *param*=*value*... ] |
38 |
| [--file-storage-dir *dir\_path*] [--file-driver {loop \| blktap}] |
39 |
| {{-n|--node} *node[:secondary-node]* \| {-I|--iallocator} *name*} |
40 |
| {{-o|--os-type} *os-type*} |
41 |
| [--submit] |
42 |
| {*instance*} |
43 |
|
44 |
Creates a new instance on the specified host. The *instance* argument |
45 |
must be in DNS, but depending on the bridge/routing setup, need not be |
46 |
in the same network as the nodes in the cluster. |
47 |
|
48 |
The ``disk`` option specifies the parameters for the disks of the |
49 |
instance. The numbering of disks starts at zero, and at least one disk |
50 |
needs to be passed. For each disk, either the size or the adoption |
51 |
source needs to be given, and optionally the access mode (read-only or |
52 |
the default of read-write) and the LVM volume group can also be |
53 |
specified (via the ``vg`` key). For DRBD devices, a different VG can |
54 |
be specified for the metadata device using the ``metavg`` key. The |
55 |
size is interpreted (when no unit is given) in mebibytes. You can also |
56 |
use one of the suffixes *m*, *g* or *t* to specify the exact the units |
57 |
used; these suffixes map to mebibytes, gibibytes and tebibytes. |
58 |
|
59 |
When using the ``adopt`` key in the disk definition, Ganeti will |
60 |
reuse those volumes (instead of creating new ones) as the |
61 |
instance's disks. Ganeti will rename these volumes to the standard |
62 |
format, and (without installing the OS) will use them as-is for the |
63 |
instance. This allows migrating instances from non-managed mode |
64 |
(e.q. plain KVM with LVM) to being managed via Ganeti. Note that |
65 |
this works only for the \`plain' disk template (see below for |
66 |
template details). |
67 |
|
68 |
Alternatively, a single-disk instance can be created via the ``-s`` |
69 |
option which takes a single argument, the size of the disk. This is |
70 |
similar to the Ganeti 1.2 version (but will only create one disk). |
71 |
|
72 |
The minimum disk specification is therefore ``--disk 0:size=20G`` (or |
73 |
``-s 20G`` when using the ``-s`` option), and a three-disk instance |
74 |
can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk |
75 |
2:size=100G``. |
76 |
|
77 |
The ``--no-ip-check`` skips the checks that are done to see if the |
78 |
instance's IP is not already alive (i.e. reachable from the master |
79 |
node). |
80 |
|
81 |
The ``--no-name-check`` skips the check for the instance name via |
82 |
the resolver (e.g. in DNS or /etc/hosts, depending on your setup). |
83 |
Since the name check is used to compute the IP address, if you pass |
84 |
this option you must also pass the ``--no-ip-check`` option. |
85 |
|
86 |
If you don't wat the instance to automatically start after |
87 |
creation, this is possible via the ``--no-start`` option. This will |
88 |
leave the instance down until a subsequent **gnt-instance start** |
89 |
command. |
90 |
|
91 |
The NICs of the instances can be specified via the ``--net`` |
92 |
option. By default, one NIC is created for the instance, with a |
93 |
random MAC, and set up according the the cluster level nic |
94 |
parameters. Each NIC can take these parameters (all optional): |
95 |
|
96 |
mac |
97 |
either a value or 'generate' to generate a new unique MAC |
98 |
|
99 |
ip |
100 |
specifies the IP address assigned to the instance from the Ganeti |
101 |
side (this is not necessarily what the instance will use, but what |
102 |
the node expects the instance to use) |
103 |
|
104 |
mode |
105 |
specifies the connection mode for this nic: routed or bridged. |
106 |
|
107 |
link |
108 |
in bridged mode specifies the bridge to attach this NIC to, in |
109 |
routed mode it's intended to differentiate between different |
110 |
routing tables/instance groups (but the meaning is dependent on |
111 |
the network script, see gnt-cluster(8) for more details) |
112 |
|
113 |
|
114 |
Of these "mode" and "link" are nic parameters, and inherit their |
115 |
default at cluster level. Alternatively, if no network is desired for |
116 |
the instance, you can prevent the default of one NIC with the |
117 |
``--no-nics`` option. |
118 |
|
119 |
The ``-o (--os-type)`` option specifies the operating system to be |
120 |
installed. The available operating systems can be listed with |
121 |
**gnt-os list**. Passing ``--no-install`` will however skip the OS |
122 |
installation, allowing a manual import if so desired. Note that the |
123 |
no-installation mode will automatically disable the start-up of the |
124 |
instance (without an OS, it most likely won't be able to start-up |
125 |
successfully). |
126 |
|
127 |
The ``-B (--backend-parameters)`` option specifies the backend |
128 |
parameters for the instance. If no such parameters are specified, the |
129 |
values are inherited from the cluster. Possible parameters are: |
130 |
|
131 |
memory |
132 |
the memory size of the instance; as usual, suffixes can be used to |
133 |
denote the unit, otherwise the value is taken in mebibites |
134 |
|
135 |
vcpus |
136 |
the number of VCPUs to assign to the instance (if this value makes |
137 |
sense for the hypervisor) |
138 |
|
139 |
auto\_balance |
140 |
whether the instance is considered in the N+1 cluster checks |
141 |
(enough redundancy in the cluster to survive a node failure) |
142 |
|
143 |
|
144 |
The ``-H (--hypervisor-parameters)`` option specified the hypervisor |
145 |
to use for the instance (must be one of the enabled hypervisors on the |
146 |
cluster) and optionally custom parameters for this instance. If not |
147 |
other options are used (i.e. the invocation is just -H *NAME*) the |
148 |
instance will inherit the cluster options. The defaults below show the |
149 |
cluster defaults at cluster creation time. |
150 |
|
151 |
The possible hypervisor options are as follows: |
152 |
|
153 |
boot\_order |
154 |
Valid for the Xen HVM and KVM hypervisors. |
155 |
|
156 |
A string value denoting the boot order. This has different meaning |
157 |
for the Xen HVM hypervisor and for the KVM one. |
158 |
|
159 |
For Xen HVM, The boot order is a string of letters listing the boot |
160 |
devices, with valid device letters being: |
161 |
|
162 |
a |
163 |
floppy drive |
164 |
|
165 |
c |
166 |
hard disk |
167 |
|
168 |
d |
169 |
CDROM drive |
170 |
|
171 |
n |
172 |
network boot (PXE) |
173 |
|
174 |
The default is not to set an HVM boot order which is interpreted |
175 |
as 'dc'. |
176 |
|
177 |
For KVM the boot order is either "floppy", "cdrom", "disk" or |
178 |
"network". Please note that older versions of KVM couldn't |
179 |
netboot from virtio interfaces. This has been fixed in more recent |
180 |
versions and is confirmed to work at least with qemu-kvm 0.11.1. |
181 |
|
182 |
blockdev\_prefix |
183 |
Valid for the Xen HVM and PVM hypervisors. |
184 |
|
185 |
Relevant to non-pvops guest kernels, in which the disk device names |
186 |
are given by the host. Allows one to specify 'xvd', which helps run |
187 |
Red Hat based installers, driven by anaconda. |
188 |
|
189 |
floppy\_image\_path |
190 |
Valid for the KVM hypervisor. |
191 |
|
192 |
The path to a floppy disk image to attach to the instance. This |
193 |
is useful to install Windows operating systems on Virt/IO disks |
194 |
because you can specify here the floppy for the drivers at |
195 |
installation time. |
196 |
|
197 |
cdrom\_image\_path |
198 |
Valid for the Xen HVM and KVM hypervisors. |
199 |
|
200 |
The path to a CDROM image to attach to the instance. |
201 |
|
202 |
cdrom2\_image\_path |
203 |
Valid for the KVM hypervisor. |
204 |
|
205 |
The path to a second CDROM image to attach to the instance. |
206 |
**NOTE**: This image can't be used to boot the system. To do that |
207 |
you have to use the 'cdrom\_image\_path' option. |
208 |
|
209 |
nic\_type |
210 |
Valid for the Xen HVM and KVM hypervisors. |
211 |
|
212 |
This parameter determines the way the network cards are presented |
213 |
to the instance. The possible options are: |
214 |
|
215 |
- rtl8139 (default for Xen HVM) (HVM & KVM) |
216 |
- ne2k\_isa (HVM & KVM) |
217 |
- ne2k\_pci (HVM & KVM) |
218 |
- i82551 (KVM) |
219 |
- i82557b (KVM) |
220 |
- i82559er (KVM) |
221 |
- pcnet (KVM) |
222 |
- e1000 (KVM) |
223 |
- paravirtual (default for KVM) (HVM & KVM) |
224 |
|
225 |
disk\_type |
226 |
Valid for the Xen HVM and KVM hypervisors. |
227 |
|
228 |
This parameter determines the way the disks are presented to the |
229 |
instance. The possible options are: |
230 |
|
231 |
- ioemu [default] (HVM & KVM) |
232 |
- ide (HVM & KVM) |
233 |
- scsi (KVM) |
234 |
- sd (KVM) |
235 |
- mtd (KVM) |
236 |
- pflash (KVM) |
237 |
|
238 |
|
239 |
cdrom\_disk\_type |
240 |
Valid for the KVM hypervisor. |
241 |
|
242 |
This parameter determines the way the cdroms disks are presented |
243 |
to the instance. The default behavior is to get the same value of |
244 |
the eariler parameter (disk_type). The possible options are: |
245 |
|
246 |
- paravirtual |
247 |
- ide |
248 |
- scsi |
249 |
- sd |
250 |
- mtd |
251 |
- pflash |
252 |
|
253 |
|
254 |
vnc\_bind\_address |
255 |
Valid for the Xen HVM and KVM hypervisors. |
256 |
|
257 |
Specifies the address that the VNC listener for this instance |
258 |
should bind to. Valid values are IPv4 addresses. Use the address |
259 |
0.0.0.0 to bind to all available interfaces (this is the default) |
260 |
or specify the address of one of the interfaces on the node to |
261 |
restrict listening to that interface. |
262 |
|
263 |
vnc\_tls |
264 |
Valid for the KVM hypervisor. |
265 |
|
266 |
A boolean option that controls whether the VNC connection is |
267 |
secured with TLS. |
268 |
|
269 |
vnc\_x509\_path |
270 |
Valid for the KVM hypervisor. |
271 |
|
272 |
If ``vnc_tls`` is enabled, this options specifies the path to the |
273 |
x509 certificate to use. |
274 |
|
275 |
vnc\_x509\_verify |
276 |
Valid for the KVM hypervisor. |
277 |
|
278 |
spice\_bind |
279 |
Valid for the KVM hypervisor. |
280 |
|
281 |
Specifies the address or interface on which the SPICE server will |
282 |
listen. Valid values are: |
283 |
|
284 |
- IPv4 addresses, including 0.0.0.0 and 127.0.0.1 |
285 |
- IPv6 addresses, including :: and ::1 |
286 |
- names of network interfaces |
287 |
|
288 |
If a network interface is specified, the SPICE server will be bound |
289 |
to one of the addresses of that interface. |
290 |
|
291 |
spice\_ip\_version |
292 |
Valid for the KVM hypervisor. |
293 |
|
294 |
Specifies which version of the IP protocol should be used by the |
295 |
SPICE server. |
296 |
|
297 |
It is mainly intended to be used for specifying what kind of IP |
298 |
addresses should be used if a network interface with both IPv4 and |
299 |
IPv6 addresses is specified via the ``spice_bind`` parameter. In |
300 |
this case, if the ``spice_ip_version`` parameter is not used, the |
301 |
default IP version of the cluster will be used. |
302 |
|
303 |
acpi |
304 |
Valid for the Xen HVM and KVM hypervisors. |
305 |
|
306 |
A boolean option that specifies if the hypervisor should enable |
307 |
ACPI support for this instance. By default, ACPI is disabled. |
308 |
|
309 |
pae |
310 |
Valid for the Xen HVM and KVM hypervisors. |
311 |
|
312 |
A boolean option that specifies if the hypervisor should enabled |
313 |
PAE support for this instance. The default is false, disabling PAE |
314 |
support. |
315 |
|
316 |
use\_localtime |
317 |
Valid for the Xen HVM and KVM hypervisors. |
318 |
|
319 |
A boolean option that specifies if the instance should be started |
320 |
with its clock set to the localtime of the machine (when true) or |
321 |
to the UTC (When false). The default is false, which is useful for |
322 |
Linux/Unix machines; for Windows OSes, it is recommended to enable |
323 |
this parameter. |
324 |
|
325 |
kernel\_path |
326 |
Valid for the Xen PVM and KVM hypervisors. |
327 |
|
328 |
This option specifies the path (on the node) to the kernel to boot |
329 |
the instance with. Xen PVM instances always require this, while |
330 |
for KVM if this option is empty, it will cause the machine to load |
331 |
the kernel from its disks. |
332 |
|
333 |
kernel\_args |
334 |
Valid for the Xen PVM and KVM hypervisors. |
335 |
|
336 |
This options specifies extra arguments to the kernel that will be |
337 |
loaded. device. This is always used for Xen PVM, while for KVM it |
338 |
is only used if the ``kernel_path`` option is also specified. |
339 |
|
340 |
The default setting for this value is simply ``"ro"``, which |
341 |
mounts the root disk (initially) in read-only one. For example, |
342 |
setting this to single will cause the instance to start in |
343 |
single-user mode. |
344 |
|
345 |
initrd\_path |
346 |
Valid for the Xen PVM and KVM hypervisors. |
347 |
|
348 |
This option specifies the path (on the node) to the initrd to boot |
349 |
the instance with. Xen PVM instances can use this always, while |
350 |
for KVM if this option is only used if the ``kernel_path`` option |
351 |
is also specified. You can pass here either an absolute filename |
352 |
(the path to the initrd) if you want to use an initrd, or use the |
353 |
format no\_initrd\_path for no initrd. |
354 |
|
355 |
root\_path |
356 |
Valid for the Xen PVM and KVM hypervisors. |
357 |
|
358 |
This options specifies the name of the root device. This is always |
359 |
needed for Xen PVM, while for KVM it is only used if the |
360 |
``kernel_path`` option is also specified. |
361 |
|
362 |
Please note, that if this setting is an empty string and the |
363 |
hypervisor is Xen it will not be written to the Xen configuration |
364 |
file |
365 |
|
366 |
serial\_console |
367 |
Valid for the KVM hypervisor. |
368 |
|
369 |
This boolean option specifies whether to emulate a serial console |
370 |
for the instance. |
371 |
|
372 |
disk\_cache |
373 |
Valid for the KVM hypervisor. |
374 |
|
375 |
The disk cache mode. It can be either default to not pass any |
376 |
cache option to KVM, or one of the KVM cache modes: none (for |
377 |
direct I/O), writethrough (to use the host cache but report |
378 |
completion to the guest only when the host has committed the |
379 |
changes to disk) or writeback (to use the host cache and report |
380 |
completion as soon as the data is in the host cache). Note that |
381 |
there are special considerations for the cache mode depending on |
382 |
version of KVM used and disk type (always raw file under Ganeti), |
383 |
please refer to the KVM documentation for more details. |
384 |
|
385 |
security\_model |
386 |
Valid for the KVM hypervisor. |
387 |
|
388 |
The security model for kvm. Currently one of *none*, *user* or |
389 |
*pool*. Under *none*, the default, nothing is done and instances |
390 |
are run as the Ganeti daemon user (normally root). |
391 |
|
392 |
Under *user* kvm will drop privileges and become the user |
393 |
specified by the security\_domain parameter. |
394 |
|
395 |
Under *pool* a global cluster pool of users will be used, making |
396 |
sure no two instances share the same user on the same node. (this |
397 |
mode is not implemented yet) |
398 |
|
399 |
security\_domain |
400 |
Valid for the KVM hypervisor. |
401 |
|
402 |
Under security model *user* the username to run the instance |
403 |
under. It must be a valid username existing on the host. |
404 |
|
405 |
Cannot be set under security model *none* or *pool*. |
406 |
|
407 |
kvm\_flag |
408 |
Valid for the KVM hypervisor. |
409 |
|
410 |
If *enabled* the -enable-kvm flag is passed to kvm. If *disabled* |
411 |
-disable-kvm is passed. If unset no flag is passed, and the |
412 |
default running mode for your kvm binary will be used. |
413 |
|
414 |
mem\_path |
415 |
Valid for the KVM hypervisor. |
416 |
|
417 |
This option passes the -mem-path argument to kvm with the path (on |
418 |
the node) to the mount point of the hugetlbfs file system, along |
419 |
with the -mem-prealloc argument too. |
420 |
|
421 |
use\_chroot |
422 |
Valid for the KVM hypervisor. |
423 |
|
424 |
This boolean option determines wether to run the KVM instance in a |
425 |
chroot directory. |
426 |
|
427 |
If it is set to ``true``, an empty directory is created before |
428 |
starting the instance and its path is passed via the -chroot flag |
429 |
to kvm. The directory is removed when the instance is stopped. |
430 |
|
431 |
It is set to ``false`` by default. |
432 |
|
433 |
migration\_downtime |
434 |
Valid for the KVM hypervisor. |
435 |
|
436 |
The maximum amount of time (in ms) a KVM instance is allowed to be |
437 |
frozen during a live migration, in order to copy dirty memory |
438 |
pages. Default value is 30ms, but you may need to increase this |
439 |
value for busy instances. |
440 |
|
441 |
This option is only effective with kvm versions >= 87 and qemu-kvm |
442 |
versions >= 0.11.0. |
443 |
|
444 |
cpu\_mask |
445 |
Valid for the LXC hypervisor. |
446 |
|
447 |
The processes belonging to the given instance are only scheduled |
448 |
on the specified CPUs. |
449 |
|
450 |
The parameter format is a comma-separated list of CPU IDs or CPU |
451 |
ID ranges. The ranges are defined by a lower and higher boundary, |
452 |
separated by a dash. The boundaries are inclusive. |
453 |
|
454 |
usb\_mouse |
455 |
Valid for the KVM hypervisor. |
456 |
|
457 |
This option specifies the usb mouse type to be used. It can be |
458 |
"mouse" or "tablet". When using VNC it's recommended to set it to |
459 |
"tablet". |
460 |
|
461 |
keymap |
462 |
Valid for the KVM hypervisor. |
463 |
|
464 |
This option specifies the keyboard mapping to be used. It is only |
465 |
needed when using the VNC console. For example: "fr" or "en-gb". |
466 |
|
467 |
reboot\_behavior |
468 |
Valid for Xen PVM, Xen HVM and KVM hypervisors. |
469 |
|
470 |
Normally if an instance reboots, the hypervisor will restart it. If |
471 |
this option is set to ``exit``, the hypervisor will treat a reboot |
472 |
as a shutdown instead. |
473 |
|
474 |
It is set to ``reboot`` by default. |
475 |
|
476 |
|
477 |
The ``-O (--os-parameters)`` option allows customisation of the OS |
478 |
parameters. The actual parameter names and values depends on the OS |
479 |
being used, but the syntax is the same key=value. For example, setting |
480 |
a hypothetical ``dhcp`` parameter to yes can be achieved by:: |
481 |
|
482 |
gnt-instance add -O dhcp=yes ... |
483 |
|
484 |
The ``-I (--iallocator)`` option specifies the instance allocator |
485 |
plugin to use. If you pass in this option the allocator will select |
486 |
nodes for this instance automatically, so you don't need to pass them |
487 |
with the ``-n`` option. For more information please refer to the |
488 |
instance allocator documentation. |
489 |
|
490 |
The ``-t (--disk-template)`` options specifies the disk layout type |
491 |
for the instance. The available choices are: |
492 |
|
493 |
diskless |
494 |
This creates an instance with no disks. Its useful for testing only |
495 |
(or other special cases). |
496 |
|
497 |
file |
498 |
Disk devices will be regular files. |
499 |
|
500 |
plain |
501 |
Disk devices will be logical volumes. |
502 |
|
503 |
drbd |
504 |
Disk devices will be drbd (version 8.x) on top of lvm volumes. |
505 |
|
506 |
|
507 |
The optional second value of the ``-n (--node)`` is used for the drbd |
508 |
template type and specifies the remote node. |
509 |
|
510 |
If you do not want gnt-instance to wait for the disk mirror to be |
511 |
synced, use the ``--no-wait-for-sync`` option. |
512 |
|
513 |
The ``--file-storage-dir`` specifies the relative path under the |
514 |
cluster-wide file storage directory to store file-based disks. It is |
515 |
useful for having different subdirectories for different |
516 |
instances. The full path of the directory where the disk files are |
517 |
stored will consist of cluster-wide file storage directory + optional |
518 |
subdirectory + instance name. Example: |
519 |
``@RPL_FILE_STORAGE_DIR@``*/mysubdir/instance1.example.com*. This |
520 |
option is only relevant for instances using the file storage backend. |
521 |
|
522 |
The ``--file-driver`` specifies the driver to use for file-based |
523 |
disks. Note that currently these drivers work with the xen hypervisor |
524 |
only. This option is only relevant for instances using the file |
525 |
storage backend. The available choices are: |
526 |
|
527 |
loop |
528 |
Kernel loopback driver. This driver uses loopback devices to |
529 |
access the filesystem within the file. However, running I/O |
530 |
intensive applications in your instance using the loop driver |
531 |
might result in slowdowns. Furthermore, if you use the loopback |
532 |
driver consider increasing the maximum amount of loopback devices |
533 |
(on most systems it's 8) using the max\_loop param. |
534 |
|
535 |
blktap |
536 |
The blktap driver (for Xen hypervisors). In order to be able to |
537 |
use the blktap driver you should check if the 'blktapctrl' user |
538 |
space disk agent is running (usually automatically started via |
539 |
xend). This user-level disk I/O interface has the advantage of |
540 |
better performance. Especially if you use a network file system |
541 |
(e.g. NFS) to store your instances this is the recommended choice. |
542 |
|
543 |
|
544 |
The ``--submit`` option is used to send the job to the master daemon |
545 |
but not wait for its completion. The job ID will be shown so that it |
546 |
can be examined via **gnt-job info**. |
547 |
|
548 |
Example:: |
549 |
|
550 |
# gnt-instance add -t file --disk 0:size=30g -B memory=512 -o debian-etch \ |
551 |
-n node1.example.com --file-storage-dir=mysubdir instance1.example.com |
552 |
# gnt-instance add -t plain --disk 0:size=30g -B memory=512 -o debian-etch \ |
553 |
-n node1.example.com instance1.example.com |
554 |
# gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \ |
555 |
-B memory=512 -o debian-etch -n node1.example.com instance1.example.com |
556 |
# gnt-instance add -t drbd --disk 0:size=30g -B memory=512 -o debian-etch \ |
557 |
-n node1.example.com:node2.example.com instance2.example.com |
558 |
|
559 |
|
560 |
BATCH-CREATE |
561 |
^^^^^^^^^^^^ |
562 |
|
563 |
**batch-create** {instances\_file.json} |
564 |
|
565 |
This command (similar to the Ganeti 1.2 **batcher** tool) submits |
566 |
multiple instance creation jobs based on a definition file. The |
567 |
instance configurations do not encompass all the possible options for |
568 |
the **add** command, but only a subset. |
569 |
|
570 |
The instance file should be a valid-formed JSON file, containing a |
571 |
dictionary with instance name and instance parameters. The accepted |
572 |
parameters are: |
573 |
|
574 |
disk\_size |
575 |
The size of the disks of the instance. |
576 |
|
577 |
disk\_template |
578 |
The disk template to use for the instance, the same as in the |
579 |
**add** command. |
580 |
|
581 |
backend |
582 |
A dictionary of backend parameters. |
583 |
|
584 |
hypervisor |
585 |
A dictionary with a single key (the hypervisor name), and as value |
586 |
the hypervisor options. If not passed, the default hypervisor and |
587 |
hypervisor options will be inherited. |
588 |
|
589 |
mac, ip, mode, link |
590 |
Specifications for the one NIC that will be created for the |
591 |
instance. 'bridge' is also accepted as a backwards compatibile |
592 |
key. |
593 |
|
594 |
nics |
595 |
List of nics that will be created for the instance. Each entry |
596 |
should be a dict, with mac, ip, mode and link as possible keys. |
597 |
Please don't provide the "mac, ip, mode, link" parent keys if you |
598 |
use this method for specifying nics. |
599 |
|
600 |
primary\_node, secondary\_node |
601 |
The primary and optionally the secondary node to use for the |
602 |
instance (in case an iallocator script is not used). |
603 |
|
604 |
iallocator |
605 |
Instead of specifying the nodes, an iallocator script can be used |
606 |
to automatically compute them. |
607 |
|
608 |
start |
609 |
whether to start the instance |
610 |
|
611 |
ip\_check |
612 |
Skip the check for already-in-use instance; see the description in |
613 |
the **add** command for details. |
614 |
|
615 |
name\_check |
616 |
Skip the name check for instances; see the description in the |
617 |
**add** command for details. |
618 |
|
619 |
file\_storage\_dir, file\_driver |
620 |
Configuration for the file disk type, see the **add** command for |
621 |
details. |
622 |
|
623 |
|
624 |
A simple definition for one instance can be (with most of the |
625 |
parameters taken from the cluster defaults):: |
626 |
|
627 |
{ |
628 |
"instance3": { |
629 |
"template": "drbd", |
630 |
"os": "debootstrap", |
631 |
"disk_size": ["25G"], |
632 |
"iallocator": "dumb" |
633 |
}, |
634 |
"instance5": { |
635 |
"template": "drbd", |
636 |
"os": "debootstrap", |
637 |
"disk_size": ["25G"], |
638 |
"iallocator": "dumb", |
639 |
"hypervisor": "xen-hvm", |
640 |
"hvparams": {"acpi": true}, |
641 |
"backend": {"memory": 512} |
642 |
} |
643 |
} |
644 |
|
645 |
The command will display the job id for each submitted instance, as |
646 |
follows:: |
647 |
|
648 |
# gnt-instance batch-create instances.json |
649 |
instance3: 11224 |
650 |
instance5: 11225 |
651 |
|
652 |
REMOVE |
653 |
^^^^^^ |
654 |
|
655 |
**remove** [--ignore-failures] [--shutdown-timeout=*N*] [--submit] |
656 |
[--force] {*instance*} |
657 |
|
658 |
Remove an instance. This will remove all data from the instance and |
659 |
there is *no way back*. If you are not sure if you use an instance |
660 |
again, use **shutdown** first and leave it in the shutdown state for a |
661 |
while. |
662 |
|
663 |
The ``--ignore-failures`` option will cause the removal to proceed |
664 |
even in the presence of errors during the removal of the instance |
665 |
(e.g. during the shutdown or the disk removal). If this option is not |
666 |
given, the command will stop at the first error. |
667 |
|
668 |
The ``--shutdown-timeout`` is used to specify how much time to wait |
669 |
before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the |
670 |
kvm process for KVM, etc.). By default two minutes are given to each |
671 |
instance to stop. |
672 |
|
673 |
The ``--submit`` option is used to send the job to the master daemon |
674 |
but not wait for its completion. The job ID will be shown so that it |
675 |
can be examined via **gnt-job info**. |
676 |
|
677 |
The ``--force`` option is used to skip the interactive confirmation. |
678 |
|
679 |
Example:: |
680 |
|
681 |
# gnt-instance remove instance1.example.com |
682 |
|
683 |
|
684 |
LIST |
685 |
^^^^ |
686 |
|
687 |
| **list** |
688 |
| [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*] [-v] |
689 |
| [{-o|--output} *[+]FIELD,...*] [--filter] [instance...] |
690 |
|
691 |
Shows the currently configured instances with memory usage, disk |
692 |
usage, the node they are running on, and their run status. |
693 |
|
694 |
The ``--no-headers`` option will skip the initial header line. The |
695 |
``--separator`` option takes an argument which denotes what will be |
696 |
used between the output fields. Both these options are to help |
697 |
scripting. |
698 |
|
699 |
The units used to display the numeric values in the output varies, |
700 |
depending on the options given. By default, the values will be |
701 |
formatted in the most appropriate unit. If the ``--separator`` option |
702 |
is given, then the values are shown in mebibytes to allow parsing by |
703 |
scripts. In both cases, the ``--units`` option can be used to enforce |
704 |
a given output unit. |
705 |
|
706 |
The ``-v`` option activates verbose mode, which changes the display of |
707 |
special field states (see **ganeti(7)**). |
708 |
|
709 |
The ``-o (--output)`` option takes a comma-separated list of output |
710 |
fields. The available fields and their meaning are: |
711 |
|
712 |
@QUERY_FIELDS_INSTANCE@ |
713 |
|
714 |
If the value of the option starts with the character ``+``, the new |
715 |
field(s) will be added to the default list. This allows one to quickly |
716 |
see the default list plus a few other fields, instead of retyping the |
717 |
entire list of fields. |
718 |
|
719 |
There is a subtle grouping about the available output fields: all |
720 |
fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and |
721 |
``status`` are configuration value and not run-time values. So if you |
722 |
don't select any of the these fields, the query will be satisfied |
723 |
instantly from the cluster configuration, without having to ask the |
724 |
remote nodes for the data. This can be helpful for big clusters when |
725 |
you only want some data and it makes sense to specify a reduced set of |
726 |
output fields. |
727 |
|
728 |
If exactly one argument is given and it appears to be a query filter |
729 |
(see **ganeti(7)**), the query result is filtered accordingly. For |
730 |
ambiguous cases (e.g. a single field name as a filter) the ``--filter`` |
731 |
(``-F``) option forces the argument to be treated as a filter (e.g. |
732 |
``gnt-instance list -F admin_state``). |
733 |
|
734 |
The default output field list is: ``name``, ``os``, ``pnode``, |
735 |
``admin_state``, ``oper_state``, ``oper_ram``. |
736 |
|
737 |
|
738 |
LIST-FIELDS |
739 |
~~~~~~~~~~~ |
740 |
|
741 |
**list-fields** [field...] |
742 |
|
743 |
Lists available fields for instances. |
744 |
|
745 |
|
746 |
INFO |
747 |
^^^^ |
748 |
|
749 |
**info** [-s \| --static] [--roman] {--all \| *instance*} |
750 |
|
751 |
Show detailed information about the given instance(s). This is |
752 |
different from **list** as it shows detailed data about the instance's |
753 |
disks (especially useful for the drbd disk template). |
754 |
|
755 |
If the option ``-s`` is used, only information available in the |
756 |
configuration file is returned, without querying nodes, making the |
757 |
operation faster. |
758 |
|
759 |
Use the ``--all`` to get info about all instances, rather than |
760 |
explicitly passing the ones you're interested in. |
761 |
|
762 |
The ``--roman`` option can be used to cause envy among people who like |
763 |
ancient cultures, but are stuck with non-latin-friendly cluster |
764 |
virtualization technologies. |
765 |
|
766 |
MODIFY |
767 |
^^^^^^ |
768 |
|
769 |
| **modify** |
770 |
| [{-H|--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*] |
771 |
| [{-B|--backend-parameters} *BACKEND\_PARAMETERS*] |
772 |
| [--net add*[:options]* \| --net remove \| --net *N:options*] |
773 |
| [--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| --disk remove \| |
774 |
| --disk *N*:mode=*MODE*] |
775 |
| [{-t|--disk-template} plain | {-t|--disk-template} drbd -n *new_secondary*] [--no-wait-for-sync] |
776 |
| [--os-type=*OS* [--force-variant]] |
777 |
| [{-O|--os-parameters} *param*=*value*... ] |
778 |
| [--submit] |
779 |
| {*instance*} |
780 |
|
781 |
Modifies the memory size, number of vcpus, ip address, MAC address |
782 |
and/or nic parameters for an instance. It can also add and remove |
783 |
disks and NICs to/from the instance. Note that you need to give at |
784 |
least one of the arguments, otherwise the command complains. |
785 |
|
786 |
The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)`` |
787 |
and ``-O (--os-parameters)`` options specifies hypervisor, backend and |
788 |
OS parameter options in the form of name=value[,...]. For details |
789 |
which options can be specified, see the **add** command. |
790 |
|
791 |
The ``-t (--disk-template)`` option will change the disk template of |
792 |
the instance. Currently only conversions between the plain and drbd |
793 |
disk templates are supported, and the instance must be stopped before |
794 |
attempting the conversion. When changing from the plain to the drbd |
795 |
disk template, a new secondary node must be specified via the ``-n`` |
796 |
option. The option ``--no-wait-for-sync`` can be used when converting |
797 |
to the ``drbd`` template in order to make the instance available for |
798 |
startup before DRBD has finished resyncing. |
799 |
|
800 |
The ``--disk add:size=``*SIZE* option adds a disk to the instance. The |
801 |
optional ``vg=``*VG* option specifies LVM volume group other than |
802 |
default vg to create the disk on. For DRBD disks, the ``metavg=``*VG* |
803 |
option specifies the volume group for the metadata device. The |
804 |
``--disk remove`` option will remove the last disk of the |
805 |
instance. The ``--disk`` *N*``:mode=``*MODE* option will change the |
806 |
mode of the Nth disk of the instance between read-only (``ro``) and |
807 |
read-write (``rw``). |
808 |
|
809 |
The ``--net add:``*options* option will add a new NIC to the |
810 |
instance. The available options are the same as in the **add** command |
811 |
(mac, ip, link, mode). The ``--net remove`` will remove the last NIC |
812 |
of the instance, while the ``--net`` *N*:*options* option will change |
813 |
the parameters of the Nth instance NIC. |
814 |
|
815 |
The option ``-o (--os-type)`` will change the OS name for the instance |
816 |
(without reinstallation). In case an OS variant is specified that is |
817 |
not found, then by default the modification is refused, unless |
818 |
``--force-variant`` is passed. An invalid OS will also be refused, |
819 |
unless the ``--force`` option is given. |
820 |
|
821 |
The ``--submit`` option is used to send the job to the master daemon |
822 |
but not wait for its completion. The job ID will be shown so that it |
823 |
can be examined via **gnt-job info**. |
824 |
|
825 |
All the changes take effect at the next restart. If the instance is |
826 |
running, there is no effect on the instance. |
827 |
|
828 |
REINSTALL |
829 |
^^^^^^^^^ |
830 |
|
831 |
| **reinstall** [{-o|--os-type} *os-type*] [--select-os] [-f *force*] |
832 |
| [--force-multiple] |
833 |
| [--instance \| --node \| --primary \| --secondary \| --all] |
834 |
| [{-O|--os-parameters} *OS\_PARAMETERS*] [--submit] {*instance*...} |
835 |
|
836 |
Reinstalls the operating system on the given instance(s). The |
837 |
instance(s) must be stopped when running this command. If the ``-o |
838 |
(--os-type)`` is specified, the operating system is changed. |
839 |
|
840 |
The ``--select-os`` option switches to an interactive OS reinstall. |
841 |
The user is prompted to select the OS template from the list of |
842 |
available OS templates. OS parameters can be overridden using ``-O |
843 |
(--os-parameters)`` (more documentation for this option under the |
844 |
**add** command). |
845 |
|
846 |
Since this is a potentially dangerous command, the user will be |
847 |
required to confirm this action, unless the ``-f`` flag is passed. |
848 |
When multiple instances are selected (either by passing multiple |
849 |
arguments or by using the ``--node``, ``--primary``, ``--secondary`` |
850 |
or ``--all`` options), the user must pass the ``--force-multiple`` |
851 |
options to skip the interactive confirmation. |
852 |
|
853 |
The ``--submit`` option is used to send the job to the master daemon |
854 |
but not wait for its completion. The job ID will be shown so that it |
855 |
can be examined via **gnt-job info**. |
856 |
|
857 |
RENAME |
858 |
^^^^^^ |
859 |
|
860 |
| **rename** [--no-ip-check] [--no-name-check] [--submit] |
861 |
| {*instance*} {*new\_name*} |
862 |
|
863 |
Renames the given instance. The instance must be stopped when running |
864 |
this command. The requirements for the new name are the same as for |
865 |
adding an instance: the new name must be resolvable and the IP it |
866 |
resolves to must not be reachable (in order to prevent duplicate IPs |
867 |
the next time the instance is started). The IP test can be skipped if |
868 |
the ``--no-ip-check`` option is passed. |
869 |
|
870 |
The ``--no-name-check`` skips the check for the new instance name via |
871 |
the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and |
872 |
that the resolved name matches the provided name. Since the name check |
873 |
is used to compute the IP address, if you pass this option you must also |
874 |
pass the ``--no-ip-check`` option. |
875 |
|
876 |
The ``--submit`` option is used to send the job to the master daemon |
877 |
but not wait for its completion. The job ID will be shown so that it |
878 |
can be examined via **gnt-job info**. |
879 |
|
880 |
Starting/stopping/connecting to console |
881 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
882 |
|
883 |
STARTUP |
884 |
^^^^^^^ |
885 |
|
886 |
| **startup** |
887 |
| [--force] [--ignore-offline] |
888 |
| [--force-multiple] [--no-remember] |
889 |
| [--instance \| --node \| --primary \| --secondary \| --all \| |
890 |
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags] |
891 |
| [{-H|--hypervisor-parameters} ``key=value...``] |
892 |
| [{-B|--backend-parameters} ``key=value...``] |
893 |
| [--submit] [--paused] |
894 |
| {*name*...} |
895 |
|
896 |
Starts one or more instances, depending on the following options. The |
897 |
four available modes are: |
898 |
|
899 |
--instance |
900 |
will start the instances given as arguments (at least one argument |
901 |
required); this is the default selection |
902 |
|
903 |
--node |
904 |
will start the instances who have the given node as either primary |
905 |
or secondary |
906 |
|
907 |
--primary |
908 |
will start all instances whose primary node is in the list of nodes |
909 |
passed as arguments (at least one node required) |
910 |
|
911 |
--secondary |
912 |
will start all instances whose secondary node is in the list of |
913 |
nodes passed as arguments (at least one node required) |
914 |
|
915 |
--all |
916 |
will start all instances in the cluster (no arguments accepted) |
917 |
|
918 |
--tags |
919 |
will start all instances in the cluster with the tags given as |
920 |
arguments |
921 |
|
922 |
--node-tags |
923 |
will start all instances in the cluster on nodes with the tags |
924 |
given as arguments |
925 |
|
926 |
--pri-node-tags |
927 |
will start all instances in the cluster on primary nodes with the |
928 |
tags given as arguments |
929 |
|
930 |
--sec-node-tags |
931 |
will start all instances in the cluster on secondary nodes with the |
932 |
tags given as arguments |
933 |
|
934 |
Note that although you can pass more than one selection option, the |
935 |
last one wins, so in order to guarantee the desired result, don't pass |
936 |
more than one such option. |
937 |
|
938 |
Use ``--force`` to start even if secondary disks are failing. |
939 |
``--ignore-offline`` can be used to ignore offline primary nodes and |
940 |
mark the instance as started even if the primary is not available. |
941 |
|
942 |
The ``--force-multiple`` will skip the interactive confirmation in the |
943 |
case the more than one instance will be affected. |
944 |
|
945 |
The ``--no-remember`` option will perform the startup but not change |
946 |
the state of the instance in the configuration file (if it was stopped |
947 |
before, Ganeti will still thinks it needs to be stopped). This can be |
948 |
used for testing, or for a one shot-start where you don't want the |
949 |
watcher to restart the instance if it crashes. |
950 |
|
951 |
The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)`` |
952 |
options specify temporary hypervisor and backend parameters that can |
953 |
be used to start an instance with modified parameters. They can be |
954 |
useful for quick testing without having to modify an instance back and |
955 |
forth, e.g.:: |
956 |
|
957 |
# gnt-instance start -H kernel_args="single" instance1 |
958 |
# gnt-instance start -B memory=2048 instance2 |
959 |
|
960 |
|
961 |
The first form will start the instance instance1 in single-user mode, |
962 |
and the instance instance2 with 2GB of RAM (this time only, unless |
963 |
that is the actual instance memory size already). Note that the values |
964 |
override the instance parameters (and not extend them): an instance |
965 |
with "kernel\_args=ro" when started with -H kernel\_args=single will |
966 |
result in "single", not "ro single". The ``--submit`` option is used |
967 |
to send the job to the master daemon but not wait for its |
968 |
completion. The job ID will be shown so that it can be examined via |
969 |
**gnt-job info**. |
970 |
|
971 |
The ``--paused`` option is only valid for Xen and kvm hypervisors. This |
972 |
pauses the instance at the start of bootup, awaiting ``gnt-instance |
973 |
console`` to unpause it, allowing the entire boot process to be |
974 |
monitored for debugging. |
975 |
|
976 |
Example:: |
977 |
|
978 |
# gnt-instance start instance1.example.com |
979 |
# gnt-instance start --node node1.example.com node2.example.com |
980 |
# gnt-instance start --all |
981 |
|
982 |
|
983 |
SHUTDOWN |
984 |
^^^^^^^^ |
985 |
|
986 |
| **shutdown** |
987 |
| [--timeout=*N*] |
988 |
| [--force-multiple] [--ignore-offline] [--no-remember] |
989 |
| [--instance \| --node \| --primary \| --secondary \| --all \| |
990 |
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags] |
991 |
| [--submit] |
992 |
| {*name*...} |
993 |
|
994 |
Stops one or more instances. If the instance cannot be cleanly stopped |
995 |
during a hardcoded interval (currently 2 minutes), it will forcibly |
996 |
stop the instance (equivalent to switching off the power on a physical |
997 |
machine). |
998 |
|
999 |
The ``--timeout`` is used to specify how much time to wait before |
1000 |
forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm |
1001 |
process for KVM, etc.). By default two minutes are given to each |
1002 |
instance to stop. |
1003 |
|
1004 |
The ``--instance``, ``--node``, ``--primary``, ``--secondary``, |
1005 |
``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and |
1006 |
``--sec-node-tags`` options are similar as for the **startup** command |
1007 |
and they influence the actual instances being shutdown. |
1008 |
|
1009 |
The ``--submit`` option is used to send the job to the master daemon |
1010 |
but not wait for its completion. The job ID will be shown so that it |
1011 |
can be examined via **gnt-job info**. |
1012 |
|
1013 |
``--ignore-offline`` can be used to ignore offline primary nodes and |
1014 |
force the instance to be marked as stopped. This option should be used |
1015 |
with care as it can lead to an inconsistent cluster state. |
1016 |
|
1017 |
The ``--no-remember`` option will perform the shutdown but not change |
1018 |
the state of the instance in the configuration file (if it was running |
1019 |
before, Ganeti will still thinks it needs to be running). This can be |
1020 |
useful for a cluster-wide shutdown, where some instances are marked as |
1021 |
up and some as down, and you don't want to change the running state: |
1022 |
you just need to disable the watcher, shutdown all instances with |
1023 |
``--no-remember``, and when the watcher is activated again it will |
1024 |
restore the correct runtime state for all instances. |
1025 |
|
1026 |
Example:: |
1027 |
|
1028 |
# gnt-instance shutdown instance1.example.com |
1029 |
# gnt-instance shutdown --all |
1030 |
|
1031 |
|
1032 |
REBOOT |
1033 |
^^^^^^ |
1034 |
|
1035 |
| **reboot** |
1036 |
| [{-t|--type} *REBOOT-TYPE*] |
1037 |
| [--ignore-secondaries] |
1038 |
| [--shutdown-timeout=*N*] |
1039 |
| [--force-multiple] |
1040 |
| [--instance \| --node \| --primary \| --secondary \| --all \| |
1041 |
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags] |
1042 |
| [--submit] |
1043 |
| [*name*...] |
1044 |
|
1045 |
Reboots one or more instances. The type of reboot depends on the value |
1046 |
of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot |
1047 |
does a instance stop, recreates the hypervisor config for the instance |
1048 |
and starts the instance. A full reboot does the equivalent of |
1049 |
**gnt-instance shutdown && gnt-instance startup**. The default is |
1050 |
hard reboot. |
1051 |
|
1052 |
For the hard reboot the option ``--ignore-secondaries`` ignores errors |
1053 |
for the secondary node while re-assembling the instance disks. |
1054 |
|
1055 |
The ``--instance``, ``--node``, ``--primary``, ``--secondary``, |
1056 |
``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and |
1057 |
``--sec-node-tags`` options are similar as for the **startup** command |
1058 |
and they influence the actual instances being rebooted. |
1059 |
|
1060 |
The ``--shutdown-timeout`` is used to specify how much time to wait |
1061 |
before forcing the shutdown (xm destroy in xen, killing the kvm |
1062 |
process, for kvm). By default two minutes are given to each instance |
1063 |
to stop. |
1064 |
|
1065 |
The ``--force-multiple`` will skip the interactive confirmation in the |
1066 |
case the more than one instance will be affected. |
1067 |
|
1068 |
Example:: |
1069 |
|
1070 |
# gnt-instance reboot instance1.example.com |
1071 |
# gnt-instance reboot --type=full instance1.example.com |
1072 |
|
1073 |
|
1074 |
CONSOLE |
1075 |
^^^^^^^ |
1076 |
|
1077 |
**console** [--show-cmd] {*instance*} |
1078 |
|
1079 |
Connects to the console of the given instance. If the instance is not |
1080 |
up, an error is returned. Use the ``--show-cmd`` option to display the |
1081 |
command instead of executing it. |
1082 |
|
1083 |
For HVM instances, this will attempt to connect to the serial console |
1084 |
of the instance. To connect to the virtualized "physical" console of a |
1085 |
HVM instance, use a VNC client with the connection info from the |
1086 |
**info** command. |
1087 |
|
1088 |
For Xen/kvm instances, if the instance is paused, this attempts to |
1089 |
unpause the instance after waiting a few seconds for the connection to |
1090 |
the console to be made. |
1091 |
|
1092 |
Example:: |
1093 |
|
1094 |
# gnt-instance console instance1.example.com |
1095 |
|
1096 |
|
1097 |
Disk management |
1098 |
~~~~~~~~~~~~~~~ |
1099 |
|
1100 |
REPLACE-DISKS |
1101 |
^^^^^^^^^^^^^ |
1102 |
|
1103 |
**replace-disks** [--submit] [--early-release] {-p} [--disks *idx*] |
1104 |
{*instance*} |
1105 |
|
1106 |
**replace-disks** [--submit] [--early-release] {-s} [--disks *idx*] |
1107 |
{*instance*} |
1108 |
|
1109 |
**replace-disks** [--submit] [--early-release] {--iallocator *name* |
1110 |
\| --new-secondary *NODE*} {*instance*} |
1111 |
|
1112 |
**replace-disks** [--submit] [--early-release] {--auto} |
1113 |
{*instance*} |
1114 |
|
1115 |
This command is a generalized form for replacing disks. It is |
1116 |
currently only valid for the mirrored (DRBD) disk template. |
1117 |
|
1118 |
The first form (when passing the ``-p`` option) will replace the disks |
1119 |
on the primary, while the second form (when passing the ``-s`` option |
1120 |
will replace the disks on the secondary node. For these two cases (as |
1121 |
the node doesn't change), it is possible to only run the replace for a |
1122 |
subset of the disks, using the option ``--disks`` which takes a list |
1123 |
of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only |
1124 |
the first and third disks. |
1125 |
|
1126 |
The third form (when passing either the ``--iallocator`` or the |
1127 |
``--new-secondary`` option) is designed to change secondary node of |
1128 |
the instance. Specifying ``--iallocator`` makes the new secondary be |
1129 |
selected automatically by the specified allocator plugin, otherwise |
1130 |
the new secondary node will be the one chosen manually via the |
1131 |
``--new-secondary`` option. |
1132 |
|
1133 |
The fourth form (when using ``--auto``) will automatically determine |
1134 |
which disks of an instance are faulty and replace them within the same |
1135 |
node. The ``--auto`` option works only when an instance has only |
1136 |
faulty disks on either the primary or secondary node; it doesn't work |
1137 |
when both sides have faulty disks. |
1138 |
|
1139 |
The ``--submit`` option is used to send the job to the master daemon |
1140 |
but not wait for its completion. The job ID will be shown so that it |
1141 |
can be examined via **gnt-job info**. |
1142 |
|
1143 |
The ``--early-release`` changes the code so that the old storage on |
1144 |
secondary node(s) is removed early (before the resync is completed) |
1145 |
and the internal Ganeti locks for the current (and new, if any) |
1146 |
secondary node are also released, thus allowing more parallelism in |
1147 |
the cluster operation. This should be used only when recovering from a |
1148 |
disk failure on the current secondary (thus the old storage is already |
1149 |
broken) or when the storage on the primary node is known to be fine |
1150 |
(thus we won't need the old storage for potential recovery). |
1151 |
|
1152 |
Note that it is not possible to select an offline or drained node as a |
1153 |
new secondary. |
1154 |
|
1155 |
ACTIVATE-DISKS |
1156 |
^^^^^^^^^^^^^^ |
1157 |
|
1158 |
**activate-disks** [--submit] [--ignore-size] {*instance*} |
1159 |
|
1160 |
Activates the block devices of the given instance. If successful, the |
1161 |
command will show the location and name of the block devices:: |
1162 |
|
1163 |
node1.example.com:disk/0:/dev/drbd0 |
1164 |
node1.example.com:disk/1:/dev/drbd1 |
1165 |
|
1166 |
|
1167 |
In this example, *node1.example.com* is the name of the node on which |
1168 |
the devices have been activated. The *disk/0* and *disk/1* are the |
1169 |
Ganeti-names of the instance disks; how they are visible inside the |
1170 |
instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the |
1171 |
actual block devices as visible on the node. The ``--submit`` option |
1172 |
is used to send the job to the master daemon but not wait for its |
1173 |
completion. The job ID will be shown so that it can be examined via |
1174 |
**gnt-job info**. |
1175 |
|
1176 |
The ``--ignore-size`` option can be used to activate disks ignoring |
1177 |
the currently configured size in Ganeti. This can be used in cases |
1178 |
where the configuration has gotten out of sync with the real-world |
1179 |
(e.g. after a partially-failed grow-disk operation or due to rounding |
1180 |
in LVM devices). This should not be used in normal cases, but only |
1181 |
when activate-disks fails without it. |
1182 |
|
1183 |
Note that it is safe to run this command while the instance is already |
1184 |
running. |
1185 |
|
1186 |
DEACTIVATE-DISKS |
1187 |
^^^^^^^^^^^^^^^^ |
1188 |
|
1189 |
**deactivate-disks** [-f] [--submit] {*instance*} |
1190 |
|
1191 |
De-activates the block devices of the given instance. Note that if you |
1192 |
run this command for an instance with a drbd disk template, while it |
1193 |
is running, it will not be able to shutdown the block devices on the |
1194 |
primary node, but it will shutdown the block devices on the secondary |
1195 |
nodes, thus breaking the replication. |
1196 |
|
1197 |
The ``-f``/``--force`` option will skip checks that the instance is |
1198 |
down; in case the hypervisor is confused and we can't talk to it, |
1199 |
normally Ganeti will refuse to deactivate the disks, but with this |
1200 |
option passed it will skip this check and directly try to deactivate |
1201 |
the disks. This can still fail due to the instance actually running or |
1202 |
other issues. |
1203 |
|
1204 |
The ``--submit`` option is used to send the job to the master daemon |
1205 |
but not wait for its completion. The job ID will be shown so that it |
1206 |
can be examined via **gnt-job info**. |
1207 |
|
1208 |
GROW-DISK |
1209 |
^^^^^^^^^ |
1210 |
|
1211 |
**grow-disk** [--no-wait-for-sync] [--submit] {*instance*} {*disk*} |
1212 |
{*amount*} |
1213 |
|
1214 |
Grows an instance's disk. This is only possible for instances having a |
1215 |
plain or drbd disk template. |
1216 |
|
1217 |
Note that this command only change the block device size; it will not |
1218 |
grow the actual filesystems, partitions, etc. that live on that |
1219 |
disk. Usually, you will need to: |
1220 |
|
1221 |
#. use **gnt-instance grow-disk** |
1222 |
|
1223 |
#. reboot the instance (later, at a convenient time) |
1224 |
|
1225 |
#. use a filesystem resizer, such as ext2online(8) or |
1226 |
xfs\_growfs(8) to resize the filesystem, or use fdisk(8) to change |
1227 |
the partition table on the disk |
1228 |
|
1229 |
The *disk* argument is the index of the instance disk to grow. The |
1230 |
*amount* argument is given either as a number (and it represents the |
1231 |
amount to increase the disk with in mebibytes) or can be given similar |
1232 |
to the arguments in the create instance operation, with a suffix |
1233 |
denoting the unit. |
1234 |
|
1235 |
Note that the disk grow operation might complete on one node but fail |
1236 |
on the other; this will leave the instance with different-sized LVs on |
1237 |
the two nodes, but this will not create problems (except for unused |
1238 |
space). |
1239 |
|
1240 |
If you do not want gnt-instance to wait for the new disk region to be |
1241 |
synced, use the ``--no-wait-for-sync`` option. |
1242 |
|
1243 |
The ``--submit`` option is used to send the job to the master daemon |
1244 |
but not wait for its completion. The job ID will be shown so that it |
1245 |
can be examined via **gnt-job info**. |
1246 |
|
1247 |
Example (increase the first disk for instance1 by 16GiB):: |
1248 |
|
1249 |
# gnt-instance grow-disk instance1.example.com 0 16g |
1250 |
|
1251 |
|
1252 |
Also note that disk shrinking is not supported; use **gnt-backup |
1253 |
export** and then **gnt-backup import** to reduce the disk size of an |
1254 |
instance. |
1255 |
|
1256 |
RECREATE-DISKS |
1257 |
^^^^^^^^^^^^^^ |
1258 |
|
1259 |
**recreate-disks** [--submit] [--disks=``indices``] [-n node1:[node2]] |
1260 |
{*instance*} |
1261 |
|
1262 |
Recreates the disks of the given instance, or only a subset of the |
1263 |
disks (if the option ``disks`` is passed, which must be a |
1264 |
comma-separated list of disk indices, starting from zero). |
1265 |
|
1266 |
Note that this functionality should only be used for missing disks; if |
1267 |
any of the given disks already exists, the operation will fail. While |
1268 |
this is suboptimal, recreate-disks should hopefully not be needed in |
1269 |
normal operation and as such the impact of this is low. |
1270 |
|
1271 |
Optionally the instance's disks can be recreated on different |
1272 |
nodes. This can be useful if, for example, the original nodes of the |
1273 |
instance have gone down (and are marked offline), so we can't recreate |
1274 |
on the same nodes. To do this, pass the new node(s) via ``-n`` option, |
1275 |
with a syntax similar to the **add** command. The number of nodes |
1276 |
passed must equal the number of nodes that the instance currently |
1277 |
has. Note that changing nodes is only allowed for 'all disk' |
1278 |
replacement (when ``--disks`` is not passed). |
1279 |
|
1280 |
The ``--submit`` option is used to send the job to the master daemon |
1281 |
but not wait for its completion. The job ID will be shown so that it |
1282 |
can be examined via **gnt-job info**. |
1283 |
|
1284 |
Recovery |
1285 |
~~~~~~~~ |
1286 |
|
1287 |
FAILOVER |
1288 |
^^^^^^^^ |
1289 |
|
1290 |
**failover** [-f] [--ignore-consistency] [--shutdown-timeout=*N*] |
1291 |
[--submit] {*instance*} |
1292 |
|
1293 |
Failover will stop the instance (if running), change its primary node, |
1294 |
and if it was originally running it will start it again (on the new |
1295 |
primary). This only works for instances with drbd template (in which |
1296 |
case you can only fail to the secondary node) and for externally |
1297 |
mirrored templates (shared storage) (which can change to any other |
1298 |
node). |
1299 |
|
1300 |
Normally the failover will check the consistency of the disks before |
1301 |
failing over the instance. If you are trying to migrate instances off |
1302 |
a dead node, this will fail. Use the ``--ignore-consistency`` option |
1303 |
for this purpose. Note that this option can be dangerous as errors in |
1304 |
shutting down the instance will be ignored, resulting in possibly |
1305 |
having the instance running on two machines in parallel (on |
1306 |
disconnected DRBD drives). |
1307 |
|
1308 |
The ``--shutdown-timeout`` is used to specify how much time to wait |
1309 |
before forcing the shutdown (xm destroy in xen, killing the kvm |
1310 |
process, for kvm). By default two minutes are given to each instance |
1311 |
to stop. |
1312 |
|
1313 |
The ``--submit`` option is used to send the job to the master daemon |
1314 |
but not wait for its completion. The job ID will be shown so that it |
1315 |
can be examined via **gnt-job info**. |
1316 |
|
1317 |
Example:: |
1318 |
|
1319 |
# gnt-instance failover instance1.example.com |
1320 |
|
1321 |
|
1322 |
MIGRATE |
1323 |
^^^^^^^ |
1324 |
|
1325 |
**migrate** [-f] {--cleanup} {*instance*} |
1326 |
|
1327 |
**migrate** [-f] [--allow-failover] [--non-live] |
1328 |
[--migration-mode=live\|non-live] {*instance*} |
1329 |
|
1330 |
Migrate will move the instance to its secondary node without |
1331 |
shutdown. It only works for instances having the drbd8 disk template |
1332 |
type. |
1333 |
|
1334 |
The migration command needs a perfectly healthy instance, as we rely |
1335 |
on the dual-master capability of drbd8 and the disks of the instance |
1336 |
are not allowed to be degraded. |
1337 |
|
1338 |
The ``--non-live`` and ``--migration-mode=non-live`` options will |
1339 |
switch (for the hypervisors that support it) between a "fully live" |
1340 |
(i.e. the interruption is as minimal as possible) migration and one in |
1341 |
which the instance is frozen, its state saved and transported to the |
1342 |
remote node, and then resumed there. This all depends on the |
1343 |
hypervisor support for two different methods. In any case, it is not |
1344 |
an error to pass this parameter (it will just be ignored if the |
1345 |
hypervisor doesn't support it). The option ``--migration-mode=live`` |
1346 |
option will request a fully-live migration. The default, when neither |
1347 |
option is passed, depends on the hypervisor parameters (and can be |
1348 |
viewed with the **gnt-cluster info** command). |
1349 |
|
1350 |
If the ``--cleanup`` option is passed, the operation changes from |
1351 |
migration to attempting recovery from a failed previous migration. In |
1352 |
this mode, Ganeti checks if the instance runs on the correct node (and |
1353 |
updates its configuration if not) and ensures the instances's disks |
1354 |
are configured correctly. In this mode, the ``--non-live`` option is |
1355 |
ignored. |
1356 |
|
1357 |
The option ``-f`` will skip the prompting for confirmation. |
1358 |
|
1359 |
If ``--allow-failover`` is specified it tries to fallback to failover if |
1360 |
it already can determine that a migration wont work (i.e. if the |
1361 |
instance is shutdown). Please note that the fallback will not happen |
1362 |
during execution. If a migration fails during execution it still fails. |
1363 |
|
1364 |
Example (and expected output):: |
1365 |
|
1366 |
# gnt-instance migrate instance1 |
1367 |
Migrate will happen to the instance instance1. Note that migration is |
1368 |
**experimental** in this version. This might impact the instance if |
1369 |
anything goes wrong. Continue? |
1370 |
y/[n]/?: y |
1371 |
* checking disk consistency between source and target |
1372 |
* ensuring the target is in secondary mode |
1373 |
* changing disks into dual-master mode |
1374 |
- INFO: Waiting for instance instance1 to sync disks. |
1375 |
- INFO: Instance instance1's disks are in sync. |
1376 |
* migrating instance to node2.example.com |
1377 |
* changing the instance's disks on source node to secondary |
1378 |
- INFO: Waiting for instance instance1 to sync disks. |
1379 |
- INFO: Instance instance1's disks are in sync. |
1380 |
* changing the instance's disks to single-master |
1381 |
# |
1382 |
|
1383 |
|
1384 |
MOVE |
1385 |
^^^^ |
1386 |
|
1387 |
**move** [-f] [--ignore-consistency] |
1388 |
[-n *node*] [--shutdown-timeout=*N*] [--submit] |
1389 |
{*instance*} |
1390 |
|
1391 |
Move will move the instance to an arbitrary node in the cluster. This |
1392 |
works only for instances having a plain or file disk template. |
1393 |
|
1394 |
Note that since this operation is done via data copy, it will take a |
1395 |
long time for big disks (similar to replace-disks for a drbd |
1396 |
instance). |
1397 |
|
1398 |
The ``--shutdown-timeout`` is used to specify how much time to wait |
1399 |
before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the |
1400 |
kvm process for KVM, etc.). By default two minutes are given to each |
1401 |
instance to stop. |
1402 |
|
1403 |
The ``--ignore-consistency`` option will make Ganeti ignore any errors |
1404 |
in trying to shutdown the instance on its node; useful if the |
1405 |
hypervisor is broken and you want to recuperate the data. |
1406 |
|
1407 |
The ``--submit`` option is used to send the job to the master daemon |
1408 |
but not wait for its completion. The job ID will be shown so that it |
1409 |
can be examined via **gnt-job info**. |
1410 |
|
1411 |
Example:: |
1412 |
|
1413 |
# gnt-instance move -n node3.example.com instance1.example.com |
1414 |
|
1415 |
|
1416 |
CHANGE-GROUP |
1417 |
~~~~~~~~~~~~ |
1418 |
|
1419 |
**change-group** [--iallocator *NAME*] [--to *GROUP*...] {*instance*} |
1420 |
|
1421 |
This command moves an instance to another node group. The move is |
1422 |
calculated by an iallocator, either given on the command line or as a |
1423 |
cluster default. |
1424 |
|
1425 |
If no specific destination groups are specified using ``--to``, all |
1426 |
groups except the one containing the instance are considered. |
1427 |
|
1428 |
Example:: |
1429 |
|
1430 |
# gnt-instance change-group -I hail --to rack2 inst1.example.com |
1431 |
|
1432 |
|
1433 |
TAGS |
1434 |
~~~~ |
1435 |
|
1436 |
ADD-TAGS |
1437 |
^^^^^^^^ |
1438 |
|
1439 |
**add-tags** [--from *file*] {*instancename*} {*tag*...} |
1440 |
|
1441 |
Add tags to the given instance. If any of the tags contains invalid |
1442 |
characters, the entire operation will abort. |
1443 |
|
1444 |
If the ``--from`` option is given, the list of tags will be extended |
1445 |
with the contents of that file (each line becomes a tag). In this |
1446 |
case, there is not need to pass tags on the command line (if you do, |
1447 |
both sources will be used). A file name of ``-`` will be interpreted |
1448 |
as stdin. |
1449 |
|
1450 |
LIST-TAGS |
1451 |
^^^^^^^^^ |
1452 |
|
1453 |
**list-tags** {*instancename*} |
1454 |
|
1455 |
List the tags of the given instance. |
1456 |
|
1457 |
REMOVE-TAGS |
1458 |
^^^^^^^^^^^ |
1459 |
|
1460 |
**remove-tags** [--from *file*] {*instancename*} {*tag*...} |
1461 |
|
1462 |
Remove tags from the given instance. If any of the tags are not |
1463 |
existing on the node, the entire operation will abort. |
1464 |
|
1465 |
If the ``--from`` option is given, the list of tags to be removed will |
1466 |
be extended with the contents of that file (each line becomes a tag). |
1467 |
In this case, there is not need to pass tags on the command line (if |
1468 |
you do, tags from both sources will be removed). A file name of ``-`` |
1469 |
will be interpreted as stdin. |
1470 |
|
1471 |
.. vim: set textwidth=72 : |
1472 |
.. Local Variables: |
1473 |
.. mode: rst |
1474 |
.. fill-column: 72 |
1475 |
.. End: |