Revision 2bbf77cc hspace.1
b/hspace.1 | ||
---|---|---|
28 | 28 |
allocation. It uses the exact same allocation algorithm as the hail |
29 | 29 |
iallocator plugin. |
30 | 30 |
|
31 |
With default options, the output of the program is designed to be |
|
32 |
parseable; when the -p option is passed, this is no longer true. |
|
31 |
The output of the program is designed to interpreted as a shell |
|
32 |
fragment (or parsed as a \fIkey=value\fR file). Options which extend |
|
33 |
the output (e.g. -p, -v) will output the additional information on |
|
34 |
stderr (such that the stdout is still parseable). |
|
35 |
|
|
36 |
The following keys are available in the output of the script (all |
|
37 |
prefixed with \fIHTS_\fR): |
|
38 |
.TP |
|
39 |
.I SPEC_MEM, SPEC_DSK, SPEC_CPU, SPEC_RQN |
|
40 |
These represent the specifications of the instance model used for |
|
41 |
allocation (the memory, disk, cpu, requested nodes). |
|
42 |
|
|
43 |
.TP |
|
44 |
.I CLUSTER_MEM, CLUSTER_DSK, CLUSTER_CPU, CLUSTER_NODES |
|
45 |
These represent the total memory, disk, CPU count and total nodes in |
|
46 |
the cluster. |
|
47 |
|
|
48 |
.TP |
|
49 |
.I INI_SCORE, FIN_SCORE |
|
50 |
These are the initial (current) and final cluster score (see the hbal |
|
51 |
man page for details about the scoring algorithm). |
|
52 |
|
|
53 |
.TP |
|
54 |
.I INI_INST_CNT, FIN_INST_CNT |
|
55 |
The initial and final instance count. |
|
56 |
|
|
57 |
.TP |
|
58 |
.I INI_MEM_FREE, FIN_MEM_FREE |
|
59 |
The initial and final total free memory in the cluster (but this |
|
60 |
doesn't necessarily mean available for use). |
|
61 |
|
|
62 |
.TP |
|
63 |
.I INI_MEM_AVAIL, FIN_MEM_AVAIL |
|
64 |
The initial and final total available memory for allocation in the |
|
65 |
cluster. If allocating redundant instances, new instances could |
|
66 |
increase the reserved memory so it doesn't necessarily mean the |
|
67 |
entirety of this memory can be used for new instance allocations. |
|
68 |
|
|
69 |
.TP |
|
70 |
.I INI_MEM_RESVD, FIN_MEM_RESVD |
|
71 |
The initial and final reserved memory (for redundancy/N+1 purposes). |
|
72 |
|
|
73 |
.TP |
|
74 |
.I INI_MEM_INST, FIN_MEM_INST |
|
75 |
The initial and final memory used for instances (actual runtime used |
|
76 |
RAM). |
|
77 |
|
|
78 |
.TP |
|
79 |
.I INI_MEM_OVERHEAD, FIN_MEM_OVERHEAD |
|
80 |
The initial and final memory overhead - memory used for the node |
|
81 |
itself and unacounted memory (e.g. due to hypervisor overhead). |
|
82 |
|
|
83 |
.TP |
|
84 |
.I INI_MEM_EFF, HTS_INI_MEM_EFF |
|
85 |
The initial and final memory efficiency, represented as instance |
|
86 |
memory divided by total memory. |
|
87 |
|
|
88 |
.TP |
|
89 |
.I INI_DSK_FREE, INI_DSK_AVAIL, INI_DSK_RESVD, INI_DSK_INST, INI_DSK_EFF |
|
90 |
Initial disk stats, similar to the memory ones. |
|
91 |
|
|
92 |
.TP |
|
93 |
.I FIN_DSK_FREE, FIN_DSK_AVAIL, FIN_DSK_RESVD, FIN_DSK_INST, FIN_DSK_EFF |
|
94 |
Final disk stats, similar to the memory ones. |
|
95 |
|
|
96 |
.TP |
|
97 |
.I INI_CPU_INST, FIN_CPU_INST |
|
98 |
Initial and final number of virtual CPUs used by instances. |
|
99 |
|
|
100 |
.TP |
|
101 |
.I INI_CPU_EFF, FIN_CPU_EFF |
|
102 |
The initial and final CPU efficiency, represented as the count of |
|
103 |
virtual instance CPUs divided by the total physical CPU count. |
|
104 |
|
|
105 |
.TP |
|
106 |
.I INI_MNODE_MEM_AVAIL, FIN_MNODE_MEM_AVAIL |
|
107 |
The initial and final maximum per-node available memory. This is not |
|
108 |
very useful as a metric but can give an impression of the status of |
|
109 |
the nodes; as an example, this value restricts the maximum instance |
|
110 |
size that can be still created on the cluster. |
|
111 |
|
|
112 |
.TP |
|
113 |
.I INI_MNODE_DSK_AVAIL, FIN_MNODE_DSK_AVAIL |
|
114 |
Like the above but for disk. |
|
115 |
|
|
116 |
.TP |
|
117 |
.I ALLOC_USAGE |
|
118 |
The current usage represented as initial number of instances divided |
|
119 |
per final number of instances. |
|
120 |
|
|
121 |
.TP |
|
122 |
.I ALLOC_COUNT |
|
123 |
The number of instances allocated (delta between FIN_INST_CNT and |
|
124 |
INI_INST_CNT). |
|
125 |
|
|
126 |
.TP |
|
127 |
.I ALLOC_FAIL*_CNT |
|
128 |
For the last attemp at allocations (which would have increased |
|
129 |
FIN_INST_CNT with one, if it had succeeded), this is the count of the |
|
130 |
failure reasons per failure type; currently defined are FAILMEM, |
|
131 |
FAILDISK and FAILCPU which represent errors due to not enough memory, |
|
132 |
disk and CPUs, and FAILN1 which represents a non N+1 compliant cluster |
|
133 |
on which we can't allocate instances at all. |
|
134 |
|
|
135 |
.TP |
|
136 |
.I ALLOC_FAIL_REASON |
|
137 |
The reason for most of the failures, being one of the above FAIL* |
|
138 |
strings. |
|
139 |
|
|
140 |
.TP |
|
141 |
.I OK |
|
142 |
A marker representing the successful end of the computation, and |
|
143 |
having value "1". If this key is not present in the output it means |
|
144 |
that the computation failed and any values present should not be |
|
145 |
relied upon. |
|
33 | 146 |
|
34 | 147 |
.SH OPTIONS |
35 | 148 |
The options that can be passed to the program are as follows: |
... | ... | |
162 | 275 |
Increase the output verbosity. Each usage of this option will increase |
163 | 276 |
the verbosity (currently more than 2 doesn't make sense) from the |
164 | 277 |
default of one. At verbosity 2 the location of the new instances is |
165 |
shown in program output.
|
|
278 |
shown in the standard error.
|
|
166 | 279 |
|
167 | 280 |
.TP |
168 | 281 |
.B -q, --quiet |
... | ... | |
189 | 302 |
fit; it just allocates in the best place for the current step, without |
190 | 303 |
taking into consideration the impact on future placements. |
191 | 304 |
|
192 |
.SH EXAMPLE |
|
193 |
|
|
194 |
.SS Default output |
|
195 |
|
|
196 |
.in +4n |
|
197 |
.nf |
|
198 |
.RB "$" " hspace --mem 16 --disk 16 --req-nodes 2" |
|
199 |
Initial score: 0.38988095 |
|
200 |
Initial instances: 3 |
|
201 |
Initial free RAM: 546 |
|
202 |
Initial free disk: 260600 |
|
203 |
Final score: 0.32638889 |
|
204 |
Final instances: 7 |
|
205 |
Final free RAM: 482 |
|
206 |
Final free disk: 260472 |
|
207 |
Usage: 0.43 |
|
208 |
Allocations: 4 |
|
209 |
.fi |
|
210 |
.in |
|
211 |
|
|
212 |
This shows that (on this fake cluster), starting from 3 initial |
|
213 |
instances, using the hail iallocator plugin, it would be possible to |
|
214 |
add four (Allocations: 4) new instances to the cluster. |
|
215 |
|
|
216 |
.SS Verbose output |
|
217 |
|
|
218 |
For the same cluster as above: |
|
219 |
.in +4n |
|
220 |
.nf |
|
221 |
.RB "$" " hspace --mem 16 --disk 16 --req-nodes 2 -v" |
|
222 |
Initial score: 0.38988095 |
|
223 |
Initial instances: 3 |
|
224 |
Initial free RAM: 546 |
|
225 |
Initial free disk: 260600 |
|
226 |
Final score: 0.32638889 |
|
227 |
Final instances: 7 |
|
228 |
Final free RAM: 482 |
|
229 |
Final free disk: 260472 |
|
230 |
Usage: 0.43 |
|
231 |
Allocations: 4 |
|
232 |
Inst: new-0 node2 node1 |
|
233 |
Inst: new-1 node2 node1 |
|
234 |
Inst: new-2 node2 node1 |
|
235 |
Inst: new-3 node2 node1 |
|
236 |
.fi |
|
237 |
.in |
|
238 |
|
|
239 |
The output now includes the placement for the new instances (named |
|
240 |
\fBnew-\fInumber\fR). |
|
241 |
|
|
242 | 305 |
.SH ENVIRONMENT |
243 | 306 |
|
244 | 307 |
If the variables \fBHTOOLS_NODES\fR and \fBHTOOLS_INSTANCES\fR are |
Also available in: Unified diff