COMMANDS
--------
+ACTIVATE-MASTER-IP
+~~~~~~~~~~~~~~~~~~
+
+**activate-master-ip**
+
+Activates the master IP on the master node.
+
ADD-TAGS
~~~~~~~~
COMMAND
~~~~~~~
-**command** [-n *node*] {*command*}
+**command** [-n *node*] [-g *group*] [-M] {*command*}
Executes a command on all nodes. If the option ``-n`` is not given,
the command will be executed on all nodes, otherwise it will be
# gnt-cluster command -n node1.example.com -n node2.example.com date
+The ``-g`` option can be used to run a command only on a specific node
+group, e.g.::
+
+ # gnt-cluster command -g default date
+
+The ``-M`` option can be used to prepend the node name to all output
+lines.
+
The command is executed serially on the selected nodes. If the
master node is present in the list, the command will be executed
last on the master. Regarding the other nodes, the execution order
COPYFILE
~~~~~~~~
-**copyfile** [--use-replication-network] [-n *node*] {*file*}
+| **copyfile** [--use-replication-network] [-n *node*] [-g *group*]
+| {*file*}
Copies a file to all or to some nodes. The argument specifies the
source file (on the current system), the ``-n`` argument specifies
the target node, or nodes if the option is given multiple times. If
-``-n`` is not given at all, the file will be copied to all nodes.
+``-n`` is not given at all, the file will be copied to all nodes. The
+``-g`` option can be used to only select nodes in a specific node group.
Passing the ``--use-replication-network`` option will cause the
copy to be done over the replication network (only matters if the
primary/secondary IPs are different). Example::
This will copy the file /tmp/test from the current node to the two
named nodes.
+DEACTIVATE-MASTER-IP
+~~~~~~~~~~~~~~~~~~~~
+
+**deactivate-master-ip** [--yes]
+
+Deactivates the master IP on the master node.
+
+This should be run only locally or on a connection to the node ip
+directly, as a connection to the master ip will be broken by this
+operation. Because of this risk it will require user confirmation
+unless the ``--yes`` option is passed.
+
DESTROY
~~~~~~~
Since this is a dangerous command, you are required to pass the
argument *--yes-do-it.*
+EPO
+~~~
+
+**epo** [--on] [--groups|--all] [--power-delay] *arguments*
+
+Performs an emergency power-off on nodes given as arguments. If
+``--groups`` is given, arguments are node groups. If ``--all`` is
+provided, the whole cluster will be shut down.
+
+The ``--on`` flag recovers the cluster after an emergency power-off.
+When powering on the cluster you can use ``--power-delay`` to define the
+time in seconds (fractions allowed) waited between powering on
+individual nodes.
+
+Please note that the master node will not be turned down or up
+automatically. It will just be left in a state, where you can manully
+perform the shutdown of that one node. If the master is in the list of
+affected nodes and this is not a complete cluster emergency power-off
+(e.g. using ``--all``), you're required to do a master failover to
+another node not affected.
+
GETMASTER
~~~~~~~~~
~~~~
| **init**
-| [-s *secondary\_ip*]
+| [{-s|--secondary-ip} *secondary\_ip*]
| [--vg-name *vg-name*]
| [--master-netdev *interface-name*]
-| [-m *mac-prefix*]
+| [--master-netmask *netmask*]
+| [--use-external-mip-script {yes \| no}]
+| [{-m|--mac-prefix} *mac-prefix*]
| [--no-lvm-storage]
| [--no-etc-hosts]
| [--no-ssh-init]
| [--file-storage-dir *dir*]
| [--enabled-hypervisors *hypervisors*]
-| [-t *hypervisor name*]
-| [--hypervisor-parameters *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
-| [--backend-parameters *be-param*=*value* [,*be-param*=*value*...]]
-| [--nic-parameters *nic-param*=*value* [,*nic-param*=*value*...]]
+| [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
+| [{-B|--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
+| [{-N|--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
+| [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
| [--maintain-node-health {yes \| no}]
| [--uid-pool *user-id pool definition*]
-| [-I *default instance allocator*]
+| [{-I|--default-iallocator} *default instance allocator*]
| [--primary-ip-version *version*]
| [--prealloc-wipe-disks {yes \| no}]
| [--node-parameters *ndparams*]
+| [{-C|--candidate-pool-size} *candidate\_pool\_size*]
+| [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
+| [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
+| [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
+| [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
+| [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
+| [--ipol-disk-templates *template* [,*template*...]]
+| [--disk-state *diskstate*]
+| [--hypervisor-state *hvstate*]
| {*clustername*}
This commands is only run once initially on the first node of the
use.
The cluster can run in two modes: single-home or dual-homed. In the
-first case, all traffic (both public traffic, inter-node traffic
-and data replication traffic) goes over the same interface. In the
+first case, all traffic (both public traffic, inter-node traffic and
+data replication traffic) goes over the same interface. In the
dual-homed case, the data replication traffic goes over the second
-network. The ``-s`` option here marks the cluster as dual-homed and
-its parameter represents this node's address on the second network.
-If you initialise the cluster with ``-s``, all nodes added must
-have a secondary IP as well.
+network. The ``-s (--secondary-ip)`` option here marks the cluster as
+dual-homed and its parameter represents this node's address on the
+second network. If you initialise the cluster with ``-s``, all nodes
+added must have a secondary IP as well.
Note that for Ganeti it doesn't matter if the secondary network is
actually a separate physical network, or is done using tunneling,
important that all nodes have this interface because you'll need it
for a master failover.
-The ``-m`` option will let you specify a three byte prefix under
-which the virtual MAC addresses of your instances will be
-generated. The prefix must be specified in the format XX:XX:XX and
-the default is aa:00:00.
+The ``--master-netmask`` option allows to specify a netmask for the
+master IP. The netmask must be specified as an integer, and will be
+interpreted as a CIDR netmask. The default value is 32 for an IPv4
+address and 128 for an IPv6 address.
+
+The ``--use-external-mip-script`` options allows to specify
+whether to use an user-supplied master IP address setup script, whose
+location is ``/etc/ganeti/scripts/master-ip-setup``. If the option value
+is set to False, the default script, whose location is
+``/usr/local/lib/ganeti/tools/master-ip-setup``, will be executed.
+
+The ``-m (--mac-prefix)`` option will let you specify a three byte
+prefix under which the virtual MAC addresses of your instances will be
+generated. The prefix must be specified in the format ``XX:XX:XX`` and
+the default is ``aa:00:00``.
The ``--no-lvm-storage`` option allows you to initialize the
cluster without lvm support. This means that only instances using
use for storing the instance disk files when using file storage as
backend for instance disks.
-The ``--enabled-hypervisors`` option allows you to set the list of
-hypervisors that will be enabled for this cluster. Instance
-hypervisors can only be chosen from the list of enabled
-hypervisors, and the first entry of this list will be used by
-default. Currently, the following hypervisors are available:
-
The ``--prealloc-wipe-disks`` sets a cluster wide configuration
value for wiping disks prior to allocation. This increases security
on instance level as the instance can't access untouched data from
it's underlying storage.
-
-
-
+The ``--enabled-hypervisors`` option allows you to set the list of
+hypervisors that will be enabled for this cluster. Instance
+hypervisors can only be chosen from the list of enabled
+hypervisors, and the first entry of this list will be used by
+default. Currently, the following hypervisors are available:
xen-pvm
Xen PVM hypervisor
fake
fake hypervisor for development/testing
-
Either a single hypervisor name or a comma-separated list of
hypervisor names can be specified. If this option is not specified,
only the xen-pvm hypervisor is enabled by default.
-The ``--hypervisor-parameters`` option allows you to set default
+The ``-H (--hypervisor-parameters)`` option allows you to set default
hypervisor specific parameters for the cluster. The format of this
option is the name of the hypervisor, followed by a colon and a
-comma-separated list of key=value pairs. The keys available for
-each hypervisors are detailed in the gnt-instance(8) man page, in
-the **add** command plus the following parameters which are only
+comma-separated list of key=value pairs. The keys available for each
+hypervisors are detailed in the gnt-instance(8) man page, in the
+**add** command plus the following parameters which are only
configurable globally (at cluster level):
migration\_port
This option is only effective with kvm versions >= 78 and qemu-kvm
versions >= 0.10.0.
-
-The ``--backend-parameters`` option allows you to set the default
+The ``-B (--backend-parameters)`` option allows you to set the default
backend parameters for the cluster. The parameter format is a
-comma-separated list of key=value pairs with the following
-supported keys:
+comma-separated list of key=value pairs with the following supported
+keys:
vcpus
Number of VCPUs to set for an instance by default, must be an
integer, will be set to 1 if no specified.
-memory
- Amount of memory to allocate for an instance by default, can be
- either an integer or an integer followed by a unit (M for mebibytes
- and G for gibibytes are supported), will be set to 128M if not
- specified.
+maxmem
+ Maximum amount of memory to allocate for an instance by default, can
+ be either an integer or an integer followed by a unit (M for
+ mebibytes and G for gibibytes are supported), will be set to 128M if
+ not specified.
+
+minmem
+ Minimum amount of memory to allocate for an instance by default, can
+ be either an integer or an integer followed by a unit (M for
+ mebibytes and G for gibibytes are supported), will be set to 128M if
+ not specified.
auto\_balance
Value of the auto\_balance flag for instances to use by default,
will be set to true if not specified.
+always\_failover
+ Default value for the ``always\_failover`` flag for instances; if
+ not set, ``False`` is used.
-The ``--nic-parameters`` option allows you to set the default nic
-parameters for the cluster. The parameter format is a
-comma-separated list of key=value pairs with the following
-supported keys:
+
+The ``-N (--nic-parameters)`` option allows you to set the default nic
+parameters for the cluster. The parameter format is a comma-separated
+list of key=value pairs with the following supported keys:
mode
The default nic mode, 'routed' or 'bridged'.
network script it is interpreted as a routing table number or
name.
+The ``-D (--disk-parameters)`` option allows you to set the default disk
+template parameters at cluster level. The format used for this option is
+similar to the one use by the ``-H`` option: the disk template name
+must be specified first, followed by a colon and by a comma-separated
+list of key-value pairs. These parameters can only be specified at
+cluster and node group level; the cluster-level parameter are inherited
+by the node group at the moment of its creation, and can be further
+modified at node group level using the **gnt-group**(8) command.
+
+The following is the list of disk parameters available for the **drbd**
+template, with measurement units specified in square brackets at the end
+of the description (when applicable):
+
+resync-rate
+ Static re-synchronization rate. [KiB/s]
+
+data-stripes
+ Number of stripes to use for data LVs.
-The option ``--maintain-node-health`` allows to enable/disable
+meta-stripes
+ Number of stripes to use for meta LVs.
+
+disk-barriers
+ What kind of barriers to **disable** for disks. It can either assume
+ the value "n", meaning no barrier disabled, or a non-empty string
+ containing a subset of the characters "bfd". "b" means disable disk
+ barriers, "f" means disable disk flushes, "d" disables disk drains.
+
+meta-barriers
+ Boolean value indicating whether the meta barriers should be
+ disabled (True) or not (False).
+
+metavg
+ String containing the name of the default LVM volume group for DRBD
+ metadata. By default, it is set to ``xenvg``. It can be overridden
+ during the instance creation process by using the ``metavg`` key of
+ the ``--disk`` parameter.
+
+disk-custom
+ String containing additional parameters to be appended to the
+ arguments list of ``drbdsetup disk``.
+
+net-custom
+ String containing additional parameters to be appended to the
+ arguments list of ``drbdsetup net``.
+
+dynamic-resync
+ Boolean indicating whether to use the dynamic resync speed
+ controller or not. If enabled, c-plan-ahead must be non-zero and all
+ the c-* parameters will be used by DRBD. Otherwise, the value of
+ resync-rate will be used as a static resync speed.
+
+c-plan-ahead
+ Agility factor of the dynamic resync speed controller. (the higher,
+ the slower the algorithm will adapt the resync speed). A value of 0
+ (that is the default) disables the controller. [ds]
+
+c-fill-target
+ Maximum amount of in-flight resync data for the dynamic resync speed
+ controller. [sectors]
+
+c-delay-target
+ Maximum estimated peer response latency for the dynamic resync speed
+ controller. [ds]
+
+c-min-rate
+ Minimum resync speed for the dynamic resync speed controller. [KiB/s]
+
+c-max-rate
+ Upper bound on resync speed for the dynamic resync speed controller.
+ [KiB/s]
+
+List of parameters available for the **plain** template:
+
+stripes
+ Number of stripes to use for new LVs.
+
+List of parameters available for the **rbd** template:
+
+pool
+ The RADOS cluster pool, inside which all rbd volumes will reside.
+ When a new RADOS cluster is deployed, the default pool to put rbd
+ volumes (Images in RADOS terminology) is 'rbd'.
+
+The option ``--maintain-node-health`` allows one to enable/disable
automatic maintenance actions on nodes. Currently these include
automatic shutdown of instances and deactivation of DRBD devices on
offline nodes; in the future it might be extended to automatic
-removal of unknown LVM volumes, etc.
+removal of unknown LVM volumes, etc. Note that this option is only
+useful if the use of ``ganeti-confd`` was enabled at compilation.
The ``--uid-pool`` option initializes the user-id pool. The
*user-id pool definition* can contain a list of user-ids and/or a
that the user-id pool feature is disabled.
The ``-I (--default-iallocator)`` option specifies the default
-instance allocator. The instance allocator will be used for
-operations like instance creation, instance and node migration,
-etc. when no manual override is specified. If this option is not
-specified, the default instance allocator will be blank, which
-means that relevant operations will require the administrator to
-manually specify either an instance allocator, or a set of nodes.
-The default iallocator can be changed later using the **modify**
-command.
+instance allocator. The instance allocator will be used for operations
+like instance creation, instance and node migration, etc. when no
+manual override is specified. If this option is not specified and
+htools was not enabled at build time, the default instance allocator
+will be blank, which means that relevant operations will require the
+administrator to manually specify either an instance allocator, or a
+set of nodes. If the option is not specified but htools was enabled,
+the default iallocator will be **hail**(1) (assuming it can be found
+on disk). The default iallocator can be changed later using the
+**modify** command.
The ``--primary-ip-version`` option specifies the IP version used
for the primary address. Possible values are 4 and 6 for IPv4 and
parameters for the cluster. Please see **ganeti**(7) for more
information about supported key=value pairs.
+The ``-C (--candidate-pool-size)`` option specifies the
+``candidate_pool_size`` cluster parameter. This is the number of nodes
+that the master will try to keep as master\_candidates. For more
+details about this role and other node roles, see the ganeti(7).
+
+The ``--specs-...`` and ``--ipol-disk-templates`` options specify
+instance policy on the cluster. For the ``--specs-...`` options, each
+option can have three values: ``min``, ``max`` and ``std``, which can
+also be modified on group level (except for ``std``, which is defined
+once for the entire cluster). Please note, that ``std`` values are not
+the same as defaults set by ``--beparams``, but they are used for the
+capacity calculations. The ``--ipol-disk-templates`` option takes a
+comma-separated list of disk templates.
+
+- ``--specs-cpu-count`` limits the number of VCPUs that can be used by an
+ instance.
+- ``--specs-disk-count`` limits the number of disks
+- ``--specs-disk-size`` limits the disk size for every disk used
+- ``--specs-mem-size`` limits the amount of memory available
+- ``--specs-nic-count`` sets limits on the number of NICs used
+- ``--ipol-disk-templates`` limits the allowed disk templates
+
+For details about how to use ``--hypervisor-state`` and ``--disk-state``
+have a look at **ganeti**(7).
+
LIST-TAGS
~~~~~~~~~
| [--vg-name *vg-name*]
| [--no-lvm-storage]
| [--enabled-hypervisors *hypervisors*]
-| [--hypervisor-parameters *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
-| [--backend-parameters *be-param*=*value* [,*be-param*=*value*...]]
-| [--nic-parameters *nic-param*=*value* [,*nic-param*=*value*...]]
+| [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
+| [{-B|--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
+| [{-N|--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
+| [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
| [--uid-pool *user-id pool definition*]
| [--add-uids *user-id pool definition*]
| [--remove-uids *user-id pool definition*]
-| [-C *candidate\_pool\_size*]
+| [{-C|--candidate-pool-size} *candidate\_pool\_size*]
| [--maintain-node-health {yes \| no}]
| [--prealloc-wipe-disks {yes \| no}]
-| [-I *default instance allocator*]
+| [{-I|--default-iallocator} *default instance allocator*]
| [--reserved-lvs=*NAMES*]
| [--node-parameters *ndparams*]
+| [--master-netdev *interface-name*]
+| [--master-netmask *netmask*]
+| [--use-external-mip-script {yes \| no}]
+| [--hypervisor-state *hvstate*]
+| [--disk-state *diskstate*]
+| [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
+| [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
+| [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
+| [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
+| [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
+| [--ipol-disk-templates *template* [,*template*...]]
+
Modify the options for the cluster.
The ``--vg-name``, ``--no-lvm-storarge``, ``--enabled-hypervisors``,
-``--hypervisor-parameters``, ``--backend-parameters``,
-``--nic-parameters``, ``--maintain-node-health``,
-``--prealloc-wipe-disks``, ``--uid-pool``, ``--node-parameters`` options
-are described in the **init** command.
-
-The ``-C`` option specifies the ``candidate_pool_size`` cluster
-parameter. This is the number of nodes that the master will try to
-keep as master\_candidates. For more details about this role and
-other node roles, see the ganeti(7). If you increase the size, the
-master will automatically promote as many nodes as required and
-possible to reach the intended number.
+``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``,
+``-D (--disk-parameters)``, ``--nic-parameters``, ``-C
+(--candidate-pool-size)``, ``--maintain-node-health``,
+``--prealloc-wipe-disks``, ``--uid-pool``, ``--node-parameters``,
+``--master-netdev``, ``--master-netmask`` and
+``--use-external-mip-script`` options are described in the **init**
+command.
+
+The ``--hypervisor-state`` and ``--disk-state`` options are described in
+detail in **ganeti**(7).
The ``--add-uids`` and ``--remove-uids`` options can be used to
modify the user-id pool by adding/removing a list of user-ids or
To remove all reserved logical volumes, pass in an empty argument
to the option, as in ``--reserved-lvs=`` or ``--reserved-lvs ''``.
-The ``-I`` is described in the **init** command. To clear the
-default iallocator, just pass an empty string ('').
+The ``-I (--default-iallocator)`` is described in the **init**
+command. To clear the default iallocator, just pass an empty string
+('').
+
+The ``--specs-...`` and ``--ipol-disk-templates`` options are described
+in the **init** command.
QUEUE
~~~~~
| **renew-crypto** [-f]
| [--new-cluster-certificate] [--new-confd-hmac-key]
| [--new-rapi-certificate] [--rapi-certificate *rapi-cert*]
+| [--new-spice-certificate | --spice-certificate *spice-cert*
+| -- spice-ca-certificate *spice-ca-cert*]
| [--new-cluster-domain-secret] [--cluster-domain-secret *filename*]
This command will stop all Ganeti daemons in the cluster and start
use your own certificate, e.g. one signed by a certificate
authority (CA), pass its filename to ``--rapi-certificate``.
+To generate a new self-signed SPICE certificate, used by SPICE
+connections to the KVM hypervisor, specify the
+``--new-spice-certificate`` option. If you want to provide a
+certificate, pass its filename to ``--spice-certificate`` and pass the
+signing CA certificate to ``--spice-ca-certificate``.
+
``--new-cluster-domain-secret`` generates a new, random cluster
domain secret. ``--cluster-domain-secret`` reads the secret from a
file. The cluster domain secret is used to sign information
VERIFY
~~~~~~
-**verify** [--no-nplus1-mem]
+| **verify** [--no-nplus1-mem] [--node-group *nodegroup*]
+| [--error-codes] [{-I|--ignore-errors} *errorcode*]
+| [{-I|--ignore-errors} *errorcode*...]
Verify correctness of cluster configuration. This is safe with
respect to running instances, and incurs no downtime of the
whether if it loses a node it can restart all the instances on
their secondaries (and report an error otherwise).
+With ``--node-group``, restrict the verification to those nodes and
+instances that live in the named group. This will not verify global
+settings, but will allow to perform verification of a group while other
+operations are ongoing in other groups.
+
+The ``--error-codes`` option outputs each error in the following
+parseable format: *ftype*:*ecode*:*edomain*:*name*:*msg*.
+These fields have the following meaning:
+
+ftype
+ Failure type. Can be *WARNING* or *ERROR*.
+
+ecode
+ Error code of the failure. See below for a list of error codes.
+
+edomain
+ Can be *cluster*, *node* or *instance*.
+
+name
+ Contains the name of the item that is affected from the failure.
+
+msg
+ Contains a descriptive error message about the error
+
+``gnt-cluster verify`` will have a non-zero exit code if at least one of
+the failures that are found are of type *ERROR*.
+
+The ``--ignore-errors`` option can be used to change this behaviour,
+because it demotes the error represented by the error code received as a
+parameter to a warning. The option must be repeated for each error that
+should be ignored (e.g.: ``-I ENODEVERSION -I ENODEORPHANLV``). The
+``--error-codes`` option can be used to determine the error code of a
+given error.
+
+List of error codes:
+
+@CONSTANTS_ECODES@
+
VERIFY-DISKS
~~~~~~~~~~~~
**version**
Show the cluster version.
+
+.. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End:
projects / ganeti-local / blobdiff