Merge branch 'stable-2.7' into stable-2.8
[ganeti-local] / man / gnt-cluster.rst
index f5d13be..9103f60 100644 (file)
@@ -33,7 +33,7 @@ COMMAND
 **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
@@ -152,6 +152,14 @@ Passing the ``--roman`` option gnt-cluster info will try to print
 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
 ~~~~
 
@@ -183,9 +191,14 @@ INIT
 | [\--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*]
+| [\--enabled-disk-templates *template* [,*template*...]]
 | {*clustername*}
 
 This commands is only run once initially on the first node of the
@@ -217,7 +230,11 @@ The ``--vg-name`` option will let you specify a volume group
 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
+**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 ``--no-lvm-storage`` option. Once the cluster is initialized
 you can change this setup with the **modify** command.
 
@@ -293,7 +310,7 @@ 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
+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):
 
@@ -302,7 +319,7 @@ migration\_port
 
     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
@@ -340,7 +357,7 @@ auto\_balance
     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.
 
 
@@ -369,7 +386,7 @@ 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.
+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
@@ -470,7 +487,7 @@ 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
+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.
 
@@ -480,22 +497,34 @@ IPv6, respectively. This option is used when resolving node names
 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.
@@ -503,10 +532,29 @@ comma-separated list of disk templates.
 - ``--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
+
+The ``--ipolicy-disk-templates`` and ``--ipolicy-spindle-ratio`` options
+take a decimal number. The ``--ipolicy-disk-templates`` option takes a
+comma-separated list of disk templates.
+
 - ``--ipolicy-disk-templates`` limits the allowed 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.
 
 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.
 
 MASTER-FAILOVER
 ~~~~~~~~~~~~~~~
@@ -547,6 +595,7 @@ MODIFY
 ~~~~~~
 
 | **modify** [\--submit]
+| [\--force]
 | [\--vg-name *vg-name*]
 | [\--no-lvm-storage]
 | [\--enabled-hypervisors *hypervisors*]
@@ -568,12 +617,12 @@ MODIFY
 | [\--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*...]]
 
 
 Modify the options for the cluster.
@@ -583,12 +632,12 @@ The ``--vg-name``, ``--no-lvm-storage``, ``--enabled-hypervisors``,
 ``-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**
+``--master-netdev``, ``--master-netmask``, ``--use-external-mip-script``,
+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
@@ -610,10 +659,9 @@ The ``-I (--default-iallocator)`` is described in the **init**
 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
@@ -656,7 +704,7 @@ 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
@@ -686,24 +734,24 @@ RENEW-CRYPTO
 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
 ~~~~~~~~~~~~~~~~~