Revision 0a68e0ff
b/man/gnt-cluster.rst | ||
---|---|---|
116 | 116 |
~~~~ |
117 | 117 |
|
118 | 118 |
| **init** |
119 |
| [-s *secondary\_ip*]
|
|
119 |
| [{-s|--secondary-ip} *secondary\_ip*]
|
|
120 | 120 |
| [--vg-name *vg-name*] |
121 | 121 |
| [--master-netdev *interface-name*] |
122 |
| [-m *mac-prefix*]
|
|
122 |
| [{-m|--mac-prefix} *mac-prefix*]
|
|
123 | 123 |
| [--no-lvm-storage] |
124 | 124 |
| [--no-etc-hosts] |
125 | 125 |
| [--no-ssh-init] |
126 | 126 |
| [--file-storage-dir *dir*] |
127 | 127 |
| [--enabled-hypervisors *hypervisors*] |
128 | 128 |
| [-t *hypervisor name*] |
129 |
| [--hypervisor-parameters *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
|
|
130 |
| [--backend-parameters *be-param*=*value* [,*be-param*=*value*...]]
|
|
131 |
| [--nic-parameters *nic-param*=*value* [,*nic-param*=*value*...]]
|
|
129 |
| [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
|
|
130 |
| [{-B|--backend-parameters} *be-param*=*value* [,*be-param*=*value*...]]
|
|
131 |
| [{-N|--nic-parameters} *nic-param*=*value* [,*nic-param*=*value*...]]
|
|
132 | 132 |
| [--maintain-node-health {yes \| no}] |
133 | 133 |
| [--uid-pool *user-id pool definition*] |
134 |
| [-I *default instance allocator*]
|
|
134 |
| [{-I|--default-iallocator} *default instance allocator*]
|
|
135 | 135 |
| [--primary-ip-version *version*] |
136 | 136 |
| [--prealloc-wipe-disks {yes \| no}] |
137 | 137 |
| [--node-parameters *ndparams*] |
138 |
| [{-C|--candidate-pool-size} *candidate\_pool\_size*] |
|
138 | 139 |
| {*clustername*} |
139 | 140 |
|
140 | 141 |
This commands is only run once initially on the first node of the |
... | ... | |
149 | 150 |
use. |
150 | 151 |
|
151 | 152 |
The cluster can run in two modes: single-home or dual-homed. In the |
152 |
first case, all traffic (both public traffic, inter-node traffic |
|
153 |
and data replication traffic) goes over the same interface. In the
|
|
153 |
first case, all traffic (both public traffic, inter-node traffic and
|
|
154 |
data replication traffic) goes over the same interface. In the |
|
154 | 155 |
dual-homed case, the data replication traffic goes over the second |
155 |
network. The ``-s`` option here marks the cluster as dual-homed and
|
|
156 |
its parameter represents this node's address on the second network.
|
|
157 |
If you initialise the cluster with ``-s``, all nodes added must
|
|
158 |
have a secondary IP as well. |
|
156 |
network. The ``-s (--secondary-ip)`` option here marks the cluster as
|
|
157 |
dual-homed and its parameter represents this node's address on the
|
|
158 |
second network. If you initialise the cluster with ``-s``, all nodes
|
|
159 |
added must have a secondary IP as well.
|
|
159 | 160 |
|
160 | 161 |
Note that for Ganeti it doesn't matter if the secondary network is |
161 | 162 |
actually a separate physical network, or is done using tunneling, |
... | ... | |
175 | 176 |
important that all nodes have this interface because you'll need it |
176 | 177 |
for a master failover. |
177 | 178 |
|
178 |
The ``-m`` option will let you specify a three byte prefix under
|
|
179 |
which the virtual MAC addresses of your instances will be |
|
180 |
generated. The prefix must be specified in the format XX:XX:XX and
|
|
181 |
the default is aa:00:00.
|
|
179 |
The ``-m (--mac-prefix)`` option will let you specify a three byte
|
|
180 |
prefix under which the virtual MAC addresses of your instances will be
|
|
181 |
generated. The prefix must be specified in the format ``XX:XX:XX`` and
|
|
182 |
the default is ``aa:00:00``.
|
|
182 | 183 |
|
183 | 184 |
The ``--no-lvm-storage`` option allows you to initialize the |
184 | 185 |
cluster without lvm support. This means that only instances using |
... | ... | |
196 | 197 |
use for storing the instance disk files when using file storage as |
197 | 198 |
backend for instance disks. |
198 | 199 |
|
199 |
The ``--enabled-hypervisors`` option allows you to set the list of |
|
200 |
hypervisors that will be enabled for this cluster. Instance |
|
201 |
hypervisors can only be chosen from the list of enabled |
|
202 |
hypervisors, and the first entry of this list will be used by |
|
203 |
default. Currently, the following hypervisors are available: |
|
204 |
|
|
205 | 200 |
The ``--prealloc-wipe-disks`` sets a cluster wide configuration |
206 | 201 |
value for wiping disks prior to allocation. This increases security |
207 | 202 |
on instance level as the instance can't access untouched data from |
208 | 203 |
it's underlying storage. |
209 | 204 |
|
210 |
|
|
211 |
|
|
212 |
|
|
205 |
The ``--enabled-hypervisors`` option allows you to set the list of |
|
206 |
hypervisors that will be enabled for this cluster. Instance |
|
207 |
hypervisors can only be chosen from the list of enabled |
|
208 |
hypervisors, and the first entry of this list will be used by |
|
209 |
default. Currently, the following hypervisors are available: |
|
213 | 210 |
|
214 | 211 |
xen-pvm |
215 | 212 |
Xen PVM hypervisor |
... | ... | |
227 | 224 |
fake |
228 | 225 |
fake hypervisor for development/testing |
229 | 226 |
|
230 |
|
|
231 | 227 |
Either a single hypervisor name or a comma-separated list of |
232 | 228 |
hypervisor names can be specified. If this option is not specified, |
233 | 229 |
only the xen-pvm hypervisor is enabled by default. |
234 | 230 |
|
235 |
The ``--hypervisor-parameters`` option allows you to set default
|
|
231 |
The ``-H (--hypervisor-parameters)`` option allows you to set default
|
|
236 | 232 |
hypervisor specific parameters for the cluster. The format of this |
237 | 233 |
option is the name of the hypervisor, followed by a colon and a |
238 |
comma-separated list of key=value pairs. The keys available for |
|
239 |
each hypervisors are detailed in the gnt-instance(8) man page, in
|
|
240 |
the **add** command plus the following parameters which are only
|
|
234 |
comma-separated list of key=value pairs. The keys available for each
|
|
235 |
hypervisors are detailed in the gnt-instance(8) man page, in the
|
|
236 |
**add** command plus the following parameters which are only |
|
241 | 237 |
configurable globally (at cluster level): |
242 | 238 |
|
243 | 239 |
migration\_port |
... | ... | |
257 | 253 |
This option is only effective with kvm versions >= 78 and qemu-kvm |
258 | 254 |
versions >= 0.10.0. |
259 | 255 |
|
260 |
|
|
261 |
The ``--backend-parameters`` option allows you to set the default |
|
256 |
The ``-B (--backend-parameters)`` option allows you to set the default |
|
262 | 257 |
backend parameters for the cluster. The parameter format is a |
263 |
comma-separated list of key=value pairs with the following |
|
264 |
supported keys:
|
|
258 |
comma-separated list of key=value pairs with the following supported
|
|
259 |
keys: |
|
265 | 260 |
|
266 | 261 |
vcpus |
267 | 262 |
Number of VCPUs to set for an instance by default, must be an |
... | ... | |
278 | 273 |
will be set to true if not specified. |
279 | 274 |
|
280 | 275 |
|
281 |
The ``--nic-parameters`` option allows you to set the default nic |
|
282 |
parameters for the cluster. The parameter format is a |
|
283 |
comma-separated list of key=value pairs with the following |
|
284 |
supported keys: |
|
276 |
The ``-N (--nic-parameters)`` option allows you to set the default nic |
|
277 |
parameters for the cluster. The parameter format is a comma-separated |
|
278 |
list of key=value pairs with the following supported keys: |
|
285 | 279 |
|
286 | 280 |
mode |
287 | 281 |
The default nic mode, 'routed' or 'bridged'. |
... | ... | |
293 | 287 |
network script it is interpreted as a routing table number or |
294 | 288 |
name. |
295 | 289 |
|
296 |
|
|
297 | 290 |
The option ``--maintain-node-health`` allows to enable/disable |
298 | 291 |
automatic maintenance actions on nodes. Currently these include |
299 | 292 |
automatic shutdown of instances and deactivation of DRBD devices on |
... | ... | |
328 | 321 |
parameters for the cluster. Please see **ganeti**(7) for more |
329 | 322 |
information about supported key=value pairs. |
330 | 323 |
|
324 |
The ``-C (--candidate-pool-size)`` option specifies the |
|
325 |
``candidate_pool_size`` cluster parameter. This is the number of nodes |
|
326 |
that the master will try to keep as master\_candidates. For more |
|
327 |
details about this role and other node roles, see the ganeti(7). |
|
328 |
|
|
331 | 329 |
LIST-TAGS |
332 | 330 |
~~~~~~~~~ |
333 | 331 |
|
... | ... | |
372 | 370 |
| [--vg-name *vg-name*] |
373 | 371 |
| [--no-lvm-storage] |
374 | 372 |
| [--enabled-hypervisors *hypervisors*] |
375 |
| [--hypervisor-parameters *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
|
|
376 |
| [--backend-parameters *be-param*=*value* [,*be-param*=*value*...]]
|
|
377 |
| [--nic-parameters *nic-param*=*value* [,*nic-param*=*value*...]]
|
|
373 |
| [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
|
|
374 |
| [{-B|--backend-parameters} *be-param*=*value* [,*be-param*=*value*...]]
|
|
375 |
| [{-N|--nic-parameters} *nic-param*=*value* [,*nic-param*=*value*...]]
|
|
378 | 376 |
| [--uid-pool *user-id pool definition*] |
379 | 377 |
| [--add-uids *user-id pool definition*] |
380 | 378 |
| [--remove-uids *user-id pool definition*] |
381 |
| [-C *candidate\_pool\_size*]
|
|
379 |
| [{-C|--candidate-pool-size} *candidate\_pool\_size*]
|
|
382 | 380 |
| [--maintain-node-health {yes \| no}] |
383 | 381 |
| [--prealloc-wipe-disks {yes \| no}] |
384 |
| [-I *default instance allocator*]
|
|
382 |
| [{-I|--default-iallocator} *default instance allocator*]
|
|
385 | 383 |
| [--reserved-lvs=*NAMES*] |
386 | 384 |
| [--node-parameters *ndparams*] |
387 | 385 |
| [--master-netdev *interface-name*] |
... | ... | |
389 | 387 |
Modify the options for the cluster. |
390 | 388 |
|
391 | 389 |
The ``--vg-name``, ``--no-lvm-storarge``, ``--enabled-hypervisors``, |
392 |
``--hypervisor-parameters``, ``--backend-parameters``, |
|
393 |
``--nic-parameters``, ``--maintain-node-health``, |
|
394 |
``--prealloc-wipe-disks``, ``--uid-pool``, ``--node-parameters``, |
|
395 |
``--master-netdev`` options are described in the **init** command. |
|
396 |
|
|
397 |
The ``-C`` option specifies the ``candidate_pool_size`` cluster |
|
398 |
parameter. This is the number of nodes that the master will try to |
|
399 |
keep as master\_candidates. For more details about this role and |
|
400 |
other node roles, see the ganeti(7). If you increase the size, the |
|
401 |
master will automatically promote as many nodes as required and |
|
402 |
possible to reach the intended number. |
|
390 |
``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``, |
|
391 |
``--nic-parameters``, ``-C (--candidate-pool-size)``, |
|
392 |
``--maintain-node-health``, ``--prealloc-wipe-disks``, ``--uid-pool``, |
|
393 |
``--node-parameters``, ``--master-netdev`` options are described in |
|
394 |
the **init** command. |
|
403 | 395 |
|
404 | 396 |
The ``--add-uids`` and ``--remove-uids`` options can be used to |
405 | 397 |
modify the user-id pool by adding/removing a list of user-ids or |
... | ... | |
417 | 409 |
To remove all reserved logical volumes, pass in an empty argument |
418 | 410 |
to the option, as in ``--reserved-lvs=`` or ``--reserved-lvs ''``. |
419 | 411 |
|
420 |
The ``-I`` is described in the **init** command. To clear the |
|
421 |
default iallocator, just pass an empty string (''). |
|
412 |
The ``-I (--default-iallocator)`` is described in the **init** |
|
413 |
command. To clear the default iallocator, just pass an empty string |
|
414 |
(''). |
|
422 | 415 |
|
423 | 416 |
QUEUE |
424 | 417 |
~~~~~ |
b/man/gnt-instance.rst | ||
---|---|---|
27 | 27 |
^^^ |
28 | 28 |
|
29 | 29 |
| **add** |
30 |
| {-t {diskless | file \| plain \| drbd}} |
|
30 |
| {-t|--disk-template {diskless | file \| plain \| drbd}}
|
|
31 | 31 |
| {--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*] |
32 |
| \| -s *SIZE*}
|
|
32 |
| \| {-s|--os-size} *SIZE*}
|
|
33 | 33 |
| [--no-ip-check] [--no-name-check] [--no-start] [--no-install] |
34 | 34 |
| [--net=*N* [:options...] \| --no-nics] |
35 |
| [-B *BEPARAMS*]
|
|
36 |
| [-H *HYPERVISOR* [: option=*value*... ]]
|
|
37 |
| [-O, --os-parameters *param*=*value*... ]
|
|
35 |
| [{-B|--backend-parameters} *BEPARAMS*]
|
|
36 |
| [{-H|--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]]
|
|
37 |
| [{-O|--os-parameters} *param*=*value*... ]
|
|
38 | 38 |
| [--file-storage-dir *dir\_path*] [--file-driver {loop \| blktap}] |
39 |
| {-n *node[:secondary-node]* \| --iallocator *name*}
|
|
40 |
| {-o *os-type*}
|
|
39 |
| {{-n|--node} *node[:secondary-node]* \| {-I|--iallocator} *name*}
|
|
40 |
| {{-o|--os-type} *os-type*}
|
|
41 | 41 |
| [--submit] |
42 | 42 |
| {*instance*} |
43 | 43 |
|
... | ... | |
93 | 93 |
random MAC, and set up according the the cluster level nic |
94 | 94 |
parameters. Each NIC can take these parameters (all optional): |
95 | 95 |
|
96 |
|
|
97 |
|
|
98 | 96 |
mac |
99 | 97 |
either a value or 'generate' to generate a new unique MAC |
100 | 98 |
|
... | ... | |
118 | 116 |
the instance, you can prevent the default of one NIC with the |
119 | 117 |
``--no-nics`` option. |
120 | 118 |
|
121 |
The ``-o`` options specifies the operating system to be installed. |
|
122 |
The available operating systems can be listed with **gnt-os list**. |
|
123 |
Passing ``--no-install`` will however skip the OS installation, |
|
124 |
allowing a manual import if so desired. Note that the no-installation |
|
125 |
mode will automatically disable the start-up of the instance (without |
|
126 |
an OS, it most likely won't be able to start-up successfully). |
|
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). |
|
127 | 126 |
|
128 |
The ``-B`` option specifies the backend parameters for the
|
|
129 |
instance. If no such parameters are specified, the values are
|
|
130 |
inherited from the cluster. Possible parameters are: |
|
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:
|
|
131 | 130 |
|
132 | 131 |
memory |
133 | 132 |
the memory size of the instance; as usual, suffixes can be used to |
... | ... | |
142 | 141 |
(enough redundancy in the cluster to survive a node failure) |
143 | 142 |
|
144 | 143 |
|
145 |
The ``-H`` option specified the hypervisor to use for the instance
|
|
146 |
(must be one of the enabled hypervisors on the cluster) and optionally
|
|
147 |
custom parameters for this instance. If not other options are used
|
|
148 |
(i.e. the invocation is just -H *NAME*) the instance will inherit the
|
|
149 |
cluster options. The defaults below show the cluster defaults at
|
|
150 |
cluster creation time. |
|
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.
|
|
151 | 150 |
|
152 | 151 |
The possible hypervisor options are as follows: |
153 | 152 |
|
... | ... | |
213 | 212 |
This parameter determines the way the network cards are presented |
214 | 213 |
to the instance. The possible options are: |
215 | 214 |
|
216 |
rtl8139 (default for Xen HVM) (HVM & KVM) |
|
217 |
ne2k\_isa (HVM & KVM) |
|
218 |
ne2k\_pci (HVM & KVM) |
|
219 |
i82551 (KVM) |
|
220 |
i82557b (KVM) |
|
221 |
i82559er (KVM) |
|
222 |
pcnet (KVM) |
|
223 |
e1000 (KVM) |
|
224 |
paravirtual (default for KVM) (HVM & KVM) |
|
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)
|
|
225 | 224 |
|
226 | 225 |
disk\_type |
227 | 226 |
Valid for the Xen HVM and KVM hypervisors. |
... | ... | |
431 | 430 |
"tablet". |
432 | 431 |
|
433 | 432 |
|
434 |
The ``-O`` (``--os-parameters``) option allows customisation of the OS
|
|
433 |
The ``-O (--os-parameters)`` option allows customisation of the OS
|
|
435 | 434 |
parameters. The actual parameter names and values depends on the OS |
436 | 435 |
being used, but the syntax is the same key=value. For example, setting |
437 | 436 |
a hypothetical ``dhcp`` parameter to yes can be achieved by:: |
438 | 437 |
|
439 | 438 |
gnt-instance add -O dhcp=yes ... |
440 | 439 |
|
440 |
The ``-I (--iallocator)`` option specifies the instance allocator |
|
441 |
plugin to use. If you pass in this option the allocator will select |
|
442 |
nodes for this instance automatically, so you don't need to pass them |
|
443 |
with the ``-n`` option. For more information please refer to the |
|
444 |
instance allocator documentation. |
|
441 | 445 |
|
442 |
The ``--iallocator`` option specifies the instance allocator plugin to |
|
443 |
use. If you pass in this option the allocator will select nodes for |
|
444 |
this instance automatically, so you don't need to pass them with the |
|
445 |
``-n`` option. For more information please refer to the instance |
|
446 |
allocator documentation. |
|
447 |
|
|
448 |
The ``-t`` options specifies the disk layout type for the instance. |
|
449 |
The available choices are: |
|
446 |
The ``-t (--disk-template)`` options specifies the disk layout type |
|
447 |
for the instance. The available choices are: |
|
450 | 448 |
|
451 | 449 |
diskless |
452 | 450 |
This creates an instance with no disks. Its useful for testing only |
... | ... | |
462 | 460 |
Disk devices will be drbd (version 8.x) on top of lvm volumes. |
463 | 461 |
|
464 | 462 |
|
465 |
The optional second value of the ``--node`` is used for the drbd
|
|
463 |
The optional second value of the ``-n (--node)`` is used for the drbd
|
|
466 | 464 |
template type and specifies the remote node. |
467 | 465 |
|
468 | 466 |
If you do not want gnt-instance to wait for the disk mirror to be |
... | ... | |
642 | 640 |
|
643 | 641 |
| **list** |
644 | 642 |
| [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*] [-v] |
645 |
| [-o *[+]FIELD,...*] [instance...]
|
|
643 |
| [{-o|--output} *[+]FIELD,...*] [instance...]
|
|
646 | 644 |
|
647 | 645 |
Shows the currently configured instances with memory usage, disk |
648 | 646 |
usage, the node they are running on, and their run status. |
... | ... | |
662 | 660 |
The ``-v`` option activates verbose mode, which changes the display of |
663 | 661 |
special field states (see **ganeti(7)**). |
664 | 662 |
|
665 |
The ``-o`` option takes a comma-separated list of output fields. The |
|
666 |
available fields and their meaning are: |
|
667 |
|
|
663 |
The ``-o (--output)`` option takes a comma-separated list of output |
|
664 |
fields. The available fields and their meaning are: |
|
668 | 665 |
|
669 | 666 |
name |
670 | 667 |
the instance name |
... | ... | |
871 | 868 |
^^^^^^ |
872 | 869 |
|
873 | 870 |
| **modify** |
874 |
| [-H *HYPERVISOR\_PARAMETERS*]
|
|
875 |
| [-B *BACKEND\_PARAMETERS*]
|
|
871 |
| [{-H|--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
|
|
872 |
| [{-B|--backend-parameters} *BACKEND\_PARAMETERS*]
|
|
876 | 873 |
| [--net add*[:options]* \| --net remove \| --net *N:options*] |
877 | 874 |
| [--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| --disk remove \| |
878 | 875 |
| --disk *N*:mode=*MODE*] |
879 |
| [-t plain | -t drbd -n *new_secondary*] [--no-wait-for-sync]
|
|
876 |
| [{-t|--disk-template} plain | {-t|--disk-template} drbd -n *new_secondary*] [--no-wait-for-sync]
|
|
880 | 877 |
| [--os-type=*OS* [--force-variant]] |
881 |
| [-O, --os-parameters *param*=*value*... ]
|
|
878 |
| [{-O|--os-parameters} *param*=*value*... ]
|
|
882 | 879 |
| [--submit] |
883 | 880 |
| {*instance*} |
884 | 881 |
|
... | ... | |
887 | 884 |
disks and NICs to/from the instance. Note that you need to give at |
888 | 885 |
least one of the arguments, otherwise the command complains. |
889 | 886 |
|
890 |
The ``-H``, ``-B`` and ``-O`` options specifies hypervisor, backend |
|
891 |
and OS parameter options in the form of name=value[,...]. For details |
|
887 |
The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)`` |
|
888 |
and ``-O (--os-parameters)`` options specifies hypervisor, backend and |
|
889 |
OS parameter options in the form of name=value[,...]. For details |
|
892 | 890 |
which options can be specified, see the **add** command. |
893 | 891 |
|
894 |
The ``-t`` option will change the disk template of the instance.
|
|
895 |
Currently only conversions between the plain and drbd disk templates
|
|
896 |
are supported, and the instance must be stopped before attempting the
|
|
897 |
conversion. When changing from the plain to the drbd disk template, a
|
|
898 |
new secondary node must be specified via the ``-n`` option. The option
|
|
899 |
``--no-wait-for-sync`` can be used when converting to the ``drbd``
|
|
900 |
template in order to make the instance available for startup before
|
|
901 |
DRBD has finished resyncing. |
|
892 |
The ``-t (--disk-template)`` option will change the disk template of
|
|
893 |
the instance. Currently only conversions between the plain and drbd
|
|
894 |
disk templates are supported, and the instance must be stopped before
|
|
895 |
attempting the conversion. When changing from the plain to the drbd
|
|
896 |
disk template, a new secondary node must be specified via the ``-n``
|
|
897 |
option. The option ``--no-wait-for-sync`` can be used when converting
|
|
898 |
to the ``drbd`` template in order to make the instance available for
|
|
899 |
startup before DRBD has finished resyncing.
|
|
902 | 900 |
|
903 | 901 |
The ``--disk add:size=``*SIZE* option adds a disk to the instance. The |
904 | 902 |
optional ``vg=``*VG* option specifies LVM volume group other than |
... | ... | |
915 | 913 |
of the instance, while the ``--net`` *N*:*options* option will change |
916 | 914 |
the parameters of the Nth instance NIC. |
917 | 915 |
|
918 |
The option ``--os-type`` will change the OS name for the instance
|
|
916 |
The option ``-o (--os-type)`` will change the OS name for the instance
|
|
919 | 917 |
(without reinstallation). In case an OS variant is specified that is |
920 | 918 |
not found, then by default the modification is refused, unless |
921 | 919 |
``--force-variant`` is passed. An invalid OS will also be refused, |
... | ... | |
931 | 929 |
REINSTALL |
932 | 930 |
^^^^^^^^^ |
933 | 931 |
|
934 |
| **reinstall** [-o *os-type*] [--select-os] [-f *force*]
|
|
932 |
| **reinstall** [{-o|--os-type} *os-type*] [--select-os] [-f *force*]
|
|
935 | 933 |
| [--force-multiple] |
936 | 934 |
| [--instance \| --node \| --primary \| --secondary \| --all] |
937 |
| [-O *OS\_PARAMETERS*] [--submit] {*instance*...}
|
|
935 |
| [{-O|--os-parameters} *OS\_PARAMETERS*] [--submit] {*instance*...}
|
|
938 | 936 |
|
939 | 937 |
Reinstalls the operating system on the given instance(s). The |
940 |
instance(s) must be stopped when running this command. If the |
|
941 |
``--os-type`` is specified, the operating system is changed.
|
|
938 |
instance(s) must be stopped when running this command. If the ``-o
|
|
939 |
(--os-type)`` is specified, the operating system is changed.
|
|
942 | 940 |
|
943 | 941 |
The ``--select-os`` option switches to an interactive OS reinstall. |
944 | 942 |
The user is prompted to select the OS template from the list of |
945 |
available OS templates. OS parameters can be overridden using ``-O`` |
|
946 |
(more documentation for this option under the **add** command). |
|
943 |
available OS templates. OS parameters can be overridden using ``-O |
|
944 |
(--os-parameters)`` (more documentation for this option under the |
|
945 |
**add** command). |
|
947 | 946 |
|
948 | 947 |
Since this is a potentially dangerous command, the user will be |
949 | 948 |
required to confirm this action, unless the ``-f`` flag is passed. |
... | ... | |
989 | 988 |
| [--force-multiple] |
990 | 989 |
| [--instance \| --node \| --primary \| --secondary \| --all \| |
991 | 990 |
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags] |
992 |
| [-H ``key=value...``] [-B ``key=value...``] |
|
991 |
| [{-H|--hypervisor-parameters} ``key=value...``] |
|
992 |
| [{-B|--backend-parameters} ``key=value...``] |
|
993 | 993 |
| [--submit] |
994 | 994 |
| {*name*...} |
995 | 995 |
|
... | ... | |
1043 | 1043 |
The ``--force-multiple`` will skip the interactive confirmation in the |
1044 | 1044 |
case the more than one instance will be affected. |
1045 | 1045 |
|
1046 |
The ``-H`` and ``-B`` options specify temporary hypervisor and backend |
|
1047 |
parameters that can be used to start an instance with modified |
|
1048 |
parameters. They can be useful for quick testing without having to |
|
1049 |
modify an instance back and forth, e.g.:: |
|
1046 |
The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)`` |
|
1047 |
options specify temporary hypervisor and backend parameters that can |
|
1048 |
be used to start an instance with modified parameters. They can be |
|
1049 |
useful for quick testing without having to modify an instance back and |
|
1050 |
forth, e.g.:: |
|
1050 | 1051 |
|
1051 | 1052 |
# gnt-instance start -H root_args="single" instance1 |
1052 | 1053 |
# gnt-instance start -B memory=2048 instance2 |
... | ... | |
1113 | 1114 |
^^^^^^ |
1114 | 1115 |
|
1115 | 1116 |
| **reboot** |
1116 |
| [--type=*REBOOT-TYPE*]
|
|
1117 |
| [{-t|--type} *REBOOT-TYPE*]
|
|
1117 | 1118 |
| [--ignore-secondaries] |
1118 | 1119 |
| [--shutdown-timeout=*N*] |
1119 | 1120 |
| [--force-multiple] |
... | ... | |
1123 | 1124 |
| [*name*...] |
1124 | 1125 |
|
1125 | 1126 |
Reboots one or more instances. The type of reboot depends on the value |
1126 |
of ``--type``. A soft reboot does a hypervisor reboot, a hard reboot
|
|
1127 |
of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
|
|
1127 | 1128 |
does a instance stop, recreates the hypervisor config for the instance |
1128 | 1129 |
and starts the instance. A full reboot does the equivalent of |
1129 | 1130 |
**gnt-instance shutdown && gnt-instance startup**. The default is |
b/man/gnt-node.rst | ||
---|---|---|
23 | 23 |
ADD |
24 | 24 |
~~~ |
25 | 25 |
|
26 |
| **add** [--readd] [-s *secondary\_ip*] [-g *nodegroup*] |
|
26 |
| **add** [--readd] [{-s|--secondary-ip} *secondary\_ip*] |
|
27 |
| [{-g|--node-group} *nodegroup*] |
|
27 | 28 |
| [--master-capable=``yes|no``] [--vm-capable=``yes|no``] |
28 | 29 |
| [--node-parameters *ndparams*] |
29 | 30 |
| {*nodename*} |
... | ... | |
39 | 40 |
forcibly join the specified host the cluster, not paying attention |
40 | 41 |
to its current status (it could be already in a cluster, etc.) |
41 | 42 |
|
42 |
The ``-s`` is used in dual-home clusters and specifies the new node's
|
|
43 |
IP in the secondary network. See the discussion in **gnt-cluster**(8)
|
|
44 |
for more information. |
|
43 |
The ``-s (--secondary-ip)`` is used in dual-home clusters and
|
|
44 |
specifies the new node's IP in the secondary network. See the
|
|
45 |
discussion in **gnt-cluster**(8) for more information.
|
|
45 | 46 |
|
46 | 47 |
In case you're readding a node after hardware failure, you can use |
47 | 48 |
the ``--readd`` parameter. In this case, you don't need to pass the |
... | ... | |
53 | 54 |
appears to belong to another cluster. This is used during cluster merging, for |
54 | 55 |
example. |
55 | 56 |
|
56 |
The ``-g`` is used to add the new node into a specific node group,
|
|
57 |
specified by UUID or name. If only one node group exists you can
|
|
58 |
skip this option, otherwise it's mandatory. |
|
57 |
The ``-g (--node-group)`` option is used to add the new node into a
|
|
58 |
specific node group, specified by UUID or name. If only one node group
|
|
59 |
exists you can skip this option, otherwise it's mandatory.
|
|
59 | 60 |
|
60 | 61 |
The ``vm_capable``, ``master_capable`` and ``ndparams`` options are |
61 | 62 |
described in **ganeti**(7), and are used to set the properties of the |
... | ... | |
93 | 94 |
|
94 | 95 |
The new location for the instances can be specified in two ways: |
95 | 96 |
|
96 |
- as a single node for all instances, via the ``--new-secondary``
|
|
97 |
- as a single node for all instances, via the ``-n (--new-secondary)``
|
|
97 | 98 |
option |
98 | 99 |
|
99 |
- or via the ``--iallocator`` option, giving a script name as
|
|
100 |
- or via the ``-I (--iallocator)`` option, giving a script name as
|
|
100 | 101 |
parameter, so each instance will be in turn placed on the (per the |
101 | 102 |
script) optimal node |
102 | 103 |
|
... | ... | |
113 | 114 |
|
114 | 115 |
Example:: |
115 | 116 |
|
116 |
# gnt-node evacuate -I dumb node3.example.com
|
|
117 |
# gnt-node evacuate -I hail node3.example.com
|
|
117 | 118 |
|
118 | 119 |
|
119 | 120 |
FAILOVER |
... | ... | |
149 | 150 |
|
150 | 151 |
| **list** |
151 | 152 |
| [--no-headers] [--separator=*SEPARATOR*] |
152 |
| [--units=*UNITS*] [-v] [-o *[+]FIELD,...*]
|
|
153 |
| [--units=*UNITS*] [-v] [{-o|--output} *[+]FIELD,...*]
|
|
153 | 154 |
| [node...] |
154 | 155 |
|
155 | 156 |
Lists the nodes in the cluster. |
... | ... | |
172 | 173 |
The ``-v`` option activates verbose mode, which changes the display of |
173 | 174 |
special field states (see **ganeti(7)**). |
174 | 175 |
|
175 |
The ``-o`` option takes a comma-separated list of output fields.
|
|
176 |
The available fields and their meaning are: |
|
176 |
The ``-o (--output)`` option takes a comma-separated list of output
|
|
177 |
fields. The available fields and their meaning are:
|
|
177 | 178 |
|
178 | 179 |
|
179 | 180 |
name |
... | ... | |
356 | 357 |
~~~~~~ |
357 | 358 |
|
358 | 359 |
| **modify** [-f] [--submit] |
359 |
| [--master-candidate=``yes|no``] [--drained=``yes|no``] [--offline=``yes|no``] |
|
360 |
| [{-C|--master-candidate} ``yes|no``] |
|
361 |
| [{-D|--drained} ``yes|no``] [{-O|--offline} ``yes|no``] |
|
360 | 362 |
| [--master-capable=``yes|no``] [--vm-capable=``yes|no``] [--auto-promote] |
361 |
| [-s *secondary_ip*]
|
|
363 |
| [{-s|--secondary-ip} *secondary_ip*]
|
|
362 | 364 |
| [--node-parameters *ndparams*] |
363 | 365 |
| [--node-powered=``yes|no``] |
364 | 366 |
| {*node*} |
... | ... | |
368 | 370 |
yes. The meaning of the roles and flags are described in the |
369 | 371 |
manpage **ganeti**(7). |
370 | 372 |
|
371 |
``--node-powered`` can be used to modify state-of-record if it doesn't reflect
|
|
372 |
the reality anymore. |
|
373 |
The option ``--node-powered`` can be used to modify state-of-record if
|
|
374 |
it doesn't reflect the reality anymore.
|
|
373 | 375 |
|
374 | 376 |
In case a node is demoted from the master candidate role, the |
375 | 377 |
operation will be refused unless you pass the ``--auto-promote`` |
... | ... | |
385 | 387 |
|
386 | 388 |
# gnt-node modify --offline=yes node1.example.com |
387 | 389 |
|
388 |
The ``-s`` can be used to change the node's secondary ip. No drbd
|
|
389 |
instances can be running on the node, while this operation is
|
|
390 |
taking place. |
|
390 |
The ``-s (--secondary-ip)`` option can be used to change the node's
|
|
391 |
secondary ip. No drbd instances can be running on the node, while this
|
|
392 |
operation is taking place.
|
|
391 | 393 |
|
392 | 394 |
Example (setting the node back to online and master candidate):: |
393 | 395 |
|
... | ... | |
425 | 427 |
~~~~~~~ |
426 | 428 |
|
427 | 429 |
| **volumes** [--no-headers] [--human-readable] |
428 |
| [--separator=*SEPARATOR*] [--output=*FIELDS*]
|
|
430 |
| [--separator=*SEPARATOR*] [{-o|--output} *FIELDS*]
|
|
429 | 431 |
| [*node*...] |
430 | 432 |
|
431 | 433 |
Lists all logical volumes and their physical disks from the node(s) |
... | ... | |
443 | 445 |
parsing by scripts. In both cases, the ``--units`` option can be |
444 | 446 |
used to enforce a given output unit. |
445 | 447 |
|
446 |
The ``-o`` option takes a comma-separated list of output fields.
|
|
447 |
The available fields and their meaning are: |
|
448 |
The ``-o (--output)`` option takes a comma-separated list of output
|
|
449 |
fields. The available fields and their meaning are:
|
|
448 | 450 |
|
449 | 451 |
node |
450 | 452 |
the node name on which the volume exists |
... | ... | |
479 | 481 |
|
480 | 482 |
| **list-storage** [--no-headers] [--human-readable] |
481 | 483 |
| [--separator=*SEPARATOR*] [--storage-type=*STORAGE\_TYPE*] |
482 |
| [--output=*FIELDS*]
|
|
484 |
| [{-o|--output} *FIELDS*]
|
|
483 | 485 |
| [*node*...] |
484 | 486 |
|
485 | 487 |
Lists the available storage units and their details for the given |
... | ... | |
500 | 502 |
The ``--storage-type`` option can be used to choose a storage unit |
501 | 503 |
type. Possible choices are lvm-pv, lvm-vg or file. |
502 | 504 |
|
503 |
The ``-o`` option takes a comma-separated list of output fields.
|
|
504 |
The available fields and their meaning are: |
|
505 |
The ``-o (--output)`` option takes a comma-separated list of output
|
|
506 |
fields. The available fields and their meaning are:
|
|
505 | 507 |
|
506 | 508 |
node |
507 | 509 |
the node name on which the volume exists |
Also available in: Unified diff