Commit f624fa95 authored by Iustin Pop's avatar Iustin Pop

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
Synopsis
--------
**ganeti-masterd** [-f] [-d] [--no-voting]
**ganeti-masterd** [-f] [-d] [\--no-voting]
DESCRIPTION
-----------
......
......@@ -225,7 +225,7 @@ Many Ganeti commands provide the following options. The
availability for a certain command can be checked by calling the
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
would succeed.
......
......@@ -24,8 +24,8 @@ COMMANDS
EXPORT
~~~~~~
**export** {-n *node*} [--shutdown-timeout=*N*] [--noshutdown]
[--remove-instance] [--ignore-remove-failures] {*instance*}
**export** {-n *node*} [\--shutdown-timeout=*N*] [\--noshutdown]
[\--remove-instance] [\--ignore-remove-failures] {*instance*}
Exports an instance to the target node. All the instance data and
its configuration will be exported under the
......@@ -62,15 +62,15 @@ IMPORT
~~~~~~
| **import**
| {-n *node[:secondary-node]* | --iallocator *name*}
| [--disk *N*:size=*VAL* [,vg=*VG*], [,mode=*ro|rw*]...]
| [--net *N* [:options...] | --no-nics]
| {-n *node[:secondary-node]* | \--iallocator *name*}
| [\--disk *N*:size=*VAL* [,vg=*VG*], [,mode=*ro|rw*]...]
| [\--net *N* [:options...] | \--no-nics]
| [-B *BEPARAMS*]
| [-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]]
| [--identify-defaults]
| [--ignore-ipolicy]
| [\--identify-defaults]
| [\--ignore-ipolicy]
| {*instance*}
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
default at cluster level.
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**.
The ``-B`` option specifies the backend parameters for the
......@@ -220,7 +220,7 @@ Explicit configuration example::
LIST
~~~~
**list** [--node=*NODE*]
**list** [\--node=*NODE*]
Lists the exports currently available in the default directory in
all the nodes of the current cluster, or optionally only a subset
......
......@@ -22,10 +22,10 @@ COMMANDS
IALLOCATOR
~~~~~~~~~~
**iallocator** [--debug] [--dir *DIRECTION*] {--algorithm
*ALLOCATOR* } [--mode *MODE*] [--mem *MEMORY*] [--disks *DISKS*]
[--disk-template *TEMPLATE*] [--nics *NICS*] [--os-type *OS*]
[--vcpus *VCPUS*] [--tags *TAGS*] {*instance*}
**iallocator** [\--debug] [\--dir *DIRECTION*] {\--algorithm
*ALLOCATOR* } [\--mode *MODE*] [\--mem *MEMORY*] [\--disks *DISKS*]
[\--disk-template *TEMPLATE*] [\--nics *NICS*] [\--os-type *OS*]
[\--vcpus *VCPUS*] [\--tags *TAGS*] {*instance*}
Executes a test run of the *iallocator* framework.
......@@ -46,7 +46,7 @@ this framework, see the HTML or PDF documentation.
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
(via an RPC call). This serves no other purpose but to execute a
......@@ -62,8 +62,8 @@ number.
SUBMIT-JOB
~~~~~~~~~~
**submit-job** [--verbose] [--timing-stats] [--job-repeat ``N``]
[--op-repeat ``N``] [--each] {opcodes_file...}
**submit-job** [\--verbose] [\--timing-stats] [\--job-repeat *N*]
[\--op-repeat *N*] [\--each] {opcodes_file...}
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
......@@ -96,8 +96,8 @@ failed jobs deliberately.
LOCKS
~~~~~
| **locks** [--no-headers] [--separator=*SEPARATOR*] [-v]
| [-o *[+]FIELD,...*] [--interval=*SECONDS*]
| **locks** [\--no-headers] [\--separator=*SEPARATOR*] [-v]
| [-o *[+]FIELD,...*] [\--interval=*SECONDS*]
Shows a list of locks in the master daemon.
......
......@@ -59,7 +59,7 @@ information).
LIST
~~~~
**list** [--no-headers] [--separator=*SEPARATOR*]
**list** [\--no-headers] [\--separator=*SEPARATOR*]
[-o *[+]FIELD,...*]
Lists the jobs and their status. By default, the job id, job
......
......@@ -23,12 +23,12 @@ COMMANDS
ADD
~~~
| **add** [--readd] [{-s|--secondary-ip} *secondary\_ip*]
| [{-g|--node-group} *nodegroup*]
| [--master-capable=``yes|no``] [--vm-capable=``yes|no``]
| [--node-parameters *ndparams*]
| [--disk-state *diskstate*]
| [--hypervisor-state *hvstate*]
| **add** [\--readd] [{-s|\--secondary-ip} *secondary\_ip*]
| [{-g|\--node-group} *nodegroup*]
| [\--master-capable=``yes|no``] [\--vm-capable=``yes|no``]
| [\--node-parameters *ndparams*]
| [\--disk-state *diskstate*]
| [\--hypervisor-state *hvstate*]
| {*nodename*}
Adds the given node to the cluster.
......@@ -81,7 +81,7 @@ Example::
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
characters, the entire operation will abort.
......@@ -95,9 +95,9 @@ interpreted as stdin.
EVACUATE
~~~~~~~~
**evacuate** [-f] [--early-release] [--iallocator *NAME* \|
--new-secondary *destination\_node*]
[--primary-only \| --secondary-only] [--early-release] {*node*}
**evacuate** [-f] [\--early-release] [\--iallocator *NAME* \|
\--new-secondary *destination\_node*]
[\--primary-only \| \--secondary-only] [\--early-release] {*node*}
This command will move instances away from the given node. If
``--primary-only`` is given, only primary instances are evacuated, with
......@@ -140,7 +140,7 @@ Example::
FAILOVER
~~~~~~~~
**failover** [-f] [--ignore-consistency] {*node*}
**failover** [-f] [\--ignore-consistency] {*node*}
This command will fail over all instances having the given node as
primary to their secondary nodes. This works only for instances having
......@@ -169,9 +169,9 @@ LIST
~~~~
| **list**
| [--no-headers] [--separator=*SEPARATOR*]
| [--units=*UNITS*] [-v] [{-o|--output} *[+]FIELD,...*]
| [--filter]
| [\--no-headers] [\--separator=*SEPARATOR*]
| [\--units=*UNITS*] [-v] [{-o|\--output} *[+]FIELD,...*]
| [\--filter]
| [node...]
Lists the nodes in the cluster.
......@@ -244,8 +244,8 @@ List the tags of the given node.
MIGRATE
~~~~~~~
**migrate** [-f] [--non-live] [--migration-mode=live\|non-live]
[--ignore-ipolicy] {*node*}
**migrate** [-f] [\--non-live] [\--migration-mode=live\|non-live]
[\--ignore-ipolicy] {*node*}
This command will migrate all instances having the given node as
primary to their secondary nodes. This works only for instances
......@@ -266,15 +266,15 @@ Example::
MODIFY
~~~~~~
| **modify** [-f] [--submit]
| [{-C|--master-candidate} ``yes|no``]
| [{-D|--drained} ``yes|no``] [{-O|--offline} ``yes|no``]
| [--master-capable=``yes|no``] [--vm-capable=``yes|no``] [--auto-promote]
| [{-s|--secondary-ip} *secondary_ip*]
| [--node-parameters *ndparams*]
| [--node-powered=``yes|no``]
| [--hypervisor-state *hvstate*]
| [--disk-state *diskstate*]
| **modify** [-f] [\--submit]
| [{-C|\--master-candidate} ``yes|no``]
| [{-D|\--drained} ``yes|no``] [{-O|\--offline} ``yes|no``]
| [\--master-capable=``yes|no``] [\--vm-capable=``yes|no``] [\--auto-promote]
| [{-s|\--secondary-ip} *secondary_ip*]
| [\--node-parameters *ndparams*]
| [\--node-powered=``yes|no``]
| [\--hypervisor-state *hvstate*]
| [\--disk-state *diskstate*]
| {*node*}
This command changes the role of the node. Each options takes
......@@ -324,7 +324,7 @@ Example::
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
existing on the node, the entire operation will abort.
......@@ -338,8 +338,8 @@ be interpreted as stdin.
VOLUMES
~~~~~~~
| **volumes** [--no-headers] [--human-readable]
| [--separator=*SEPARATOR*] [{-o|--output} *FIELDS*]
| **volumes** [\--no-headers] [\--human-readable]
| [\--separator=*SEPARATOR*] [{-o|\--output} *FIELDS*]
| [*node*...]
Lists all logical volumes and their physical disks from the node(s)
......@@ -391,9 +391,9 @@ Example::
LIST-STORAGE
~~~~~~~~~~~~
| **list-storage** [--no-headers] [--human-readable]
| [--separator=*SEPARATOR*] [--storage-type=*STORAGE\_TYPE*]
| [{-o|--output} *FIELDS*]
| **list-storage** [\--no-headers] [\--human-readable]
| [\--separator=*SEPARATOR*] [\--storage-type=*STORAGE\_TYPE*]
| [{-o|\--output} *FIELDS*]
| [*node*...]
Lists the available storage units and their details for the given
......@@ -476,14 +476,14 @@ Example::
REPAIR-STORAGE
~~~~~~~~~~~~~~
**repair-storage** [--ignore-consistency] {*node*} {*storage-type*}
**repair-storage** [\--ignore-consistency] {*node*} {*storage-type*}
{*volume-name*}
Repairs a storage volume on a node. Only LVM volume groups can be
repaired at this time. They have the storage type "lvm-vg".
On LVM volume groups, **repair-storage** runs "vgreduce
--removemissing".
On LVM volume groups, **repair-storage** runs ``vgreduce
--removemissing``.
......
......@@ -45,7 +45,7 @@ versions, the supported parameters (if any) and their
documentations, etc.
| **modify** [-H *HYPERVISOR*:option=*value*[,...]]
| [--hidden=*yes|no*] [--blacklisted=*yes|no*]
| [\--hidden=*yes|no*] [\--blacklisted=*yes|no*]
| {*OS*}
This command will allow you to modify OS parameters.
......
......@@ -9,9 +9,9 @@ hail - Ganeti IAllocator plugin
SYNOPSIS
--------
**hail** [ **-t** *file* | **--simulate** *spec* ] [options...] *input-file*
**hail** [ **-t** *file* | **\--simulate** *spec* ] [options...] *input-file*
**hail** --version
**hail** \--version
DESCRIPTION
-----------
......@@ -62,22 +62,22 @@ OPTIONS
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
the user to understand the node's most important parameters. See the
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
in the JSON request itself. This is mostly used for debugging. The
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
overriding the cluster data with a simulated cluster. For details
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
saved to a file named *filename.pre-ialloc*, respectively
*filename.post-ialloc*. This allows re-feeding the cluster state to
......
......@@ -11,7 +11,7 @@ SYNOPSIS
**hbal** {backend options...} [algorithm options...] [reporting options...]
**hbal** --version
**hbal** \--version
Backend options:
......@@ -20,24 +20,24 @@ Backend options:
Algorithm options:
**[ --max-cpu *cpu-ratio* ]**
**[ --min-disk *disk-ratio* ]**
**[ \--max-cpu *cpu-ratio* ]**
**[ \--min-disk *disk-ratio* ]**
**[ -l *limit* ]**
**[ -e *score* ]**
**[ -g *delta* ]** **[ --min-gain-limit *threshold* ]**
**[ -g *delta* ]** **[ \--min-gain-limit *threshold* ]**
**[ -O *name...* ]**
**[ --no-disk-moves ]**
**[ --no-instance-moves ]**
**[ \--no-disk-moves ]**
**[ \--no-instance-moves ]**
**[ -U *util-file* ]**
**[ --evac-mode ]**
**[ --select-instances *inst...* ]**
**[ --exclude-instances *inst...* ]**
**[ \--evac-mode ]**
**[ \--select-instances *inst...* ]**
**[ \--exclude-instances *inst...* ]**
Reporting options:
**[ -C[ *file* ] ]**
**[ -p[ *fields* ] ]**
**[ --print-instances ]**
**[ \--print-instances ]**
**[ -o ]**
**[ -v... | -q ]**
......@@ -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
same results when restarting it from the middle of the solution) and
reasonably fast. It is not, however, designed to be a perfect
algorithm--it is possible to make it go into a corner from which
it can find no improvement, because it looks only one "step" ahead.
reasonably fast. It is not, however, designed to be a perfect algorithm:
it is possible to make it go into a corner from which it can find no
improvement, because it looks only one "step" ahead.
By default, the program will show the solution incrementally as it is
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:
- an instance to move onto an offline node (offline nodes are either
read from the cluster or declared with *-O*)
- an exclusion-tag based conflict (exclusion tags are read from the
cluster and/or defined via the *--exclusion-tags* option)
- a max vcpu/pcpu ratio to be exceeded (configured via *--max-cpu*)
cluster and/or defined via the *\--exclusion-tags* option)
- a max vcpu/pcpu ratio to be exceeded (configured via *\--max-cpu*)
- min disk free percentage to go below the configured limit
(configured via *--min-disk*)
(configured via *\--min-disk*)
CLUSTER SCORING
~~~~~~~~~~~~~~~
......@@ -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
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:
--exclusion-tags=a,b
\--exclusion-tags=a,b
This will make all instance tags of the form *a:\**, *b:\** be
considered for the exclusion map
......@@ -198,7 +198,7 @@ OPTIONS
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
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:
parallel (due to resource allocation in Ganeti) and thus we start a
new jobset.
-p, --print-nodes
-p, \--print-nodes
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
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
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:
reported by RAPI as such, or that have "?" in file-based input in
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
the computation in two ways:
......@@ -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
empirically).
-g *delta*, --min-gain=*delta*
-g *delta*, \--min-gain=*delta*
Since the balancing algorithm can sometimes result in just very tiny
improvements, that bring less gain that they cost in relocation
time, this parameter (defaulting to 0.01) represents the minimum
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
is already below *threshold* (defaults to 0.1). The rationale behind
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:
threshold, the total gain is only the threshold value, so we can
exit early.
--no-disk-moves
\--no-disk-moves
This parameter prevents hbal from using disk move
(i.e. "gnt-instance replace-disks") operations. This will result in
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.
--no-instance-moves
\--no-instance-moves
This parameter prevents hbal from using instance moves
(i.e. "gnt-instance migrate/failover") operations. This will only use
the slow disk-replacement operations, and will also provide a worse
balance, but can be useful if moving instances around is deemed unsafe
or not preferred.
--evac-mode
\--evac-mode
This parameter restricts the list of instances considered for moving
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
note that it doesn't guarantee full evacuation.
--select-instances=*instances*
\--select-instances=*instances*
This parameter marks the given instances (as a comma-separated list)
as the only ones being moved during the rebalance.
--exclude-instances=*instances*
\--exclude-instances=*instances*
This parameter marks the given instances (as a comma-separated list)
from being moved during the rebalance.
......@@ -313,7 +313,7 @@ The options that can be passed to the program are as follows:
metrics and thus the influence of the dynamic utilisation will be
practically insignificant.
-S *filename*, --save-cluster=*filename*
-S *filename*, \--save-cluster=*filename*
If given, the state of the cluster before the balancing is saved to
the given file plus the extension "original"
(i.e. *filename*.original), and the state at the end of the
......@@ -321,7 +321,7 @@ The options that can be passed to the program are as follows:
(i.e. *filename*.balanced). This allows re-feeding the cluster state
to either hbal itself or for example hspace via the ``-t`` option.
-t *datafile*, --text-data=*datafile*
-t *datafile*, \--text-data=*datafile*
Backend specification: the name of the file holding node and instance
information (if not collecting via RAPI or LUXI). This or one of the
other backends must be selected. The option is described in the man
......@@ -350,11 +350,11 @@ The options that can be passed to the program are as follows:
The execution of the job series can be interrupted, see below for
signal handling.
-l *N*, --max-length=*N*
-l *N*, \--max-length=*N*
Restrict the solution to this length. This can be used for example
to automate the execution of the balancing.
--max-cpu=*cpu-ratio*
\--max-cpu=*cpu-ratio*
The maximum virtual to physical cpu ratio, as a floating point number
greater than or equal to one. For example, specifying *cpu-ratio* as
**2.5** means that, for a 4-cpu machine, a maximum of 10 virtual cpus
......@@ -364,27 +364,27 @@ The options that can be passed to the program are as follows:
make sense, as that means other resources (e.g. disk) won't be fully
utilised due to CPU restrictions.
--min-disk=*disk-ratio*
\--min-disk=*disk-ratio*
The minimum amount of free disk space remaining, as a floating point
number. For example, specifying *disk-ratio* as **0.25** means that
at least one quarter of disk space should be left free on nodes.
-G *uuid*, --group=*uuid*
-G *uuid*, \--group=*uuid*
On an multi-group cluster, select this group for
processing. Otherwise hbal will abort, since it cannot balance
multiple groups at the same time.
-v, --verbose
-v, \--verbose
Increase the output verbosity. Each usage of this option will
increase the verbosity (currently more than 2 doesn't make sense)
from the default of one.
-q, --quiet
-q, \--quiet
Decrease the output verbosity. Each usage of this option will
decrease the verbosity (less than zero doesn't make sense) from the
default of one.
-V, --version
-V, \--version
Just show the program version and exit.
SIGNAL HANDLING
......
......@@ -12,32 +12,32 @@ SYNOPSIS
**hspace** {backend options...} [algorithm options...] [request options...]
[output options...] [-v... | -q]
**hspace** --version
**hspace** \--version
Backend options:
{ **-m** *cluster* | **-L[** *path* **] [-X]** | **-t** *data-file* |
**--simulate** *spec* }
**\--simulate** *spec* }
Algorithm options:
**[ --max-cpu *cpu-ratio* ]**
**[ --min-disk *disk-ratio* ]**
**[ \--max-cpu *cpu-ratio* ]**
**[ \--min-disk *disk-ratio* ]**
**[ -O *name...* ]**
Request options:
**[--disk-template** *template* **]**
**[\--disk-template** *template* **]**
**[--standard-alloc** *disk,ram,cpu* **]**
**[\--standard-alloc** *disk,ram,cpu* **]**
**[--tiered-alloc** *disk,ram,cpu* **]**
**[\--tiered-alloc** *disk,ram,cpu* **]**
Output options:
**[--machine-readable**[=*CHOICE*] **]**
**[\--machine-readable**[=*CHOICE*] **]**
**[-p**[*fields*]**]**
......@@ -105,7 +105,7 @@ INI_MEM_INST, FIN_MEM_INST
RAM).
INI_MEM_OVERHEAD, FIN_MEM_OVERHEAD
The initial and final memory overhead--memory used for the node
The initial and final memory overhead, i.e. memory used for the node
itself and unacounted memory (e.g. due to hypervisor overhead).
INI_MEM_EFF, HTS_INI_MEM_EFF
......@@ -162,7 +162,7 @@ KM_UNAV_CPU, KM_POOL_NPU, KM_UNAV_MEM, KM_UNAV_DSK
example, the cluster might still have 100GiB disk free, but with no
memory left for instances, we cannot allocate another instance, so
in effect the disk space is unallocable. Note that the CPUs here
represent instance virtual CPUs, and in case the *--max-cpu* option
represent instance virtual CPUs, and in case the *\--max-cpu* option
hasn't been specified this will be -1.
ALLOC_USAGE
......@@ -202,12 +202,12 @@ OPTIONS
The options that can be passed to the program are as follows:
--disk-template *template*
\--disk-template *template*
Overrides the disk template for the instance read from the cluster;
one of the Ganeti disk templates (e.g. plain, drbd, so on) should be
passed in.
--max-cpu=*cpu-ratio*
\--max-cpu=*cpu-ratio*
The maximum virtual to physical cpu ratio, as a floating point number
greater than or equal to one. For example, specifying *cpu-ratio* as
**2.5** means that, for a 4-cpu machine, a maximum of 10 virtual cpus
......@@ -217,17 +217,17 @@ The options that can be passed to the program are as follows:
make sense, as that means other resources (e.g. disk) won't be fully
utilised due to CPU restrictions.
--min-disk=*disk-ratio*
\--min-disk=*disk-ratio*
The minimum amount of free disk space remaining, as a floating point
number. For example, specifying *disk-ratio* as **0.25** means that
at least one quarter of disk space should be left free on nodes.
-l *rounds*, --max-length=*rounds*
-l *rounds*, \--max-length=*rounds*
Restrict the number of instance allocations to this length. This is
not very useful in practice, but can be used for testing hspace
itself, or to limit the runtime for very big clusters.
-p, --print-nodes
-p, \--print-nodes
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
man page **htools**(1) for more details about this option.
......@@ -246,7 +246,7 @@ The options that can be passed to the program are as follows:
are reported by RAPI as such, or that have "?" in file-based input
in any numeric fields.
-S *filename*, --save-cluster=*filename*
-S *filename*, \--save-cluster=*filename*
If given, the state of the cluster at the end of the allocation is
saved to a file named *filename.alloc*, and if tiered allocation is
enabled, the state after tiered allocation will be saved to
......@@ -254,7 +254,7 @@ The options that can be passed to the program are as follows:
either hspace itself (with different parameters) or for example
hbal, via the ``-t`` option.
-t *datafile*, --text-data=*datafile*
-t *datafile*, \--text-data=*datafile*
Backend specification: the name of the file holding node and instance
information (if not collecting via RAPI or LUXI). This or one of the
other backends must be selected. The option is described in the man
......@@ -270,17 +270,17 @@ The options that can be passed to the program are as follows:
which is to be contacted via LUXI (an internal Ganeti protocol). The
option is described in the man page **htools**(1).
--simulate *description*
\--simulate *description*
Backend specification: similar to the **-t** option, this allows
overriding the cluster data with a simulated cluster. For details
about the description, see the man page **htools**(1).
--standard-alloc *disk,ram,cpu*
\--standard-alloc *disk,ram,cpu*
This option overrides the instance size read from the cluster for the
*standard* allocation mode, where we simply allocate instances of the
same, fixed size until the cluster runs out of space.
The specification given is similar to the *--simulate* option and it
The specification given is similar to the *\--simulate* option and it
holds:
- the disk size of the instance (units can be used)
......@@ -290,7 +290,7 @@ The options that can be passed to the program are as follows:
An example description would be *100G,4g,2* describing an instance
specification of 100GB of disk space, 4GiB of memory and 2 VCPUs.
--tiered-alloc *disk,ram,cpu*
\--tiered-alloc *disk,ram,cpu*
This option overrides the instance size for the *tiered* allocation
mode. In this mode, the algorithm starts from the given specification
and allocates until there is no more space; then it decreases the
......@@ -303,24 +303,24 @@ The options that can be passed to the program are as follows:
the instance count for these two modes are not related one to
another.
--machine-readable[=*choice*]
\--machine-readable[=*choice*]
By default, the output of the program is in "human-readable" format,
i.e. text descriptions. By passing this flag you can either enable
(``--machine-readable`` or ``--machine-readable=yes``) or explicitly
disable (``--machine-readable=no``) the machine readable format
described above.
-v, --verbose
-v, \--verbose
Increase the output verbosity. Each usage of this option will
increase the verbosity (currently more than 2 doesn't make sense)
from the default of one.
-q, --quiet
-q, \--quiet