Revision f624fa95 man/hspace.rst

b/man/hspace.rst
12 12
**hspace** {backend options...} [algorithm options...] [request options...]
13 13
[output options...] [-v... | -q]
14 14

  
15
**hspace** --version
15
**hspace** \--version
16 16

  
17 17
Backend options:
18 18

  
19 19
{ **-m** *cluster* | **-L[** *path* **] [-X]** | **-t** *data-file* |
20
**--simulate** *spec* }
20
**\--simulate** *spec* }
21 21

  
22 22

  
23 23
Algorithm options:
24 24

  
25
**[ --max-cpu *cpu-ratio* ]**
26
**[ --min-disk *disk-ratio* ]**
25
**[ \--max-cpu *cpu-ratio* ]**
26
**[ \--min-disk *disk-ratio* ]**
27 27
**[ -O *name...* ]**
28 28

  
29 29

  
30 30
Request options:
31 31

  
32
**[--disk-template** *template* **]**
32
**[\--disk-template** *template* **]**
33 33

  
34
**[--standard-alloc** *disk,ram,cpu*  **]**
34
**[\--standard-alloc** *disk,ram,cpu*  **]**
35 35

  
36
**[--tiered-alloc** *disk,ram,cpu* **]**
36
**[\--tiered-alloc** *disk,ram,cpu* **]**
37 37

  
38 38
Output options:
39 39

  
40
**[--machine-readable**[=*CHOICE*] **]**
40
**[\--machine-readable**[=*CHOICE*] **]**
41 41
**[-p**[*fields*]**]**
42 42

  
43 43

  
......
105 105
  RAM).
106 106

  
107 107
INI_MEM_OVERHEAD, FIN_MEM_OVERHEAD
108
  The initial and final memory overhead--memory used for the node
108
  The initial and final memory overhead, i.e. memory used for the node
109 109
  itself and unacounted memory (e.g. due to hypervisor overhead).
110 110

  
111 111
INI_MEM_EFF, HTS_INI_MEM_EFF
......
162 162
  example, the cluster might still have 100GiB disk free, but with no
163 163
  memory left for instances, we cannot allocate another instance, so
164 164
  in effect the disk space is unallocable. Note that the CPUs here
165
  represent instance virtual CPUs, and in case the *--max-cpu* option
165
  represent instance virtual CPUs, and in case the *\--max-cpu* option
166 166
  hasn't been specified this will be -1.
167 167

  
168 168
ALLOC_USAGE
......
202 202

  
203 203
The options that can be passed to the program are as follows:
204 204

  
205
--disk-template *template*
205
\--disk-template *template*
206 206
  Overrides the disk template for the instance read from the cluster;
207 207
  one of the Ganeti disk templates (e.g. plain, drbd, so on) should be
208 208
  passed in.
209 209

  
210
--max-cpu=*cpu-ratio*
210
\--max-cpu=*cpu-ratio*
211 211
  The maximum virtual to physical cpu ratio, as a floating point number
212 212
  greater than or equal to one. For example, specifying *cpu-ratio* as
213 213
  **2.5** means that, for a 4-cpu machine, a maximum of 10 virtual cpus
......
217 217
  make sense, as that means other resources (e.g. disk) won't be fully
218 218
  utilised due to CPU restrictions.
219 219

  
220
--min-disk=*disk-ratio*
220
\--min-disk=*disk-ratio*
221 221
  The minimum amount of free disk space remaining, as a floating point
222 222
  number. For example, specifying *disk-ratio* as **0.25** means that
223 223
  at least one quarter of disk space should be left free on nodes.
224 224

  
225
-l *rounds*, --max-length=*rounds*
225
-l *rounds*, \--max-length=*rounds*
226 226
  Restrict the number of instance allocations to this length. This is
227 227
  not very useful in practice, but can be used for testing hspace
228 228
  itself, or to limit the runtime for very big clusters.
229 229

  
230
-p, --print-nodes
230
-p, \--print-nodes
231 231
  Prints the before and after node status, in a format designed to allow
232 232
  the user to understand the node's most important parameters. See the
233 233
  man page **htools**(1) for more details about this option.
......
246 246
  are reported by RAPI as such, or that have "?" in file-based input
247 247
  in any numeric fields.
248 248

  
249
-S *filename*, --save-cluster=*filename*
249
-S *filename*, \--save-cluster=*filename*
250 250
  If given, the state of the cluster at the end of the allocation is
251 251
  saved to a file named *filename.alloc*, and if tiered allocation is
252 252
  enabled, the state after tiered allocation will be saved to
......
254 254
  either hspace itself (with different parameters) or for example
255 255
  hbal, via the ``-t`` option.
256 256

  
257
-t *datafile*, --text-data=*datafile*
257
-t *datafile*, \--text-data=*datafile*
258 258
  Backend specification: the name of the file holding node and instance
259 259
  information (if not collecting via RAPI or LUXI). This or one of the
260 260
  other backends must be selected. The option is described in the man
......
270 270
  which is to be contacted via LUXI (an internal Ganeti protocol). The
271 271
  option is described in the man page **htools**(1).
272 272

  
273
--simulate *description*
273
\--simulate *description*
274 274
  Backend specification: similar to the **-t** option, this allows
275 275
  overriding the cluster data with a simulated cluster. For details
276 276
  about the description, see the man page **htools**(1).
277 277

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

  
283
  The specification given is similar to the *--simulate* option and it
283
  The specification given is similar to the *\--simulate* option and it
284 284
  holds:
285 285

  
286 286
  - the disk size of the instance (units can be used)
......
290 290
  An example description would be *100G,4g,2* describing an instance
291 291
  specification of 100GB of disk space, 4GiB of memory and 2 VCPUs.
292 292

  
293
--tiered-alloc *disk,ram,cpu*
293
\--tiered-alloc *disk,ram,cpu*
294 294
  This option overrides the instance size for the *tiered* allocation
295 295
  mode. In this mode, the algorithm starts from the given specification
296 296
  and allocates until there is no more space; then it decreases the
......
303 303
  the instance count for these two modes are not related one to
304 304
  another.
305 305

  
306
--machine-readable[=*choice*]
306
\--machine-readable[=*choice*]
307 307
  By default, the output of the program is in "human-readable" format,
308 308
  i.e. text descriptions. By passing this flag you can either enable
309 309
  (``--machine-readable`` or ``--machine-readable=yes``) or explicitly
310 310
  disable (``--machine-readable=no``) the machine readable format
311 311
  described above.
312 312

  
313
-v, --verbose
313
-v, \--verbose
314 314
  Increase the output verbosity. Each usage of this option will
315 315
  increase the verbosity (currently more than 2 doesn't make sense)
316 316
  from the default of one.
317 317

  
318
-q, --quiet
318
-q, \--quiet
319 319
  Decrease the output verbosity. Each usage of this option will
320 320
  decrease the verbosity (less than zero doesn't make sense) from the
321 321
  default of one.
322 322

  
323
-V, --version
323
-V, \--version
324 324
  Just show the program version and exit.
325 325

  
326 326
UNITS

Also available in: Unified diff