Statistics
| Branch: | Tag: | Revision:

root / man / gnt-cluster.rst @ a24aed2a

History | View | Annotate | Download (29.9 kB)

1 3cb9e1fe Iustin Pop
gnt-cluster(8) Ganeti | Version @GANETI_VERSION@
2 3cb9e1fe Iustin Pop
================================================
3 3cb9e1fe Iustin Pop
4 3cb9e1fe Iustin Pop
Name
5 3cb9e1fe Iustin Pop
----
6 3cb9e1fe Iustin Pop
7 3cb9e1fe Iustin Pop
gnt-cluster - Ganeti administration, cluster-wide
8 3cb9e1fe Iustin Pop
9 3cb9e1fe Iustin Pop
Synopsis
10 3cb9e1fe Iustin Pop
--------
11 3cb9e1fe Iustin Pop
12 3cb9e1fe Iustin Pop
**gnt-cluster** {command} [arguments...]
13 3cb9e1fe Iustin Pop
14 3cb9e1fe Iustin Pop
DESCRIPTION
15 3cb9e1fe Iustin Pop
-----------
16 3cb9e1fe Iustin Pop
17 3cb9e1fe Iustin Pop
The **gnt-cluster** is used for cluster-wide administration in the
18 3cb9e1fe Iustin Pop
Ganeti system.
19 3cb9e1fe Iustin Pop
20 3cb9e1fe Iustin Pop
COMMANDS
21 3cb9e1fe Iustin Pop
--------
22 3cb9e1fe Iustin Pop
23 fb926117 Andrea Spadaccini
ACTIVATE-MASTER-IP
24 fb926117 Andrea Spadaccini
~~~~~~~~~~~~~~~~~~
25 fb926117 Andrea Spadaccini
26 fb926117 Andrea Spadaccini
**activate-master-ip**
27 fb926117 Andrea Spadaccini
28 fb926117 Andrea Spadaccini
Activates the master IP on the master node.
29 fb926117 Andrea Spadaccini
30 3cb9e1fe Iustin Pop
ADD-TAGS
31 3cb9e1fe Iustin Pop
~~~~~~~~
32 3cb9e1fe Iustin Pop
33 3cb9e1fe Iustin Pop
**add-tags** [--from *file*] {*tag*...}
34 3cb9e1fe Iustin Pop
35 3cb9e1fe Iustin Pop
Add tags to the cluster. If any of the tags contains invalid
36 3cb9e1fe Iustin Pop
characters, the entire operation will abort.
37 3cb9e1fe Iustin Pop
38 3cb9e1fe Iustin Pop
If the ``--from`` option is given, the list of tags will be
39 3cb9e1fe Iustin Pop
extended with the contents of that file (each line becomes a tag).
40 3cb9e1fe Iustin Pop
In this case, there is not need to pass tags on the command line
41 3cb9e1fe Iustin Pop
(if you do, both sources will be used). A file name of - will be
42 3cb9e1fe Iustin Pop
interpreted as stdin.
43 3cb9e1fe Iustin Pop
44 3cb9e1fe Iustin Pop
COMMAND
45 3cb9e1fe Iustin Pop
~~~~~~~
46 3cb9e1fe Iustin Pop
47 a24aed2a Michael Hanselmann
**command** [-n *node*] [-g *group*] [-M] {*command*}
48 3cb9e1fe Iustin Pop
49 3cb9e1fe Iustin Pop
Executes a command on all nodes. If the option ``-n`` is not given,
50 3cb9e1fe Iustin Pop
the command will be executed on all nodes, otherwise it will be
51 3cb9e1fe Iustin Pop
executed only on the node(s) specified. Use the option multiple
52 3cb9e1fe Iustin Pop
times for running it on multiple nodes, like::
53 3cb9e1fe Iustin Pop
54 3cb9e1fe Iustin Pop
    # gnt-cluster command -n node1.example.com -n node2.example.com date
55 3cb9e1fe Iustin Pop
56 b6e88032 Michael Hanselmann
The ``-g`` option can be used to run a command only on a specific node
57 b6e88032 Michael Hanselmann
group, e.g.::
58 b6e88032 Michael Hanselmann
59 b6e88032 Michael Hanselmann
    # gnt-cluster command -g default date
60 b6e88032 Michael Hanselmann
61 a24aed2a Michael Hanselmann
The ``-M`` option can be used to prepend the node name to all output
62 a24aed2a Michael Hanselmann
lines.
63 a24aed2a Michael Hanselmann
64 3cb9e1fe Iustin Pop
The command is executed serially on the selected nodes. If the
65 3cb9e1fe Iustin Pop
master node is present in the list, the command will be executed
66 3cb9e1fe Iustin Pop
last on the master. Regarding the other nodes, the execution order
67 3cb9e1fe Iustin Pop
is somewhat alphabetic, so that node2.example.com will be earlier
68 3cb9e1fe Iustin Pop
than node10.example.com but after node1.example.com.
69 3cb9e1fe Iustin Pop
70 3cb9e1fe Iustin Pop
So given the node names node1, node2, node3, node10, node11, with
71 3cb9e1fe Iustin Pop
node3 being the master, the order will be: node1, node2, node10,
72 3cb9e1fe Iustin Pop
node11, node3.
73 3cb9e1fe Iustin Pop
74 3cb9e1fe Iustin Pop
The command is constructed by concatenating all other command line
75 3cb9e1fe Iustin Pop
arguments. For example, to list the contents of the /etc directory
76 3cb9e1fe Iustin Pop
on all nodes, run::
77 3cb9e1fe Iustin Pop
78 3cb9e1fe Iustin Pop
    # gnt-cluster command ls -l /etc
79 3cb9e1fe Iustin Pop
80 3cb9e1fe Iustin Pop
and the command which will be executed will be ``ls -l /etc``.
81 3cb9e1fe Iustin Pop
82 3cb9e1fe Iustin Pop
COPYFILE
83 3cb9e1fe Iustin Pop
~~~~~~~~
84 3cb9e1fe Iustin Pop
85 b6e88032 Michael Hanselmann
| **copyfile** [--use-replication-network] [-n *node*] [-g *group*]
86 b6e88032 Michael Hanselmann
| {*file*}
87 3cb9e1fe Iustin Pop
88 3cb9e1fe Iustin Pop
Copies a file to all or to some nodes. The argument specifies the
89 3cb9e1fe Iustin Pop
source file (on the current system), the ``-n`` argument specifies
90 3cb9e1fe Iustin Pop
the target node, or nodes if the option is given multiple times. If
91 b6e88032 Michael Hanselmann
``-n`` is not given at all, the file will be copied to all nodes. The
92 b6e88032 Michael Hanselmann
``-g`` option can be used to only select nodes in a specific node group.
93 3cb9e1fe Iustin Pop
Passing the ``--use-replication-network`` option will cause the
94 3cb9e1fe Iustin Pop
copy to be done over the replication network (only matters if the
95 3cb9e1fe Iustin Pop
primary/secondary IPs are different). Example::
96 3cb9e1fe Iustin Pop
97 3cb9e1fe Iustin Pop
    # gnt-cluster -n node1.example.com -n node2.example.com copyfile /tmp/test
98 3cb9e1fe Iustin Pop
99 3cb9e1fe Iustin Pop
This will copy the file /tmp/test from the current node to the two
100 3cb9e1fe Iustin Pop
named nodes.
101 3cb9e1fe Iustin Pop
102 fb926117 Andrea Spadaccini
DEACTIVATE-MASTER-IP
103 fb926117 Andrea Spadaccini
~~~~~~~~~~~~~~~~~~~~
104 fb926117 Andrea Spadaccini
105 fb926117 Andrea Spadaccini
**deactivate-master-ip** [--yes]
106 fb926117 Andrea Spadaccini
107 fb926117 Andrea Spadaccini
Deactivates the master IP on the master node.
108 fb926117 Andrea Spadaccini
109 fb926117 Andrea Spadaccini
This should be run only locally or on a connection to the node ip
110 fb926117 Andrea Spadaccini
directly, as a connection to the master ip will be broken by this
111 fb926117 Andrea Spadaccini
operation. Because of this risk it will require user confirmation
112 fb926117 Andrea Spadaccini
unless the ``--yes`` option is passed.
113 fb926117 Andrea Spadaccini
114 3cb9e1fe Iustin Pop
DESTROY
115 3cb9e1fe Iustin Pop
~~~~~~~
116 3cb9e1fe Iustin Pop
117 3cb9e1fe Iustin Pop
**destroy** {--yes-do-it}
118 3cb9e1fe Iustin Pop
119 3cb9e1fe Iustin Pop
Remove all configuration files related to the cluster, so that a
120 3cb9e1fe Iustin Pop
**gnt-cluster init** can be done again afterwards.
121 3cb9e1fe Iustin Pop
122 3cb9e1fe Iustin Pop
Since this is a dangerous command, you are required to pass the
123 3cb9e1fe Iustin Pop
argument *--yes-do-it.*
124 3cb9e1fe Iustin Pop
125 66d1f035 Renรฉ Nussbaumer
EPO
126 66d1f035 Renรฉ Nussbaumer
~~~
127 66d1f035 Renรฉ Nussbaumer
128 cfed3b9f Renรฉ Nussbaumer
**epo** [--on] [--groups|--all] [--power-delay] *arguments*
129 cfed3b9f Renรฉ Nussbaumer
130 cfed3b9f Renรฉ Nussbaumer
Performs an emergency power-off on nodes given as arguments. If
131 cfed3b9f Renรฉ Nussbaumer
``--groups`` is given, arguments are node groups. If ``--all`` is
132 cfed3b9f Renรฉ Nussbaumer
provided, the whole cluster will be shut down.
133 cfed3b9f Renรฉ Nussbaumer
134 cfed3b9f Renรฉ Nussbaumer
The ``--on`` flag recovers the cluster after an emergency power-off.
135 cfed3b9f Renรฉ Nussbaumer
When powering on the cluster you can use ``--power-delay`` to define the
136 cfed3b9f Renรฉ Nussbaumer
time in seconds (fractions allowed) waited between powering on
137 cfed3b9f Renรฉ Nussbaumer
individual nodes.
138 cfed3b9f Renรฉ Nussbaumer
139 cfed3b9f Renรฉ Nussbaumer
Please note that the master node will not be turned down or up
140 cfed3b9f Renรฉ Nussbaumer
automatically.  It will just be left in a state, where you can manully
141 cfed3b9f Renรฉ Nussbaumer
perform the shutdown of that one node. If the master is in the list of
142 cfed3b9f Renรฉ Nussbaumer
affected nodes and this is not a complete cluster emergency power-off
143 cfed3b9f Renรฉ Nussbaumer
(e.g. using ``--all``), you're required to do a master failover to
144 cfed3b9f Renรฉ Nussbaumer
another node not affected.
145 66d1f035 Renรฉ Nussbaumer
146 3cb9e1fe Iustin Pop
GETMASTER
147 3cb9e1fe Iustin Pop
~~~~~~~~~
148 3cb9e1fe Iustin Pop
149 3cb9e1fe Iustin Pop
**getmaster**
150 3cb9e1fe Iustin Pop
151 3cb9e1fe Iustin Pop
Displays the current master node.
152 3cb9e1fe Iustin Pop
153 3cb9e1fe Iustin Pop
INFO
154 3cb9e1fe Iustin Pop
~~~~
155 3cb9e1fe Iustin Pop
156 3cb9e1fe Iustin Pop
**info** [--roman]
157 3cb9e1fe Iustin Pop
158 3cb9e1fe Iustin Pop
Shows runtime cluster information: cluster name, architecture (32
159 3cb9e1fe Iustin Pop
or 64 bit), master node, node list and instance list.
160 3cb9e1fe Iustin Pop
161 3cb9e1fe Iustin Pop
Passing the ``--roman`` option gnt-cluster info will try to print
162 3cb9e1fe Iustin Pop
its integer fields in a latin friendly way. This allows further
163 3cb9e1fe Iustin Pop
diffusion of Ganeti among ancient cultures.
164 3cb9e1fe Iustin Pop
165 3cb9e1fe Iustin Pop
INIT
166 3cb9e1fe Iustin Pop
~~~~
167 3cb9e1fe Iustin Pop
168 3cb9e1fe Iustin Pop
| **init**
169 0a68e0ff Iustin Pop
| [{-s|--secondary-ip} *secondary\_ip*]
170 3cb9e1fe Iustin Pop
| [--vg-name *vg-name*]
171 3cb9e1fe Iustin Pop
| [--master-netdev *interface-name*]
172 5a8648eb Andrea Spadaccini
| [--master-netmask *netmask*]
173 bf689b7a Andrea Spadaccini
| [--use-external-mip-script {yes \| no}]
174 0a68e0ff Iustin Pop
| [{-m|--mac-prefix} *mac-prefix*]
175 3cb9e1fe Iustin Pop
| [--no-lvm-storage]
176 3cb9e1fe Iustin Pop
| [--no-etc-hosts]
177 3cb9e1fe Iustin Pop
| [--no-ssh-init]
178 3cb9e1fe Iustin Pop
| [--file-storage-dir *dir*]
179 3cb9e1fe Iustin Pop
| [--enabled-hypervisors *hypervisors*]
180 0a68e0ff Iustin Pop
| [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
181 9475189d Andrea Spadaccini
| [{-B|--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
182 9475189d Andrea Spadaccini
| [{-N|--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
183 9475189d Andrea Spadaccini
| [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
184 3cb9e1fe Iustin Pop
| [--maintain-node-health {yes \| no}]
185 3cb9e1fe Iustin Pop
| [--uid-pool *user-id pool definition*]
186 0a68e0ff Iustin Pop
| [{-I|--default-iallocator} *default instance allocator*]
187 3cb9e1fe Iustin Pop
| [--primary-ip-version *version*]
188 3cb9e1fe Iustin Pop
| [--prealloc-wipe-disks {yes \| no}]
189 6204ee71 Renรฉ Nussbaumer
| [--node-parameters *ndparams*]
190 0a68e0ff Iustin Pop
| [{-C|--candidate-pool-size} *candidate\_pool\_size*]
191 e37c5129 Agata Murawska
| [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
192 e37c5129 Agata Murawska
| [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
193 e37c5129 Agata Murawska
| [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
194 e37c5129 Agata Murawska
| [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
195 e37c5129 Agata Murawska
| [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
196 0ce212e5 Iustin Pop
| [--specs-disk-templates *template* [,*template*...]]
197 c4929a8b Renรฉ Nussbaumer
| [--disk-state *diskstate*]
198 c4929a8b Renรฉ Nussbaumer
| [--hypervisor-state *hvstate*]
199 3cb9e1fe Iustin Pop
| {*clustername*}
200 3cb9e1fe Iustin Pop
201 3cb9e1fe Iustin Pop
This commands is only run once initially on the first node of the
202 3cb9e1fe Iustin Pop
cluster. It will initialize the cluster configuration, setup the
203 3cb9e1fe Iustin Pop
ssh-keys, start the daemons on the master node, etc. in order to have
204 3cb9e1fe Iustin Pop
a working one-node cluster.
205 3cb9e1fe Iustin Pop
206 3cb9e1fe Iustin Pop
Note that the *clustername* is not any random name. It has to be
207 3cb9e1fe Iustin Pop
resolvable to an IP address using DNS, and it is best if you give the
208 3cb9e1fe Iustin Pop
fully-qualified domain name. This hostname must resolve to an IP
209 3cb9e1fe Iustin Pop
address reserved exclusively for this purpose, i.e. not already in
210 3cb9e1fe Iustin Pop
use.
211 3cb9e1fe Iustin Pop
212 3cb9e1fe Iustin Pop
The cluster can run in two modes: single-home or dual-homed. In the
213 0a68e0ff Iustin Pop
first case, all traffic (both public traffic, inter-node traffic and
214 0a68e0ff Iustin Pop
data replication traffic) goes over the same interface. In the
215 3cb9e1fe Iustin Pop
dual-homed case, the data replication traffic goes over the second
216 0a68e0ff Iustin Pop
network. The ``-s (--secondary-ip)`` option here marks the cluster as
217 0a68e0ff Iustin Pop
dual-homed and its parameter represents this node's address on the
218 0a68e0ff Iustin Pop
second network.  If you initialise the cluster with ``-s``, all nodes
219 0a68e0ff Iustin Pop
added must have a secondary IP as well.
220 3cb9e1fe Iustin Pop
221 3cb9e1fe Iustin Pop
Note that for Ganeti it doesn't matter if the secondary network is
222 3cb9e1fe Iustin Pop
actually a separate physical network, or is done using tunneling,
223 3cb9e1fe Iustin Pop
etc. For performance reasons, it's recommended to use a separate
224 3cb9e1fe Iustin Pop
network, of course.
225 3cb9e1fe Iustin Pop
226 3cb9e1fe Iustin Pop
The ``--vg-name`` option will let you specify a volume group
227 3cb9e1fe Iustin Pop
different than "xenvg" for Ganeti to use when creating instance
228 3cb9e1fe Iustin Pop
disks. This volume group must have the same name on all nodes. Once
229 3cb9e1fe Iustin Pop
the cluster is initialized this can be altered by using the
230 3cb9e1fe Iustin Pop
**modify** command. If you don't want to use lvm storage at all use
231 3cb9e1fe Iustin Pop
the ``--no-lvm-storage`` option. Once the cluster is initialized
232 3cb9e1fe Iustin Pop
you can change this setup with the **modify** command.
233 3cb9e1fe Iustin Pop
234 3cb9e1fe Iustin Pop
The ``--master-netdev`` option is useful for specifying a different
235 3cb9e1fe Iustin Pop
interface on which the master will activate its IP address. It's
236 3cb9e1fe Iustin Pop
important that all nodes have this interface because you'll need it
237 3cb9e1fe Iustin Pop
for a master failover.
238 3cb9e1fe Iustin Pop
239 5a8648eb Andrea Spadaccini
The ``--master-netmask`` option allows to specify a netmask for the
240 5a8648eb Andrea Spadaccini
master IP. The netmask must be specified as an integer, and will be
241 5a8648eb Andrea Spadaccini
interpreted as a CIDR netmask. The default value is 32 for an IPv4
242 5a8648eb Andrea Spadaccini
address and 128 for an IPv6 address.
243 5a8648eb Andrea Spadaccini
244 bf689b7a Andrea Spadaccini
The ``--use-external-mip-script`` options allows to specify
245 bf689b7a Andrea Spadaccini
whether to use an user-supplied master IP address setup script, whose
246 bf689b7a Andrea Spadaccini
location is ``/etc/ganeti/scripts/master-ip-setup``. If the option value
247 bf689b7a Andrea Spadaccini
is set to False, the default script, whose location is
248 bf689b7a Andrea Spadaccini
``/usr/local/lib/ganeti/tools/master-ip-setup``, will be executed.
249 bf689b7a Andrea Spadaccini
250 0a68e0ff Iustin Pop
The ``-m (--mac-prefix)`` option will let you specify a three byte
251 0a68e0ff Iustin Pop
prefix under which the virtual MAC addresses of your instances will be
252 0a68e0ff Iustin Pop
generated. The prefix must be specified in the format ``XX:XX:XX`` and
253 0a68e0ff Iustin Pop
the default is ``aa:00:00``.
254 3cb9e1fe Iustin Pop
255 3cb9e1fe Iustin Pop
The ``--no-lvm-storage`` option allows you to initialize the
256 3cb9e1fe Iustin Pop
cluster without lvm support. This means that only instances using
257 3cb9e1fe Iustin Pop
files as storage backend will be possible to create. Once the
258 3cb9e1fe Iustin Pop
cluster is initialized you can change this setup with the
259 3cb9e1fe Iustin Pop
**modify** command.
260 3cb9e1fe Iustin Pop
261 3cb9e1fe Iustin Pop
The ``--no-etc-hosts`` option allows you to initialize the cluster
262 3cb9e1fe Iustin Pop
without modifying the /etc/hosts file.
263 3cb9e1fe Iustin Pop
264 3cb9e1fe Iustin Pop
The ``--no-ssh-init`` option allows you to initialize the cluster
265 3cb9e1fe Iustin Pop
without creating or distributing SSH key pairs.
266 3cb9e1fe Iustin Pop
267 3cb9e1fe Iustin Pop
The ``--file-storage-dir`` option allows you set the directory to
268 3cb9e1fe Iustin Pop
use for storing the instance disk files when using file storage as
269 3cb9e1fe Iustin Pop
backend for instance disks.
270 3cb9e1fe Iustin Pop
271 3cb9e1fe Iustin Pop
The ``--prealloc-wipe-disks`` sets a cluster wide configuration
272 3cb9e1fe Iustin Pop
value for wiping disks prior to allocation. This increases security
273 3cb9e1fe Iustin Pop
on instance level as the instance can't access untouched data from
274 3cb9e1fe Iustin Pop
it's underlying storage.
275 3cb9e1fe Iustin Pop
276 3cb9e1fe Iustin Pop
The ``--enabled-hypervisors`` option allows you to set the list of
277 3cb9e1fe Iustin Pop
hypervisors that will be enabled for this cluster. Instance
278 3cb9e1fe Iustin Pop
hypervisors can only be chosen from the list of enabled
279 3cb9e1fe Iustin Pop
hypervisors, and the first entry of this list will be used by
280 3cb9e1fe Iustin Pop
default. Currently, the following hypervisors are available:
281 3cb9e1fe Iustin Pop
282 3cb9e1fe Iustin Pop
xen-pvm
283 3cb9e1fe Iustin Pop
    Xen PVM hypervisor
284 3cb9e1fe Iustin Pop
285 3cb9e1fe Iustin Pop
xen-hvm
286 3cb9e1fe Iustin Pop
    Xen HVM hypervisor
287 3cb9e1fe Iustin Pop
288 3cb9e1fe Iustin Pop
kvm
289 3cb9e1fe Iustin Pop
    Linux KVM hypervisor
290 3cb9e1fe Iustin Pop
291 3cb9e1fe Iustin Pop
chroot
292 3cb9e1fe Iustin Pop
    a simple chroot manager that starts chroot based on a script at the
293 3cb9e1fe Iustin Pop
    root of the filesystem holding the chroot
294 3cb9e1fe Iustin Pop
295 3cb9e1fe Iustin Pop
fake
296 3cb9e1fe Iustin Pop
    fake hypervisor for development/testing
297 3cb9e1fe Iustin Pop
298 3cb9e1fe Iustin Pop
Either a single hypervisor name or a comma-separated list of
299 3cb9e1fe Iustin Pop
hypervisor names can be specified. If this option is not specified,
300 3cb9e1fe Iustin Pop
only the xen-pvm hypervisor is enabled by default.
301 3cb9e1fe Iustin Pop
302 0a68e0ff Iustin Pop
The ``-H (--hypervisor-parameters)`` option allows you to set default
303 3cb9e1fe Iustin Pop
hypervisor specific parameters for the cluster. The format of this
304 3cb9e1fe Iustin Pop
option is the name of the hypervisor, followed by a colon and a
305 0a68e0ff Iustin Pop
comma-separated list of key=value pairs. The keys available for each
306 0a68e0ff Iustin Pop
hypervisors are detailed in the gnt-instance(8) man page, in the
307 0a68e0ff Iustin Pop
**add** command plus the following parameters which are only
308 3cb9e1fe Iustin Pop
configurable globally (at cluster level):
309 3cb9e1fe Iustin Pop
310 3cb9e1fe Iustin Pop
migration\_port
311 3cb9e1fe Iustin Pop
    Valid for the Xen PVM and KVM hypervisors.
312 3cb9e1fe Iustin Pop
313 3cb9e1fe Iustin Pop
    This options specifies the TCP port to use for live-migration. For
314 3cb9e1fe Iustin Pop
    Xen, the same port should be configured on all nodes in the
315 3cb9e1fe Iustin Pop
    ``/etc/xen/xend-config.sxp`` file, under the key
316 3cb9e1fe Iustin Pop
    "xend-relocation-port".
317 3cb9e1fe Iustin Pop
318 3cb9e1fe Iustin Pop
migration\_bandwidth
319 3cb9e1fe Iustin Pop
    Valid for the KVM hypervisor.
320 3cb9e1fe Iustin Pop
321 3cb9e1fe Iustin Pop
    This option specifies the maximum bandwidth that KVM will use for
322 3cb9e1fe Iustin Pop
    instance live migrations. The value is in MiB/s.
323 3cb9e1fe Iustin Pop
324 3cb9e1fe Iustin Pop
    This option is only effective with kvm versions >= 78 and qemu-kvm
325 3cb9e1fe Iustin Pop
    versions >= 0.10.0.
326 3cb9e1fe Iustin Pop
327 0a68e0ff Iustin Pop
The ``-B (--backend-parameters)`` option allows you to set the default
328 3cb9e1fe Iustin Pop
backend parameters for the cluster. The parameter format is a
329 0a68e0ff Iustin Pop
comma-separated list of key=value pairs with the following supported
330 0a68e0ff Iustin Pop
keys:
331 3cb9e1fe Iustin Pop
332 3cb9e1fe Iustin Pop
vcpus
333 3cb9e1fe Iustin Pop
    Number of VCPUs to set for an instance by default, must be an
334 3cb9e1fe Iustin Pop
    integer, will be set to 1 if no specified.
335 3cb9e1fe Iustin Pop
336 90bb3fe1 Guido Trotter
maxmem
337 90bb3fe1 Guido Trotter
    Maximum amount of memory to allocate for an instance by default, can
338 90bb3fe1 Guido Trotter
    be either an integer or an integer followed by a unit (M for
339 90bb3fe1 Guido Trotter
    mebibytes and G for gibibytes are supported), will be set to 128M if
340 90bb3fe1 Guido Trotter
    not specified.
341 90bb3fe1 Guido Trotter
342 90bb3fe1 Guido Trotter
minmem
343 90bb3fe1 Guido Trotter
    Minimum amount of memory to allocate for an instance by default, can
344 90bb3fe1 Guido Trotter
    be either an integer or an integer followed by a unit (M for
345 90bb3fe1 Guido Trotter
    mebibytes and G for gibibytes are supported), will be set to 128M if
346 90bb3fe1 Guido Trotter
    not specified.
347 3cb9e1fe Iustin Pop
348 3cb9e1fe Iustin Pop
auto\_balance
349 3cb9e1fe Iustin Pop
    Value of the auto\_balance flag for instances to use by default,
350 3cb9e1fe Iustin Pop
    will be set to true if not specified.
351 3cb9e1fe Iustin Pop
352 11dc66f3 Bernardo Dal Seno
always\_failover
353 11dc66f3 Bernardo Dal Seno
    Default value for the ``always\_failover`` flag for instances; if
354 11dc66f3 Bernardo Dal Seno
    not set, ``False`` is used.
355 11dc66f3 Bernardo Dal Seno
356 3cb9e1fe Iustin Pop
357 0a68e0ff Iustin Pop
The ``-N (--nic-parameters)`` option allows you to set the default nic
358 0a68e0ff Iustin Pop
parameters for the cluster. The parameter format is a comma-separated
359 0a68e0ff Iustin Pop
list of key=value pairs with the following supported keys:
360 3cb9e1fe Iustin Pop
361 3cb9e1fe Iustin Pop
mode
362 3cb9e1fe Iustin Pop
    The default nic mode, 'routed' or 'bridged'.
363 3cb9e1fe Iustin Pop
364 3cb9e1fe Iustin Pop
link
365 3cb9e1fe Iustin Pop
    In bridged mode the default NIC bridge. In routed mode it
366 3cb9e1fe Iustin Pop
    represents an hypervisor-vif-script dependent value to allow
367 3cb9e1fe Iustin Pop
    different instance groups. For example under the KVM default
368 3cb9e1fe Iustin Pop
    network script it is interpreted as a routing table number or
369 3cb9e1fe Iustin Pop
    name.
370 3cb9e1fe Iustin Pop
371 a46b1883 Andrea Spadaccini
The ``-D (--disk-parameters)`` option allows you to set the default disk
372 a46b1883 Andrea Spadaccini
template parameters at cluster level. The format used for this option is
373 a46b1883 Andrea Spadaccini
similar to the one use by the  ``-H`` option: the disk template name
374 a46b1883 Andrea Spadaccini
must be specified first, followed by a colon and by a comma-separated
375 a46b1883 Andrea Spadaccini
list of key-value pairs. These parameters can only be specified at
376 a46b1883 Andrea Spadaccini
cluster and node group level; the cluster-level parameter are inherited
377 a46b1883 Andrea Spadaccini
by the node group at the moment of its creation, and can be further
378 0ce212e5 Iustin Pop
modified at node group level using the **gnt-group**(8) command.
379 a46b1883 Andrea Spadaccini
380 9475189d Andrea Spadaccini
The following is the list of disk parameters available for the **drbd**
381 9475189d Andrea Spadaccini
template, with measurement units specified in square brackets at the end
382 9475189d Andrea Spadaccini
of the description (when applicable):
383 a46b1883 Andrea Spadaccini
384 a46b1883 Andrea Spadaccini
resync-rate
385 9475189d Andrea Spadaccini
    Static re-synchronization rate. [KiB/s]
386 a46b1883 Andrea Spadaccini
387 a46b1883 Andrea Spadaccini
data-stripes
388 9475189d Andrea Spadaccini
    Number of stripes to use for data LVs.
389 a46b1883 Andrea Spadaccini
390 a46b1883 Andrea Spadaccini
meta-stripes
391 9475189d Andrea Spadaccini
    Number of stripes to use for meta LVs.
392 a46b1883 Andrea Spadaccini
393 a46b1883 Andrea Spadaccini
disk-barriers
394 a46b1883 Andrea Spadaccini
    What kind of barriers to **disable** for disks. It can either assume
395 a46b1883 Andrea Spadaccini
    the value "n", meaning no barrier disabled, or a non-empty string
396 a46b1883 Andrea Spadaccini
    containing a subset of the characters "bfd". "b" means disable disk
397 9475189d Andrea Spadaccini
    barriers, "f" means disable disk flushes, "d" disables disk drains.
398 a46b1883 Andrea Spadaccini
399 a46b1883 Andrea Spadaccini
meta-barriers
400 a46b1883 Andrea Spadaccini
    Boolean value indicating whether the meta barriers should be
401 a46b1883 Andrea Spadaccini
    disabled (True) or not (False).
402 a46b1883 Andrea Spadaccini
403 a46b1883 Andrea Spadaccini
metavg
404 a46b1883 Andrea Spadaccini
    String containing the name of the default LVM volume group for DRBD
405 a46b1883 Andrea Spadaccini
    metadata. By default, it is set to ``xenvg``. It can be overridden
406 a46b1883 Andrea Spadaccini
    during the instance creation process by using the ``metavg`` key of
407 a46b1883 Andrea Spadaccini
    the ``--disk`` parameter.
408 a46b1883 Andrea Spadaccini
409 a46b1883 Andrea Spadaccini
disk-custom
410 a46b1883 Andrea Spadaccini
    String containing additional parameters to be appended to the
411 a46b1883 Andrea Spadaccini
    arguments list of ``drbdsetup disk``.
412 a46b1883 Andrea Spadaccini
413 a46b1883 Andrea Spadaccini
net-custom
414 a46b1883 Andrea Spadaccini
    String containing additional parameters to be appended to the
415 a46b1883 Andrea Spadaccini
    arguments list of ``drbdsetup net``.
416 a46b1883 Andrea Spadaccini
417 9475189d Andrea Spadaccini
dynamic-resync
418 9475189d Andrea Spadaccini
    Boolean indicating whether to use the dynamic resync speed
419 9475189d Andrea Spadaccini
    controller or not. If enabled, c-plan-ahead must be non-zero and all
420 9475189d Andrea Spadaccini
    the c-* parameters will be used by DRBD. Otherwise, the value of
421 9475189d Andrea Spadaccini
    resync-rate will be used as a static resync speed.
422 9475189d Andrea Spadaccini
423 9475189d Andrea Spadaccini
c-plan-ahead
424 9475189d Andrea Spadaccini
    Agility factor of the dynamic resync speed controller. (the higher,
425 9475189d Andrea Spadaccini
    the slower the algorithm will adapt the resync speed). A value of 0
426 9475189d Andrea Spadaccini
    (that is the default) disables the controller. [ds]
427 9475189d Andrea Spadaccini
428 9475189d Andrea Spadaccini
c-fill-target
429 9475189d Andrea Spadaccini
    Maximum amount of in-flight resync data for the dynamic resync speed
430 9475189d Andrea Spadaccini
    controller. [sectors]
431 9475189d Andrea Spadaccini
432 9475189d Andrea Spadaccini
c-delay-target
433 9475189d Andrea Spadaccini
    Maximum estimated peer response latency for the dynamic resync speed
434 9475189d Andrea Spadaccini
    controller. [ds]
435 9475189d Andrea Spadaccini
436 9475189d Andrea Spadaccini
c-min-rate
437 9475189d Andrea Spadaccini
    Minimum resync speed for the dynamic resync speed controller. [KiB/s]
438 9475189d Andrea Spadaccini
439 9475189d Andrea Spadaccini
c-max-rate
440 9475189d Andrea Spadaccini
    Upper bound on resync speed for the dynamic resync speed controller.
441 9475189d Andrea Spadaccini
    [KiB/s]
442 9475189d Andrea Spadaccini
443 a46b1883 Andrea Spadaccini
List of parameters available for the **plain** template:
444 a46b1883 Andrea Spadaccini
445 a46b1883 Andrea Spadaccini
stripes
446 9475189d Andrea Spadaccini
    Number of stripes to use for new LVs.
447 a46b1883 Andrea Spadaccini
448 f7b769b1 Iustin Pop
The option ``--maintain-node-health`` allows one to enable/disable
449 3cb9e1fe Iustin Pop
automatic maintenance actions on nodes. Currently these include
450 3cb9e1fe Iustin Pop
automatic shutdown of instances and deactivation of DRBD devices on
451 3cb9e1fe Iustin Pop
offline nodes; in the future it might be extended to automatic
452 d29036c1 Iustin Pop
removal of unknown LVM volumes, etc. Note that this option is only
453 d29036c1 Iustin Pop
useful if the use of ``ganeti-confd`` was enabled at compilation.
454 3cb9e1fe Iustin Pop
455 3cb9e1fe Iustin Pop
The ``--uid-pool`` option initializes the user-id pool. The
456 3cb9e1fe Iustin Pop
*user-id pool definition* can contain a list of user-ids and/or a
457 3cb9e1fe Iustin Pop
list of user-id ranges. The parameter format is a comma-separated
458 3cb9e1fe Iustin Pop
list of numeric user-ids or user-id ranges. The ranges are defined
459 3cb9e1fe Iustin Pop
by a lower and higher boundary, separated by a dash. The boundaries
460 3cb9e1fe Iustin Pop
are inclusive. If the ``--uid-pool`` option is not supplied, the
461 3cb9e1fe Iustin Pop
user-id pool is initialized to an empty list. An empty list means
462 3cb9e1fe Iustin Pop
that the user-id pool feature is disabled.
463 3cb9e1fe Iustin Pop
464 3cb9e1fe Iustin Pop
The ``-I (--default-iallocator)`` option specifies the default
465 d1e9c98d Iustin Pop
instance allocator. The instance allocator will be used for operations
466 d1e9c98d Iustin Pop
like instance creation, instance and node migration, etc. when no
467 d1e9c98d Iustin Pop
manual override is specified. If this option is not specified and
468 d1e9c98d Iustin Pop
htools was not enabled at build time, the default instance allocator
469 d1e9c98d Iustin Pop
will be blank, which means that relevant operations will require the
470 d1e9c98d Iustin Pop
administrator to manually specify either an instance allocator, or a
471 d1e9c98d Iustin Pop
set of nodes. If the option is not specified but htools was enabled,
472 d1e9c98d Iustin Pop
the default iallocator will be **hail**(1) (assuming it can be found
473 d1e9c98d Iustin Pop
on disk). The default iallocator can be changed later using the
474 d1e9c98d Iustin Pop
**modify** command.
475 3cb9e1fe Iustin Pop
476 3cb9e1fe Iustin Pop
The ``--primary-ip-version`` option specifies the IP version used
477 3cb9e1fe Iustin Pop
for the primary address. Possible values are 4 and 6 for IPv4 and
478 3cb9e1fe Iustin Pop
IPv6, respectively. This option is used when resolving node names
479 3cb9e1fe Iustin Pop
and the cluster name.
480 3cb9e1fe Iustin Pop
481 6204ee71 Renรฉ Nussbaumer
The ``--node-parameters`` option allows you to set default node
482 6204ee71 Renรฉ Nussbaumer
parameters for the cluster. Please see **ganeti**(7) for more
483 6204ee71 Renรฉ Nussbaumer
information about supported key=value pairs.
484 6204ee71 Renรฉ Nussbaumer
485 0a68e0ff Iustin Pop
The ``-C (--candidate-pool-size)`` option specifies the
486 0a68e0ff Iustin Pop
``candidate_pool_size`` cluster parameter. This is the number of nodes
487 0a68e0ff Iustin Pop
that the master will try to keep as master\_candidates. For more
488 0a68e0ff Iustin Pop
details about this role and other node roles, see the ganeti(7).
489 0a68e0ff Iustin Pop
490 0ce212e5 Iustin Pop
The ``--specs-...`` options specify instance policy on the
491 0ce212e5 Iustin Pop
cluster. Except for the ``disk-templates`` option, each option can have
492 0ce212e5 Iustin Pop
three values: ``min``, ``max`` and ``std``, which can also be modified
493 0ce212e5 Iustin Pop
on group level (except for ``std``, which is defined once for the entire
494 0ce212e5 Iustin Pop
cluster). Please note, that ``std`` values are not the same as defaults
495 0ce212e5 Iustin Pop
set by ``--beparams``, but they are used for the capacity calculations.
496 0ce212e5 Iustin Pop
497 0ce212e5 Iustin Pop
- ``--specs-cpu-count`` limits the number of VCPUs that can be used by an
498 0ce212e5 Iustin Pop
  instance.
499 0ce212e5 Iustin Pop
- ``--specs-disk-count`` limits the number of disks
500 0ce212e5 Iustin Pop
- ``--specs-disk-size`` limits the disk size for every disk used
501 0ce212e5 Iustin Pop
- ``--specs-mem-size`` limits the amount of memory available
502 0ce212e5 Iustin Pop
- ``--specs-nic-count`` sets limits on the number of NICs used
503 0ce212e5 Iustin Pop
- ``--specs-disk-templates`` limits the allowed disk templates (no
504 0ce212e5 Iustin Pop
  mix/std/max for this option)
505 e37c5129 Agata Murawska
506 c4929a8b Renรฉ Nussbaumer
For details about how to use ``--hypervisor-state`` and ``--disk-state``
507 c4929a8b Renรฉ Nussbaumer
have a look at **ganeti**(7).
508 c4929a8b Renรฉ Nussbaumer
509 3cb9e1fe Iustin Pop
LIST-TAGS
510 3cb9e1fe Iustin Pop
~~~~~~~~~
511 3cb9e1fe Iustin Pop
512 3cb9e1fe Iustin Pop
**list-tags**
513 3cb9e1fe Iustin Pop
514 3cb9e1fe Iustin Pop
List the tags of the cluster.
515 3cb9e1fe Iustin Pop
516 3cb9e1fe Iustin Pop
MASTER-FAILOVER
517 3cb9e1fe Iustin Pop
~~~~~~~~~~~~~~~
518 3cb9e1fe Iustin Pop
519 3cb9e1fe Iustin Pop
**master-failover** [--no-voting]
520 3cb9e1fe Iustin Pop
521 3cb9e1fe Iustin Pop
Failover the master role to the current node.
522 3cb9e1fe Iustin Pop
523 3cb9e1fe Iustin Pop
The ``--no-voting`` option skips the remote node agreement checks.
524 3cb9e1fe Iustin Pop
This is dangerous, but necessary in some cases (for example failing
525 3cb9e1fe Iustin Pop
over the master role in a 2 node cluster with the original master
526 3cb9e1fe Iustin Pop
down). If the original master then comes up, it won't be able to
527 3cb9e1fe Iustin Pop
start its master daemon because it won't have enough votes, but so
528 3cb9e1fe Iustin Pop
won't the new master, if the master daemon ever needs a restart.
529 3cb9e1fe Iustin Pop
You can pass ``--no-voting`` to **ganeti-masterd** on the new
530 3cb9e1fe Iustin Pop
master to solve this problem, and run **gnt-cluster redist-conf**
531 3cb9e1fe Iustin Pop
to make sure the cluster is consistent again.
532 3cb9e1fe Iustin Pop
533 3cb9e1fe Iustin Pop
MASTER-PING
534 3cb9e1fe Iustin Pop
~~~~~~~~~~~
535 3cb9e1fe Iustin Pop
536 3cb9e1fe Iustin Pop
**master-ping**
537 3cb9e1fe Iustin Pop
538 3cb9e1fe Iustin Pop
Checks if the master daemon is alive.
539 3cb9e1fe Iustin Pop
540 3cb9e1fe Iustin Pop
If the master daemon is alive and can respond to a basic query (the
541 3cb9e1fe Iustin Pop
equivalent of **gnt-cluster info**), then the exit code of the
542 3cb9e1fe Iustin Pop
command will be 0. If the master daemon is not alive (either due to
543 3cb9e1fe Iustin Pop
a crash or because this is not the master node), the exit code will
544 3cb9e1fe Iustin Pop
be 1.
545 3cb9e1fe Iustin Pop
546 3cb9e1fe Iustin Pop
MODIFY
547 3cb9e1fe Iustin Pop
~~~~~~
548 3cb9e1fe Iustin Pop
549 3cb9e1fe Iustin Pop
| **modify**
550 3cb9e1fe Iustin Pop
| [--vg-name *vg-name*]
551 3cb9e1fe Iustin Pop
| [--no-lvm-storage]
552 3cb9e1fe Iustin Pop
| [--enabled-hypervisors *hypervisors*]
553 0a68e0ff Iustin Pop
| [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
554 9475189d Andrea Spadaccini
| [{-B|--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
555 9475189d Andrea Spadaccini
| [{-N|--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
556 9475189d Andrea Spadaccini
| [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
557 3cb9e1fe Iustin Pop
| [--uid-pool *user-id pool definition*]
558 3cb9e1fe Iustin Pop
| [--add-uids *user-id pool definition*]
559 3cb9e1fe Iustin Pop
| [--remove-uids *user-id pool definition*]
560 0a68e0ff Iustin Pop
| [{-C|--candidate-pool-size} *candidate\_pool\_size*]
561 3cb9e1fe Iustin Pop
| [--maintain-node-health {yes \| no}]
562 3cb9e1fe Iustin Pop
| [--prealloc-wipe-disks {yes \| no}]
563 0a68e0ff Iustin Pop
| [{-I|--default-iallocator} *default instance allocator*]
564 3cb9e1fe Iustin Pop
| [--reserved-lvs=*NAMES*]
565 6204ee71 Renรฉ Nussbaumer
| [--node-parameters *ndparams*]
566 38f9d2cf Guido Trotter
| [--master-netdev *interface-name*]
567 5a8648eb Andrea Spadaccini
| [--master-netmask *netmask*]
568 bf689b7a Andrea Spadaccini
| [--use-external-mip-script {yes \| no}]
569 2da9f556 Renรฉ Nussbaumer
| [--hypervisor-state *hvstate*]
570 2da9f556 Renรฉ Nussbaumer
| [--disk-state *diskstate*]
571 e37c5129 Agata Murawska
| [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
572 e37c5129 Agata Murawska
| [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
573 e37c5129 Agata Murawska
| [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
574 e37c5129 Agata Murawska
| [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
575 e37c5129 Agata Murawska
| [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
576 0ce212e5 Iustin Pop
| [--specs-disk-templates *template* [,*template*...]]
577 e37c5129 Agata Murawska
578 3cb9e1fe Iustin Pop
579 3cb9e1fe Iustin Pop
Modify the options for the cluster.
580 3cb9e1fe Iustin Pop
581 6204ee71 Renรฉ Nussbaumer
The ``--vg-name``, ``--no-lvm-storarge``, ``--enabled-hypervisors``,
582 0a68e0ff Iustin Pop
``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``,
583 a46b1883 Andrea Spadaccini
``-D (--disk-parameters)``, ``--nic-parameters``, ``-C
584 a46b1883 Andrea Spadaccini
(--candidate-pool-size)``, ``--maintain-node-health``,
585 a46b1883 Andrea Spadaccini
``--prealloc-wipe-disks``, ``--uid-pool``, ``--node-parameters``,
586 a46b1883 Andrea Spadaccini
``--master-netdev``, ``--master-netmask`` and
587 a46b1883 Andrea Spadaccini
``--use-external-mip-script`` options are described in the **init**
588 a46b1883 Andrea Spadaccini
command.
589 3cb9e1fe Iustin Pop
590 2da9f556 Renรฉ Nussbaumer
The ``--hypervisor-state`` and ``--disk-state`` options are described in
591 2da9f556 Renรฉ Nussbaumer
detail in **ganeti**(7).
592 2da9f556 Renรฉ Nussbaumer
593 3cb9e1fe Iustin Pop
The ``--add-uids`` and ``--remove-uids`` options can be used to
594 3cb9e1fe Iustin Pop
modify the user-id pool by adding/removing a list of user-ids or
595 3cb9e1fe Iustin Pop
user-id ranges.
596 3cb9e1fe Iustin Pop
597 3cb9e1fe Iustin Pop
The option ``--reserved-lvs`` specifies a list (comma-separated) of
598 3cb9e1fe Iustin Pop
logical volume group names (regular expressions) that will be
599 3cb9e1fe Iustin Pop
ignored by the cluster verify operation. This is useful if the
600 3cb9e1fe Iustin Pop
volume group used for Ganeti is shared with the system for other
601 3cb9e1fe Iustin Pop
uses. Note that it's not recommended to create and mark as ignored
602 3cb9e1fe Iustin Pop
logical volume names which match Ganeti's own name format (starting
603 3cb9e1fe Iustin Pop
with UUID and then .diskN), as this option only skips the
604 3cb9e1fe Iustin Pop
verification, but not the actual use of the names given.
605 3cb9e1fe Iustin Pop
606 3cb9e1fe Iustin Pop
To remove all reserved logical volumes, pass in an empty argument
607 3cb9e1fe Iustin Pop
to the option, as in ``--reserved-lvs=`` or ``--reserved-lvs ''``.
608 3cb9e1fe Iustin Pop
609 0a68e0ff Iustin Pop
The ``-I (--default-iallocator)`` is described in the **init**
610 0a68e0ff Iustin Pop
command. To clear the default iallocator, just pass an empty string
611 0a68e0ff Iustin Pop
('').
612 3cb9e1fe Iustin Pop
613 0ce212e5 Iustin Pop
The ``--specs-...`` options are described in the **init** command.
614 e37c5129 Agata Murawska
615 3cb9e1fe Iustin Pop
QUEUE
616 3cb9e1fe Iustin Pop
~~~~~
617 3cb9e1fe Iustin Pop
618 3cb9e1fe Iustin Pop
**queue** {drain | undrain | info}
619 3cb9e1fe Iustin Pop
620 3cb9e1fe Iustin Pop
Change job queue properties.
621 3cb9e1fe Iustin Pop
622 3cb9e1fe Iustin Pop
The ``drain`` option sets the drain flag on the job queue. No new
623 3cb9e1fe Iustin Pop
jobs will be accepted, but jobs already in the queue will be
624 3cb9e1fe Iustin Pop
processed.
625 3cb9e1fe Iustin Pop
626 3cb9e1fe Iustin Pop
The ``undrain`` will unset the drain flag on the job queue. New
627 3cb9e1fe Iustin Pop
jobs will be accepted.
628 3cb9e1fe Iustin Pop
629 3cb9e1fe Iustin Pop
The ``info`` option shows the properties of the job queue.
630 3cb9e1fe Iustin Pop
631 3cb9e1fe Iustin Pop
WATCHER
632 3cb9e1fe Iustin Pop
~~~~~~~
633 3cb9e1fe Iustin Pop
634 3cb9e1fe Iustin Pop
**watcher** {pause *duration* | continue | info}
635 3cb9e1fe Iustin Pop
636 3cb9e1fe Iustin Pop
Make the watcher pause or let it continue.
637 3cb9e1fe Iustin Pop
638 3cb9e1fe Iustin Pop
The ``pause`` option causes the watcher to pause for *duration*
639 3cb9e1fe Iustin Pop
seconds.
640 3cb9e1fe Iustin Pop
641 3cb9e1fe Iustin Pop
The ``continue`` option will let the watcher continue.
642 3cb9e1fe Iustin Pop
643 3cb9e1fe Iustin Pop
The ``info`` option shows whether the watcher is currently paused.
644 3cb9e1fe Iustin Pop
645 3cb9e1fe Iustin Pop
redist-conf
646 3cb9e1fe Iustin Pop
~~~~~~~~~~~
647 3cb9e1fe Iustin Pop
648 3cb9e1fe Iustin Pop
**redist-conf** [--submit]
649 3cb9e1fe Iustin Pop
650 3cb9e1fe Iustin Pop
This command forces a full push of configuration files from the
651 3cb9e1fe Iustin Pop
master node to the other nodes in the cluster. This is normally not
652 3cb9e1fe Iustin Pop
needed, but can be run if the **verify** complains about
653 3cb9e1fe Iustin Pop
configuration mismatches.
654 3cb9e1fe Iustin Pop
655 3cb9e1fe Iustin Pop
The ``--submit`` option is used to send the job to the master
656 3cb9e1fe Iustin Pop
daemon but not wait for its completion. The job ID will be shown so
657 3cb9e1fe Iustin Pop
that it can be examined via **gnt-job info**.
658 3cb9e1fe Iustin Pop
659 3cb9e1fe Iustin Pop
REMOVE-TAGS
660 3cb9e1fe Iustin Pop
~~~~~~~~~~~
661 3cb9e1fe Iustin Pop
662 3cb9e1fe Iustin Pop
**remove-tags** [--from *file*] {*tag*...}
663 3cb9e1fe Iustin Pop
664 3cb9e1fe Iustin Pop
Remove tags from the cluster. If any of the tags are not existing
665 3cb9e1fe Iustin Pop
on the cluster, the entire operation will abort.
666 3cb9e1fe Iustin Pop
667 3cb9e1fe Iustin Pop
If the ``--from`` option is given, the list of tags to be removed will
668 3cb9e1fe Iustin Pop
be extended with the contents of that file (each line becomes a tag).
669 3cb9e1fe Iustin Pop
In this case, there is not need to pass tags on the command line (if
670 3cb9e1fe Iustin Pop
you do, tags from both sources will be removed). A file name of - will
671 3cb9e1fe Iustin Pop
be interpreted as stdin.
672 3cb9e1fe Iustin Pop
673 3cb9e1fe Iustin Pop
RENAME
674 3cb9e1fe Iustin Pop
~~~~~~
675 3cb9e1fe Iustin Pop
676 3cb9e1fe Iustin Pop
**rename** [-f] {*name*}
677 3cb9e1fe Iustin Pop
678 3cb9e1fe Iustin Pop
Renames the cluster and in the process updates the master IP
679 3cb9e1fe Iustin Pop
address to the one the new name resolves to. At least one of either
680 3cb9e1fe Iustin Pop
the name or the IP address must be different, otherwise the
681 3cb9e1fe Iustin Pop
operation will be aborted.
682 3cb9e1fe Iustin Pop
683 3cb9e1fe Iustin Pop
Note that since this command can be dangerous (especially when run
684 3cb9e1fe Iustin Pop
over SSH), the command will require confirmation unless run with
685 3cb9e1fe Iustin Pop
the ``-f`` option.
686 3cb9e1fe Iustin Pop
687 3cb9e1fe Iustin Pop
RENEW-CRYPTO
688 3cb9e1fe Iustin Pop
~~~~~~~~~~~~
689 3cb9e1fe Iustin Pop
690 3cb9e1fe Iustin Pop
| **renew-crypto** [-f]
691 3cb9e1fe Iustin Pop
| [--new-cluster-certificate] [--new-confd-hmac-key]
692 3cb9e1fe Iustin Pop
| [--new-rapi-certificate] [--rapi-certificate *rapi-cert*]
693 b8a10435 Andrea Spadaccini
| [--new-spice-certificate | --spice-certificate *spice-cert*
694 b8a10435 Andrea Spadaccini
| -- spice-ca-certificate *spice-ca-cert*]
695 3cb9e1fe Iustin Pop
| [--new-cluster-domain-secret] [--cluster-domain-secret *filename*]
696 3cb9e1fe Iustin Pop
697 3cb9e1fe Iustin Pop
This command will stop all Ganeti daemons in the cluster and start
698 3cb9e1fe Iustin Pop
them again once the new certificates and keys are replicated. The
699 3cb9e1fe Iustin Pop
options ``--new-cluster-certificate`` and ``--new-confd-hmac-key``
700 3cb9e1fe Iustin Pop
can be used to regenerate the cluster-internal SSL certificate
701 3cb9e1fe Iustin Pop
respective the HMAC key used by ganeti-confd(8).
702 3cb9e1fe Iustin Pop
703 3cb9e1fe Iustin Pop
To generate a new self-signed RAPI certificate (used by
704 3cb9e1fe Iustin Pop
ganeti-rapi(8)) specify ``--new-rapi-certificate``. If you want to
705 3cb9e1fe Iustin Pop
use your own certificate, e.g. one signed by a certificate
706 3cb9e1fe Iustin Pop
authority (CA), pass its filename to ``--rapi-certificate``.
707 3cb9e1fe Iustin Pop
708 b8a10435 Andrea Spadaccini
To generate a new self-signed SPICE certificate, used by SPICE
709 b8a10435 Andrea Spadaccini
connections to the KVM hypervisor, specify the
710 b8a10435 Andrea Spadaccini
``--new-spice-certificate`` option. If you want to provide a
711 b8a10435 Andrea Spadaccini
certificate, pass its filename to ``--spice-certificate`` and pass the
712 b8a10435 Andrea Spadaccini
signing CA certificate to ``--spice-ca-certificate``.
713 b8a10435 Andrea Spadaccini
714 3cb9e1fe Iustin Pop
``--new-cluster-domain-secret`` generates a new, random cluster
715 3cb9e1fe Iustin Pop
domain secret. ``--cluster-domain-secret`` reads the secret from a
716 3cb9e1fe Iustin Pop
file. The cluster domain secret is used to sign information
717 3cb9e1fe Iustin Pop
exchanged between separate clusters via a third party.
718 3cb9e1fe Iustin Pop
719 3cb9e1fe Iustin Pop
REPAIR-DISK-SIZES
720 3cb9e1fe Iustin Pop
~~~~~~~~~~~~~~~~~
721 3cb9e1fe Iustin Pop
722 3cb9e1fe Iustin Pop
**repair-disk-sizes** [instance...]
723 3cb9e1fe Iustin Pop
724 3cb9e1fe Iustin Pop
This command checks that the recorded size of the given instance's
725 3cb9e1fe Iustin Pop
disks matches the actual size and updates any mismatches found.
726 3cb9e1fe Iustin Pop
This is needed if the Ganeti configuration is no longer consistent
727 3cb9e1fe Iustin Pop
with reality, as it will impact some disk operations. If no
728 3cb9e1fe Iustin Pop
arguments are given, all instances will be checked.
729 3cb9e1fe Iustin Pop
730 3cb9e1fe Iustin Pop
Note that only active disks can be checked by this command; in case
731 3cb9e1fe Iustin Pop
a disk cannot be activated it's advised to use
732 3cb9e1fe Iustin Pop
**gnt-instance activate-disks --ignore-size ...** to force
733 3cb9e1fe Iustin Pop
activation without regard to the current size.
734 3cb9e1fe Iustin Pop
735 3cb9e1fe Iustin Pop
When the all disk sizes are consistent, the command will return no
736 3cb9e1fe Iustin Pop
output. Otherwise it will log details about the inconsistencies in
737 3cb9e1fe Iustin Pop
the configuration.
738 3cb9e1fe Iustin Pop
739 3cb9e1fe Iustin Pop
SEARCH-TAGS
740 3cb9e1fe Iustin Pop
~~~~~~~~~~~
741 3cb9e1fe Iustin Pop
742 3cb9e1fe Iustin Pop
**search-tags** {*pattern*}
743 3cb9e1fe Iustin Pop
744 3cb9e1fe Iustin Pop
Searches the tags on all objects in the cluster (the cluster
745 3cb9e1fe Iustin Pop
itself, the nodes and the instances) for a given pattern. The
746 3cb9e1fe Iustin Pop
pattern is interpreted as a regular expression and a search will be
747 3cb9e1fe Iustin Pop
done on it (i.e. the given pattern is not anchored to the beggining
748 3cb9e1fe Iustin Pop
of the string; if you want that, prefix the pattern with ^).
749 3cb9e1fe Iustin Pop
750 3cb9e1fe Iustin Pop
If no tags are matching the pattern, the exit code of the command
751 3cb9e1fe Iustin Pop
will be one. If there is at least one match, the exit code will be
752 3cb9e1fe Iustin Pop
zero. Each match is listed on one line, the object and the tag
753 3cb9e1fe Iustin Pop
separated by a space. The cluster will be listed as /cluster, a
754 3cb9e1fe Iustin Pop
node will be listed as /nodes/*name*, and an instance as
755 3cb9e1fe Iustin Pop
/instances/*name*. Example:
756 3cb9e1fe Iustin Pop
757 3cb9e1fe Iustin Pop
::
758 3cb9e1fe Iustin Pop
759 3cb9e1fe Iustin Pop
    # gnt-cluster search-tags time
760 3cb9e1fe Iustin Pop
    /cluster ctime:2007-09-01
761 3cb9e1fe Iustin Pop
    /nodes/node1.example.com mtime:2007-10-04
762 3cb9e1fe Iustin Pop
763 3cb9e1fe Iustin Pop
VERIFY
764 3cb9e1fe Iustin Pop
~~~~~~
765 3cb9e1fe Iustin Pop
766 830fc5da Andrea Spadaccini
| **verify** [--no-nplus1-mem] [--node-group *nodegroup*]
767 830fc5da Andrea Spadaccini
| [--error-codes] [{-I|--ignore-errors} *errorcode*]
768 830fc5da Andrea Spadaccini
| [{-I|--ignore-errors} *errorcode*...]
769 3cb9e1fe Iustin Pop
770 3cb9e1fe Iustin Pop
Verify correctness of cluster configuration. This is safe with
771 3cb9e1fe Iustin Pop
respect to running instances, and incurs no downtime of the
772 3cb9e1fe Iustin Pop
instances.
773 3cb9e1fe Iustin Pop
774 3cb9e1fe Iustin Pop
If the ``--no-nplus1-mem`` option is given, Ganeti won't check
775 3cb9e1fe Iustin Pop
whether if it loses a node it can restart all the instances on
776 3cb9e1fe Iustin Pop
their secondaries (and report an error otherwise).
777 3cb9e1fe Iustin Pop
778 40167d65 Adeodato Simo
With ``--node-group``, restrict the verification to those nodes and
779 40167d65 Adeodato Simo
instances that live in the named group. This will not verify global
780 40167d65 Adeodato Simo
settings, but will allow to perform verification of a group while other
781 40167d65 Adeodato Simo
operations are ongoing in other groups.
782 40167d65 Adeodato Simo
783 830fc5da Andrea Spadaccini
The ``--error-codes`` option outputs each error in the following
784 830fc5da Andrea Spadaccini
parseable format: *ftype*:*ecode*:*edomain*:*name*:*msg*.
785 830fc5da Andrea Spadaccini
These fields have the following meaning:
786 830fc5da Andrea Spadaccini
787 830fc5da Andrea Spadaccini
ftype
788 830fc5da Andrea Spadaccini
    Failure type. Can be *WARNING* or *ERROR*.
789 830fc5da Andrea Spadaccini
790 830fc5da Andrea Spadaccini
ecode
791 830fc5da Andrea Spadaccini
    Error code of the failure. See below for a list of error codes.
792 830fc5da Andrea Spadaccini
793 830fc5da Andrea Spadaccini
edomain
794 830fc5da Andrea Spadaccini
    Can be *cluster*, *node* or *instance*.
795 830fc5da Andrea Spadaccini
796 830fc5da Andrea Spadaccini
name
797 830fc5da Andrea Spadaccini
    Contains the name of the item that is affected from the failure.
798 830fc5da Andrea Spadaccini
799 830fc5da Andrea Spadaccini
msg
800 830fc5da Andrea Spadaccini
    Contains a descriptive error message about the error
801 830fc5da Andrea Spadaccini
802 830fc5da Andrea Spadaccini
``gnt-cluster verify`` will have a non-zero exit code if at least one of
803 830fc5da Andrea Spadaccini
the failures that are found are of type *ERROR*.
804 830fc5da Andrea Spadaccini
805 830fc5da Andrea Spadaccini
The ``--ignore-errors`` option can be used to change this behaviour,
806 830fc5da Andrea Spadaccini
because it demotes the error represented by the error code received as a
807 830fc5da Andrea Spadaccini
parameter to a warning. The option must be repeated for each error that
808 830fc5da Andrea Spadaccini
should be ignored (e.g.: ``-I ENODEVERSION -I ENODEORPHANLV``). The
809 830fc5da Andrea Spadaccini
``--error-codes`` option can be used to determine the error code of a
810 830fc5da Andrea Spadaccini
given error.
811 830fc5da Andrea Spadaccini
812 830fc5da Andrea Spadaccini
List of error codes:
813 830fc5da Andrea Spadaccini
814 830fc5da Andrea Spadaccini
@CONSTANTS_ECODES@
815 830fc5da Andrea Spadaccini
816 3cb9e1fe Iustin Pop
VERIFY-DISKS
817 3cb9e1fe Iustin Pop
~~~~~~~~~~~~
818 3cb9e1fe Iustin Pop
819 3cb9e1fe Iustin Pop
**verify-disks**
820 3cb9e1fe Iustin Pop
821 3cb9e1fe Iustin Pop
The command checks which instances have degraded DRBD disks and
822 3cb9e1fe Iustin Pop
activates the disks of those instances.
823 3cb9e1fe Iustin Pop
824 3cb9e1fe Iustin Pop
This command is run from the **ganeti-watcher** tool, which also
825 3cb9e1fe Iustin Pop
has a different, complementary algorithm for doing this check.
826 3cb9e1fe Iustin Pop
Together, these two should ensure that DRBD disks are kept
827 3cb9e1fe Iustin Pop
consistent.
828 3cb9e1fe Iustin Pop
829 3cb9e1fe Iustin Pop
VERSION
830 3cb9e1fe Iustin Pop
~~~~~~~
831 3cb9e1fe Iustin Pop
832 3cb9e1fe Iustin Pop
**version**
833 3cb9e1fe Iustin Pop
834 3cb9e1fe Iustin Pop
Show the cluster version.
835 9ff4f2c0 Michael Hanselmann
836 9ff4f2c0 Michael Hanselmann
.. vim: set textwidth=72 :
837 9ff4f2c0 Michael Hanselmann
.. Local Variables:
838 9ff4f2c0 Michael Hanselmann
.. mode: rst
839 9ff4f2c0 Michael Hanselmann
.. fill-column: 72
840 9ff4f2c0 Michael Hanselmann
.. End: