**command** [-n *node*] [-g *group*] [-M] {*command*}
Executes a command on all nodes. This command is designed for simple
-usage. For more complex use cases the commands **dsh(1)** or **cssh(1)**
+usage. For more complex use cases the commands **dsh**\(1) or **cssh**\(1)
should be used instead.
If the option ``-n`` is not given, the command will be executed on all
its integer fields in a latin friendly way. This allows further
diffusion of Ganeti among ancient cultures.
+SHOW-ISPECS-CMD
+~~~~~~~~~~~~~~~
+
+**show-ispecs-cmd**
+
+Shows the command line that can be used to recreate the cluster with the
+same options relative to specs in the instance policies.
+
INIT
~~~~
| [\--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*]
+| [\--shared-file-storage-dir *dir*]
| [\--enabled-hypervisors *hypervisors*]
| [{-H|\--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
| [{-B|\--backend-parameters} *be-param*=*value*[,*be-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*...]]
+| [\--ipolicy-std-specs *spec*=*value* [,*spec*=*value*...]]
+| [\--ipolicy-bounds-specs *bounds_ispecs*]
| [\--ipolicy-disk-templates *template* [,*template*...]]
+| [\--ipolicy-spindle-ratio *ratio*]
+| [\--ipolicy-vcpu-ratio *ratio*]
| [\--disk-state *diskstate*]
| [\--hypervisor-state *hvstate*]
+| [\--drbd-usermode-helper *helper*]
+| [\--enabled-disk-templates *template* [,*template*...]]
| {*clustername*}
This commands is only run once initially on the first node of the
different than "xenvg" for Ganeti to use when creating instance
disks. This volume group must have the same name on all nodes. Once
the cluster is initialized this can be altered by using the
-**modify** command. If you don't want to use lvm storage at all use
-the ``--no-lvm-storage`` option. Once the cluster is initialized
+**modify** command. Note that if the volume group name is modified after
+the cluster creation and DRBD support is enabled you might have to
+manually modify the metavg as well.
+
+If you don't want to use lvm storage at all use
+the ``--enabled-disk-templates`` option to restrict the set of enabled
+disk templates. Once the cluster is initialized
you can change this setup with the **modify** command.
The ``--master-netdev`` option is useful for specifying a different
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
-files as storage backend will be possible to create. Once the
-cluster is initialized you can change this setup with the
-**modify** command.
-
The ``--no-etc-hosts`` option allows you to initialize the cluster
without modifying the /etc/hosts file.
The ``--no-ssh-init`` option allows you to initialize the cluster
without creating or distributing SSH key pairs.
-The ``--file-storage-dir`` option allows you set the directory to
-use for storing the instance disk files when using file storage as
-backend for instance disks.
+The ``--file-storage-dir`` and ``--shared-file-storage-dir`` options
+allow you set the directory to use for storing the instance disk files
+when using file storage backend, respectively shared file storage
+backend, for instance disks. Note that the file and shared file storage
+dir must be an allowed directory for file storage. Those directories
+are specified in the ``@SYSCONFDIR@/ganeti/file-storage-paths`` file.
+The file storage directory can also be a subdirectory of an allowed one.
+The file storage directory should be present on all nodes.
The ``--prealloc-wipe-disks`` sets a cluster wide configuration value
for wiping disks prior to allocation and size changes (``gnt-instance
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
+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):
This options specifies the TCP port to use for live-migration. For
Xen, the same port should be configured on all nodes in the
- ``/etc/xen/xend-config.sxp`` file, under the key
+ ``@XEN_CONFIG_DIR@/xend-config.sxp`` file, under the key
"xend-relocation-port".
migration\_bandwidth
will be set to true if not specified.
always\_failover
- Default value for the ``always\_failover`` flag for instances; if
+ Default value for the ``always_failover`` flag for instances; if
not set, ``False`` is used.
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.
+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
String containing additional parameters to be appended to the
arguments list of ``drbdsetup net``.
+protocol
+ Replication protocol for the DRBD device. Has to be either "A", "B"
+ or "C". Refer to the DRBD documentation for further information
+ about the differences between the protocols.
+
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
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
+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.
and the cluster name.
The ``--node-parameters`` option allows you to set default node
-parameters for the cluster. Please see **ganeti**(7) for more
+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 ``--ipolicy-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 ``--ipolicy-disk-templates`` option takes a
-comma-separated list of disk templates.
+details about this role and other node roles, see the **ganeti**\(7).
+
+The ``--specs-...`` and ``--ipolicy-...`` options specify the instance
+policy on the cluster. The ``--ipolicy-bounds-specs`` option sets the
+minimum and maximum specifications for instances. The format is:
+min:*param*=*value*,.../max:*param*=*value*,... and further
+specifications pairs can be added by using ``//`` as a separator. The
+``--ipolicy-std-specs`` option takes a list of parameter/value pairs.
+For both options, *param* can be:
+
+- ``cpu-count``: number of VCPUs for an instance
+- ``disk-count``: number of disk for an instance
+- ``disk-size``: size of each disk
+- ``memory-size``: instance memory
+- ``nic-count``: number of network interface
+- ``spindle-use``: spindle usage for an instance
+
+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.
- ``--specs-cpu-count`` limits the number of VCPUs that can be used by an
instance.
- ``--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
-- ``--ipolicy-disk-templates`` limits the allowed disk templates
+
+The ``--ipolicy-spindle-ratio`` option takes a decimal number. The
+``--ipolicy-disk-templates`` option takes a comma-separated list of disk
+templates. This list of disk templates must be a subset of the list
+of cluster-wide enabled disk templates (which can be set with
+``--enabled-disk-templates``).
+
+- ``--ipolicy-spindle-ratio`` limits the instances-spindles ratio
+- ``--ipolicy-vcpu-ratio`` limits the vcpu-cpu ratio
+
+All the instance policy elements can be overridden at group level. Group
+level overrides can be removed by specifying ``default`` as the value of
+an item.
+
+The ``--drbd-usermode-helper`` option can be used to specify a usermode
+helper. Check that this string is the one used by the DRBD kernel.
For details about how to use ``--hypervisor-state`` and ``--disk-state``
-have a look at **ganeti**(7).
+have a look at **ganeti**\(7).
+
+The ``--enabled-disk-templates`` option specifies a list of disk templates
+that can be used by instances of the cluster. For the possible values in
+this list, see **gnt-instance**\(8). Note that in contrast to the list of
+disk templates in the ipolicy, this list is a hard restriction. It is not
+possible to create instances with disk templates that are not enabled in
+the cluster. It is also not possible to disable a disk template when there
+are still instances using it. The first disk template in the list of
+enabled disk template is the default disk template. It will be used for
+instance creation, if no disk template is requested explicitely.
MASTER-FAILOVER
~~~~~~~~~~~~~~~
MODIFY
~~~~~~
-| **modify** [\--submit]
+| **modify** [\--submit] [\--print-job-id]
+| [\--force]
| [\--vg-name *vg-name*]
-| [\--no-lvm-storage]
| [\--enabled-hypervisors *hypervisors*]
| [{-H|\--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
| [{-B|\--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
| [\--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*...]]
+| [\--ipolicy-std-specs *spec*=*value* [,*spec*=*value*...]]
+| [\--ipolicy-bounds-specs *bounds_ispecs*]
| [\--ipolicy-disk-templates *template* [,*template*...]]
+| [\--ipolicy-spindle-ratio *ratio*]
+| [\--ipolicy-vcpu-ratio *ratio*]
+| [\--enabled-disk-templates *template* [,*template*...]]
+| [\--drbd-usermode-helper *helper*]
+| [\--file-storage-dir *dir*]
+| [\--shared-file-storage-dir *dir*]
Modify the options for the cluster.
-The ``--vg-name``, ``--no-lvm-storage``, ``--enabled-hypervisors``,
-``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``,
-``-D (--disk-parameters)``, ``--nic-parameters``, ``-C
-(--candidate-pool-size)``, ``--maintain-node-health``,
+The ``--vg-name``, ``--enabled-hypervisors``, ``-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.
+``--master-netdev``, ``--master-netmask``, ``--use-external-mip-script``,
+``--drbd-usermode-helper``, ``--file-storage-dir``,
+``--shared-file-storage-dir``, and ``--enabled-disk-templates`` options are
+described in the **init** command.
The ``--hypervisor-state`` and ``--disk-state`` options are described in
-detail in **ganeti(7)**.
+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
command. To clear the default iallocator, just pass an empty string
('').
-The ``--specs-...`` and ``--ipolicy-disk-templates`` options are
-described in the **init** command.
+The ``--ipolicy-...`` options are described in the **init** command.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
QUEUE
REDIST-CONF
~~~~~~~~~~~
-**redist-conf** [\--submit]
+**redist-conf** [\--submit] [\--print-job-id]
This command forces a full push of configuration files from the
master node to the other nodes in the cluster. This is normally not
needed, but can be run if the **verify** complains about
configuration mismatches.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
RENAME
This command will stop all Ganeti daemons in the cluster and start
them again once the new certificates and keys are replicated. The
options ``--new-cluster-certificate`` and ``--new-confd-hmac-key``
-can be used to regenerate the cluster-internal SSL certificate
-respective the HMAC key used by ganeti-confd(8).
+can be used to regenerate respectively the cluster-internal SSL
+certificate and the HMAC key used by **ganeti-confd**\(8).
To generate a new self-signed RAPI certificate (used by
-ganeti-rapi(8)) specify ``--new-rapi-certificate``. If you want to
+**ganeti-rapi**\(8)) specify ``--new-rapi-certificate``. If you want to
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
+To generate a new self-signed SPICE certificate, used for 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
-exchanged between separate clusters via a third party.
+Finally ``--new-cluster-domain-secret`` generates a new, random
+cluster domain secret, and ``--cluster-domain-secret`` reads the
+secret from a file. The cluster domain secret is used to sign
+information exchanged between separate clusters via a third party.
REPAIR-DISK-SIZES
~~~~~~~~~~~~~~~~~
disks matches the actual size and updates any mismatches found.
This is needed if the Ganeti configuration is no longer consistent
with reality, as it will impact some disk operations. If no
-arguments are given, all instances will be checked.
+arguments are given, all instances will be checked. When exclusive
+storage is active, also spindles are updated.
Note that only active disks can be checked by this command; in case
a disk cannot be activated it's advised to use
**gnt-instance activate-disks \--ignore-size ...** to force
activation without regard to the current size.
-When the all disk sizes are consistent, the command will return no
+When all the disk sizes are consistent, the command will return no
output. Otherwise it will log details about the inconsistencies in
the configuration.
projects / ganeti-local / blobdiff