root / hspace.1 @ 691dcd2a
History | View | Annotate | Download (13.5 kB)
1 |
.TH HSPACE 1 2009-06-01 htools "Ganeti H-tools" |
---|---|
2 |
.SH NAME |
3 |
hspace \- Cluster space analyzer for Ganeti |
4 |
|
5 |
.SH SYNOPSIS |
6 |
.B hspace |
7 |
.B "[backend options...]" |
8 |
.B "[algorithm options...]" |
9 |
.B "[request options..."] |
10 |
.BI "[ -p[" fields "] ]" |
11 |
.B "[-v... | -q]" |
12 |
|
13 |
.B hspace |
14 |
.B --version |
15 |
|
16 |
.TP |
17 |
Backend options: |
18 |
.BI " -m " cluster |
19 |
| |
20 |
.BI " -L[" path "]" |
21 |
| |
22 |
.BI " -t " data-file |
23 |
| |
24 |
.BI " --simulate " spec |
25 |
|
26 |
.TP |
27 |
Algorithm options: |
28 |
.BI "[ --max-cpu " cpu-ratio " ]" |
29 |
.BI "[ --min-disk " disk-ratio " ]" |
30 |
.BI "[ -O " name... " ]" |
31 |
|
32 |
.TP |
33 |
Request options: |
34 |
.BI "[--memory " mem "]" |
35 |
.BI "[--disk " disk "]" |
36 |
.BI "[--req-nodes " req-nodes "]" |
37 |
.BI "[--vcpus " vcpus "]" |
38 |
.BI "[--tiered-alloc " spec "]" |
39 |
|
40 |
|
41 |
.SH DESCRIPTION |
42 |
hspace computes how many additional instances can be fit on a cluster, |
43 |
while maintaining N+1 status. |
44 |
|
45 |
The program will try to place instances, all of the same size, on the |
46 |
cluster, until the point where we don't have any N+1 possible |
47 |
allocation. It uses the exact same allocation algorithm as the hail |
48 |
iallocator plugin. |
49 |
|
50 |
The output of the program is designed to interpreted as a shell |
51 |
fragment (or parsed as a \fIkey=value\fR file). Options which extend |
52 |
the output (e.g. \-p, \-v) will output the additional information on |
53 |
stderr (such that the stdout is still parseable). |
54 |
|
55 |
The following keys are available in the output of the script (all |
56 |
prefixed with \fIHTS_\fR): |
57 |
.TP |
58 |
.I SPEC_MEM, SPEC_DSK, SPEC_CPU, SPEC_RQN |
59 |
These represent the specifications of the instance model used for |
60 |
allocation (the memory, disk, cpu, requested nodes). |
61 |
|
62 |
.TP |
63 |
.I CLUSTER_MEM, CLUSTER_DSK, CLUSTER_CPU, CLUSTER_NODES |
64 |
These represent the total memory, disk, CPU count and total nodes in |
65 |
the cluster. |
66 |
|
67 |
.TP |
68 |
.I INI_SCORE, FIN_SCORE |
69 |
These are the initial (current) and final cluster score (see the hbal |
70 |
man page for details about the scoring algorithm). |
71 |
|
72 |
.TP |
73 |
.I INI_INST_CNT, FIN_INST_CNT |
74 |
The initial and final instance count. |
75 |
|
76 |
.TP |
77 |
.I INI_MEM_FREE, FIN_MEM_FREE |
78 |
The initial and final total free memory in the cluster (but this |
79 |
doesn't necessarily mean available for use). |
80 |
|
81 |
.TP |
82 |
.I INI_MEM_AVAIL, FIN_MEM_AVAIL |
83 |
The initial and final total available memory for allocation in the |
84 |
cluster. If allocating redundant instances, new instances could |
85 |
increase the reserved memory so it doesn't necessarily mean the |
86 |
entirety of this memory can be used for new instance allocations. |
87 |
|
88 |
.TP |
89 |
.I INI_MEM_RESVD, FIN_MEM_RESVD |
90 |
The initial and final reserved memory (for redundancy/N+1 purposes). |
91 |
|
92 |
.TP |
93 |
.I INI_MEM_INST, FIN_MEM_INST |
94 |
The initial and final memory used for instances (actual runtime used |
95 |
RAM). |
96 |
|
97 |
.TP |
98 |
.I INI_MEM_OVERHEAD, FIN_MEM_OVERHEAD |
99 |
The initial and final memory overhead \(em memory used for the node |
100 |
itself and unacounted memory (e.g. due to hypervisor overhead). |
101 |
|
102 |
.TP |
103 |
.I INI_MEM_EFF, HTS_INI_MEM_EFF |
104 |
The initial and final memory efficiency, represented as instance |
105 |
memory divided by total memory. |
106 |
|
107 |
.TP |
108 |
.I INI_DSK_FREE, INI_DSK_AVAIL, INI_DSK_RESVD, INI_DSK_INST, INI_DSK_EFF |
109 |
Initial disk stats, similar to the memory ones. |
110 |
|
111 |
.TP |
112 |
.I FIN_DSK_FREE, FIN_DSK_AVAIL, FIN_DSK_RESVD, FIN_DSK_INST, FIN_DSK_EFF |
113 |
Final disk stats, similar to the memory ones. |
114 |
|
115 |
.TP |
116 |
.I INI_CPU_INST, FIN_CPU_INST |
117 |
Initial and final number of virtual CPUs used by instances. |
118 |
|
119 |
.TP |
120 |
.I INI_CPU_EFF, FIN_CPU_EFF |
121 |
The initial and final CPU efficiency, represented as the count of |
122 |
virtual instance CPUs divided by the total physical CPU count. |
123 |
|
124 |
.TP |
125 |
.I INI_MNODE_MEM_AVAIL, FIN_MNODE_MEM_AVAIL |
126 |
The initial and final maximum per\(hynode available memory. This is not |
127 |
very useful as a metric but can give an impression of the status of |
128 |
the nodes; as an example, this value restricts the maximum instance |
129 |
size that can be still created on the cluster. |
130 |
|
131 |
.TP |
132 |
.I INI_MNODE_DSK_AVAIL, FIN_MNODE_DSK_AVAIL |
133 |
Like the above but for disk. |
134 |
|
135 |
.TP |
136 |
.I TSPEC |
137 |
If the tiered allocation mode has been enabled, this parameter holds |
138 |
the pairs of specifications and counts of instances that can be |
139 |
created in this mode. The value of the key is a space\(hyseparated list |
140 |
of values; each value is of the form \fImemory,disk,vcpu=count\fR |
141 |
where the memory, disk and vcpu are the values for the current spec, |
142 |
and count is how many instances of this spec can be created. A |
143 |
complete value for this variable could be: \fB4096,102400,2=225 |
144 |
2560,102400,2=20 512,102400,2=21\fR. |
145 |
|
146 |
.TP |
147 |
.I KM_USED_CPU, KM_USED_MEM, KM_USED_DSK |
148 |
These represents the metrics of used resources at the start of the |
149 |
computation (only for tiered allocation mode). |
150 |
|
151 |
.TP |
152 |
.I KM_POOL_CPU, KM_POOL_MEM, KM_POOL_DSK |
153 |
These represents the total resources allocated during the tiered |
154 |
allocation process. In effect, they represent how much is readily |
155 |
available for allocation. |
156 |
|
157 |
.TP |
158 |
.I KM_UNAV_CPU, KM_UNAV_MEM, KM_UNAV_DSK |
159 |
These represents the resources left over (either free as in |
160 |
unallocable or allocable on their own) after the tiered allocation has |
161 |
been completed. They represent better the actual unallocable |
162 |
resources, because some other resource has been exhausted. For |
163 |
example, the cluster might still have 100GiB disk free, but with no |
164 |
memory left for instances, we cannot allocate another instance, so in |
165 |
effect the disk space is unallocable. Note that the CPUs here |
166 |
represent instance virtual CPUs, and in case the \fI--max-cpu\fR |
167 |
option hasn't been specified this will be -1. |
168 |
|
169 |
.TP |
170 |
.I ALLOC_USAGE |
171 |
The current usage represented as initial number of instances divided |
172 |
per final number of instances. |
173 |
|
174 |
.TP |
175 |
.I ALLOC_COUNT |
176 |
The number of instances allocated (delta between FIN_INST_CNT and |
177 |
INI_INST_CNT). |
178 |
|
179 |
.TP |
180 |
.I ALLOC_FAIL*_CNT |
181 |
For the last attemp at allocations (which would have increased |
182 |
FIN_INST_CNT with one, if it had succeeded), this is the count of the |
183 |
failure reasons per failure type; currently defined are FAILMEM, |
184 |
FAILDISK and FAILCPU which represent errors due to not enough memory, |
185 |
disk and CPUs, and FAILN1 which represents a non N+1 compliant cluster |
186 |
on which we can't allocate instances at all. |
187 |
|
188 |
.TP |
189 |
.I ALLOC_FAIL_REASON |
190 |
The reason for most of the failures, being one of the above FAIL* |
191 |
strings. |
192 |
|
193 |
.TP |
194 |
.I OK |
195 |
A marker representing the successful end of the computation, and |
196 |
having value "1". If this key is not present in the output it means |
197 |
that the computation failed and any values present should not be |
198 |
relied upon. |
199 |
|
200 |
.PP |
201 |
|
202 |
If the tiered allocation mode is enabled, then many of the INI_/FIN_ |
203 |
metrics will be also displayed with a TRL_ prefix, and denote the |
204 |
cluster status at the end of the tiered allocation run. |
205 |
|
206 |
.SH OPTIONS |
207 |
The options that can be passed to the program are as follows: |
208 |
|
209 |
.TP |
210 |
.BI "--memory " mem |
211 |
The memory size of the instances to be placed (defaults to 4GiB). |
212 |
|
213 |
.TP |
214 |
.BI "--disk " disk |
215 |
The disk size of the instances to be placed (defaults to 100GiB). |
216 |
|
217 |
.TP |
218 |
.BI "--req-nodes " num-nodes |
219 |
The number of nodes for the instances; the default of two means |
220 |
mirrored instances, while passing one means plain type instances. |
221 |
|
222 |
.TP |
223 |
.BI "--vcpus " vcpus |
224 |
The number of VCPUs of the instances to be placed (defaults to 1). |
225 |
|
226 |
.TP |
227 |
.BI "--max-cpu " cpu-ratio |
228 |
The maximum virtual\(hyto\(hyphysical cpu ratio, as a floating point |
229 |
number between zero and one. For example, specifying \fIcpu-ratio\fR |
230 |
as \fB2.5\fR means that, for a 4\(hycpu machine, a maximum of 10 |
231 |
virtual cpus should be allowed to be in use for primary instances. A |
232 |
value of one doesn't make sense though, as that means no disk space |
233 |
can be used on it. |
234 |
|
235 |
.TP |
236 |
.BI "--min-disk " disk-ratio |
237 |
The minimum amount of free disk space remaining, as a floating point |
238 |
number. For example, specifying \fIdisk-ratio\fR as \fB0.25\fR means |
239 |
that at least one quarter of disk space should be left free on nodes. |
240 |
|
241 |
.TP |
242 |
.B -p, --print-nodes |
243 |
Prints the before and after node status, in a format designed to allow |
244 |
the user to understand the node's most important parameters. |
245 |
|
246 |
It is possible to customise the listed information by passing a |
247 |
comma\(hyseparated list of field names to this option (the field list |
248 |
is currently undocumented), or to extend the default field list by |
249 |
prefixing the additional field list with a plus sign. By default, the |
250 |
node list will contain these informations: |
251 |
.RS |
252 |
.TP |
253 |
.B F |
254 |
a character denoting the status of the node, with '\-' meaning an |
255 |
offline node, '*' meaning N+1 failure and blank meaning a good node |
256 |
.TP |
257 |
.B Name |
258 |
the node name |
259 |
.TP |
260 |
.B t_mem |
261 |
the total node memory |
262 |
.TP |
263 |
.B n_mem |
264 |
the memory used by the node itself |
265 |
.TP |
266 |
.B i_mem |
267 |
the memory used by instances |
268 |
.TP |
269 |
.B x_mem |
270 |
amount memory which seems to be in use but cannot be determined why or |
271 |
by which instance; usually this means that the hypervisor has some |
272 |
overhead or that there are other reporting errors |
273 |
.TP |
274 |
.B f_mem |
275 |
the free node memory |
276 |
.TP |
277 |
.B r_mem |
278 |
the reserved node memory, which is the amount of free memory needed |
279 |
for N+1 compliance |
280 |
.TP |
281 |
.B t_dsk |
282 |
total disk |
283 |
.TP |
284 |
.B f_dsk |
285 |
free disk |
286 |
.TP |
287 |
.B pcpu |
288 |
the number of physical cpus on the node |
289 |
.TP |
290 |
.B vcpu |
291 |
the number of virtual cpus allocated to primary instances |
292 |
.TP |
293 |
.B pcnt |
294 |
number of primary instances |
295 |
.TP |
296 |
.B pcnt |
297 |
number of secondary instances |
298 |
.TP |
299 |
.B p_fmem |
300 |
percent of free memory |
301 |
.TP |
302 |
.B p_fdsk |
303 |
percent of free disk |
304 |
.TP |
305 |
.B r_cpu |
306 |
ratio of virtual to physical cpus |
307 |
.TP |
308 |
.B lCpu |
309 |
the dynamic CPU load (if the information is available) |
310 |
.TP |
311 |
.B lMem |
312 |
the dynamic memory load (if the information is available) |
313 |
.TP |
314 |
.B lDsk |
315 |
the dynamic disk load (if the information is available) |
316 |
.TP |
317 |
.B lNet |
318 |
the dynamic net load (if the information is available) |
319 |
.RE |
320 |
|
321 |
.TP |
322 |
.BI "-O " name |
323 |
This option (which can be given multiple times) will mark nodes as |
324 |
being \fIoffline\fR, and instances won't be placed on these nodes. |
325 |
|
326 |
Note that hspace will also mark as offline any nodes which are |
327 |
reported by RAPI as such, or that have "?" in file\(hybased input in any |
328 |
numeric fields. |
329 |
.RE |
330 |
|
331 |
.TP |
332 |
.BI "-t" datafile ", --text-data=" datafile |
333 |
The name of the file holding node and instance information (if not |
334 |
collecting via RAPI or LUXI). This or one of the other backends must |
335 |
be selected. |
336 |
|
337 |
.TP |
338 |
.BI "-m" cluster |
339 |
Collect data directly from the |
340 |
.I cluster |
341 |
given as an argument via RAPI. If the argument doesn't contain a colon |
342 |
(:), then it is converted into a fully\(hybuilt URL via prepending |
343 |
https:// and appending the default RAPI port, otherwise it's |
344 |
considered a fully\(hyspecified URL and is used as\(hyis. |
345 |
|
346 |
.TP |
347 |
.BI "-L[" path "]" |
348 |
Collect data directly from the master daemon, which is to be contacted |
349 |
via the luxi (an internal Ganeti protocol). An optional \fIpath\fR |
350 |
argument is interpreted as the path to the unix socket on which the |
351 |
master daemon listens; otherwise, the default path used by ganeti when |
352 |
installed with \fI--localstatedir=/var\fR is used. |
353 |
|
354 |
.TP |
355 |
.BI "--simulate " description |
356 |
Instead of using actual data, build an empty cluster given a node |
357 |
description. The \fIdescription\fR parameter must be a |
358 |
comma\(hyseparated list of four elements, describing in order: |
359 |
|
360 |
.RS |
361 |
|
362 |
.RS |
363 |
.TP |
364 |
the number of nodes in the cluster |
365 |
|
366 |
.TP |
367 |
the disk size of the nodes, in mebibytes |
368 |
|
369 |
.TP |
370 |
the memory size of the nodes, in mebibytes |
371 |
|
372 |
.TP |
373 |
the cpu core count for the nodes |
374 |
|
375 |
.RE |
376 |
|
377 |
An example description would be \fB20,102400,16384,4\fR describing a |
378 |
20\(hynode cluster where each node has 100GiB of disk space, 16GiB of |
379 |
memory and 4 CPU cores. Note that all nodes must have the same specs |
380 |
currently. |
381 |
|
382 |
.RE |
383 |
|
384 |
.TP |
385 |
.BI "--tiered-alloc " spec |
386 |
Beside the standard, fixed\(hysize allocation, also do a tiered |
387 |
allocation scheme where the algorithm starts from the given |
388 |
specification and allocates until there is no more space; then it |
389 |
decreases the specification and tries the allocation again. The |
390 |
decrease is done on the matric that last failed during allocation. The |
391 |
specification given is similar to the \fI--simulate\fR option and it |
392 |
holds: |
393 |
|
394 |
.RS |
395 |
|
396 |
.RS |
397 |
|
398 |
.TP |
399 |
the disk size of the instance |
400 |
|
401 |
.TP |
402 |
the memory size of the instance |
403 |
|
404 |
.TP |
405 |
the vcpu count for the insance |
406 |
|
407 |
.RE |
408 |
|
409 |
An example description would be \fB10240,8192,2\fR describing an |
410 |
initial starting specification of 10GiB of disk space, 4GiB of memory |
411 |
and 2 VCPUs. |
412 |
|
413 |
Also note that the normal allocation and the tiered allocation are |
414 |
independent, and both start from the initial cluster state; as such, |
415 |
the instance count for these two modes are not related one to another. |
416 |
|
417 |
.RE |
418 |
|
419 |
.TP |
420 |
.B -v, --verbose |
421 |
Increase the output verbosity. Each usage of this option will increase |
422 |
the verbosity (currently more than 2 doesn't make sense) from the |
423 |
default of one. At verbosity 2 the location of the new instances is |
424 |
shown in the standard error. |
425 |
|
426 |
.TP |
427 |
.B -q, --quiet |
428 |
Decrease the output verbosity. Each usage of this option will decrease |
429 |
the verbosity (less than zero doesn't make sense) from the default of |
430 |
one. |
431 |
|
432 |
.TP |
433 |
.B -V, --version |
434 |
Just show the program version and exit. |
435 |
|
436 |
.SH EXIT STATUS |
437 |
|
438 |
The exist status of the command will be zero, unless for some reason |
439 |
the algorithm fatally failed (e.g. wrong node or instance data). |
440 |
|
441 |
.SH BUGS |
442 |
|
443 |
The algorithm is highly dependent on the number of nodes; its runtime |
444 |
grows exponentially with this number, and as such is impractical for |
445 |
really big clusters. |
446 |
|
447 |
The algorithm doesn't rebalance the cluster or try to get the optimal |
448 |
fit; it just allocates in the best place for the current step, without |
449 |
taking into consideration the impact on future placements. |
450 |
|
451 |
.SH ENVIRONMENT |
452 |
|
453 |
If the variables \fBHTOOLS_NODES\fR and \fBHTOOLS_INSTANCES\fR are |
454 |
present in the environment, they will override the default names for |
455 |
the nodes and instances files. These will have of course no effect |
456 |
when the RAPI or Luxi backends are used. |
457 |
|
458 |
.SH SEE ALSO |
459 |
.BR hbal "(1), " hscan "(1), " ganeti "(7), " gnt-instance "(8), " |
460 |
.BR gnt-node "(8)" |
461 |
|
462 |
.SH "COPYRIGHT" |
463 |
.PP |
464 |
Copyright (C) 2009 Google Inc. Permission is granted to copy, |
465 |
distribute and/or modify under the terms of the GNU General Public |
466 |
License as published by the Free Software Foundation; either version 2 |
467 |
of the License, or (at your option) any later version. |
468 |
.PP |
469 |
On Debian systems, the complete text of the GNU General Public License |
470 |
can be found in /usr/share/common-licenses/GPL. |