**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* | **-I** *path* }
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*]**]**
DESCRIPTION
-----------
-
hspace computes how many additional instances can be fit on a cluster,
while maintaining N+1 status.
output the additional information on stderr (such that the stdout is
still parseable).
+By default, the instance specifications will be read from the cluster;
+the options ``--standard-alloc`` and ``--tiered-alloc`` can be used to
+override them.
+
The following keys are available in the machine-readable output of the
script (all prefixed with *HTS_*):
RAM).
INI_MEM_OVERHEAD, FIN_MEM_OVERHEAD
- The initial and final memory overhead--memory used for the node
- itself and unacounted memory (e.g. due to hypervisor overhead).
+ The initial and final memory overhead, i.e. memory used for the node
+ itself and unaccounted memory (e.g. due to hypervisor overhead).
INI_MEM_EFF, HTS_INI_MEM_EFF
The initial and final memory efficiency, represented as instance
Like the above but for disk.
TSPEC
- If the tiered allocation mode has been enabled, this parameter holds
- the pairs of specifications and counts of instances that can be
- created in this mode. The value of the key is a space-separated list
- of values; each value is of the form *memory,disk,vcpu=count* where
- the memory, disk and vcpu are the values for the current spec, and
- count is how many instances of this spec can be created. A complete
- value for this variable could be: **4096,102400,2=225
- 2560,102400,2=20 512,102400,2=21**.
+ This parameter holds the pairs of specifications and counts of
+ instances that can be created in the *tiered allocation* mode. The
+ value of the key is a space-separated list of values; each value is of
+ the form *memory,disk,vcpu=count* where the memory, disk and vcpu are
+ the values for the current spec, and count is how many instances of
+ this spec can be created. A complete value for this variable could be:
+ **4096,102400,2=225 2560,102400,2=20 512,102400,2=21**.
KM_USED_CPU, KM_USED_NPU, KM_USED_MEM, KM_USED_DSK
These represents the metrics of used resources at the start of the
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
that the computation failed and any values present should not be
relied upon.
-If the tiered allocation mode is enabled, then many of the INI_/FIN_
-metrics will be also displayed with a TRL_ prefix, and denote the
-cluster status at the end of the tiered allocation run.
+Many of the ``INI_``/``FIN_`` metrics will be also displayed with a
+``TRL_`` prefix, and denote the cluster status at the end of the tiered
+allocation run.
The human output format should be self-explanatory, so it is not
described further.
The options that can be passed to the program are as follows:
---disk-template *template*
- The disk template for the instance; one of the Ganeti disk templates
- (e.g. plain, drbd, so on) should be passed in.
+\--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.
+
+\--spindle-use *spindles*
+ Override the spindle use for the instance read from the cluster. The
+ value can be 0 (for example for instances that use very low I/O), but not
+ negative. For shared storage the value is ignored.
---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
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.
+ man page **htools**\(1) for more details about this option.
-O *name*
This option (which can be given multiple times) will mark nodes as
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
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
- page **htools**(1).
+ page **htools**\(1).
-m *cluster*
Backend specification: collect data directly from the *cluster* given
as an argument via RAPI. The option is described in the man page
- **htools**(1).
+ **htools**\(1).
-L [*path*]
Backend specification: collect data directly from the master daemon,
which is to be contacted via LUXI (an internal Ganeti protocol). The
- option is described in the man page **htools**(1).
+ 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).
+ about the description, see the man page **htools**\(1).
---standard-alloc *disk,ram,cpu*
- This option specifies the instance size for the *standard* allocation
- mode, where we simply allocate instances of the same, fixed size until
- the cluster runs out of space.
+\--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)
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*
- Besides the standard, fixed-size allocation, also do a tiered
- allocation scheme where the algorithm starts from the given
- specification and allocates until there is no more space; then it
- decreases the specification and tries the allocation again. The
- decrease is done on the metric that last failed during allocation. The
- argument should have the same format as for ``-standard-alloc``.
+\--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
+ specification and tries the allocation again. The decrease is done on
+ the metric that last failed during allocation. The argument should
+ have the same format as for ``--standard-alloc``.
Also note that the normal allocation and the tiered allocation are
independent, and both start from the initial cluster state; as such,
the instance count for these two modes are not related one to
another.
---machines-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
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.
UNITS
*MB*, *GB*, *TB*, for which case doesn't matter).
More details about the difference between the SI and binary systems can
-be read in the *units(7)* man page.
+be read in the **units**\(7) man page.
EXIT STATUS
-----------
projects / ganeti-local / blobdiff