Revision be468da0 man/hspace.rst

b/man/hspace.rst
44 44
DESCRIPTION
45 45
-----------
46 46

  
47

  
48 47
hspace computes how many additional instances can be fit on a cluster,
49 48
while maintaining N+1 status.
50 49

  
......
61 60
output the additional information on stderr (such that the stdout is
62 61
still parseable).
63 62

  
63
By default, the instance specifications will be read from the cluster;
64
the options ``--standard-alloc`` and ``--tiered-alloc`` can be used to
65
override them.
66

  
64 67
The following keys are available in the machine-readable output of the
65 68
script (all prefixed with *HTS_*):
66 69

  
......
132 135
  Like the above but for disk.
133 136

  
134 137
TSPEC
135
  If the tiered allocation mode has been enabled, this parameter holds
136
  the pairs of specifications and counts of instances that can be
137
  created in this mode. The value of the key is a space-separated list
138
  of values; each value is of the form *memory,disk,vcpu=count* where
139
  the memory, disk and vcpu are the values for the current spec, and
140
  count is how many instances of this spec can be created. A complete
141
  value for this variable could be: **4096,102400,2=225
142
  2560,102400,2=20 512,102400,2=21**.
138
  This parameter holds the pairs of specifications and counts of
139
  instances that can be created in the *tiered allocation* mode. The
140
  value of the key is a space-separated list of values; each value is of
141
  the form *memory,disk,vcpu=count* where the memory, disk and vcpu are
142
  the values for the current spec, and count is how many instances of
143
  this spec can be created. A complete value for this variable could be:
144
  **4096,102400,2=225 2560,102400,2=20 512,102400,2=21**.
143 145

  
144 146
KM_USED_CPU, KM_USED_NPU, KM_USED_MEM, KM_USED_DSK
145 147
  These represents the metrics of used resources at the start of the
......
189 191
  that the computation failed and any values present should not be
190 192
  relied upon.
191 193

  
192
If the tiered allocation mode is enabled, then many of the INI_/FIN_
193
metrics will be also displayed with a TRL_ prefix, and denote the
194
cluster status at the end of the tiered allocation run.
194
Many of the INI_/FIN_ metrics will be also displayed with a TRL_ prefix,
195
and denote the cluster status at the end of the tiered allocation run.
195 196

  
196 197
The human output format should be self-explanatory, so it is not
197 198
described further.
......
274 275
  about the description, see the man page **htools**(1).
275 276

  
276 277
--standard-alloc *disk,ram,cpu*
277
  This option specifies the instance size for the *standard* allocation
278
  mode, where we simply allocate instances of the same, fixed size until
279
  the cluster runs out of space.
278
  This option overrides the instance size read from the cluster for the
279
  *standard* allocation mode, where we simply allocate instances of the
280
  same, fixed size until the cluster runs out of space.
280 281

  
281 282
  The specification given is similar to the *--simulate* option and it
282 283
  holds:
......
289 290
  specification of 100GB of disk space, 4GiB of memory and 2 VCPUs.
290 291

  
291 292
--tiered-alloc *disk,ram,cpu*
292
  Besides the standard, fixed-size allocation, also do a tiered
293
  allocation scheme where the algorithm starts from the given
294
  specification and allocates until there is no more space; then it
295
  decreases the specification and tries the allocation again. The
296
  decrease is done on the metric that last failed during allocation. The
297
  argument should have the same format as for ``-standard-alloc``.
293
  This option overrides the instance size for the *tiered* allocation
294
  mode. In this mode, the algorithm starts from the given specification
295
  and allocates until there is no more space; then it decreases the
296
  specification and tries the allocation again. The decrease is done on
297
  the metric that last failed during allocation. The argument should
298
  have the same format as for ``--standard-alloc``.
298 299

  
299 300
  Also note that the normal allocation and the tiered allocation are
300 301
  independent, and both start from the initial cluster state; as such,
301 302
  the instance count for these two modes are not related one to
302 303
  another.
303 304

  
304
--machines-readable[=*choice*]
305
--machine-readable[=*choice*]
305 306
  By default, the output of the program is in "human-readable" format,
306 307
  i.e. text descriptions. By passing this flag you can either enable
307 308
  (``--machine-readable`` or ``--machine-readable=yes``) or explicitly

Also available in: Unified diff