root / man / htools.rst @ d26d808a
History | View | Annotate | Download (2.7 kB)
1 |
HTOOLS(1) Ganeti | Version @GANETI_VERSION@ |
---|---|
2 |
=========================================== |
3 |
|
4 |
NAME |
5 |
---- |
6 |
|
7 |
htools - Cluster allocation and placement tools for Ganeti |
8 |
|
9 |
SYNOPSIS |
10 |
-------- |
11 |
|
12 |
**hbal** |
13 |
cluster balancer |
14 |
|
15 |
**hspace** |
16 |
cluster capacity computation |
17 |
|
18 |
**hail** |
19 |
IAllocator plugin |
20 |
|
21 |
**hscan** |
22 |
saves cluster state for later reuse |
23 |
|
24 |
|
25 |
DESCRIPTION |
26 |
----------- |
27 |
|
28 |
|
29 |
``htools`` is a suite of tools designed to help with allocation/movement |
30 |
of instances and balancing of Ganeti clusters. ``htools`` is also the |
31 |
generic binary that must be symlinked or hardlinked under each tool's |
32 |
name in order to perform the different functions. Alternatively, the |
33 |
environment variable HTOOLS can be used to set the desired role. |
34 |
|
35 |
Installed as ``hbal``, it computes and optionally executes a suite of |
36 |
instance moves in order to balance the cluster. |
37 |
|
38 |
Installed as ``hspace``, it computes how many additional instances can |
39 |
be fit on a cluster, while maintaining N+1 status. It can run on models |
40 |
of existing clusters or of simulated clusters. |
41 |
|
42 |
Installed as ``hail``, it acts as an IAllocator plugin, i.e. it is used |
43 |
by Ganeti to compute new instance allocations and instance moves. |
44 |
|
45 |
Installed as ``hscan``, it scans the local or remote cluster state and |
46 |
saves it to files which can later be reused by the other roles. |
47 |
|
48 |
COMMON OPTIONS |
49 |
-------------- |
50 |
|
51 |
Options behave the same in all program modes, but not all program modes |
52 |
support all options. Some common options are: |
53 |
|
54 |
-v, --verbose |
55 |
Increase the output verbosity. Each usage of this option will |
56 |
increase the verbosity (currently more than 2 doesn't make sense) |
57 |
from the default of one. |
58 |
|
59 |
-q, --quiet |
60 |
Decrease the output verbosity. Each usage of this option will |
61 |
decrease the verbosity (less than zero doesn't make sense) from the |
62 |
default of one. |
63 |
|
64 |
-V, --version |
65 |
Just show the program version and exit. |
66 |
|
67 |
UNITS |
68 |
~~~~~ |
69 |
|
70 |
Some options accept not simply numerical values, but numerical values |
71 |
together with a unit. By default, such unit-accepting options use |
72 |
mebibytes. Using the lower-case letters of *m*, *g* and *t* (or their |
73 |
longer equivalents of *mib*, *gib*, *tib*, for which case doesn't |
74 |
matter) explicit binary units can be selected. Units in the SI system |
75 |
can be selected using the upper-case letters of *M*, *G* and *T* (or |
76 |
their longer equivalents of *MB*, *GB*, *TB*, for which case doesn't |
77 |
matter). |
78 |
|
79 |
More details about the difference between the SI and binary systems can |
80 |
be read in the *units(7)* man page. |
81 |
|
82 |
ENVIRONMENT |
83 |
----------- |
84 |
|
85 |
The environment variable ``HTOOLS`` can be used instead of |
86 |
renaming/symlinking the programs; simply set it to the desired role and |
87 |
then the name of the program is no longer used. |
88 |
|
89 |
.. vim: set textwidth=72 : |
90 |
.. Local Variables: |
91 |
.. mode: rst |
92 |
.. fill-column: 72 |
93 |
.. End: |