Revision 1cd133d6 hspace.1

b/hspace.1
50 50

  
51 51
The output of the program is designed to interpreted as a shell
52 52
fragment (or parsed as a \fIkey=value\fR file). Options which extend
53
the output (e.g. -p, -v) will output the additional information on
53
the output (e.g. \-p, \-v) will output the additional information on
54 54
stderr (such that the stdout is still parseable).
55 55

  
56 56
The following keys are available in the output of the script (all
......
97 97

  
98 98
.TP
99 99
.I INI_MEM_OVERHEAD, FIN_MEM_OVERHEAD
100
The initial and final memory overhead - memory used for the node
100
The initial and final memory overhead \(em memory used for the node
101 101
itself and unacounted memory (e.g. due to hypervisor overhead).
102 102

  
103 103
.TP
......
124 124

  
125 125
.TP
126 126
.I INI_MNODE_MEM_AVAIL, FIN_MNODE_MEM_AVAIL
127
The initial and final maximum per-node available memory. This is not
127
The initial and final maximum per\(hynode available memory. This is not
128 128
very useful as a metric but can give an impression of the status of
129 129
the nodes; as an example, this value restricts the maximum instance
130 130
size that can be still created on the cluster.
......
137 137
.I TSPEC
138 138
If the tiered allocation mode has been enabled, this parameter holds
139 139
the pairs of specifications and counts of instances that can be
140
created in this mode. The value of the key is a space-separated list
140
created in this mode. The value of the key is a space\(hyseparated list
141 141
of values; each value is of the form \fImemory,disk,vcpu=count\fR
142 142
where the memory, disk and vcpu are the values for the current spec,
143 143
and count is how many instances of this spec can be created. A
......
203 203

  
204 204
.TP
205 205
.BI "--max-cpu " cpu-ratio
206
The maximum virtual-to-physical cpu ratio, as a floating point number
207
between zero and one. For example, specifying \fIcpu-ratio\fR as
208
\fB2.5\fR means that, for a 4-cpu machine, a maximum of 10 virtual
209
cpus should be allowed to be in use for primary instances. A value of
210
one doesn't make sense though, as that means no disk space can be used
211
on it.
206
The maximum virtual\(hyto\(hyphysical cpu ratio, as a floating point
207
number between zero and one. For example, specifying \fIcpu-ratio\fR
208
as \fB2.5\fR means that, for a 4\(hycpu machine, a maximum of 10
209
virtual cpus should be allowed to be in use for primary instances. A
210
value of one doesn't make sense though, as that means no disk space
211
can be used on it.
212 212

  
213 213
.TP
214 214
.BI "--min-disk " disk-ratio
......
222 222
the user to understand the node's most important parameters.
223 223

  
224 224
It is possible to customise the listed information by passing a
225
comma-separated list of field names to this option (the field list is
225
comma\(hyseparated list of field names to this option (the field list is
226 226
currently undocumented). By default, the node list will contain these
227 227
informations:
228 228
.RS
229 229
.TP
230 230
.B F
231
a character denoting the status of the node, with '-' meaning an
231
a character denoting the status of the node, with '\-' meaning an
232 232
offline node, '*' meaning N+1 failure and blank meaning a good node
233 233
.TP
234 234
.B Name
......
301 301
being \fIoffline\fR, and instances won't be placed on these nodes.
302 302

  
303 303
Note that hspace will also mark as offline any nodes which are
304
reported by RAPI as such, or that have "?" in file-based input in any
304
reported by RAPI as such, or that have "?" in file\(hybased input in any
305 305
numeric fields.
306 306
.RE
307 307

  
......
322 322
Collect data not from files but directly from the
323 323
.I cluster
324 324
given as an argument via RAPI. If the argument doesn't contain a colon
325
(:), then it is converted into a fully-built URL via prepending
325
(:), then it is converted into a fully\(hybuilt URL via prepending
326 326
https:// and appending the default RAPI port, otherwise it's
327
considered a fully-specified URL and is used as-is.
327
considered a fully\(hyspecified URL and is used as\(hyis.
328 328

  
329 329
.TP
330 330
.BI "-L[" path "]"
......
332 332
is to be contacted via the luxi (an internal Ganeti protocol). An
333 333
optional \fIpath\fR argument is interpreted as the path to the unix
334 334
socket on which the master daemon listens; otherwise, the default path
335
used by ganeti when installed with "--localstatedir=/var" is used.
335
used by ganeti when installed with \fI--localstatedir=/var\fR is used.
336 336

  
337 337
.TP
338 338
.BI "--simulate " description
339 339
Instead of using actual data, build an empty cluster given a node
340
description. The \fIdescription\fR parameter must be a comma-separated
341
list of four elements, describing in order:
340
description. The \fIdescription\fR parameter must be a
341
comma\(hyseparated list of four elements, describing in order:
342 342

  
343 343
.RS
344 344

  
......
358 358
.RE
359 359

  
360 360
An example description would be \fB20,102400,16384,4\fR describing a
361
20-node cluster where each node has 100GiB of disk space, 16GiB of
361
20\(hynode cluster where each node has 100GiB of disk space, 16GiB of
362 362
memory and 4 CPU cores. Note that all nodes must have the same specs
363 363
currently.
364 364

  
......
366 366

  
367 367
.TP
368 368
.BI "--tiered-alloc " spec
369
Beside the standard, fixed-size allocation, also do a tiered
369
Beside the standard, fixed\(hysize allocation, also do a tiered
370 370
allocation scheme where the algorithm starts from the given
371 371
specification and allocates until there is no more space; then it
372 372
decreases the specification and tries the allocation again. The
373 373
decrease is done on the matric that last failed during allocation. The
374
specification given is similar to the "--simulate" option and it
374
specification given is similar to the \fI--simulate\fR option and it
375 375
holds:
376 376

  
377 377
.RS

Also available in: Unified diff