05381da0d8b27409a3285e774e03d0e5c566ab48
[ganeti-github.git] / man / gnt-node.rst
1 gnt-node(8) Ganeti | Version @GANETI_VERSION@
2 =============================================
3
4 Name
5 ----
6
7 gnt-node - Node administration
8
9 Synopsis
10 --------
11
12 **gnt-node** {command} [arguments...]
13
14 DESCRIPTION
15 -----------
16
17 The **gnt-node** is used for managing the (physical) nodes in the
18 Ganeti system.
19
20 COMMANDS
21 --------
22
23 ADD
24 ~~~
25
26 | **add** [\--readd] [{-s|\--secondary-ip} *secondary\_ip*]
27 | [{-g|\--node-group} *nodegroup*]
28 | [\--master-capable=``yes|no``] [\--vm-capable=``yes|no``]
29 | [\--node-parameters *ndparams*]
30 | [\--disk-state *diskstate*]
31 | [\--hypervisor-state *hvstate*]
32 | [\--no-node-setup]
33 | {*nodename*}
34
35 Adds the given node to the cluster.
36
37 This command is used to join a new node to the cluster. You will
38 have to provide the password for root of the node to be able to add
39 the node in the cluster. The command needs to be run on the Ganeti
40 master.
41
42 Note that the command is potentially destructive, as it will
43 forcibly join the specified host to the cluster, not paying attention
44 to its current status (it could be already in a cluster, etc.)
45
46 The ``-s (--secondary-ip)`` is used in dual-home clusters and
47 specifies the new node's IP in the secondary network. See the
48 discussion in **gnt-cluster**\(8) for more information.
49
50 In case you're readding a node after hardware failure, you can use
51 the ``--readd`` parameter. In this case, you don't need to pass the
52 secondary IP again, it will be reused from the cluster. Also, the
53 drained and offline flags of the node will be cleared before
54 re-adding it. Note that even for readded nodes, a new SSH key is
55 generated and distributed and previous Ganeti keys are removed
56 from the machine.
57
58 The ``-g (--node-group)`` option is used to add the new node into a
59 specific node group, specified by UUID or name. If only one node group
60 exists you can skip this option, otherwise it's mandatory.
61
62 The ``--no-node-setup`` option prevents Ganeti from performing the
63 initial SSH setup on the new node. This means that Ganeti will not
64 touch the SSH keys or the ``authorized_keys`` file of the node at
65 all. Using this option, it lies in the administrators responsibility
66 to ensure SSH connectivity between the hosts by other means. Note,
67 that the equivalent of this option in ``gnt-cluster init`` is called
68 ``--no-ssh-init``.
69
70 The ``vm_capable``, ``master_capable``, ``ndparams``, ``diskstate`` and
71 ``hvstate`` options are described in **ganeti**\(7), and are used to set
72 the properties of the new node.
73
74 The command performs some operations that change the state of the master
75 and the new node, like copying certificates and starting the node daemon
76 on the new node, or updating ``/etc/hosts`` on the master node.  If the
77 command fails at a later stage, it doesn't undo such changes.  This
78 should not be a problem, as a successful run of ``gnt-node add`` will
79 bring everything back in sync.
80
81 If the node was previously part of another cluster and still has daemons
82 running, the ``node-cleanup`` tool can be run on the machine to be added
83 to clean remains of the previous cluster from the node.
84
85 Example::
86
87     # gnt-node add node5.example.com
88     # gnt-node add -s 192.0.2.5 node5.example.com
89     # gnt-node add -g group2 -s 192.0.2.9 node9.group2.example.com
90
91
92 EVACUATE
93 ~~~~~~~~
94
95 | **evacuate** [-f] [\--early-release] [\--submit] [\--print-job-id]
96 | [{-I|\--iallocator} *NAME* \| {-n|\--new-secondary} *destination\_node*]
97 | [{-p|\--primary-only} \| {-s|\--secondary-only} ]
98 |  {*node*}
99
100 This command will move instances away from the given node. If
101 ``--primary-only`` is given, only primary instances are evacuated, with
102 ``--secondary-only`` only secondaries. If neither is given, all
103 instances are evacuated. It works only for instances having a drbd disk
104 template.
105
106 The new location for the instances can be specified in two ways:
107
108 - as a single node for all instances, via the ``-n (--new-secondary)``
109   option
110
111 - or via the ``-I (--iallocator)`` option, giving a script name as
112   parameter (or ``.`` to use the default allocator), so each instance
113   will be in turn placed on the (per the script) optimal node
114
115 The ``--early-release`` changes the code so that the old storage on
116 node being evacuated is removed early (before the resync is
117 completed) and the internal Ganeti locks are also released for both
118 the current secondary and the new secondary, thus allowing more
119 parallelism in the cluster operation. This should be used only when
120 recovering from a disk failure on the current secondary (thus the
121 old storage is already broken) or when the storage on the primary
122 node is known to be fine (thus we won't need the old storage for
123 potential recovery).
124
125 Note that this command is equivalent to using per-instance commands for
126 each affected instance individually:
127
128 - ``--primary-only`` is equivalent to performing ``gnt-instance
129   migrate`` for every primary instance running on the node that can be
130   migrated and ``gnt-instance failover`` for every primary instance that
131   cannot be migrated.
132 - ``--secondary-only`` is equivalent to ``gnt-instance replace-disks``
133   in secondary node change mode (``--new-secondary``) for every DRBD
134   instance that the node is a secondary for.
135 - when neither of the above is done a combination of the two cases is run
136
137 Note that the iallocator currently only considers disk information of
138 the default disk template, even if the instance's disk templates differ
139 from that.
140
141 See **ganeti**\(7) for a description of ``--submit`` and other common
142 options.
143
144 Example::
145
146     # gnt-node evacuate -I hail node3.example.com
147
148 Note that, due to an issue with the iallocator interface, evacuation of
149 all instances at once is not yet implemented. Full evacuation can
150 currently be achieved by sequentially evacuating primaries and
151 secondaries.
152 ::
153
154     # gnt-node evacuate -p node3.example.com
155     # gnt-node evacuate -s node3.example.com
156
157
158 FAILOVER
159 ~~~~~~~~
160
161 **failover** [-f] [\--ignore-consistency] {*node*}
162
163 This command will fail over all instances having the given node as
164 primary to their secondary nodes. This works only for instances having
165 a drbd disk template.
166
167 Note that failover will stop any running instances on the given node and
168 restart them again on the new primary.
169 See also FAILOVER in **gnt-instance**\(8).
170
171 Normally the failover will check the consistency of the disks before
172 failing over the instance. If you are trying to migrate instances off
173 a dead node, this will fail. Use the ``--ignore-consistency`` option
174 for this purpose.
175
176 Example::
177
178     # gnt-node failover node1.example.com
179
180
181 INFO
182 ~~~~
183
184 **info** [*node*...]
185
186 Show detailed information about the nodes in the cluster. If you
187 don't give any arguments, all nodes will be shows, otherwise the
188 output will be restricted to the given names.
189
190 LIST
191 ~~~~
192
193 | **list**
194 | [\--no-headers] [\--separator=*SEPARATOR*]
195 | [\--units=*UNITS*] [-v] [{-o|\--output} *[+]FIELD,...*]
196 | [\--filter]
197 | [node...]
198
199 Lists the nodes in the cluster.
200
201 The ``--no-headers`` option will skip the initial header line. The
202 ``--separator`` option takes an argument which denotes what will be
203 used between the output fields. Both these options are to help
204 scripting.
205
206 The units used to display the numeric values in the output varies,
207 depending on the options given. By default, the values will be
208 formatted in the most appropriate unit. If the ``--separator``
209 option is given, then the values are shown in mebibytes to allow
210 parsing by scripts. In both cases, the ``--units`` option can be
211 used to enforce a given output unit.
212
213 Queries of nodes will be done in parallel with any running jobs. This might
214 give inconsistent results for the free disk/memory.
215
216 The ``-v`` option activates verbose mode, which changes the display of
217 special field states (see **ganeti**\(7)).
218
219 The ``-o (--output)`` option takes a comma-separated list of output
220 fields. The available fields and their meaning are:
221
222 @QUERY_FIELDS_NODE@
223
224 If the value of the option starts with the character ``+``, the new
225 fields will be added to the default list. This allows one to quickly
226 see the default list plus a few other fields, instead of retyping
227 the entire list of fields.
228
229 Note that some of these fields are known from the configuration of the
230 cluster (e.g. ``name``, ``pinst``, ``sinst``, ``pip``, ``sip``) and thus
231 the master does not need to contact the node for this data (making the
232 listing fast if only fields from this set are selected), whereas the
233 other fields are "live" fields and require a query to the cluster nodes.
234
235 Depending on the virtualization type and implementation details, the
236 ``mtotal``, ``mnode`` and ``mfree`` fields may have slightly varying
237 meanings. For example, some solutions share the node memory with the
238 pool of memory used for instances (KVM), whereas others have separate
239 memory for the node and for the instances (Xen).
240
241 Note that the field 'dtotal' and 'dfree' refer to the storage type
242 that is defined by the default disk template. The default disk template
243 is the first on in the list of cluster-wide enabled disk templates and
244 can be set with ``gnt-cluster modify``. Currently, only the disk
245 templates 'plain', 'drbd', 'file', and 'sharedfile' support storage
246 reporting, for all others '0' is displayed.
247
248 If exactly one argument is given and it appears to be a query filter
249 (see **ganeti**\(7)), the query result is filtered accordingly. For
250 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
251 (``-F``) option forces the argument to be treated as a filter (e.g.
252 ``gnt-node list -F master_candidate``).
253
254 If no node names are given, then all nodes are queried. Otherwise,
255 only the given nodes will be listed.
256
257
258 LIST-DRBD
259 ~~~~~~~~~
260
261 **list-drbd** [\--no-headers] [\--separator=*SEPARATOR*] node
262
263 Lists the mapping of DRBD minors for a given node. This outputs a static
264 list of fields (it doesn't accept the ``--output`` option), as follows:
265
266 ``Node``
267   The (full) name of the node we are querying
268 ``Minor``
269   The DRBD minor
270 ``Instance``
271   The instance the DRBD minor belongs to
272 ``Disk``
273   The disk index that the DRBD minor belongs to
274 ``Role``
275   Either ``primary`` or ``secondary``, denoting the role of the node for
276   the instance (note: this is not the live status of the DRBD device,
277   but the configuration value)
278 ``PeerNode``
279   The node that the minor is connected to on the other end
280
281 This command can be used as a reverse lookup (from node and minor) to a
282 given instance, which can be useful when debugging DRBD issues.
283
284 Note that this command queries Ganeti via **ganeti-confd**\(8), so
285 it won't be available if support for ``confd`` has not been enabled at
286 build time; furthermore, in Ganeti 2.6 this is only available via the
287 Haskell version of confd (again selected at build time).
288
289 LIST-FIELDS
290 ~~~~~~~~~~~
291
292 **list-fields** [field...]
293
294 Lists available fields for nodes.
295
296
297 MIGRATE
298 ~~~~~~~
299
300 | **migrate** [-f] [\--non-live] [\--migration-mode=live\|non-live]
301 | [\--ignore-ipolicy] [\--submit] [\--print-job-id] {*node*}
302
303 This command will migrate all instances having the given node as
304 primary to their secondary nodes. This works only for instances
305 having a drbd disk template.
306
307 As for the **gnt-instance migrate** command, the options
308 ``--no-live``, ``--migration-mode`` and ``--no-runtime-changes``
309 can be given to influence the migration type.
310
311 If ``--ignore-ipolicy`` is given any instance policy violations
312 occurring during this operation are ignored.
313
314 See **ganeti**\(7) for a description of ``--submit`` and other common
315 options.
316
317 Example::
318
319     # gnt-node migrate node1.example.com
320
321
322 MODIFY
323 ~~~~~~
324
325 | **modify** [-f] [\--submit] [\--print-job-id]
326 | [{-C|\--master-candidate} ``yes|no``]
327 | [{-D|\--drained} ``yes|no``] [{-O|\--offline} ``yes|no``]
328 | [\--master-capable=``yes|no``] [\--vm-capable=``yes|no``] [\--auto-promote]
329 | [{-s|\--secondary-ip} *secondary_ip*]
330 | [\--node-parameters *ndparams*]
331 | [\--node-powered=``yes|no``]
332 | [\--hypervisor-state *hvstate*]
333 | [\--disk-state *diskstate*]
334 | {*node*}
335
336 This command changes the role of the node. Each options takes
337 either a literal yes or no, and only one option should be given as
338 yes. The meaning of the roles and flags are described in the
339 manpage **ganeti**\(7).
340
341 The option ``--node-powered`` can be used to modify state-of-record if
342 it doesn't reflect the reality anymore.
343
344 In case a node is demoted from the master candidate role, the
345 operation will be refused unless you pass the ``--auto-promote``
346 option. This option will cause the operation to lock all cluster nodes
347 (thus it will not be able to run in parallel with most other jobs),
348 but it allows automated maintenance of the cluster candidate pool. If
349 locking all cluster node is too expensive, another option is to
350 promote manually another node to master candidate before demoting the
351 current one.
352
353 Example (setting a node offline, which will demote it from master
354 candidate role if is in that role)::
355
356     # gnt-node modify --offline=yes node1.example.com
357
358 The ``-s (--secondary-ip)`` option can be used to change the node's
359 secondary ip. No drbd instances can be running on the node, while this
360 operation is taking place. Remember that the secondary ip must be
361 reachable from the master secondary ip, when being changed, so be sure
362 that the node has the new IP already configured and active. In order to
363 convert a cluster from single homed to multi-homed or vice versa
364 ``--force`` is needed as well, and the target node for the first change
365 must be the master.
366
367 See **ganeti**\(7) for a description of ``--submit`` and other common
368 options.
369
370 Example (setting the node back to online and master candidate)::
371
372     # gnt-node modify --offline=no --master-candidate=yes node1.example.com
373
374
375 REMOVE
376 ~~~~~~
377
378 **remove** {*nodename*}
379
380 Removes a node from the cluster. Instances must be removed or
381 migrated to another cluster before.
382
383 Example::
384
385     # gnt-node remove node5.example.com
386
387
388 VOLUMES
389 ~~~~~~~
390
391 | **volumes** [\--no-headers] [\--human-readable]
392 | [\--separator=*SEPARATOR*] [{-o|\--output} *FIELDS*]
393 | [*node*...]
394
395 Lists all logical volumes and their physical disks from the node(s)
396 provided.
397
398 The ``--no-headers`` option will skip the initial header line. The
399 ``--separator`` option takes an argument which denotes what will be
400 used between the output fields. Both these options are to help
401 scripting.
402
403 The units used to display the numeric values in the output varies,
404 depending on the options given. By default, the values will be
405 formatted in the most appropriate unit. If the ``--separator``
406 option is given, then the values are shown in mebibytes to allow
407 parsing by scripts. In both cases, the ``--units`` option can be
408 used to enforce a given output unit.
409
410 The ``-o (--output)`` option takes a comma-separated list of output
411 fields. The available fields and their meaning are:
412
413 node
414     the node name on which the volume exists
415
416 phys
417     the physical drive (on which the LVM physical volume lives)
418
419 vg
420     the volume group name
421
422 name
423     the logical volume name
424
425 size
426     the logical volume size
427
428 instance
429     The name of the instance to which this volume belongs, or (in case
430     it's an orphan volume) the character "-"
431
432
433 Example::
434
435     # gnt-node volumes node5.example.com
436     Node              PhysDev   VG    Name                                 Size Instance
437     node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11000.meta 128  instance1.example.com
438     node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11001.data 256  instance1.example.com
439
440
441 LIST-STORAGE
442 ~~~~~~~~~~~~
443
444 | **list-storage** [\--no-headers] [\--human-readable]
445 | [\--separator=*SEPARATOR*] [\--storage-type=*STORAGE\_TYPE*]
446 | [{-o|\--output} *FIELDS*]
447 | [*node*...]
448
449 Lists the available storage units and their details for the given
450 node(s).
451
452 The ``--no-headers`` option will skip the initial header line. The
453 ``--separator`` option takes an argument which denotes what will be
454 used between the output fields. Both these options are to help
455 scripting.
456
457 The units used to display the numeric values in the output varies,
458 depending on the options given. By default, the values will be
459 formatted in the most appropriate unit. If the ``--separator``
460 option is given, then the values are shown in mebibytes to allow
461 parsing by scripts. In both cases, the ``--units`` option can be
462 used to enforce a given output unit.
463
464 The ``--storage-type`` option can be used to choose a storage unit
465 type. Possible choices are lvm-pv, lvm-vg, file, sharedfile and gluster.
466
467 The ``-o (--output)`` option takes a comma-separated list of output
468 fields. The available fields and their meaning are:
469
470 node
471     the node name on which the volume exists
472
473 type
474     the type of the storage unit (currently just what is passed in via
475     ``--storage-type``)
476
477 name
478     the path/identifier of the storage unit
479
480 size
481     total size of the unit; for the file type see a note below
482
483 used
484     used space in the unit; for the file type see a note below
485
486 free
487     available disk space
488
489 allocatable
490     whether we the unit is available for allocation (only lvm-pv can
491     change this setting, the other types always report true)
492
493
494 Note that for the "file" type, the total disk space might not equal
495 to the sum of used and free, due to the method Ganeti uses to
496 compute each of them. The total and free values are computed as the
497 total and free space values for the filesystem to which the
498 directory belongs, but the used space is computed from the used
499 space under that directory *only*, which might not be necessarily
500 the root of the filesystem, and as such there could be files
501 outside the file storage directory using disk space and causing a
502 mismatch in the values.
503
504 Example::
505
506     node1# gnt-node list-storage node2
507     Node  Type   Name        Size Used   Free Allocatable
508     node2 lvm-pv /dev/sda7 673.8G 1.5G 672.3G Y
509     node2 lvm-pv /dev/sdb1 698.6G   0M 698.6G Y
510
511
512 MODIFY-STORAGE
513 ~~~~~~~~~~~~~~
514
515 | **modify-storage** [\--allocatable={yes|no}] [\--submit] [\--print-job-id]
516 | {*node*} {*storage-type*} {*volume-name*}
517
518 Modifies storage volumes on a node. Only LVM physical volumes can
519 be modified at the moment. They have a storage type of "lvm-pv".
520
521 Example::
522
523     # gnt-node modify-storage --allocatable no node5.example.com lvm-pv /dev/sdb1
524
525
526 REPAIR-STORAGE
527 ~~~~~~~~~~~~~~
528
529 | **repair-storage** [\--ignore-consistency] ]\--submit]
530 | {*node*} {*storage-type*} {*volume-name*}
531
532 Repairs a storage volume on a node. Only LVM volume groups can be
533 repaired at this time. They have the storage type "lvm-vg".
534
535 On LVM volume groups, **repair-storage** runs ``vgreduce
536 --removemissing``.
537
538
539
540 **Caution:** Running this command can lead to data loss. Use it with
541 care.
542
543 The ``--ignore-consistency`` option will ignore any inconsistent
544 disks (on the nodes paired with this one). Use of this option is
545 most likely to lead to data-loss.
546
547 Example::
548
549     # gnt-node repair-storage node5.example.com lvm-vg xenvg
550
551
552 POWERCYCLE
553 ~~~~~~~~~~
554
555 **powercycle** [\--yes] [\--force] [\--submit] [\--print-job-id] {*node*}
556
557 This command (tries to) forcefully reboot a node. It is a command
558 that can be used if the node environment is broken, such that the
559 admin can no longer login over SSH, but the Ganeti node daemon is
560 still working.
561
562 Note that this command is not guaranteed to work; it depends on the
563 hypervisor how effective is the reboot attempt. For Linux, this
564 command requires the kernel option ``CONFIG_MAGIC_SYSRQ`` to be
565 enabled.
566
567 The ``--yes`` option can be used to skip confirmation, while the
568 ``--force`` option is needed if the target node is the master
569 node.
570
571 See **ganeti**\(7) for a description of ``--submit`` and other common
572 options.
573
574 POWER
575 ~~~~~
576
577 **power** [``--force``] [``--ignore-status``] [``--all``]
578 [``--power-delay``] on|off|cycle|status [*nodes*]
579
580 This command calls out to out-of-band management to change the power
581 state of given node. With ``status`` you get the power status as reported
582 by the out-of-band management script.
583
584 Note that this command will only work if the out-of-band functionality
585 is configured and enabled on the cluster. If this is not the case,
586 please use the **powercycle** command above.
587
588 Using ``--force`` you skip the confirmation to do the operation.
589 Currently this only has effect on ``off`` and ``cycle``. On those two
590 you can *not* operate on the master. However, the command will provide
591 you with the command to invoke to operate on the master nerver-mind.
592 This is considered harmful and Ganeti does not support the use of it.
593
594 Providing ``--ignore-status`` will ignore the offline=N state of a node
595 and continue with power off.
596
597 ``--power-delay`` specifies the time in seconds (factions allowed)
598 waited between powering on the next node. This is by default 2 seconds
599 but can increased if needed with this option.
600
601 *nodes* are optional. If not provided it will call out for every node in
602 the cluster. Except for the ``off`` and ``cycle`` command where you've
603 to explicit use ``--all`` to select all.
604
605
606 HEALTH
607 ~~~~~~
608
609 **health** [*nodes*]
610
611 This command calls out to out-of-band management to ask for the health status
612 of all or given nodes. The health contains the node name and then the items
613 element with their status in a ``item=status`` manner. Where ``item`` is script
614 specific and ``status`` can be one of ``OK``, ``WARNING``, ``CRITICAL`` or
615 ``UNKNOWN``. Items with status ``WARNING`` or ``CRITICAL`` are logged and
616 annotated in the command line output.
617
618
619 RESTRICTED-COMMAND
620 ~~~~~~~~~~~~~~~~~~
621
622 | **restricted-command** [-M] [\--sync]
623 | { -g *group* *command* | *command* *nodes*... }
624
625 Executes a restricted command on the specified nodes. Restricted commands are
626 not arbitrary, but must reside in
627 ``@SYSCONFDIR@/ganeti/restricted-commands`` on a node, either as a regular
628 file or as a symlink. The directory must be owned by root and not be
629 world- or group-writable. If a command fails verification or otherwise
630 fails to start, the node daemon log must be consulted for more detailed
631 information.
632
633 Example for running a command on two nodes::
634
635     # gnt-node restricted-command mycommand \
636       node1.example.com node2.example.com
637
638 The ``-g`` option can be used to run a command only on a specific node
639 group, e.g.::
640
641     # gnt-node restricted-command -g default mycommand
642
643 The ``-M`` option can be used to prepend the node name to all command
644 output lines. ``--sync`` forces the opcode to acquire the node lock(s)
645 in exclusive mode.
646
647 Tags
648 ~~~~
649
650 ADD-TAGS
651 ^^^^^^^^
652
653 **add-tags** [\--from *file*] {*nodename*} {*tag*...}
654
655 Add tags to the given node. If any of the tags contains invalid
656 characters, the entire operation will abort.
657
658 If the ``--from`` option is given, the list of tags will be
659 extended with the contents of that file (each line becomes a tag).
660 In this case, there is not need to pass tags on the command line
661 (if you do, both sources will be used). A file name of - will be
662 interpreted as stdin.
663
664 LIST-TAGS
665 ^^^^^^^^^
666
667 **list-tags** {*nodename*}
668
669 List the tags of the given node.
670
671 REMOVE-TAGS
672 ^^^^^^^^^^^
673
674 **remove-tags** [\--from *file*] {*nodename*} {*tag*...}
675
676 Remove tags from the given node. If any of the tags are not
677 existing on the node, the entire operation will abort.
678
679 If the ``--from`` option is given, the list of tags to be removed will
680 be extended with the contents of that file (each line becomes a tag).
681 In this case, there is not need to pass tags on the command line (if
682 you do, tags from both sources will be removed). A file name of - will
683 be interpreted as stdin.
684
685 .. vim: set textwidth=72 :
686 .. Local Variables:
687 .. mode: rst
688 .. fill-column: 72
689 .. End: