X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/5914192ce6b554383be4078f8b3a31c39543cc12..8e4230a8edd6f78480e116aa6257640400951221:/man/gnt-cluster.rst diff --git a/man/gnt-cluster.rst b/man/gnt-cluster.rst index 52c2c3f..2f9ac38 100644 --- a/man/gnt-cluster.rst +++ b/man/gnt-cluster.rst @@ -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 ~~~~ @@ -162,7 +170,6 @@ 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*] @@ -183,9 +190,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*] +| [\--drbd-usermode-helper *helper*] | [\--enabled-disk-templates *template* [,*template*...]] | {*clustername*} @@ -218,8 +230,13 @@ 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 -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-template`` 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 @@ -243,12 +260,6 @@ 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 -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. @@ -489,14 +500,26 @@ The ``-C (--candidate-pool-size)`` option specifies the 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. +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. @@ -504,7 +527,21 @@ 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. + +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). @@ -555,9 +592,9 @@ be 1. 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*...]] @@ -577,25 +614,24 @@ 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*...]] +| [\--drbd-usermode-helper *helper*] 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``, ``--use-external-mip-script``, -and ``--enabled-disk-templates`` options are described in the **init** -command. +``--drbd-usermode-helper``, 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). @@ -620,8 +656,7 @@ 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 options. @@ -659,7 +694,7 @@ The ``info`` option shows whether the watcher is currently paused. 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 @@ -696,24 +731,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 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 ~~~~~~~~~~~~~~~~~ @@ -724,14 +759,15 @@ This command checks that the recorded size of the given instance's 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.