Statistics
| Branch: | Tag: | Revision:

root / man / gnt-cluster.rst @ 7ba93b8a

History | View | Annotate | Download (31.3 kB)

1
gnt-cluster(8) Ganeti | Version @GANETI_VERSION@
2
================================================
3

    
4
Name
5
----
6

    
7
gnt-cluster - Ganeti administration, cluster-wide
8

    
9
Synopsis
10
--------
11

    
12
**gnt-cluster** {command} [arguments...]
13

    
14
DESCRIPTION
15
-----------
16

    
17
The **gnt-cluster** is used for cluster-wide administration in the
18
Ganeti system.
19

    
20
COMMANDS
21
--------
22

    
23
ACTIVATE-MASTER-IP
24
~~~~~~~~~~~~~~~~~~
25

    
26
**activate-master-ip**
27

    
28
Activates the master IP on the master node.
29

    
30
COMMAND
31
~~~~~~~
32

    
33
**command** [-n *node*] [-g *group*] [-M] {*command*}
34

    
35
Executes a command on all nodes. This command is designed for simple
36
usage. For more complex use cases the commands **dsh**\(1) or **cssh**\(1)
37
should be used instead.
38

    
39
If the option ``-n`` is not given, the command will be executed on all
40
nodes, otherwise it will be executed only on the node(s) specified. Use
41
the option multiple times for running it on multiple nodes, like::
42

    
43
    # gnt-cluster command -n node1.example.com -n node2.example.com date
44

    
45
The ``-g`` option can be used to run a command only on a specific node
46
group, e.g.::
47

    
48
    # gnt-cluster command -g default date
49

    
50
The ``-M`` option can be used to prepend the node name to all output
51
lines. The ``--failure-only`` option hides successful commands, making
52
it easier to see failures.
53

    
54
The command is executed serially on the selected nodes. If the
55
master node is present in the list, the command will be executed
56
last on the master. Regarding the other nodes, the execution order
57
is somewhat alphabetic, so that node2.example.com will be earlier
58
than node10.example.com but after node1.example.com.
59

    
60
So given the node names node1, node2, node3, node10, node11, with
61
node3 being the master, the order will be: node1, node2, node10,
62
node11, node3.
63

    
64
The command is constructed by concatenating all other command line
65
arguments. For example, to list the contents of the /etc directory
66
on all nodes, run::
67

    
68
    # gnt-cluster command ls -l /etc
69

    
70
and the command which will be executed will be ``ls -l /etc``.
71

    
72
COPYFILE
73
~~~~~~~~
74

    
75
| **copyfile** [\--use-replication-network] [-n *node*] [-g *group*]
76
| {*file*}
77

    
78
Copies a file to all or to some nodes. The argument specifies the
79
source file (on the current system), the ``-n`` argument specifies
80
the target node, or nodes if the option is given multiple times. If
81
``-n`` is not given at all, the file will be copied to all nodes. The
82
``-g`` option can be used to only select nodes in a specific node group.
83
Passing the ``--use-replication-network`` option will cause the
84
copy to be done over the replication network (only matters if the
85
primary/secondary IPs are different). Example::
86

    
87
    # gnt-cluster -n node1.example.com -n node2.example.com copyfile /tmp/test
88

    
89
This will copy the file /tmp/test from the current node to the two
90
named nodes.
91

    
92
DEACTIVATE-MASTER-IP
93
~~~~~~~~~~~~~~~~~~~~
94

    
95
**deactivate-master-ip** [\--yes]
96

    
97
Deactivates the master IP on the master node.
98

    
99
This should be run only locally or on a connection to the node ip
100
directly, as a connection to the master ip will be broken by this
101
operation. Because of this risk it will require user confirmation
102
unless the ``--yes`` option is passed.
103

    
104
DESTROY
105
~~~~~~~
106

    
107
**destroy** {\--yes-do-it}
108

    
109
Remove all configuration files related to the cluster, so that a
110
**gnt-cluster init** can be done again afterwards.
111

    
112
Since this is a dangerous command, you are required to pass the
113
argument *\--yes-do-it.*
114

    
115
EPO
116
~~~
117

    
118
**epo** [\--on] [\--groups|\--all] [\--power-delay] *arguments*
119

    
120
Performs an emergency power-off on nodes given as arguments. If
121
``--groups`` is given, arguments are node groups. If ``--all`` is
122
provided, the whole cluster will be shut down.
123

    
124
The ``--on`` flag recovers the cluster after an emergency power-off.
125
When powering on the cluster you can use ``--power-delay`` to define the
126
time in seconds (fractions allowed) waited between powering on
127
individual nodes.
128

    
129
Please note that the master node will not be turned down or up
130
automatically.  It will just be left in a state, where you can manully
131
perform the shutdown of that one node. If the master is in the list of
132
affected nodes and this is not a complete cluster emergency power-off
133
(e.g. using ``--all``), you're required to do a master failover to
134
another node not affected.
135

    
136
GETMASTER
137
~~~~~~~~~
138

    
139
**getmaster**
140

    
141
Displays the current master node.
142

    
143
INFO
144
~~~~
145

    
146
**info** [\--roman]
147

    
148
Shows runtime cluster information: cluster name, architecture (32
149
or 64 bit), master node, node list and instance list.
150

    
151
Passing the ``--roman`` option gnt-cluster info will try to print
152
its integer fields in a latin friendly way. This allows further
153
diffusion of Ganeti among ancient cultures.
154

    
155
INIT
156
~~~~
157

    
158
| **init**
159
| [{-s|\--secondary-ip} *secondary\_ip*]
160
| [\--vg-name *vg-name*]
161
| [\--master-netdev *interface-name*]
162
| [\--master-netmask *netmask*]
163
| [\--use-external-mip-script {yes \| no}]
164
| [{-m|\--mac-prefix} *mac-prefix*]
165
| [\--no-lvm-storage]
166
| [\--no-etc-hosts]
167
| [\--no-ssh-init]
168
| [\--file-storage-dir *dir*]
169
| [\--enabled-hypervisors *hypervisors*]
170
| [{-H|\--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
171
| [{-B|\--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
172
| [{-N|\--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
173
| [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
174
| [\--maintain-node-health {yes \| no}]
175
| [\--uid-pool *user-id pool definition*]
176
| [{-I|\--default-iallocator} *default instance allocator*]
177
| [\--primary-ip-version *version*]
178
| [\--prealloc-wipe-disks {yes \| no}]
179
| [\--node-parameters *ndparams*]
180
| [{-C|\--candidate-pool-size} *candidate\_pool\_size*]
181
| [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
182
| [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
183
| [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
184
| [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
185
| [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
186
| [\--ipolicy-disk-templates *template* [,*template*...]]
187
| [\--disk-state *diskstate*]
188
| [\--hypervisor-state *hvstate*]
189
| {*clustername*}
190

    
191
This commands is only run once initially on the first node of the
192
cluster. It will initialize the cluster configuration, setup the
193
ssh-keys, start the daemons on the master node, etc. in order to have
194
a working one-node cluster.
195

    
196
Note that the *clustername* is not any random name. It has to be
197
resolvable to an IP address using DNS, and it is best if you give the
198
fully-qualified domain name. This hostname must resolve to an IP
199
address reserved exclusively for this purpose, i.e. not already in
200
use.
201

    
202
The cluster can run in two modes: single-home or dual-homed. In the
203
first case, all traffic (both public traffic, inter-node traffic and
204
data replication traffic) goes over the same interface. In the
205
dual-homed case, the data replication traffic goes over the second
206
network. The ``-s (--secondary-ip)`` option here marks the cluster as
207
dual-homed and its parameter represents this node's address on the
208
second network.  If you initialise the cluster with ``-s``, all nodes
209
added must have a secondary IP as well.
210

    
211
Note that for Ganeti it doesn't matter if the secondary network is
212
actually a separate physical network, or is done using tunneling,
213
etc. For performance reasons, it's recommended to use a separate
214
network, of course.
215

    
216
The ``--vg-name`` option will let you specify a volume group
217
different than "xenvg" for Ganeti to use when creating instance
218
disks. This volume group must have the same name on all nodes. Once
219
the cluster is initialized this can be altered by using the
220
**modify** command. Note that if the volume group is modified after
221
the cluster creation, the metavg will have to be manually modified
222
accordingly.
223

    
224
If you don't want to use lvm storage at all use
225
the ``--no-lvm-storage`` option. Once the cluster is initialized
226
you can change this setup with the **modify** command.
227

    
228
The ``--master-netdev`` option is useful for specifying a different
229
interface on which the master will activate its IP address. It's
230
important that all nodes have this interface because you'll need it
231
for a master failover.
232

    
233
The ``--master-netmask`` option allows to specify a netmask for the
234
master IP. The netmask must be specified as an integer, and will be
235
interpreted as a CIDR netmask. The default value is 32 for an IPv4
236
address and 128 for an IPv6 address.
237

    
238
The ``--use-external-mip-script`` option allows to specify whether to
239
use an user-supplied master IP address setup script, whose location is
240
``@SYSCONFDIR@/ganeti/scripts/master-ip-setup``. If the option value is
241
set to False, the default script (located at
242
``@PKGLIBDIR@/tools/master-ip-setup``) will be executed.
243

    
244
The ``-m (--mac-prefix)`` option will let you specify a three byte
245
prefix under which the virtual MAC addresses of your instances will be
246
generated. The prefix must be specified in the format ``XX:XX:XX`` and
247
the default is ``aa:00:00``.
248

    
249
The ``--no-lvm-storage`` option allows you to initialize the
250
cluster without lvm support. This means that only instances using
251
files as storage backend will be possible to create. Once the
252
cluster is initialized you can change this setup with the
253
**modify** command.
254

    
255
The ``--no-etc-hosts`` option allows you to initialize the cluster
256
without modifying the /etc/hosts file.
257

    
258
The ``--no-ssh-init`` option allows you to initialize the cluster
259
without creating or distributing SSH key pairs.
260

    
261
The ``--file-storage-dir`` option allows you set the directory to
262
use for storing the instance disk files when using file storage as
263
backend for instance disks.
264

    
265
The ``--prealloc-wipe-disks`` sets a cluster wide configuration value
266
for wiping disks prior to allocation and size changes (``gnt-instance
267
grow-disk``). This increases security on instance level as the instance
268
can't access untouched data from its underlying storage.
269

    
270
The ``--enabled-hypervisors`` option allows you to set the list of
271
hypervisors that will be enabled for this cluster. Instance
272
hypervisors can only be chosen from the list of enabled
273
hypervisors, and the first entry of this list will be used by
274
default. Currently, the following hypervisors are available:
275

    
276
xen-pvm
277
    Xen PVM hypervisor
278

    
279
xen-hvm
280
    Xen HVM hypervisor
281

    
282
kvm
283
    Linux KVM hypervisor
284

    
285
chroot
286
    a simple chroot manager that starts chroot based on a script at the
287
    root of the filesystem holding the chroot
288

    
289
fake
290
    fake hypervisor for development/testing
291

    
292
Either a single hypervisor name or a comma-separated list of
293
hypervisor names can be specified. If this option is not specified,
294
only the xen-pvm hypervisor is enabled by default.
295

    
296
The ``-H (--hypervisor-parameters)`` option allows you to set default
297
hypervisor specific parameters for the cluster. The format of this
298
option is the name of the hypervisor, followed by a colon and a
299
comma-separated list of key=value pairs. The keys available for each
300
hypervisors are detailed in the **gnt-instance**\(8) man page, in the
301
**add** command plus the following parameters which are only
302
configurable globally (at cluster level):
303

    
304
migration\_port
305
    Valid for the Xen PVM and KVM hypervisors.
306

    
307
    This options specifies the TCP port to use for live-migration. For
308
    Xen, the same port should be configured on all nodes in the
309
    ``@XEN_CONFIG_DIR@/xend-config.sxp`` file, under the key
310
    "xend-relocation-port".
311

    
312
migration\_bandwidth
313
    Valid for the KVM hypervisor.
314

    
315
    This option specifies the maximum bandwidth that KVM will use for
316
    instance live migrations. The value is in MiB/s.
317

    
318
    This option is only effective with kvm versions >= 78 and qemu-kvm
319
    versions >= 0.10.0.
320

    
321
The ``-B (--backend-parameters)`` option allows you to set the default
322
backend parameters for the cluster. The parameter format is a
323
comma-separated list of key=value pairs with the following supported
324
keys:
325

    
326
vcpus
327
    Number of VCPUs to set for an instance by default, must be an
328
    integer, will be set to 1 if no specified.
329

    
330
maxmem
331
    Maximum amount of memory to allocate for an instance by default, can
332
    be either an integer or an integer followed by a unit (M for
333
    mebibytes and G for gibibytes are supported), will be set to 128M if
334
    not specified.
335

    
336
minmem
337
    Minimum amount of memory to allocate for an instance by default, can
338
    be either an integer or an integer followed by a unit (M for
339
    mebibytes and G for gibibytes are supported), will be set to 128M if
340
    not specified.
341

    
342
auto\_balance
343
    Value of the auto\_balance flag for instances to use by default,
344
    will be set to true if not specified.
345

    
346
always\_failover
347
    Default value for the ``always_failover`` flag for instances; if
348
    not set, ``False`` is used.
349

    
350

    
351
The ``-N (--nic-parameters)`` option allows you to set the default
352
network interface parameters for the cluster. The parameter format is a
353
comma-separated list of key=value pairs with the following supported
354
keys:
355

    
356
mode
357
    The default NIC mode, one of ``routed``, ``bridged`` or
358
    ``openvswitch``.
359

    
360
link
361
    In ``bridged`` or ``openvswitch`` mode the default interface where
362
    to attach NICs. In ``routed`` mode it represents an
363
    hypervisor-vif-script dependent value to allow different instance
364
    groups. For example under the KVM default network script it is
365
    interpreted as a routing table number or name. Openvswitch support
366
    is also hypervisor dependent and currently works for the default KVM
367
    network script. Under Xen a custom network script must be provided.
368

    
369
The ``-D (--disk-parameters)`` option allows you to set the default disk
370
template parameters at cluster level. The format used for this option is
371
similar to the one use by the  ``-H`` option: the disk template name
372
must be specified first, followed by a colon and by a comma-separated
373
list of key-value pairs. These parameters can only be specified at
374
cluster and node group level; the cluster-level parameter are inherited
375
by the node group at the moment of its creation, and can be further
376
modified at node group level using the **gnt-group**\(8) command.
377

    
378
The following is the list of disk parameters available for the **drbd**
379
template, with measurement units specified in square brackets at the end
380
of the description (when applicable):
381

    
382
resync-rate
383
    Static re-synchronization rate. [KiB/s]
384

    
385
data-stripes
386
    Number of stripes to use for data LVs.
387

    
388
meta-stripes
389
    Number of stripes to use for meta LVs.
390

    
391
disk-barriers
392
    What kind of barriers to **disable** for disks. It can either assume
393
    the value "n", meaning no barrier disabled, or a non-empty string
394
    containing a subset of the characters "bfd". "b" means disable disk
395
    barriers, "f" means disable disk flushes, "d" disables disk drains.
396

    
397
meta-barriers
398
    Boolean value indicating whether the meta barriers should be
399
    disabled (True) or not (False).
400

    
401
metavg
402
    String containing the name of the default LVM volume group for DRBD
403
    metadata. By default, it is set to ``xenvg``. It can be overridden
404
    during the instance creation process by using the ``metavg`` key of
405
    the ``--disk`` parameter.
406

    
407
disk-custom
408
    String containing additional parameters to be appended to the
409
    arguments list of ``drbdsetup disk``.
410

    
411
net-custom
412
    String containing additional parameters to be appended to the
413
    arguments list of ``drbdsetup net``.
414

    
415
dynamic-resync
416
    Boolean indicating whether to use the dynamic resync speed
417
    controller or not. If enabled, c-plan-ahead must be non-zero and all
418
    the c-* parameters will be used by DRBD. Otherwise, the value of
419
    resync-rate will be used as a static resync speed.
420

    
421
c-plan-ahead
422
    Agility factor of the dynamic resync speed controller. (the higher,
423
    the slower the algorithm will adapt the resync speed). A value of 0
424
    (that is the default) disables the controller. [ds]
425

    
426
c-fill-target
427
    Maximum amount of in-flight resync data for the dynamic resync speed
428
    controller. [sectors]
429

    
430
c-delay-target
431
    Maximum estimated peer response latency for the dynamic resync speed
432
    controller. [ds]
433

    
434
c-min-rate
435
    Minimum resync speed for the dynamic resync speed controller. [KiB/s]
436

    
437
c-max-rate
438
    Upper bound on resync speed for the dynamic resync speed controller.
439
    [KiB/s]
440

    
441
List of parameters available for the **plain** template:
442

    
443
stripes
444
    Number of stripes to use for new LVs.
445

    
446
List of parameters available for the **rbd** template:
447

    
448
pool
449
    The RADOS cluster pool, inside which all rbd volumes will reside.
450
    When a new RADOS cluster is deployed, the default pool to put rbd
451
    volumes (Images in RADOS terminology) is 'rbd'.
452

    
453
The option ``--maintain-node-health`` allows one to enable/disable
454
automatic maintenance actions on nodes. Currently these include
455
automatic shutdown of instances and deactivation of DRBD devices on
456
offline nodes; in the future it might be extended to automatic
457
removal of unknown LVM volumes, etc. Note that this option is only
458
useful if the use of ``ganeti-confd`` was enabled at compilation.
459

    
460
The ``--uid-pool`` option initializes the user-id pool. The
461
*user-id pool definition* can contain a list of user-ids and/or a
462
list of user-id ranges. The parameter format is a comma-separated
463
list of numeric user-ids or user-id ranges. The ranges are defined
464
by a lower and higher boundary, separated by a dash. The boundaries
465
are inclusive. If the ``--uid-pool`` option is not supplied, the
466
user-id pool is initialized to an empty list. An empty list means
467
that the user-id pool feature is disabled.
468

    
469
The ``-I (--default-iallocator)`` option specifies the default
470
instance allocator. The instance allocator will be used for operations
471
like instance creation, instance and node migration, etc. when no
472
manual override is specified. If this option is not specified and
473
htools was not enabled at build time, the default instance allocator
474
will be blank, which means that relevant operations will require the
475
administrator to manually specify either an instance allocator, or a
476
set of nodes. If the option is not specified but htools was enabled,
477
the default iallocator will be **hail**\(1) (assuming it can be found
478
on disk). The default iallocator can be changed later using the
479
**modify** command.
480

    
481
The ``--primary-ip-version`` option specifies the IP version used
482
for the primary address. Possible values are 4 and 6 for IPv4 and
483
IPv6, respectively. This option is used when resolving node names
484
and the cluster name.
485

    
486
The ``--node-parameters`` option allows you to set default node
487
parameters for the cluster. Please see **ganeti**\(7) for more
488
information about supported key=value pairs.
489

    
490
The ``-C (--candidate-pool-size)`` option specifies the
491
``candidate_pool_size`` cluster parameter. This is the number of nodes
492
that the master will try to keep as master\_candidates. For more
493
details about this role and other node roles, see the **ganeti**\(7).
494

    
495
The ``--specs-...`` and ``--ipolicy-disk-templates`` options specify
496
instance policy on the cluster. For the ``--specs-...`` options, each
497
option can have three values: ``min``, ``max`` and ``std``, which can
498
also be modified on group level (except for ``std``, which is defined
499
once for the entire cluster). Please note, that ``std`` values are not
500
the same as defaults set by ``--beparams``, but they are used for the
501
capacity calculations. The ``--ipolicy-disk-templates`` option takes a
502
comma-separated list of disk templates.
503

    
504
- ``--specs-cpu-count`` limits the number of VCPUs that can be used by an
505
  instance.
506
- ``--specs-disk-count`` limits the number of disks
507
- ``--specs-disk-size`` limits the disk size for every disk used
508
- ``--specs-mem-size`` limits the amount of memory available
509
- ``--specs-nic-count`` sets limits on the number of NICs used
510
- ``--ipolicy-disk-templates`` limits the allowed disk templates
511

    
512
For details about how to use ``--hypervisor-state`` and ``--disk-state``
513
have a look at **ganeti**\(7).
514

    
515
MASTER-FAILOVER
516
~~~~~~~~~~~~~~~
517

    
518
**master-failover** [\--no-voting] [\--yes-do-it]
519

    
520
Failover the master role to the current node.
521

    
522
The ``--no-voting`` option skips the remote node agreement checks.
523
This is dangerous, but necessary in some cases (for example failing
524
over the master role in a 2 node cluster with the original master
525
down). If the original master then comes up, it won't be able to
526
start its master daemon because it won't have enough votes, but so
527
won't the new master, if the master daemon ever needs a restart.
528
You can pass ``--no-voting`` to **ganeti-masterd** on the new
529
master to solve this problem, and run **gnt-cluster redist-conf**
530
to make sure the cluster is consistent again.
531

    
532
The option ``--yes-do-it`` is used together with ``--no-voting``, for
533
skipping the interactive checks. This is even more dangerous, and should
534
only be used in conjunction with other means (e.g. a HA suite) to
535
confirm that the operation is indeed safe.
536

    
537
MASTER-PING
538
~~~~~~~~~~~
539

    
540
**master-ping**
541

    
542
Checks if the master daemon is alive.
543

    
544
If the master daemon is alive and can respond to a basic query (the
545
equivalent of **gnt-cluster info**), then the exit code of the
546
command will be 0. If the master daemon is not alive (either due to
547
a crash or because this is not the master node), the exit code will
548
be 1.
549

    
550
MODIFY
551
~~~~~~
552

    
553
| **modify** [\--submit]
554
| [\--vg-name *vg-name*]
555
| [\--no-lvm-storage]
556
| [\--enabled-hypervisors *hypervisors*]
557
| [{-H|\--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
558
| [{-B|\--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
559
| [{-N|\--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
560
| [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
561
| [\--uid-pool *user-id pool definition*]
562
| [\--add-uids *user-id pool definition*]
563
| [\--remove-uids *user-id pool definition*]
564
| [{-C|\--candidate-pool-size} *candidate\_pool\_size*]
565
| [\--maintain-node-health {yes \| no}]
566
| [\--prealloc-wipe-disks {yes \| no}]
567
| [{-I|\--default-iallocator} *default instance allocator*]
568
| [\--reserved-lvs=*NAMES*]
569
| [\--node-parameters *ndparams*]
570
| [\--master-netdev *interface-name*]
571
| [\--master-netmask *netmask*]
572
| [\--use-external-mip-script {yes \| no}]
573
| [\--hypervisor-state *hvstate*]
574
| [\--disk-state *diskstate*]
575
| [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
576
| [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
577
| [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
578
| [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
579
| [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
580
| [\--ipolicy-disk-templates *template* [,*template*...]]
581

    
582

    
583
Modify the options for the cluster.
584

    
585
The ``--vg-name``, ``--no-lvm-storage``, ``--enabled-hypervisors``,
586
``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``,
587
``-D (--disk-parameters)``, ``--nic-parameters``, ``-C
588
(--candidate-pool-size)``, ``--maintain-node-health``,
589
``--prealloc-wipe-disks``, ``--uid-pool``, ``--node-parameters``,
590
``--master-netdev``, ``--master-netmask`` and
591
``--use-external-mip-script`` options are described in the **init**
592
command.
593

    
594
The ``--hypervisor-state`` and ``--disk-state`` options are described in
595
detail in **ganeti**\(7).
596

    
597
The ``--add-uids`` and ``--remove-uids`` options can be used to
598
modify the user-id pool by adding/removing a list of user-ids or
599
user-id ranges.
600

    
601
The option ``--reserved-lvs`` specifies a list (comma-separated) of
602
logical volume group names (regular expressions) that will be
603
ignored by the cluster verify operation. This is useful if the
604
volume group used for Ganeti is shared with the system for other
605
uses. Note that it's not recommended to create and mark as ignored
606
logical volume names which match Ganeti's own name format (starting
607
with UUID and then .diskN), as this option only skips the
608
verification, but not the actual use of the names given.
609

    
610
To remove all reserved logical volumes, pass in an empty argument
611
to the option, as in ``--reserved-lvs=`` or ``--reserved-lvs ''``.
612

    
613
The ``-I (--default-iallocator)`` is described in the **init**
614
command. To clear the default iallocator, just pass an empty string
615
('').
616

    
617
The ``--specs-...`` and ``--ipolicy-disk-templates`` options are
618
described in the **init** command.
619

    
620
See **ganeti**\(7) for a description of ``--submit`` and other common
621
options.
622

    
623
QUEUE
624
~~~~~
625

    
626
**queue** {drain | undrain | info}
627

    
628
Change job queue properties.
629

    
630
The ``drain`` option sets the drain flag on the job queue. No new
631
jobs will be accepted, but jobs already in the queue will be
632
processed.
633

    
634
The ``undrain`` will unset the drain flag on the job queue. New
635
jobs will be accepted.
636

    
637
The ``info`` option shows the properties of the job queue.
638

    
639
WATCHER
640
~~~~~~~
641

    
642
**watcher** {pause *duration* | continue | info}
643

    
644
Make the watcher pause or let it continue.
645

    
646
The ``pause`` option causes the watcher to pause for *duration*
647
seconds.
648

    
649
The ``continue`` option will let the watcher continue.
650

    
651
The ``info`` option shows whether the watcher is currently paused.
652

    
653
REDIST-CONF
654
~~~~~~~~~~~
655

    
656
**redist-conf** [\--submit]
657

    
658
This command forces a full push of configuration files from the
659
master node to the other nodes in the cluster. This is normally not
660
needed, but can be run if the **verify** complains about
661
configuration mismatches.
662

    
663
See **ganeti**\(7) for a description of ``--submit`` and other common
664
options.
665

    
666
RENAME
667
~~~~~~
668

    
669
**rename** [-f] {*name*}
670

    
671
Renames the cluster and in the process updates the master IP
672
address to the one the new name resolves to. At least one of either
673
the name or the IP address must be different, otherwise the
674
operation will be aborted.
675

    
676
Note that since this command can be dangerous (especially when run
677
over SSH), the command will require confirmation unless run with
678
the ``-f`` option.
679

    
680
RENEW-CRYPTO
681
~~~~~~~~~~~~
682

    
683
| **renew-crypto** [-f]
684
| [\--new-cluster-certificate] [\--new-confd-hmac-key]
685
| [\--new-rapi-certificate] [\--rapi-certificate *rapi-cert*]
686
| [\--new-spice-certificate | \--spice-certificate *spice-cert*
687
| \--spice-ca-certificate *spice-ca-cert*]
688
| [\--new-cluster-domain-secret] [\--cluster-domain-secret *filename*]
689

    
690
This command will stop all Ganeti daemons in the cluster and start
691
them again once the new certificates and keys are replicated. The
692
options ``--new-cluster-certificate`` and ``--new-confd-hmac-key``
693
can be used to regenerate the cluster-internal SSL certificate
694
respective the HMAC key used by **ganeti-confd**\(8).
695

    
696
To generate a new self-signed RAPI certificate (used by
697
**ganeti-rapi**\(8)) specify ``--new-rapi-certificate``. If you want to
698
use your own certificate, e.g. one signed by a certificate
699
authority (CA), pass its filename to ``--rapi-certificate``.
700

    
701
To generate a new self-signed SPICE certificate, used by SPICE
702
connections to the KVM hypervisor, specify the
703
``--new-spice-certificate`` option. If you want to provide a
704
certificate, pass its filename to ``--spice-certificate`` and pass the
705
signing CA certificate to ``--spice-ca-certificate``.
706

    
707
``--new-cluster-domain-secret`` generates a new, random cluster
708
domain secret. ``--cluster-domain-secret`` reads the secret from a
709
file. The cluster domain secret is used to sign information
710
exchanged between separate clusters via a third party.
711

    
712
REPAIR-DISK-SIZES
713
~~~~~~~~~~~~~~~~~
714

    
715
**repair-disk-sizes** [instance...]
716

    
717
This command checks that the recorded size of the given instance's
718
disks matches the actual size and updates any mismatches found.
719
This is needed if the Ganeti configuration is no longer consistent
720
with reality, as it will impact some disk operations. If no
721
arguments are given, all instances will be checked.
722

    
723
Note that only active disks can be checked by this command; in case
724
a disk cannot be activated it's advised to use
725
**gnt-instance activate-disks \--ignore-size ...** to force
726
activation without regard to the current size.
727

    
728
When the all disk sizes are consistent, the command will return no
729
output. Otherwise it will log details about the inconsistencies in
730
the configuration.
731

    
732
VERIFY
733
~~~~~~
734

    
735
| **verify** [\--no-nplus1-mem] [\--node-group *nodegroup*]
736
| [\--error-codes] [{-I|\--ignore-errors} *errorcode*]
737
| [{-I|\--ignore-errors} *errorcode*...]
738

    
739
Verify correctness of cluster configuration. This is safe with
740
respect to running instances, and incurs no downtime of the
741
instances.
742

    
743
If the ``--no-nplus1-mem`` option is given, Ganeti won't check
744
whether if it loses a node it can restart all the instances on
745
their secondaries (and report an error otherwise).
746

    
747
With ``--node-group``, restrict the verification to those nodes and
748
instances that live in the named group. This will not verify global
749
settings, but will allow to perform verification of a group while other
750
operations are ongoing in other groups.
751

    
752
The ``--error-codes`` option outputs each error in the following
753
parseable format: *ftype*:*ecode*:*edomain*:*name*:*msg*.
754
These fields have the following meaning:
755

    
756
ftype
757
    Failure type. Can be *WARNING* or *ERROR*.
758

    
759
ecode
760
    Error code of the failure. See below for a list of error codes.
761

    
762
edomain
763
    Can be *cluster*, *node* or *instance*.
764

    
765
name
766
    Contains the name of the item that is affected from the failure.
767

    
768
msg
769
    Contains a descriptive error message about the error
770

    
771
``gnt-cluster verify`` will have a non-zero exit code if at least one of
772
the failures that are found are of type *ERROR*.
773

    
774
The ``--ignore-errors`` option can be used to change this behaviour,
775
because it demotes the error represented by the error code received as a
776
parameter to a warning. The option must be repeated for each error that
777
should be ignored (e.g.: ``-I ENODEVERSION -I ENODEORPHANLV``). The
778
``--error-codes`` option can be used to determine the error code of a
779
given error.
780

    
781
List of error codes:
782

    
783
@CONSTANTS_ECODES@
784

    
785
VERIFY-DISKS
786
~~~~~~~~~~~~
787

    
788
**verify-disks**
789

    
790
The command checks which instances have degraded DRBD disks and
791
activates the disks of those instances.
792

    
793
This command is run from the **ganeti-watcher** tool, which also
794
has a different, complementary algorithm for doing this check.
795
Together, these two should ensure that DRBD disks are kept
796
consistent.
797

    
798
VERSION
799
~~~~~~~
800

    
801
**version**
802

    
803
Show the cluster version.
804

    
805
Tags
806
~~~~
807

    
808
ADD-TAGS
809
^^^^^^^^
810

    
811
**add-tags** [\--from *file*] {*tag*...}
812

    
813
Add tags to the cluster. If any of the tags contains invalid
814
characters, the entire operation will abort.
815

    
816
If the ``--from`` option is given, the list of tags will be
817
extended with the contents of that file (each line becomes a tag).
818
In this case, there is not need to pass tags on the command line
819
(if you do, both sources will be used). A file name of - will be
820
interpreted as stdin.
821

    
822
LIST-TAGS
823
^^^^^^^^^
824

    
825
**list-tags**
826

    
827
List the tags of the cluster.
828

    
829
REMOVE-TAGS
830
^^^^^^^^^^^
831

    
832
**remove-tags** [\--from *file*] {*tag*...}
833

    
834
Remove tags from the cluster. If any of the tags are not existing
835
on the cluster, the entire operation will abort.
836

    
837
If the ``--from`` option is given, the list of tags to be removed will
838
be extended with the contents of that file (each line becomes a tag).
839
In this case, there is not need to pass tags on the command line (if
840
you do, tags from both sources will be removed). A file name of - will
841
be interpreted as stdin.
842

    
843
SEARCH-TAGS
844
^^^^^^^^^^^
845

    
846
**search-tags** {*pattern*}
847

    
848
Searches the tags on all objects in the cluster (the cluster
849
itself, the nodes and the instances) for a given pattern. The
850
pattern is interpreted as a regular expression and a search will be
851
done on it (i.e. the given pattern is not anchored to the beggining
852
of the string; if you want that, prefix the pattern with ^).
853

    
854
If no tags are matching the pattern, the exit code of the command
855
will be one. If there is at least one match, the exit code will be
856
zero. Each match is listed on one line, the object and the tag
857
separated by a space. The cluster will be listed as /cluster, a
858
node will be listed as /nodes/*name*, and an instance as
859
/instances/*name*. Example:
860

    
861
::
862

    
863
    # gnt-cluster search-tags time
864
    /cluster ctime:2007-09-01
865
    /nodes/node1.example.com mtime:2007-10-04
866

    
867
.. vim: set textwidth=72 :
868
.. Local Variables:
869
.. mode: rst
870
.. fill-column: 72
871
.. End: