Revision 0a68e0ff man/gnt-cluster.rst

b/man/gnt-cluster.rst
116 116
~~~~
117 117

  
118 118
| **init**
119
| [-s *secondary\_ip*]
119
| [{-s|--secondary-ip} *secondary\_ip*]
120 120
| [--vg-name *vg-name*]
121 121
| [--master-netdev *interface-name*]
122
| [-m *mac-prefix*]
122
| [{-m|--mac-prefix} *mac-prefix*]
123 123
| [--no-lvm-storage]
124 124
| [--no-etc-hosts]
125 125
| [--no-ssh-init]
126 126
| [--file-storage-dir *dir*]
127 127
| [--enabled-hypervisors *hypervisors*]
128 128
| [-t *hypervisor name*]
129
| [--hypervisor-parameters *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
130
| [--backend-parameters *be-param*=*value* [,*be-param*=*value*...]]
131
| [--nic-parameters *nic-param*=*value* [,*nic-param*=*value*...]]
129
| [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
130
| [{-B|--backend-parameters} *be-param*=*value* [,*be-param*=*value*...]]
131
| [{-N|--nic-parameters} *nic-param*=*value* [,*nic-param*=*value*...]]
132 132
| [--maintain-node-health {yes \| no}]
133 133
| [--uid-pool *user-id pool definition*]
134
| [-I *default instance allocator*]
134
| [{-I|--default-iallocator} *default instance allocator*]
135 135
| [--primary-ip-version *version*]
136 136
| [--prealloc-wipe-disks {yes \| no}]
137 137
| [--node-parameters *ndparams*]
138
| [{-C|--candidate-pool-size} *candidate\_pool\_size*]
138 139
| {*clustername*}
139 140

  
140 141
This commands is only run once initially on the first node of the
......
149 150
use.
150 151

  
151 152
The cluster can run in two modes: single-home or dual-homed. In the
152
first case, all traffic (both public traffic, inter-node traffic
153
and data replication traffic) goes over the same interface. In the
153
first case, all traffic (both public traffic, inter-node traffic and
154
data replication traffic) goes over the same interface. In the
154 155
dual-homed case, the data replication traffic goes over the second
155
network. The ``-s`` option here marks the cluster as dual-homed and
156
its parameter represents this node's address on the second network.
157
If you initialise the cluster with ``-s``, all nodes added must
158
have a secondary IP as well.
156
network. The ``-s (--secondary-ip)`` option here marks the cluster as
157
dual-homed and its parameter represents this node's address on the
158
second network.  If you initialise the cluster with ``-s``, all nodes
159
added must have a secondary IP as well.
159 160

  
160 161
Note that for Ganeti it doesn't matter if the secondary network is
161 162
actually a separate physical network, or is done using tunneling,
......
175 176
important that all nodes have this interface because you'll need it
176 177
for a master failover.
177 178

  
178
The ``-m`` option will let you specify a three byte prefix under
179
which the virtual MAC addresses of your instances will be
180
generated. The prefix must be specified in the format XX:XX:XX and
181
the default is aa:00:00.
179
The ``-m (--mac-prefix)`` option will let you specify a three byte
180
prefix under which the virtual MAC addresses of your instances will be
181
generated. The prefix must be specified in the format ``XX:XX:XX`` and
182
the default is ``aa:00:00``.
182 183

  
183 184
The ``--no-lvm-storage`` option allows you to initialize the
184 185
cluster without lvm support. This means that only instances using
......
196 197
use for storing the instance disk files when using file storage as
197 198
backend for instance disks.
198 199

  
199
The ``--enabled-hypervisors`` option allows you to set the list of
200
hypervisors that will be enabled for this cluster. Instance
201
hypervisors can only be chosen from the list of enabled
202
hypervisors, and the first entry of this list will be used by
203
default. Currently, the following hypervisors are available:
204

  
205 200
The ``--prealloc-wipe-disks`` sets a cluster wide configuration
206 201
value for wiping disks prior to allocation. This increases security
207 202
on instance level as the instance can't access untouched data from
208 203
it's underlying storage.
209 204

  
210

  
211

  
212

  
205
The ``--enabled-hypervisors`` option allows you to set the list of
206
hypervisors that will be enabled for this cluster. Instance
207
hypervisors can only be chosen from the list of enabled
208
hypervisors, and the first entry of this list will be used by
209
default. Currently, the following hypervisors are available:
213 210

  
214 211
xen-pvm
215 212
    Xen PVM hypervisor
......
227 224
fake
228 225
    fake hypervisor for development/testing
229 226

  
230

  
231 227
Either a single hypervisor name or a comma-separated list of
232 228
hypervisor names can be specified. If this option is not specified,
233 229
only the xen-pvm hypervisor is enabled by default.
234 230

  
235
The ``--hypervisor-parameters`` option allows you to set default
231
The ``-H (--hypervisor-parameters)`` option allows you to set default
236 232
hypervisor specific parameters for the cluster. The format of this
237 233
option is the name of the hypervisor, followed by a colon and a
238
comma-separated list of key=value pairs. The keys available for
239
each hypervisors are detailed in the gnt-instance(8) man page, in
240
the **add** command plus the following parameters which are only
234
comma-separated list of key=value pairs. The keys available for each
235
hypervisors are detailed in the gnt-instance(8) man page, in the
236
**add** command plus the following parameters which are only
241 237
configurable globally (at cluster level):
242 238

  
243 239
migration\_port
......
257 253
    This option is only effective with kvm versions >= 78 and qemu-kvm
258 254
    versions >= 0.10.0.
259 255

  
260

  
261
The ``--backend-parameters`` option allows you to set the default
256
The ``-B (--backend-parameters)`` option allows you to set the default
262 257
backend parameters for the cluster. The parameter format is a
263
comma-separated list of key=value pairs with the following
264
supported keys:
258
comma-separated list of key=value pairs with the following supported
259
keys:
265 260

  
266 261
vcpus
267 262
    Number of VCPUs to set for an instance by default, must be an
......
278 273
    will be set to true if not specified.
279 274

  
280 275

  
281
The ``--nic-parameters`` option allows you to set the default nic
282
parameters for the cluster. The parameter format is a
283
comma-separated list of key=value pairs with the following
284
supported keys:
276
The ``-N (--nic-parameters)`` option allows you to set the default nic
277
parameters for the cluster. The parameter format is a comma-separated
278
list of key=value pairs with the following supported keys:
285 279

  
286 280
mode
287 281
    The default nic mode, 'routed' or 'bridged'.
......
293 287
    network script it is interpreted as a routing table number or
294 288
    name.
295 289

  
296

  
297 290
The option ``--maintain-node-health`` allows to enable/disable
298 291
automatic maintenance actions on nodes. Currently these include
299 292
automatic shutdown of instances and deactivation of DRBD devices on
......
328 321
parameters for the cluster. Please see **ganeti**(7) for more
329 322
information about supported key=value pairs.
330 323

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

  
331 329
LIST-TAGS
332 330
~~~~~~~~~
333 331

  
......
372 370
| [--vg-name *vg-name*]
373 371
| [--no-lvm-storage]
374 372
| [--enabled-hypervisors *hypervisors*]
375
| [--hypervisor-parameters *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
376
| [--backend-parameters *be-param*=*value* [,*be-param*=*value*...]]
377
| [--nic-parameters *nic-param*=*value* [,*nic-param*=*value*...]]
373
| [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
374
| [{-B|--backend-parameters} *be-param*=*value* [,*be-param*=*value*...]]
375
| [{-N|--nic-parameters} *nic-param*=*value* [,*nic-param*=*value*...]]
378 376
| [--uid-pool *user-id pool definition*]
379 377
| [--add-uids *user-id pool definition*]
380 378
| [--remove-uids *user-id pool definition*]
381
| [-C *candidate\_pool\_size*]
379
| [{-C|--candidate-pool-size} *candidate\_pool\_size*]
382 380
| [--maintain-node-health {yes \| no}]
383 381
| [--prealloc-wipe-disks {yes \| no}]
384
| [-I *default instance allocator*]
382
| [{-I|--default-iallocator} *default instance allocator*]
385 383
| [--reserved-lvs=*NAMES*]
386 384
| [--node-parameters *ndparams*]
387 385
| [--master-netdev *interface-name*]
......
389 387
Modify the options for the cluster.
390 388

  
391 389
The ``--vg-name``, ``--no-lvm-storarge``, ``--enabled-hypervisors``,
392
``--hypervisor-parameters``, ``--backend-parameters``,
393
``--nic-parameters``, ``--maintain-node-health``,
394
``--prealloc-wipe-disks``, ``--uid-pool``, ``--node-parameters``,
395
``--master-netdev`` options are described in the **init** command.
396

  
397
The ``-C`` option specifies the ``candidate_pool_size`` cluster
398
parameter. This is the number of nodes that the master will try to
399
keep as master\_candidates. For more details about this role and
400
other node roles, see the ganeti(7). If you increase the size, the
401
master will automatically promote as many nodes as required and
402
possible to reach the intended number.
390
``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``,
391
``--nic-parameters``, ``-C (--candidate-pool-size)``,
392
``--maintain-node-health``, ``--prealloc-wipe-disks``, ``--uid-pool``,
393
``--node-parameters``, ``--master-netdev`` options are described in
394
the **init** command.
403 395

  
404 396
The ``--add-uids`` and ``--remove-uids`` options can be used to
405 397
modify the user-id pool by adding/removing a list of user-ids or
......
417 409
To remove all reserved logical volumes, pass in an empty argument
418 410
to the option, as in ``--reserved-lvs=`` or ``--reserved-lvs ''``.
419 411

  
420
The ``-I`` is described in the **init** command. To clear the
421
default iallocator, just pass an empty string ('').
412
The ``-I (--default-iallocator)`` is described in the **init**
413
command. To clear the default iallocator, just pass an empty string
414
('').
422 415

  
423 416
QUEUE
424 417
~~~~~

Also available in: Unified diff