Commit f624fa95 authored by Iustin Pop's avatar Iustin Pop
Browse files

Fix man pages to not use unescaped --

I've seen that man pages, as generated by the version of pandoc we
use, show single dashes in option names instead of double ones (-
versus --). After bringing it up with upstream
(http://groups.google.com/group/pandoc-discuss/browse_thread/thread/9c4589a4001d42f9/95ee8dae8932dc93

),
it seems that this is a known behaviour of pandoc that has been
improved in newer versions.

Until then, let's use correctly double dashes; from the two options in
the above thread, I chose to use \-- as that doesn't change the actual
output; whereas ``--nodes`` make this a code block, which will look
differently from a short option and could change how the output looks
(e.g. when in a bold span).

Additionally, I've removed two cases where unescape em was explicitly
intended, as that makes automated checking harder and we can use other
formatting.
Signed-off-by: default avatarIustin Pop <iustin@google.com>
Reviewed-by: default avatarMichael Hanselmann <hansmi@google.com>
parent cc67d8eb
...@@ -9,7 +9,7 @@ ganeti-masterd - Ganeti master daemon ...@@ -9,7 +9,7 @@ ganeti-masterd - Ganeti master daemon
Synopsis Synopsis
-------- --------
**ganeti-masterd** [-f] [-d] [--no-voting] **ganeti-masterd** [-f] [-d] [\--no-voting]
DESCRIPTION DESCRIPTION
----------- -----------
......
...@@ -225,7 +225,7 @@ Many Ganeti commands provide the following options. The ...@@ -225,7 +225,7 @@ Many Ganeti commands provide the following options. The
availability for a certain command can be checked by calling the availability for a certain command can be checked by calling the
command using the ``--help`` option. command using the ``--help`` option.
**gnt-...** *command* [--dry-run] [--priority {low | normal | high}] **gnt-...** *command* [\--dry-run] [\--priority {low | normal | high}]
The ``--dry-run`` option can be used to check whether an operation The ``--dry-run`` option can be used to check whether an operation
would succeed. would succeed.
......
...@@ -24,8 +24,8 @@ COMMANDS ...@@ -24,8 +24,8 @@ COMMANDS
EXPORT EXPORT
~~~~~~ ~~~~~~
**export** {-n *node*} [--shutdown-timeout=*N*] [--noshutdown] **export** {-n *node*} [\--shutdown-timeout=*N*] [\--noshutdown]
[--remove-instance] [--ignore-remove-failures] {*instance*} [\--remove-instance] [\--ignore-remove-failures] {*instance*}
Exports an instance to the target node. All the instance data and Exports an instance to the target node. All the instance data and
its configuration will be exported under the its configuration will be exported under the
...@@ -62,15 +62,15 @@ IMPORT ...@@ -62,15 +62,15 @@ IMPORT
~~~~~~ ~~~~~~
| **import** | **import**
| {-n *node[:secondary-node]* | --iallocator *name*} | {-n *node[:secondary-node]* | \--iallocator *name*}
| [--disk *N*:size=*VAL* [,vg=*VG*], [,mode=*ro|rw*]...] | [\--disk *N*:size=*VAL* [,vg=*VG*], [,mode=*ro|rw*]...]
| [--net *N* [:options...] | --no-nics] | [\--net *N* [:options...] | \--no-nics]
| [-B *BEPARAMS*] | [-B *BEPARAMS*]
| [-H *HYPERVISOR* [: option=*value*... ]] | [-H *HYPERVISOR* [: option=*value*... ]]
| [--src-node=*source-node*] [--src-dir=*source-dir*] | [\--src-node=*source-node*] [\--src-dir=*source-dir*]
| [-t [diskless | plain | drbd | file]] | [-t [diskless | plain | drbd | file]]
| [--identify-defaults] | [\--identify-defaults]
| [--ignore-ipolicy] | [\--ignore-ipolicy]
| {*instance*} | {*instance*}
Imports a new instance from an export residing on *source-node* in Imports a new instance from an export residing on *source-node* in
...@@ -130,7 +130,7 @@ Of these ``mode`` and ``link`` are nic parameters, and inherit their ...@@ -130,7 +130,7 @@ Of these ``mode`` and ``link`` are nic parameters, and inherit their
default at cluster level. default at cluster level.
If no network is desired for the instance, you should create a single If no network is desired for the instance, you should create a single
empty NIC and delete it afterwards via **gnt-instance modify --net empty NIC and delete it afterwards via **gnt-instance modify \--net
delete**. delete**.
The ``-B`` option specifies the backend parameters for the The ``-B`` option specifies the backend parameters for the
...@@ -220,7 +220,7 @@ Explicit configuration example:: ...@@ -220,7 +220,7 @@ Explicit configuration example::
LIST LIST
~~~~ ~~~~
**list** [--node=*NODE*] **list** [\--node=*NODE*]
Lists the exports currently available in the default directory in Lists the exports currently available in the default directory in
all the nodes of the current cluster, or optionally only a subset all the nodes of the current cluster, or optionally only a subset
......
...@@ -22,10 +22,10 @@ COMMANDS ...@@ -22,10 +22,10 @@ COMMANDS
IALLOCATOR IALLOCATOR
~~~~~~~~~~ ~~~~~~~~~~
**iallocator** [--debug] [--dir *DIRECTION*] {--algorithm **iallocator** [\--debug] [\--dir *DIRECTION*] {\--algorithm
*ALLOCATOR* } [--mode *MODE*] [--mem *MEMORY*] [--disks *DISKS*] *ALLOCATOR* } [\--mode *MODE*] [\--mem *MEMORY*] [\--disks *DISKS*]
[--disk-template *TEMPLATE*] [--nics *NICS*] [--os-type *OS*] [\--disk-template *TEMPLATE*] [\--nics *NICS*] [\--os-type *OS*]
[--vcpus *VCPUS*] [--tags *TAGS*] {*instance*} [\--vcpus *VCPUS*] [\--tags *TAGS*] {*instance*}
Executes a test run of the *iallocator* framework. Executes a test run of the *iallocator* framework.
...@@ -46,7 +46,7 @@ this framework, see the HTML or PDF documentation. ...@@ -46,7 +46,7 @@ this framework, see the HTML or PDF documentation.
DELAY DELAY
~~~~~ ~~~~~
**delay** [--debug] [--no-master] [-n *NODE*...] {*duration*} **delay** [\--debug] [\--no-master] [-n *NODE*...] {*duration*}
Run a test opcode (a sleep) on the master and on selected nodes Run a test opcode (a sleep) on the master and on selected nodes
(via an RPC call). This serves no other purpose but to execute a (via an RPC call). This serves no other purpose but to execute a
...@@ -62,8 +62,8 @@ number. ...@@ -62,8 +62,8 @@ number.
SUBMIT-JOB SUBMIT-JOB
~~~~~~~~~~ ~~~~~~~~~~
**submit-job** [--verbose] [--timing-stats] [--job-repeat ``N``] **submit-job** [\--verbose] [\--timing-stats] [\--job-repeat *N*]
[--op-repeat ``N``] [--each] {opcodes_file...} [\--op-repeat *N*] [\--each] {opcodes_file...}
This command builds a list of opcodes from files in JSON format and This command builds a list of opcodes from files in JSON format and
submits a job per file to the master daemon. It can be used to test submits a job per file to the master daemon. It can be used to test
...@@ -96,8 +96,8 @@ failed jobs deliberately. ...@@ -96,8 +96,8 @@ failed jobs deliberately.
LOCKS LOCKS
~~~~~ ~~~~~
| **locks** [--no-headers] [--separator=*SEPARATOR*] [-v] | **locks** [\--no-headers] [\--separator=*SEPARATOR*] [-v]
| [-o *[+]FIELD,...*] [--interval=*SECONDS*] | [-o *[+]FIELD,...*] [\--interval=*SECONDS*]
Shows a list of locks in the master daemon. Shows a list of locks in the master daemon.
......
...@@ -59,7 +59,7 @@ information). ...@@ -59,7 +59,7 @@ information).
LIST LIST
~~~~ ~~~~
**list** [--no-headers] [--separator=*SEPARATOR*] **list** [\--no-headers] [\--separator=*SEPARATOR*]
[-o *[+]FIELD,...*] [-o *[+]FIELD,...*]
Lists the jobs and their status. By default, the job id, job Lists the jobs and their status. By default, the job id, job
......
...@@ -23,12 +23,12 @@ COMMANDS ...@@ -23,12 +23,12 @@ COMMANDS
ADD ADD
~~~ ~~~
| **add** [--readd] [{-s|--secondary-ip} *secondary\_ip*] | **add** [\--readd] [{-s|\--secondary-ip} *secondary\_ip*]
| [{-g|--node-group} *nodegroup*] | [{-g|\--node-group} *nodegroup*]
| [--master-capable=``yes|no``] [--vm-capable=``yes|no``] | [\--master-capable=``yes|no``] [\--vm-capable=``yes|no``]
| [--node-parameters *ndparams*] | [\--node-parameters *ndparams*]
| [--disk-state *diskstate*] | [\--disk-state *diskstate*]
| [--hypervisor-state *hvstate*] | [\--hypervisor-state *hvstate*]
| {*nodename*} | {*nodename*}
Adds the given node to the cluster. Adds the given node to the cluster.
...@@ -81,7 +81,7 @@ Example:: ...@@ -81,7 +81,7 @@ Example::
ADD-TAGS ADD-TAGS
~~~~~~~~ ~~~~~~~~
**add-tags** [--from *file*] {*nodename*} {*tag*...} **add-tags** [\--from *file*] {*nodename*} {*tag*...}
Add tags to the given node. If any of the tags contains invalid Add tags to the given node. If any of the tags contains invalid
characters, the entire operation will abort. characters, the entire operation will abort.
...@@ -95,9 +95,9 @@ interpreted as stdin. ...@@ -95,9 +95,9 @@ interpreted as stdin.
EVACUATE EVACUATE
~~~~~~~~ ~~~~~~~~
**evacuate** [-f] [--early-release] [--iallocator *NAME* \| **evacuate** [-f] [\--early-release] [\--iallocator *NAME* \|
--new-secondary *destination\_node*] \--new-secondary *destination\_node*]
[--primary-only \| --secondary-only] [--early-release] {*node*} [\--primary-only \| \--secondary-only] [\--early-release] {*node*}
This command will move instances away from the given node. If This command will move instances away from the given node. If
``--primary-only`` is given, only primary instances are evacuated, with ``--primary-only`` is given, only primary instances are evacuated, with
...@@ -140,7 +140,7 @@ Example:: ...@@ -140,7 +140,7 @@ Example::
FAILOVER FAILOVER
~~~~~~~~ ~~~~~~~~
**failover** [-f] [--ignore-consistency] {*node*} **failover** [-f] [\--ignore-consistency] {*node*}
This command will fail over all instances having the given node as This command will fail over all instances having the given node as
primary to their secondary nodes. This works only for instances having primary to their secondary nodes. This works only for instances having
...@@ -169,9 +169,9 @@ LIST ...@@ -169,9 +169,9 @@ LIST
~~~~ ~~~~
| **list** | **list**
| [--no-headers] [--separator=*SEPARATOR*] | [\--no-headers] [\--separator=*SEPARATOR*]
| [--units=*UNITS*] [-v] [{-o|--output} *[+]FIELD,...*] | [\--units=*UNITS*] [-v] [{-o|\--output} *[+]FIELD,...*]
| [--filter] | [\--filter]
| [node...] | [node...]
Lists the nodes in the cluster. Lists the nodes in the cluster.
...@@ -244,8 +244,8 @@ List the tags of the given node. ...@@ -244,8 +244,8 @@ List the tags of the given node.
MIGRATE MIGRATE
~~~~~~~ ~~~~~~~
**migrate** [-f] [--non-live] [--migration-mode=live\|non-live] **migrate** [-f] [\--non-live] [\--migration-mode=live\|non-live]
[--ignore-ipolicy] {*node*} [\--ignore-ipolicy] {*node*}
This command will migrate all instances having the given node as This command will migrate all instances having the given node as
primary to their secondary nodes. This works only for instances primary to their secondary nodes. This works only for instances
...@@ -266,15 +266,15 @@ Example:: ...@@ -266,15 +266,15 @@ Example::
MODIFY MODIFY
~~~~~~ ~~~~~~
| **modify** [-f] [--submit] | **modify** [-f] [\--submit]
| [{-C|--master-candidate} ``yes|no``] | [{-C|\--master-candidate} ``yes|no``]
| [{-D|--drained} ``yes|no``] [{-O|--offline} ``yes|no``] | [{-D|\--drained} ``yes|no``] [{-O|\--offline} ``yes|no``]
| [--master-capable=``yes|no``] [--vm-capable=``yes|no``] [--auto-promote] | [\--master-capable=``yes|no``] [\--vm-capable=``yes|no``] [\--auto-promote]
| [{-s|--secondary-ip} *secondary_ip*] | [{-s|\--secondary-ip} *secondary_ip*]
| [--node-parameters *ndparams*] | [\--node-parameters *ndparams*]
| [--node-powered=``yes|no``] | [\--node-powered=``yes|no``]
| [--hypervisor-state *hvstate*] | [\--hypervisor-state *hvstate*]
| [--disk-state *diskstate*] | [\--disk-state *diskstate*]
| {*node*} | {*node*}
This command changes the role of the node. Each options takes This command changes the role of the node. Each options takes
...@@ -324,7 +324,7 @@ Example:: ...@@ -324,7 +324,7 @@ Example::
REMOVE-TAGS REMOVE-TAGS
~~~~~~~~~~~ ~~~~~~~~~~~
**remove-tags** [--from *file*] {*nodename*} {*tag*...} **remove-tags** [\--from *file*] {*nodename*} {*tag*...}
Remove tags from the given node. If any of the tags are not Remove tags from the given node. If any of the tags are not
existing on the node, the entire operation will abort. existing on the node, the entire operation will abort.
...@@ -338,8 +338,8 @@ be interpreted as stdin. ...@@ -338,8 +338,8 @@ be interpreted as stdin.
VOLUMES VOLUMES
~~~~~~~ ~~~~~~~
| **volumes** [--no-headers] [--human-readable] | **volumes** [\--no-headers] [\--human-readable]
| [--separator=*SEPARATOR*] [{-o|--output} *FIELDS*] | [\--separator=*SEPARATOR*] [{-o|\--output} *FIELDS*]
| [*node*...] | [*node*...]
Lists all logical volumes and their physical disks from the node(s) Lists all logical volumes and their physical disks from the node(s)
...@@ -391,9 +391,9 @@ Example:: ...@@ -391,9 +391,9 @@ Example::
LIST-STORAGE LIST-STORAGE
~~~~~~~~~~~~ ~~~~~~~~~~~~
| **list-storage** [--no-headers] [--human-readable] | **list-storage** [\--no-headers] [\--human-readable]
| [--separator=*SEPARATOR*] [--storage-type=*STORAGE\_TYPE*] | [\--separator=*SEPARATOR*] [\--storage-type=*STORAGE\_TYPE*]
| [{-o|--output} *FIELDS*] | [{-o|\--output} *FIELDS*]
| [*node*...] | [*node*...]
Lists the available storage units and their details for the given Lists the available storage units and their details for the given
...@@ -476,14 +476,14 @@ Example:: ...@@ -476,14 +476,14 @@ Example::
REPAIR-STORAGE REPAIR-STORAGE
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
**repair-storage** [--ignore-consistency] {*node*} {*storage-type*} **repair-storage** [\--ignore-consistency] {*node*} {*storage-type*}
{*volume-name*} {*volume-name*}
Repairs a storage volume on a node. Only LVM volume groups can be Repairs a storage volume on a node. Only LVM volume groups can be
repaired at this time. They have the storage type "lvm-vg". repaired at this time. They have the storage type "lvm-vg".
On LVM volume groups, **repair-storage** runs "vgreduce On LVM volume groups, **repair-storage** runs ``vgreduce
--removemissing". --removemissing``.
......
...@@ -45,7 +45,7 @@ versions, the supported parameters (if any) and their ...@@ -45,7 +45,7 @@ versions, the supported parameters (if any) and their
documentations, etc. documentations, etc.
| **modify** [-H *HYPERVISOR*:option=*value*[,...]] | **modify** [-H *HYPERVISOR*:option=*value*[,...]]
| [--hidden=*yes|no*] [--blacklisted=*yes|no*] | [\--hidden=*yes|no*] [\--blacklisted=*yes|no*]
| {*OS*} | {*OS*}
This command will allow you to modify OS parameters. This command will allow you to modify OS parameters.
......
...@@ -9,9 +9,9 @@ hail - Ganeti IAllocator plugin ...@@ -9,9 +9,9 @@ hail - Ganeti IAllocator plugin
SYNOPSIS SYNOPSIS
-------- --------
**hail** [ **-t** *file* | **--simulate** *spec* ] [options...] *input-file* **hail** [ **-t** *file* | **\--simulate** *spec* ] [options...] *input-file*
**hail** --version **hail** \--version
DESCRIPTION DESCRIPTION
----------- -----------
...@@ -62,22 +62,22 @@ OPTIONS ...@@ -62,22 +62,22 @@ OPTIONS
The options that can be passed to the program are as follows: The options that can be passed to the program are as follows:
-p, --print-nodes -p, \--print-nodes
Prints the before and after node status, in a format designed to allow Prints the before and after node status, in a format designed to allow
the user to understand the node's most important parameters. See the the user to understand the node's most important parameters. See the
man page **htools**(1) for more details about this option. man page **htools**(1) for more details about this option.
-t *datafile*, --text-data=*datafile* -t *datafile*, \--text-data=*datafile*
The name of the file holding cluster information, to override the data The name of the file holding cluster information, to override the data
in the JSON request itself. This is mostly used for debugging. The in the JSON request itself. This is mostly used for debugging. The
format of the file is described in the man page **htools**(1). format of the file is described in the man page **htools**(1).
--simulate *description* \--simulate *description*
Backend specification: similar to the **-t** option, this allows Backend specification: similar to the **-t** option, this allows
overriding the cluster data with a simulated cluster. For details overriding the cluster data with a simulated cluster. For details
about the description, see the man page **htools**(1). about the description, see the man page **htools**(1).
-S *filename*, --save-cluster=*filename* -S *filename*, \--save-cluster=*filename*
If given, the state of the cluster before and the iallocator run is If given, the state of the cluster before and the iallocator run is
saved to a file named *filename.pre-ialloc*, respectively saved to a file named *filename.pre-ialloc*, respectively
*filename.post-ialloc*. This allows re-feeding the cluster state to *filename.post-ialloc*. This allows re-feeding the cluster state to
......
...@@ -11,7 +11,7 @@ SYNOPSIS ...@@ -11,7 +11,7 @@ SYNOPSIS
**hbal** {backend options...} [algorithm options...] [reporting options...] **hbal** {backend options...} [algorithm options...] [reporting options...]
**hbal** --version **hbal** \--version
Backend options: Backend options:
...@@ -20,24 +20,24 @@ Backend options: ...@@ -20,24 +20,24 @@ Backend options:
Algorithm options: Algorithm options:
**[ --max-cpu *cpu-ratio* ]** **[ \--max-cpu *cpu-ratio* ]**
**[ --min-disk *disk-ratio* ]** **[ \--min-disk *disk-ratio* ]**
**[ -l *limit* ]** **[ -l *limit* ]**
**[ -e *score* ]** **[ -e *score* ]**
**[ -g *delta* ]** **[ --min-gain-limit *threshold* ]** **[ -g *delta* ]** **[ \--min-gain-limit *threshold* ]**
**[ -O *name...* ]** **[ -O *name...* ]**
**[ --no-disk-moves ]** **[ \--no-disk-moves ]**
**[ --no-instance-moves ]** **[ \--no-instance-moves ]**
**[ -U *util-file* ]** **[ -U *util-file* ]**
**[ --evac-mode ]** **[ \--evac-mode ]**
**[ --select-instances *inst...* ]** **[ \--select-instances *inst...* ]**
**[ --exclude-instances *inst...* ]** **[ \--exclude-instances *inst...* ]**
Reporting options: Reporting options:
**[ -C[ *file* ] ]** **[ -C[ *file* ] ]**
**[ -p[ *fields* ] ]** **[ -p[ *fields* ] ]**
**[ --print-instances ]** **[ \--print-instances ]**
**[ -o ]** **[ -o ]**
**[ -v... | -q ]** **[ -v... | -q ]**
...@@ -52,9 +52,9 @@ the cluster into a better state. ...@@ -52,9 +52,9 @@ the cluster into a better state.
The algorithm used is designed to be stable (i.e. it will give you the The algorithm used is designed to be stable (i.e. it will give you the
same results when restarting it from the middle of the solution) and same results when restarting it from the middle of the solution) and
reasonably fast. It is not, however, designed to be a perfect reasonably fast. It is not, however, designed to be a perfect algorithm:
algorithm--it is possible to make it go into a corner from which it is possible to make it go into a corner from which it can find no
it can find no improvement, because it looks only one "step" ahead. improvement, because it looks only one "step" ahead.
By default, the program will show the solution incrementally as it is By default, the program will show the solution incrementally as it is
computed, in a somewhat cryptic format; for getting the actual Ganeti computed, in a somewhat cryptic format; for getting the actual Ganeti
...@@ -92,10 +92,10 @@ At each step, we prevent an instance move if it would cause: ...@@ -92,10 +92,10 @@ At each step, we prevent an instance move if it would cause:
- an instance to move onto an offline node (offline nodes are either - an instance to move onto an offline node (offline nodes are either
read from the cluster or declared with *-O*) read from the cluster or declared with *-O*)
- an exclusion-tag based conflict (exclusion tags are read from the - an exclusion-tag based conflict (exclusion tags are read from the
cluster and/or defined via the *--exclusion-tags* option) cluster and/or defined via the *\--exclusion-tags* option)
- a max vcpu/pcpu ratio to be exceeded (configured via *--max-cpu*) - a max vcpu/pcpu ratio to be exceeded (configured via *\--max-cpu*)
- min disk free percentage to go below the configured limit - min disk free percentage to go below the configured limit
(configured via *--min-disk*) (configured via *\--min-disk*)
CLUSTER SCORING CLUSTER SCORING
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
...@@ -178,10 +178,10 @@ which would make the respective node a SPOF for the given service. ...@@ -178,10 +178,10 @@ which would make the respective node a SPOF for the given service.
It works by tagging instances with certain tags and then building It works by tagging instances with certain tags and then building
exclusion maps based on these. Which tags are actually used is exclusion maps based on these. Which tags are actually used is
configured either via the command line (option *--exclusion-tags*) configured either via the command line (option *\--exclusion-tags*)
or via adding them to the cluster tags: or via adding them to the cluster tags:
--exclusion-tags=a,b \--exclusion-tags=a,b
This will make all instance tags of the form *a:\**, *b:\** be This will make all instance tags of the form *a:\**, *b:\** be
considered for the exclusion map considered for the exclusion map
...@@ -198,7 +198,7 @@ OPTIONS ...@@ -198,7 +198,7 @@ OPTIONS
The options that can be passed to the program are as follows: The options that can be passed to the program are as follows:
-C, --print-commands -C, \--print-commands
Print the command list at the end of the run. Without this, the Print the command list at the end of the run. Without this, the
program will only show a shorter, but cryptic output. program will only show a shorter, but cryptic output.
...@@ -216,12 +216,12 @@ The options that can be passed to the program are as follows: ...@@ -216,12 +216,12 @@ The options that can be passed to the program are as follows:
parallel (due to resource allocation in Ganeti) and thus we start a parallel (due to resource allocation in Ganeti) and thus we start a
new jobset. new jobset.
-p, --print-nodes -p, \--print-nodes
Prints the before and after node status, in a format designed to allow Prints the before and after node status, in a format designed to allow
the user to understand the node's most important parameters. See the the user to understand the node's most important parameters. See the
man page **htools**(1) for more details about this option. man page **htools**(1) for more details about this option.
--print-instances \--print-instances
Prints the before and after instance map. This is less useful as the Prints the before and after instance map. This is less useful as the
node status, but it can help in understanding instance moves. node status, but it can help in understanding instance moves.
...@@ -239,7 +239,7 @@ The options that can be passed to the program are as follows: ...@@ -239,7 +239,7 @@ The options that can be passed to the program are as follows:
reported by RAPI as such, or that have "?" in file-based input in reported by RAPI as such, or that have "?" in file-based input in
any numeric fields. any numeric fields.
-e *score*, --min-score=*score* -e *score*, \--min-score=*score*
This parameter denotes the minimum score we are happy with and alters This parameter denotes the minimum score we are happy with and alters
the computation in two ways: the computation in two ways:
...@@ -251,13 +251,13 @@ The options that can be passed to the program are as follows: ...@@ -251,13 +251,13 @@ The options that can be passed to the program are as follows:
The default value of the parameter is currently ``1e-9`` (chosen The default value of the parameter is currently ``1e-9`` (chosen
empirically). empirically).
-g *delta*, --min-gain=*delta* -g *delta*, \--min-gain=*delta*
Since the balancing algorithm can sometimes result in just very tiny Since the balancing algorithm can sometimes result in just very tiny
improvements, that bring less gain that they cost in relocation improvements, that bring less gain that they cost in relocation
time, this parameter (defaulting to 0.01) represents the minimum time, this parameter (defaulting to 0.01) represents the minimum
gain we require during a step, to continue balancing. gain we require during a step, to continue balancing.
--min-gain-limit=*threshold* \--min-gain-limit=*threshold*
The above min-gain option will only take effect if the cluster score The above min-gain option will only take effect if the cluster score
is already below *threshold* (defaults to 0.1). The rationale behind is already below *threshold* (defaults to 0.1). The rationale behind
this setting is that at high cluster scores (badly balanced this setting is that at high cluster scores (badly balanced
...@@ -266,30 +266,30 @@ The options that can be passed to the program are as follows: ...@@ -266,30 +266,30 @@ The options that can be passed to the program are as follows:
threshold, the total gain is only the threshold value, so we can threshold, the total gain is only the threshold value, so we can
exit early. exit early.
--no-disk-moves \--no-disk-moves
This parameter prevents hbal from using disk move This parameter prevents hbal from using disk move
(i.e. "gnt-instance replace-disks") operations. This will result in (i.e. "gnt-instance replace-disks") operations. This will result in
a much quicker balancing, but of course the improvements are a much quicker balancing, but of course the improvements are
limited. It is up to the user to decide when to use one or another. limited. It is up to the user to decide when to use one or another.
--no-instance-moves \--no-instance-moves
This parameter prevents hbal from using instance moves This parameter prevents hbal from using instance moves
(i.e. "gnt-instance migrate/failover") operations. This will only use (i.e. "gnt-instance migrate/failover") operations. This will only use
the slow disk-replacement operations, and will also provide a worse the slow disk-replacement operations, and will also provide a worse
balance, but can be useful if moving instances around is deemed unsafe balance, but can be useful if moving instances around is deemed unsafe
or not preferred. or not preferred.
--evac-mode \--evac-mode
This parameter restricts the list of instances considered for moving This parameter restricts the list of instances considered for moving
to the ones living on offline/drained nodes. It can be used as a to the ones living on offline/drained nodes. It can be used as a
(bulk) replacement for Ganeti's own *gnt-node evacuate*, with the (bulk) replacement for Ganeti's own *gnt-node evacuate*, with the