Statistics
| Branch: | Tag: | Revision:

root / man / hbal.rst @ 756df409

History | View | Annotate | Download (26.9 kB)

1 5a19bd35 Iustin Pop
HBAL(1) Ganeti | Version @GANETI_VERSION@
2 5a19bd35 Iustin Pop
=========================================
3 49148d15 Iustin Pop
4 49148d15 Iustin Pop
NAME
5 49148d15 Iustin Pop
----
6 49148d15 Iustin Pop
7 49148d15 Iustin Pop
hbal \- Cluster balancer for Ganeti
8 49148d15 Iustin Pop
9 49148d15 Iustin Pop
SYNOPSIS
10 49148d15 Iustin Pop
--------
11 49148d15 Iustin Pop
12 49148d15 Iustin Pop
**hbal** {backend options...} [algorithm options...] [reporting options...]
13 49148d15 Iustin Pop
14 49148d15 Iustin Pop
**hbal** --version
15 49148d15 Iustin Pop
16 49148d15 Iustin Pop
17 49148d15 Iustin Pop
Backend options:
18 49148d15 Iustin Pop
19 49148d15 Iustin Pop
{ **-m** *cluster* | **-L[** *path* **] [-X]** | **-t** *data-file* }
20 49148d15 Iustin Pop
21 49148d15 Iustin Pop
Algorithm options:
22 49148d15 Iustin Pop
23 49148d15 Iustin Pop
**[ --max-cpu *cpu-ratio* ]**
24 49148d15 Iustin Pop
**[ --min-disk *disk-ratio* ]**
25 49148d15 Iustin Pop
**[ -l *limit* ]**
26 49148d15 Iustin Pop
**[ -e *score* ]**
27 49148d15 Iustin Pop
**[ -g *delta* ]** **[ --min-gain-limit *threshold* ]**
28 49148d15 Iustin Pop
**[ -O *name...* ]**
29 49148d15 Iustin Pop
**[ --no-disk-moves ]**
30 0aa71dbd Guido Trotter
**[ --no-instance-moves ]**
31 49148d15 Iustin Pop
**[ -U *util-file* ]**
32 49148d15 Iustin Pop
**[ --evac-mode ]**
33 bcd87e22 Guido Trotter
**[ --select-instances *inst...* ]**
34 49148d15 Iustin Pop
**[ --exclude-instances *inst...* ]**
35 49148d15 Iustin Pop
36 49148d15 Iustin Pop
Reporting options:
37 49148d15 Iustin Pop
38 49148d15 Iustin Pop
**[ -C[ *file* ] ]**
39 49148d15 Iustin Pop
**[ -p[ *fields* ] ]**
40 49148d15 Iustin Pop
**[ --print-instances ]**
41 49148d15 Iustin Pop
**[ -o ]**
42 49148d15 Iustin Pop
**[ -v... | -q ]**
43 49148d15 Iustin Pop
44 49148d15 Iustin Pop
45 49148d15 Iustin Pop
DESCRIPTION
46 49148d15 Iustin Pop
-----------
47 49148d15 Iustin Pop
48 49148d15 Iustin Pop
hbal is a cluster balancer that looks at the current state of the
49 49148d15 Iustin Pop
cluster (nodes with their total and free disk, memory, etc.) and
50 49148d15 Iustin Pop
instance placement and computes a series of steps designed to bring
51 49148d15 Iustin Pop
the cluster into a better state.
52 49148d15 Iustin Pop
53 49148d15 Iustin Pop
The algorithm used is designed to be stable (i.e. it will give you the
54 49148d15 Iustin Pop
same results when restarting it from the middle of the solution) and
55 49148d15 Iustin Pop
reasonably fast. It is not, however, designed to be a perfect
56 49148d15 Iustin Pop
algorithm--it is possible to make it go into a corner from which
57 49148d15 Iustin Pop
it can find no improvement, because it looks only one "step" ahead.
58 49148d15 Iustin Pop
59 49148d15 Iustin Pop
By default, the program will show the solution incrementally as it is
60 49148d15 Iustin Pop
computed, in a somewhat cryptic format; for getting the actual Ganeti
61 49148d15 Iustin Pop
command list, use the **-C** option.
62 49148d15 Iustin Pop
63 49148d15 Iustin Pop
ALGORITHM
64 49148d15 Iustin Pop
~~~~~~~~~
65 49148d15 Iustin Pop
66 49148d15 Iustin Pop
The program works in independent steps; at each step, we compute the
67 49148d15 Iustin Pop
best instance move that lowers the cluster score.
68 49148d15 Iustin Pop
69 49148d15 Iustin Pop
The possible move type for an instance are combinations of
70 49148d15 Iustin Pop
failover/migrate and replace-disks such that we change one of the
71 49148d15 Iustin Pop
instance nodes, and the other one remains (but possibly with changed
72 49148d15 Iustin Pop
role, e.g. from primary it becomes secondary). The list is:
73 49148d15 Iustin Pop
74 49148d15 Iustin Pop
- failover (f)
75 49148d15 Iustin Pop
- replace secondary (r)
76 49148d15 Iustin Pop
- replace primary, a composite move (f, r, f)
77 49148d15 Iustin Pop
- failover and replace secondary, also composite (f, r)
78 49148d15 Iustin Pop
- replace secondary and failover, also composite (r, f)
79 49148d15 Iustin Pop
80 49148d15 Iustin Pop
We don't do the only remaining possibility of replacing both nodes
81 49148d15 Iustin Pop
(r,f,r,f or the equivalent f,r,f,r) since these move needs an
82 49148d15 Iustin Pop
exhaustive search over both candidate primary and secondary nodes, and
83 49148d15 Iustin Pop
is O(n*n) in the number of nodes. Furthermore, it doesn't seems to
84 49148d15 Iustin Pop
give better scores but will result in more disk replacements.
85 49148d15 Iustin Pop
86 49148d15 Iustin Pop
PLACEMENT RESTRICTIONS
87 49148d15 Iustin Pop
~~~~~~~~~~~~~~~~~~~~~~
88 49148d15 Iustin Pop
89 49148d15 Iustin Pop
At each step, we prevent an instance move if it would cause:
90 49148d15 Iustin Pop
91 49148d15 Iustin Pop
- a node to go into N+1 failure state
92 49148d15 Iustin Pop
- an instance to move onto an offline node (offline nodes are either
93 49148d15 Iustin Pop
  read from the cluster or declared with *-O*)
94 49148d15 Iustin Pop
- an exclusion-tag based conflict (exclusion tags are read from the
95 49148d15 Iustin Pop
  cluster and/or defined via the *--exclusion-tags* option)
96 49148d15 Iustin Pop
- a max vcpu/pcpu ratio to be exceeded (configured via *--max-cpu*)
97 49148d15 Iustin Pop
- min disk free percentage to go below the configured limit
98 49148d15 Iustin Pop
  (configured via *--min-disk*)
99 49148d15 Iustin Pop
100 49148d15 Iustin Pop
CLUSTER SCORING
101 49148d15 Iustin Pop
~~~~~~~~~~~~~~~
102 49148d15 Iustin Pop
103 49148d15 Iustin Pop
As said before, the algorithm tries to minimise the cluster score at
104 49148d15 Iustin Pop
each step. Currently this score is computed as a sum of the following
105 49148d15 Iustin Pop
components:
106 49148d15 Iustin Pop
107 49148d15 Iustin Pop
- standard deviation of the percent of free memory
108 49148d15 Iustin Pop
- standard deviation of the percent of reserved memory
109 49148d15 Iustin Pop
- standard deviation of the percent of free disk
110 49148d15 Iustin Pop
- count of nodes failing N+1 check
111 49148d15 Iustin Pop
- count of instances living (either as primary or secondary) on
112 49148d15 Iustin Pop
  offline nodes
113 49148d15 Iustin Pop
- count of instances living (as primary) on offline nodes; this
114 49148d15 Iustin Pop
  differs from the above metric by helping failover of such instances
115 49148d15 Iustin Pop
  in 2-node clusters
116 49148d15 Iustin Pop
- standard deviation of the ratio of virtual-to-physical cpus (for
117 49148d15 Iustin Pop
  primary instances of the node)
118 49148d15 Iustin Pop
- standard deviation of the dynamic load on the nodes, for cpus,
119 49148d15 Iustin Pop
  memory, disk and network
120 49148d15 Iustin Pop
121 49148d15 Iustin Pop
The free memory and free disk values help ensure that all nodes are
122 49148d15 Iustin Pop
somewhat balanced in their resource usage. The reserved memory helps
123 49148d15 Iustin Pop
to ensure that nodes are somewhat balanced in holding secondary
124 49148d15 Iustin Pop
instances, and that no node keeps too much memory reserved for
125 49148d15 Iustin Pop
N+1. And finally, the N+1 percentage helps guide the algorithm towards
126 49148d15 Iustin Pop
eliminating N+1 failures, if possible.
127 49148d15 Iustin Pop
128 49148d15 Iustin Pop
Except for the N+1 failures and offline instances counts, we use the
129 49148d15 Iustin Pop
standard deviation since when used with values within a fixed range
130 49148d15 Iustin Pop
(we use percents expressed as values between zero and one) it gives
131 49148d15 Iustin Pop
consistent results across all metrics (there are some small issues
132 49148d15 Iustin Pop
related to different means, but it works generally well). The 'count'
133 49148d15 Iustin Pop
type values will have higher score and thus will matter more for
134 49148d15 Iustin Pop
balancing; thus these are better for hard constraints (like evacuating
135 49148d15 Iustin Pop
nodes and fixing N+1 failures). For example, the offline instances
136 49148d15 Iustin Pop
count (i.e. the number of instances living on offline nodes) will
137 49148d15 Iustin Pop
cause the algorithm to actively move instances away from offline
138 49148d15 Iustin Pop
nodes. This, coupled with the restriction on placement given by
139 49148d15 Iustin Pop
offline nodes, will cause evacuation of such nodes.
140 49148d15 Iustin Pop
141 49148d15 Iustin Pop
The dynamic load values need to be read from an external file (Ganeti
142 49148d15 Iustin Pop
doesn't supply them), and are computed for each node as: sum of
143 49148d15 Iustin Pop
primary instance cpu load, sum of primary instance memory load, sum of
144 49148d15 Iustin Pop
primary and secondary instance disk load (as DRBD generates write load
145 49148d15 Iustin Pop
on secondary nodes too in normal case and in degraded scenarios also
146 49148d15 Iustin Pop
read load), and sum of primary instance network load. An example of
147 49148d15 Iustin Pop
how to generate these values for input to hbal would be to track ``xm
148 49148d15 Iustin Pop
list`` for instances over a day and by computing the delta of the cpu
149 49148d15 Iustin Pop
values, and feed that via the *-U* option for all instances (and keep
150 49148d15 Iustin Pop
the other metrics as one). For the algorithm to work, all that is
151 49148d15 Iustin Pop
needed is that the values are consistent for a metric across all
152 49148d15 Iustin Pop
instances (e.g. all instances use cpu% to report cpu usage, and not
153 49148d15 Iustin Pop
something related to number of CPU seconds used if the CPUs are
154 49148d15 Iustin Pop
different), and that they are normalised to between zero and one. Note
155 49148d15 Iustin Pop
that it's recommended to not have zero as the load value for any
156 49148d15 Iustin Pop
instance metric since then secondary instances are not well balanced.
157 49148d15 Iustin Pop
158 49148d15 Iustin Pop
On a perfectly balanced cluster (all nodes the same size, all
159 49148d15 Iustin Pop
instances the same size and spread across the nodes equally), the
160 49148d15 Iustin Pop
values for all metrics would be zero. This doesn't happen too often in
161 49148d15 Iustin Pop
practice :)
162 49148d15 Iustin Pop
163 49148d15 Iustin Pop
OFFLINE INSTANCES
164 49148d15 Iustin Pop
~~~~~~~~~~~~~~~~~
165 49148d15 Iustin Pop
166 49148d15 Iustin Pop
Since current Ganeti versions do not report the memory used by offline
167 49148d15 Iustin Pop
(down) instances, ignoring the run status of instances will cause
168 49148d15 Iustin Pop
wrong calculations. For this reason, the algorithm subtracts the
169 49148d15 Iustin Pop
memory size of down instances from the free node memory of their
170 49148d15 Iustin Pop
primary node, in effect simulating the startup of such instances.
171 49148d15 Iustin Pop
172 49148d15 Iustin Pop
EXCLUSION TAGS
173 49148d15 Iustin Pop
~~~~~~~~~~~~~~
174 49148d15 Iustin Pop
175 49148d15 Iustin Pop
The exclusion tags mechanism is designed to prevent instances which
176 49148d15 Iustin Pop
run the same workload (e.g. two DNS servers) to land on the same node,
177 49148d15 Iustin Pop
which would make the respective node a SPOF for the given service.
178 49148d15 Iustin Pop
179 49148d15 Iustin Pop
It works by tagging instances with certain tags and then building
180 49148d15 Iustin Pop
exclusion maps based on these. Which tags are actually used is
181 49148d15 Iustin Pop
configured either via the command line (option *--exclusion-tags*)
182 49148d15 Iustin Pop
or via adding them to the cluster tags:
183 49148d15 Iustin Pop
184 49148d15 Iustin Pop
--exclusion-tags=a,b
185 49148d15 Iustin Pop
  This will make all instance tags of the form *a:\**, *b:\** be
186 49148d15 Iustin Pop
  considered for the exclusion map
187 49148d15 Iustin Pop
188 49148d15 Iustin Pop
cluster tags *htools:iextags:a*, *htools:iextags:b*
189 49148d15 Iustin Pop
  This will make instance tags *a:\**, *b:\** be considered for the
190 49148d15 Iustin Pop
  exclusion map. More precisely, the suffix of cluster tags starting
191 49148d15 Iustin Pop
  with *htools:iextags:* will become the prefix of the exclusion tags.
192 49148d15 Iustin Pop
193 49148d15 Iustin Pop
Both the above forms mean that two instances both having (e.g.) the
194 49148d15 Iustin Pop
tag *a:foo* or *b:bar* won't end on the same node.
195 49148d15 Iustin Pop
196 49148d15 Iustin Pop
OPTIONS
197 49148d15 Iustin Pop
-------
198 49148d15 Iustin Pop
199 49148d15 Iustin Pop
The options that can be passed to the program are as follows:
200 49148d15 Iustin Pop
201 49148d15 Iustin Pop
-C, --print-commands
202 49148d15 Iustin Pop
  Print the command list at the end of the run. Without this, the
203 49148d15 Iustin Pop
  program will only show a shorter, but cryptic output.
204 49148d15 Iustin Pop
205 49148d15 Iustin Pop
  Note that the moves list will be split into independent steps,
206 49148d15 Iustin Pop
  called "jobsets", but only for visual inspection, not for actually
207 49148d15 Iustin Pop
  parallelisation. It is not possible to parallelise these directly
208 49148d15 Iustin Pop
  when executed via "gnt-instance" commands, since a compound command
209 49148d15 Iustin Pop
  (e.g. failover and replace-disks) must be executed
210 49148d15 Iustin Pop
  serially. Parallel execution is only possible when using the Luxi
211 49148d15 Iustin Pop
  backend and the *-L* option.
212 49148d15 Iustin Pop
213 49148d15 Iustin Pop
  The algorithm for splitting the moves into jobsets is by
214 49148d15 Iustin Pop
  accumulating moves until the next move is touching nodes already
215 49148d15 Iustin Pop
  touched by the current moves; this means we can't execute in
216 49148d15 Iustin Pop
  parallel (due to resource allocation in Ganeti) and thus we start a
217 49148d15 Iustin Pop
  new jobset.
218 49148d15 Iustin Pop
219 49148d15 Iustin Pop
-p, --print-nodes
220 49148d15 Iustin Pop
  Prints the before and after node status, in a format designed to
221 49148d15 Iustin Pop
  allow the user to understand the node's most important parameters.
222 49148d15 Iustin Pop
223 49148d15 Iustin Pop
  It is possible to customise the listed information by passing a
224 49148d15 Iustin Pop
  comma-separated list of field names to this option (the field list
225 49148d15 Iustin Pop
  is currently undocumented), or to extend the default field list by
226 49148d15 Iustin Pop
  prefixing the additional field list with a plus sign. By default,
227 49148d15 Iustin Pop
  the node list will contain the following information:
228 49148d15 Iustin Pop
229 49148d15 Iustin Pop
  F
230 49148d15 Iustin Pop
    a character denoting the status of the node, with '-' meaning an
231 49148d15 Iustin Pop
    offline node, '*' meaning N+1 failure and blank meaning a good
232 49148d15 Iustin Pop
    node
233 49148d15 Iustin Pop
234 49148d15 Iustin Pop
  Name
235 49148d15 Iustin Pop
    the node name
236 49148d15 Iustin Pop
237 49148d15 Iustin Pop
  t_mem
238 49148d15 Iustin Pop
    the total node memory
239 49148d15 Iustin Pop
240 49148d15 Iustin Pop
  n_mem
241 49148d15 Iustin Pop
    the memory used by the node itself
242 49148d15 Iustin Pop
243 49148d15 Iustin Pop
  i_mem
244 49148d15 Iustin Pop
    the memory used by instances
245 49148d15 Iustin Pop
246 49148d15 Iustin Pop
  x_mem
247 49148d15 Iustin Pop
    amount memory which seems to be in use but cannot be determined
248 49148d15 Iustin Pop
    why or by which instance; usually this means that the hypervisor
249 49148d15 Iustin Pop
    has some overhead or that there are other reporting errors
250 49148d15 Iustin Pop
251 49148d15 Iustin Pop
  f_mem
252 49148d15 Iustin Pop
    the free node memory
253 49148d15 Iustin Pop
254 49148d15 Iustin Pop
  r_mem
255 49148d15 Iustin Pop
    the reserved node memory, which is the amount of free memory
256 49148d15 Iustin Pop
    needed for N+1 compliance
257 49148d15 Iustin Pop
258 49148d15 Iustin Pop
  t_dsk
259 49148d15 Iustin Pop
    total disk
260 49148d15 Iustin Pop
261 49148d15 Iustin Pop
  f_dsk
262 49148d15 Iustin Pop
    free disk
263 49148d15 Iustin Pop
264 49148d15 Iustin Pop
  pcpu
265 49148d15 Iustin Pop
    the number of physical cpus on the node
266 49148d15 Iustin Pop
267 49148d15 Iustin Pop
  vcpu
268 49148d15 Iustin Pop
    the number of virtual cpus allocated to primary instances
269 49148d15 Iustin Pop
270 49148d15 Iustin Pop
  pcnt
271 49148d15 Iustin Pop
    number of primary instances
272 49148d15 Iustin Pop
273 49148d15 Iustin Pop
  scnt
274 49148d15 Iustin Pop
    number of secondary instances
275 49148d15 Iustin Pop
276 49148d15 Iustin Pop
  p_fmem
277 49148d15 Iustin Pop
    percent of free memory
278 49148d15 Iustin Pop
279 49148d15 Iustin Pop
  p_fdsk
280 49148d15 Iustin Pop
    percent of free disk
281 49148d15 Iustin Pop
282 49148d15 Iustin Pop
  r_cpu
283 49148d15 Iustin Pop
    ratio of virtual to physical cpus
284 49148d15 Iustin Pop
285 49148d15 Iustin Pop
  lCpu
286 49148d15 Iustin Pop
    the dynamic CPU load (if the information is available)
287 49148d15 Iustin Pop
288 49148d15 Iustin Pop
  lMem
289 49148d15 Iustin Pop
    the dynamic memory load (if the information is available)
290 49148d15 Iustin Pop
291 49148d15 Iustin Pop
  lDsk
292 49148d15 Iustin Pop
    the dynamic disk load (if the information is available)
293 49148d15 Iustin Pop
294 49148d15 Iustin Pop
  lNet
295 49148d15 Iustin Pop
    the dynamic net load (if the information is available)
296 49148d15 Iustin Pop
297 49148d15 Iustin Pop
--print-instances
298 49148d15 Iustin Pop
  Prints the before and after instance map. This is less useful as the
299 49148d15 Iustin Pop
  node status, but it can help in understanding instance moves.
300 49148d15 Iustin Pop
301 49148d15 Iustin Pop
-o, --oneline
302 49148d15 Iustin Pop
  Only shows a one-line output from the program, designed for the case
303 49148d15 Iustin Pop
  when one wants to look at multiple clusters at once and check their
304 49148d15 Iustin Pop
  status.
305 49148d15 Iustin Pop
306 49148d15 Iustin Pop
  The line will contain four fields:
307 49148d15 Iustin Pop
308 49148d15 Iustin Pop
  - initial cluster score
309 49148d15 Iustin Pop
  - number of steps in the solution
310 49148d15 Iustin Pop
  - final cluster score
311 49148d15 Iustin Pop
  - improvement in the cluster score
312 49148d15 Iustin Pop
313 49148d15 Iustin Pop
-O *name*
314 49148d15 Iustin Pop
  This option (which can be given multiple times) will mark nodes as
315 49148d15 Iustin Pop
  being *offline*. This means a couple of things:
316 49148d15 Iustin Pop
317 49148d15 Iustin Pop
  - instances won't be placed on these nodes, not even temporarily;
318 49148d15 Iustin Pop
    e.g. the *replace primary* move is not available if the secondary
319 49148d15 Iustin Pop
    node is offline, since this move requires a failover.
320 49148d15 Iustin Pop
  - these nodes will not be included in the score calculation (except
321 49148d15 Iustin Pop
    for the percentage of instances on offline nodes)
322 49148d15 Iustin Pop
323 49148d15 Iustin Pop
  Note that algorithm will also mark as offline any nodes which are
324 49148d15 Iustin Pop
  reported by RAPI as such, or that have "?" in file-based input in
325 49148d15 Iustin Pop
  any numeric fields.
326 49148d15 Iustin Pop
327 49148d15 Iustin Pop
-e *score*, --min-score=*score*
328 49148d15 Iustin Pop
  This parameter denotes the minimum score we are happy with and alters
329 49148d15 Iustin Pop
  the computation in two ways:
330 49148d15 Iustin Pop
331 49148d15 Iustin Pop
  - if the cluster has the initial score lower than this value, then we
332 49148d15 Iustin Pop
    don't enter the algorithm at all, and exit with success
333 49148d15 Iustin Pop
  - during the iterative process, if we reach a score lower than this
334 49148d15 Iustin Pop
    value, we exit the algorithm
335 49148d15 Iustin Pop
336 49148d15 Iustin Pop
  The default value of the parameter is currently ``1e-9`` (chosen
337 49148d15 Iustin Pop
  empirically).
338 49148d15 Iustin Pop
339 49148d15 Iustin Pop
-g *delta*, --min-gain=*delta*
340 49148d15 Iustin Pop
  Since the balancing algorithm can sometimes result in just very tiny
341 49148d15 Iustin Pop
  improvements, that bring less gain that they cost in relocation
342 49148d15 Iustin Pop
  time, this parameter (defaulting to 0.01) represents the minimum
343 49148d15 Iustin Pop
  gain we require during a step, to continue balancing.
344 49148d15 Iustin Pop
345 49148d15 Iustin Pop
--min-gain-limit=*threshold*
346 49148d15 Iustin Pop
  The above min-gain option will only take effect if the cluster score
347 49148d15 Iustin Pop
  is already below *threshold* (defaults to 0.1). The rationale behind
348 49148d15 Iustin Pop
  this setting is that at high cluster scores (badly balanced
349 49148d15 Iustin Pop
  clusters), we don't want to abort the rebalance too quickly, as
350 49148d15 Iustin Pop
  later gains might still be significant. However, under the
351 49148d15 Iustin Pop
  threshold, the total gain is only the threshold value, so we can
352 49148d15 Iustin Pop
  exit early.
353 49148d15 Iustin Pop
354 49148d15 Iustin Pop
--no-disk-moves
355 49148d15 Iustin Pop
  This parameter prevents hbal from using disk move
356 49148d15 Iustin Pop
  (i.e. "gnt-instance replace-disks") operations. This will result in
357 49148d15 Iustin Pop
  a much quicker balancing, but of course the improvements are
358 49148d15 Iustin Pop
  limited. It is up to the user to decide when to use one or another.
359 49148d15 Iustin Pop
360 0aa71dbd Guido Trotter
--no-instance-moves
361 0aa71dbd Guido Trotter
  This parameter prevents hbal from using instance moves
362 0aa71dbd Guido Trotter
  (i.e. "gnt-instance migrate/failover") operations. This will only use
363 0aa71dbd Guido Trotter
  the slow disk-replacement operations, and will also provide a worse
364 0aa71dbd Guido Trotter
  balance, but can be useful if moving instances around is deemed unsafe
365 0aa71dbd Guido Trotter
  or not preferred.
366 0aa71dbd Guido Trotter
367 49148d15 Iustin Pop
--evac-mode
368 49148d15 Iustin Pop
  This parameter restricts the list of instances considered for moving
369 49148d15 Iustin Pop
  to the ones living on offline/drained nodes. It can be used as a
370 49148d15 Iustin Pop
  (bulk) replacement for Ganeti's own *gnt-node evacuate*, with the
371 49148d15 Iustin Pop
  note that it doesn't guarantee full evacuation.
372 49148d15 Iustin Pop
373 bcd87e22 Guido Trotter
--select-instances=*instances*
374 bcd87e22 Guido Trotter
  This parameter marks the given instances (as a comma-separated list)
375 bcd87e22 Guido Trotter
  as the only ones being moved during the rebalance.
376 bcd87e22 Guido Trotter
377 49148d15 Iustin Pop
--exclude-instances=*instances*
378 49148d15 Iustin Pop
  This parameter marks the given instances (as a comma-separated list)
379 49148d15 Iustin Pop
  from being moved during the rebalance.
380 49148d15 Iustin Pop
381 49148d15 Iustin Pop
-U *util-file*
382 49148d15 Iustin Pop
  This parameter specifies a file holding instance dynamic utilisation
383 49148d15 Iustin Pop
  information that will be used to tweak the balancing algorithm to
384 49148d15 Iustin Pop
  equalise load on the nodes (as opposed to static resource
385 49148d15 Iustin Pop
  usage). The file is in the format "instance_name cpu_util mem_util
386 49148d15 Iustin Pop
  disk_util net_util" where the "_util" parameters are interpreted as
387 49148d15 Iustin Pop
  numbers and the instance name must match exactly the instance as
388 49148d15 Iustin Pop
  read from Ganeti. In case of unknown instance names, the program
389 49148d15 Iustin Pop
  will abort.
390 49148d15 Iustin Pop
391 49148d15 Iustin Pop
  If not given, the default values are one for all metrics and thus
392 49148d15 Iustin Pop
  dynamic utilisation has only one effect on the algorithm: the
393 49148d15 Iustin Pop
  equalisation of the secondary instances across nodes (this is the
394 49148d15 Iustin Pop
  only metric that is not tracked by another, dedicated value, and
395 49148d15 Iustin Pop
  thus the disk load of instances will cause secondary instance
396 49148d15 Iustin Pop
  equalisation). Note that value of one will also influence slightly
397 49148d15 Iustin Pop
  the primary instance count, but that is already tracked via other
398 49148d15 Iustin Pop
  metrics and thus the influence of the dynamic utilisation will be
399 49148d15 Iustin Pop
  practically insignificant.
400 49148d15 Iustin Pop
401 49148d15 Iustin Pop
-t *datafile*, --text-data=*datafile*
402 49148d15 Iustin Pop
  The name of the file holding node and instance information (if not
403 49148d15 Iustin Pop
  collecting via RAPI or LUXI). This or one of the other backends must
404 49148d15 Iustin Pop
  be selected.
405 49148d15 Iustin Pop
406 4188449c Iustin Pop
-S *filename*, --save-cluster=*filename*
407 4188449c Iustin Pop
  If given, the state of the cluster before the balancing is saved to
408 4188449c Iustin Pop
  the given file plus the extension "original"
409 4188449c Iustin Pop
  (i.e. *filename*.original), and the state at the end of the
410 4188449c Iustin Pop
  balancing is saved to the given file plus the extension "balanced"
411 4188449c Iustin Pop
  (i.e. *filename*.balanced). This allows re-feeding the cluster state
412 4188449c Iustin Pop
  to either hbal itself or for example hspace.
413 49148d15 Iustin Pop
414 49148d15 Iustin Pop
-m *cluster*
415 49148d15 Iustin Pop
 Collect data directly from the *cluster* given as an argument via
416 49148d15 Iustin Pop
 RAPI. If the argument doesn't contain a colon (:), then it is
417 49148d15 Iustin Pop
 converted into a fully-built URL via prepending ``https://`` and
418 49148d15 Iustin Pop
 appending the default RAPI port, otherwise it's considered a
419 49148d15 Iustin Pop
 fully-specified URL and is used as-is.
420 49148d15 Iustin Pop
421 49148d15 Iustin Pop
-L [*path*]
422 49148d15 Iustin Pop
  Collect data directly from the master daemon, which is to be
423 49148d15 Iustin Pop
  contacted via the luxi (an internal Ganeti protocol). An optional
424 49148d15 Iustin Pop
  *path* argument is interpreted as the path to the unix socket on
425 49148d15 Iustin Pop
  which the master daemon listens; otherwise, the default path used by
426 49148d15 Iustin Pop
  ganeti when installed with *--localstatedir=/var* is used.
427 49148d15 Iustin Pop
428 49148d15 Iustin Pop
-X
429 49148d15 Iustin Pop
  When using the Luxi backend, hbal can also execute the given
430 49148d15 Iustin Pop
  commands. The execution method is to execute the individual jobsets
431 49148d15 Iustin Pop
  (see the *-C* option for details) in separate stages, aborting if at
432 49148d15 Iustin Pop
  any time a jobset doesn't have all jobs successful. Each step in the
433 49148d15 Iustin Pop
  balancing solution will be translated into exactly one Ganeti job
434 49148d15 Iustin Pop
  (having between one and three OpCodes), and all the steps in a
435 49148d15 Iustin Pop
  jobset will be executed in parallel. The jobsets themselves are
436 49148d15 Iustin Pop
  executed serially.
437 49148d15 Iustin Pop
438 49148d15 Iustin Pop
-l *N*, --max-length=*N*
439 49148d15 Iustin Pop
  Restrict the solution to this length. This can be used for example
440 49148d15 Iustin Pop
  to automate the execution of the balancing.
441 49148d15 Iustin Pop
442 49148d15 Iustin Pop
--max-cpu=*cpu-ratio*
443 f815aa89 Iustin Pop
  The maximum virtual to physical cpu ratio, as a floating point number
444 f815aa89 Iustin Pop
  greater than or equal to one. For example, specifying *cpu-ratio* as
445 f815aa89 Iustin Pop
  **2.5** means that, for a 4-cpu machine, a maximum of 10 virtual cpus
446 f815aa89 Iustin Pop
  should be allowed to be in use for primary instances. A value of
447 f815aa89 Iustin Pop
  exactly one means there will be no over-subscription of CPU (except
448 f815aa89 Iustin Pop
  for the CPU time used by the node itself), and values below one do not
449 f815aa89 Iustin Pop
  make sense, as that means other resources (e.g. disk) won't be fully
450 f815aa89 Iustin Pop
  utilised due to CPU restrictions.
451 49148d15 Iustin Pop
452 49148d15 Iustin Pop
--min-disk=*disk-ratio*
453 49148d15 Iustin Pop
  The minimum amount of free disk space remaining, as a floating point
454 49148d15 Iustin Pop
  number. For example, specifying *disk-ratio* as **0.25** means that
455 49148d15 Iustin Pop
  at least one quarter of disk space should be left free on nodes.
456 49148d15 Iustin Pop
457 646aa028 Iustin Pop
-G *uuid*, --group=*uuid*
458 646aa028 Iustin Pop
  On an multi-group cluster, select this group for
459 646aa028 Iustin Pop
  processing. Otherwise hbal will abort, since it cannot balance
460 646aa028 Iustin Pop
  multiple groups at the same time.
461 646aa028 Iustin Pop
462 49148d15 Iustin Pop
-v, --verbose
463 49148d15 Iustin Pop
  Increase the output verbosity. Each usage of this option will
464 49148d15 Iustin Pop
  increase the verbosity (currently more than 2 doesn't make sense)
465 49148d15 Iustin Pop
  from the default of one.
466 49148d15 Iustin Pop
467 49148d15 Iustin Pop
-q, --quiet
468 49148d15 Iustin Pop
  Decrease the output verbosity. Each usage of this option will
469 49148d15 Iustin Pop
  decrease the verbosity (less than zero doesn't make sense) from the
470 49148d15 Iustin Pop
  default of one.
471 49148d15 Iustin Pop
472 49148d15 Iustin Pop
-V, --version
473 49148d15 Iustin Pop
  Just show the program version and exit.
474 49148d15 Iustin Pop
475 49148d15 Iustin Pop
EXIT STATUS
476 49148d15 Iustin Pop
-----------
477 49148d15 Iustin Pop
478 6656790a Iustin Pop
The exit status of the command will be zero, unless for some reason
479 6656790a Iustin Pop
the algorithm fatally failed (e.g. wrong node or instance data), or
480 6656790a Iustin Pop
(in case of job execution) any job has failed.
481 49148d15 Iustin Pop
482 49148d15 Iustin Pop
BUGS
483 49148d15 Iustin Pop
----
484 49148d15 Iustin Pop
485 49148d15 Iustin Pop
The program does not check its input data for consistency, and aborts
486 49148d15 Iustin Pop
with cryptic errors messages in this case.
487 49148d15 Iustin Pop
488 49148d15 Iustin Pop
The algorithm is not perfect.
489 49148d15 Iustin Pop
490 49148d15 Iustin Pop
The output format is not easily scriptable, and the program should
491 49148d15 Iustin Pop
feed moves directly into Ganeti (either via RAPI or via a gnt-debug
492 49148d15 Iustin Pop
input file).
493 49148d15 Iustin Pop
494 49148d15 Iustin Pop
EXAMPLE
495 49148d15 Iustin Pop
-------
496 49148d15 Iustin Pop
497 49148d15 Iustin Pop
Note that these examples are not for the latest version (they don't
498 49148d15 Iustin Pop
have full node data).
499 49148d15 Iustin Pop
500 49148d15 Iustin Pop
Default output
501 49148d15 Iustin Pop
~~~~~~~~~~~~~~
502 49148d15 Iustin Pop
503 49148d15 Iustin Pop
With the default options, the program shows each individual step and
504 49148d15 Iustin Pop
the improvements it brings in cluster score::
505 49148d15 Iustin Pop
506 49148d15 Iustin Pop
    $ hbal
507 49148d15 Iustin Pop
    Loaded 20 nodes, 80 instances
508 49148d15 Iustin Pop
    Cluster is not N+1 happy, continuing but no guarantee that the cluster will end N+1 happy.
509 49148d15 Iustin Pop
    Initial score: 0.52329131
510 49148d15 Iustin Pop
    Trying to minimize the CV...
511 49148d15 Iustin Pop
        1. instance14  node1:node10  => node16:node10 0.42109120 a=f r:node16 f
512 49148d15 Iustin Pop
        2. instance54  node4:node15  => node16:node15 0.31904594 a=f r:node16 f
513 49148d15 Iustin Pop
        3. instance4   node5:node2   => node2:node16  0.26611015 a=f r:node16
514 49148d15 Iustin Pop
        4. instance48  node18:node20 => node2:node18  0.21361717 a=r:node2 f
515 49148d15 Iustin Pop
        5. instance93  node19:node18 => node16:node19 0.16166425 a=r:node16 f
516 49148d15 Iustin Pop
        6. instance89  node3:node20  => node2:node3   0.11005629 a=r:node2 f
517 49148d15 Iustin Pop
        7. instance5   node6:node2   => node16:node6  0.05841589 a=r:node16 f
518 49148d15 Iustin Pop
        8. instance94  node7:node20  => node20:node16 0.00658759 a=f r:node16
519 49148d15 Iustin Pop
        9. instance44  node20:node2  => node2:node15  0.00438740 a=f r:node15
520 49148d15 Iustin Pop
       10. instance62  node14:node18 => node14:node16 0.00390087 a=r:node16
521 49148d15 Iustin Pop
       11. instance13  node11:node14 => node11:node16 0.00361787 a=r:node16
522 49148d15 Iustin Pop
       12. instance19  node10:node11 => node10:node7  0.00336636 a=r:node7
523 49148d15 Iustin Pop
       13. instance43  node12:node13 => node12:node1  0.00305681 a=r:node1
524 49148d15 Iustin Pop
       14. instance1   node1:node2   => node1:node4   0.00263124 a=r:node4
525 49148d15 Iustin Pop
       15. instance58  node19:node20 => node19:node17 0.00252594 a=r:node17
526 49148d15 Iustin Pop
    Cluster score improved from 0.52329131 to 0.00252594
527 49148d15 Iustin Pop
528 49148d15 Iustin Pop
In the above output, we can see:
529 49148d15 Iustin Pop
530 49148d15 Iustin Pop
- the input data (here from files) shows a cluster with 20 nodes and
531 49148d15 Iustin Pop
  80 instances
532 49148d15 Iustin Pop
- the cluster is not initially N+1 compliant
533 49148d15 Iustin Pop
- the initial score is 0.52329131
534 49148d15 Iustin Pop
535 49148d15 Iustin Pop
The step list follows, showing the instance, its initial
536 49148d15 Iustin Pop
primary/secondary nodes, the new primary secondary, the cluster list,
537 49148d15 Iustin Pop
and the actions taken in this step (with 'f' denoting failover/migrate
538 49148d15 Iustin Pop
and 'r' denoting replace secondary).
539 49148d15 Iustin Pop
540 49148d15 Iustin Pop
Finally, the program shows the improvement in cluster score.
541 49148d15 Iustin Pop
542 49148d15 Iustin Pop
A more detailed output is obtained via the *-C* and *-p* options::
543 49148d15 Iustin Pop
544 49148d15 Iustin Pop
    $ hbal
545 49148d15 Iustin Pop
    Loaded 20 nodes, 80 instances
546 49148d15 Iustin Pop
    Cluster is not N+1 happy, continuing but no guarantee that the cluster will end N+1 happy.
547 49148d15 Iustin Pop
    Initial cluster status:
548 49148d15 Iustin Pop
    N1 Name   t_mem f_mem r_mem t_dsk f_dsk pri sec  p_fmem  p_fdsk
549 49148d15 Iustin Pop
     * node1  32762  1280  6000  1861  1026   5   3 0.03907 0.55179
550 49148d15 Iustin Pop
       node2  32762 31280 12000  1861  1026   0   8 0.95476 0.55179
551 49148d15 Iustin Pop
     * node3  32762  1280  6000  1861  1026   5   3 0.03907 0.55179
552 49148d15 Iustin Pop
     * node4  32762  1280  6000  1861  1026   5   3 0.03907 0.55179
553 49148d15 Iustin Pop
     * node5  32762  1280  6000  1861   978   5   5 0.03907 0.52573
554 49148d15 Iustin Pop
     * node6  32762  1280  6000  1861  1026   5   3 0.03907 0.55179
555 49148d15 Iustin Pop
     * node7  32762  1280  6000  1861  1026   5   3 0.03907 0.55179
556 49148d15 Iustin Pop
       node8  32762  7280  6000  1861  1026   4   4 0.22221 0.55179
557 49148d15 Iustin Pop
       node9  32762  7280  6000  1861  1026   4   4 0.22221 0.55179
558 49148d15 Iustin Pop
     * node10 32762  7280 12000  1861  1026   4   4 0.22221 0.55179
559 49148d15 Iustin Pop
       node11 32762  7280  6000  1861   922   4   5 0.22221 0.49577
560 49148d15 Iustin Pop
       node12 32762  7280  6000  1861  1026   4   4 0.22221 0.55179
561 49148d15 Iustin Pop
       node13 32762  7280  6000  1861   922   4   5 0.22221 0.49577
562 49148d15 Iustin Pop
       node14 32762  7280  6000  1861   922   4   5 0.22221 0.49577
563 49148d15 Iustin Pop
     * node15 32762  7280 12000  1861  1131   4   3 0.22221 0.60782
564 49148d15 Iustin Pop
       node16 32762 31280     0  1861  1860   0   0 0.95476 1.00000
565 49148d15 Iustin Pop
       node17 32762  7280  6000  1861  1106   5   3 0.22221 0.59479
566 49148d15 Iustin Pop
     * node18 32762  1280  6000  1396   561   5   3 0.03907 0.40239
567 49148d15 Iustin Pop
     * node19 32762  1280  6000  1861  1026   5   3 0.03907 0.55179
568 49148d15 Iustin Pop
       node20 32762 13280 12000  1861   689   3   9 0.40535 0.37068
569 49148d15 Iustin Pop
570 49148d15 Iustin Pop
    Initial score: 0.52329131
571 49148d15 Iustin Pop
    Trying to minimize the CV...
572 49148d15 Iustin Pop
        1. instance14  node1:node10  => node16:node10 0.42109120 a=f r:node16 f
573 49148d15 Iustin Pop
        2. instance54  node4:node15  => node16:node15 0.31904594 a=f r:node16 f
574 49148d15 Iustin Pop
        3. instance4   node5:node2   => node2:node16  0.26611015 a=f r:node16
575 49148d15 Iustin Pop
        4. instance48  node18:node20 => node2:node18  0.21361717 a=r:node2 f
576 49148d15 Iustin Pop
        5. instance93  node19:node18 => node16:node19 0.16166425 a=r:node16 f
577 49148d15 Iustin Pop
        6. instance89  node3:node20  => node2:node3   0.11005629 a=r:node2 f
578 49148d15 Iustin Pop
        7. instance5   node6:node2   => node16:node6  0.05841589 a=r:node16 f
579 49148d15 Iustin Pop
        8. instance94  node7:node20  => node20:node16 0.00658759 a=f r:node16
580 49148d15 Iustin Pop
        9. instance44  node20:node2  => node2:node15  0.00438740 a=f r:node15
581 49148d15 Iustin Pop
       10. instance62  node14:node18 => node14:node16 0.00390087 a=r:node16
582 49148d15 Iustin Pop
       11. instance13  node11:node14 => node11:node16 0.00361787 a=r:node16
583 49148d15 Iustin Pop
       12. instance19  node10:node11 => node10:node7  0.00336636 a=r:node7
584 49148d15 Iustin Pop
       13. instance43  node12:node13 => node12:node1  0.00305681 a=r:node1
585 49148d15 Iustin Pop
       14. instance1   node1:node2   => node1:node4   0.00263124 a=r:node4
586 49148d15 Iustin Pop
       15. instance58  node19:node20 => node19:node17 0.00252594 a=r:node17
587 49148d15 Iustin Pop
    Cluster score improved from 0.52329131 to 0.00252594
588 49148d15 Iustin Pop
589 49148d15 Iustin Pop
    Commands to run to reach the above solution:
590 49148d15 Iustin Pop
      echo step 1
591 49148d15 Iustin Pop
      echo gnt-instance migrate instance14
592 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node16 instance14
593 49148d15 Iustin Pop
      echo gnt-instance migrate instance14
594 49148d15 Iustin Pop
      echo step 2
595 49148d15 Iustin Pop
      echo gnt-instance migrate instance54
596 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node16 instance54
597 49148d15 Iustin Pop
      echo gnt-instance migrate instance54
598 49148d15 Iustin Pop
      echo step 3
599 49148d15 Iustin Pop
      echo gnt-instance migrate instance4
600 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node16 instance4
601 49148d15 Iustin Pop
      echo step 4
602 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node2 instance48
603 49148d15 Iustin Pop
      echo gnt-instance migrate instance48
604 49148d15 Iustin Pop
      echo step 5
605 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node16 instance93
606 49148d15 Iustin Pop
      echo gnt-instance migrate instance93
607 49148d15 Iustin Pop
      echo step 6
608 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node2 instance89
609 49148d15 Iustin Pop
      echo gnt-instance migrate instance89
610 49148d15 Iustin Pop
      echo step 7
611 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node16 instance5
612 49148d15 Iustin Pop
      echo gnt-instance migrate instance5
613 49148d15 Iustin Pop
      echo step 8
614 49148d15 Iustin Pop
      echo gnt-instance migrate instance94
615 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node16 instance94
616 49148d15 Iustin Pop
      echo step 9
617 49148d15 Iustin Pop
      echo gnt-instance migrate instance44
618 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node15 instance44
619 49148d15 Iustin Pop
      echo step 10
620 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node16 instance62
621 49148d15 Iustin Pop
      echo step 11
622 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node16 instance13
623 49148d15 Iustin Pop
      echo step 12
624 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node7 instance19
625 49148d15 Iustin Pop
      echo step 13
626 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node1 instance43
627 49148d15 Iustin Pop
      echo step 14
628 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node4 instance1
629 49148d15 Iustin Pop
      echo step 15
630 49148d15 Iustin Pop
      echo gnt-instance replace-disks -n node17 instance58
631 49148d15 Iustin Pop
632 49148d15 Iustin Pop
    Final cluster status:
633 49148d15 Iustin Pop
    N1 Name   t_mem f_mem r_mem t_dsk f_dsk pri sec  p_fmem  p_fdsk
634 49148d15 Iustin Pop
       node1  32762  7280  6000  1861  1026   4   4 0.22221 0.55179
635 49148d15 Iustin Pop
       node2  32762  7280  6000  1861  1026   4   4 0.22221 0.55179
636 49148d15 Iustin Pop
       node3  32762  7280  6000  1861  1026   4   4 0.22221 0.55179
637 49148d15 Iustin Pop
       node4  32762  7280  6000  1861  1026   4   4 0.22221 0.55179
638 49148d15 Iustin Pop
       node5  32762  7280  6000  1861  1078   4   5 0.22221 0.57947
639 49148d15 Iustin Pop
       node6  32762  7280  6000  1861  1026   4   4 0.22221 0.55179
640 49148d15 Iustin Pop
       node7  32762  7280  6000  1861  1026   4   4 0.22221 0.55179
641 49148d15 Iustin Pop
       node8  32762  7280  6000  1861  1026   4   4 0.22221 0.55179
642 49148d15 Iustin Pop
       node9  32762  7280  6000  1861  1026   4   4 0.22221 0.55179
643 49148d15 Iustin Pop
       node10 32762  7280  6000  1861  1026   4   4 0.22221 0.55179
644 49148d15 Iustin Pop
       node11 32762  7280  6000  1861  1022   4   4 0.22221 0.54951
645 49148d15 Iustin Pop
       node12 32762  7280  6000  1861  1026   4   4 0.22221 0.55179
646 49148d15 Iustin Pop
       node13 32762  7280  6000  1861  1022   4   4 0.22221 0.54951
647 49148d15 Iustin Pop
       node14 32762  7280  6000  1861  1022   4   4 0.22221 0.54951
648 49148d15 Iustin Pop
       node15 32762  7280  6000  1861  1031   4   4 0.22221 0.55408
649 49148d15 Iustin Pop
       node16 32762  7280  6000  1861  1060   4   4 0.22221 0.57007
650 49148d15 Iustin Pop
       node17 32762  7280  6000  1861  1006   5   4 0.22221 0.54105
651 49148d15 Iustin Pop
       node18 32762  7280  6000  1396   761   4   2 0.22221 0.54570
652 49148d15 Iustin Pop
       node19 32762  7280  6000  1861  1026   4   4 0.22221 0.55179
653 49148d15 Iustin Pop
       node20 32762 13280  6000  1861  1089   3   5 0.40535 0.58565
654 49148d15 Iustin Pop
655 49148d15 Iustin Pop
Here we see, beside the step list, the initial and final cluster
656 49148d15 Iustin Pop
status, with the final one showing all nodes being N+1 compliant, and
657 49148d15 Iustin Pop
the command list to reach the final solution. In the initial listing,
658 49148d15 Iustin Pop
we see which nodes are not N+1 compliant.
659 49148d15 Iustin Pop
660 49148d15 Iustin Pop
The algorithm is stable as long as each step above is fully completed,
661 49148d15 Iustin Pop
e.g. in step 8, both the migrate and the replace-disks are
662 49148d15 Iustin Pop
done. Otherwise, if only the migrate is done, the input data is
663 49148d15 Iustin Pop
changed in a way that the program will output a different solution
664 49148d15 Iustin Pop
list (but hopefully will end in the same state).
665 9ff4f2c0 Michael Hanselmann
666 9ff4f2c0 Michael Hanselmann
.. vim: set textwidth=72 :
667 9ff4f2c0 Michael Hanselmann
.. Local Variables:
668 9ff4f2c0 Michael Hanselmann
.. mode: rst
669 9ff4f2c0 Michael Hanselmann
.. fill-column: 72
670 9ff4f2c0 Michael Hanselmann
.. End: