root / man / htools.rst @ 896a03f6
History | View | Annotate | Download (4.5 kB)
1 | d26d808a | Iustin Pop | HTOOLS(1) Ganeti | Version @GANETI_VERSION@ |
---|---|---|---|
2 | d26d808a | Iustin Pop | =========================================== |
3 | d26d808a | Iustin Pop | |
4 | d26d808a | Iustin Pop | NAME |
5 | d26d808a | Iustin Pop | ---- |
6 | d26d808a | Iustin Pop | |
7 | d26d808a | Iustin Pop | htools - Cluster allocation and placement tools for Ganeti |
8 | d26d808a | Iustin Pop | |
9 | d26d808a | Iustin Pop | SYNOPSIS |
10 | d26d808a | Iustin Pop | -------- |
11 | d26d808a | Iustin Pop | |
12 | d26d808a | Iustin Pop | **hbal** |
13 | d26d808a | Iustin Pop | cluster balancer |
14 | d26d808a | Iustin Pop | |
15 | d26d808a | Iustin Pop | **hspace** |
16 | d26d808a | Iustin Pop | cluster capacity computation |
17 | d26d808a | Iustin Pop | |
18 | d26d808a | Iustin Pop | **hail** |
19 | d26d808a | Iustin Pop | IAllocator plugin |
20 | d26d808a | Iustin Pop | |
21 | d26d808a | Iustin Pop | **hscan** |
22 | d26d808a | Iustin Pop | saves cluster state for later reuse |
23 | d26d808a | Iustin Pop | |
24 | d26d808a | Iustin Pop | |
25 | d26d808a | Iustin Pop | DESCRIPTION |
26 | d26d808a | Iustin Pop | ----------- |
27 | d26d808a | Iustin Pop | |
28 | d26d808a | Iustin Pop | |
29 | d26d808a | Iustin Pop | ``htools`` is a suite of tools designed to help with allocation/movement |
30 | d26d808a | Iustin Pop | of instances and balancing of Ganeti clusters. ``htools`` is also the |
31 | d26d808a | Iustin Pop | generic binary that must be symlinked or hardlinked under each tool's |
32 | d26d808a | Iustin Pop | name in order to perform the different functions. Alternatively, the |
33 | d26d808a | Iustin Pop | environment variable HTOOLS can be used to set the desired role. |
34 | d26d808a | Iustin Pop | |
35 | d26d808a | Iustin Pop | Installed as ``hbal``, it computes and optionally executes a suite of |
36 | d26d808a | Iustin Pop | instance moves in order to balance the cluster. |
37 | d26d808a | Iustin Pop | |
38 | d26d808a | Iustin Pop | Installed as ``hspace``, it computes how many additional instances can |
39 | d26d808a | Iustin Pop | be fit on a cluster, while maintaining N+1 status. It can run on models |
40 | d26d808a | Iustin Pop | of existing clusters or of simulated clusters. |
41 | d26d808a | Iustin Pop | |
42 | d26d808a | Iustin Pop | Installed as ``hail``, it acts as an IAllocator plugin, i.e. it is used |
43 | d26d808a | Iustin Pop | by Ganeti to compute new instance allocations and instance moves. |
44 | d26d808a | Iustin Pop | |
45 | d26d808a | Iustin Pop | Installed as ``hscan``, it scans the local or remote cluster state and |
46 | d26d808a | Iustin Pop | saves it to files which can later be reused by the other roles. |
47 | d26d808a | Iustin Pop | |
48 | d26d808a | Iustin Pop | COMMON OPTIONS |
49 | d26d808a | Iustin Pop | -------------- |
50 | d26d808a | Iustin Pop | |
51 | d26d808a | Iustin Pop | Options behave the same in all program modes, but not all program modes |
52 | d26d808a | Iustin Pop | support all options. Some common options are: |
53 | d26d808a | Iustin Pop | |
54 | d7731f51 | Iustin Pop | -p, --print-nodes |
55 | d7731f51 | Iustin Pop | Prints the node status, in a format designed to allow the user to |
56 | d7731f51 | Iustin Pop | understand the node's most important parameters. If the command in |
57 | d7731f51 | Iustin Pop | question makes a cluster transition (e.g. balancing or allocation), |
58 | d7731f51 | Iustin Pop | then usually both the initial and final node status is printed. |
59 | d7731f51 | Iustin Pop | |
60 | d7731f51 | Iustin Pop | It is possible to customise the listed information by passing a |
61 | d7731f51 | Iustin Pop | comma-separated list of field names to this option (the field list |
62 | d7731f51 | Iustin Pop | is currently undocumented), or to extend the default field list by |
63 | d7731f51 | Iustin Pop | prefixing the additional field list with a plus sign. By default, |
64 | d7731f51 | Iustin Pop | the node list will contain the following information: |
65 | d7731f51 | Iustin Pop | |
66 | d7731f51 | Iustin Pop | F |
67 | d7731f51 | Iustin Pop | a character denoting the status of the node, with '-' meaning an |
68 | d7731f51 | Iustin Pop | offline node, '*' meaning N+1 failure and blank meaning a good |
69 | d7731f51 | Iustin Pop | node |
70 | d7731f51 | Iustin Pop | |
71 | d7731f51 | Iustin Pop | Name |
72 | d7731f51 | Iustin Pop | the node name |
73 | d7731f51 | Iustin Pop | |
74 | d7731f51 | Iustin Pop | t_mem |
75 | d7731f51 | Iustin Pop | the total node memory |
76 | d7731f51 | Iustin Pop | |
77 | d7731f51 | Iustin Pop | n_mem |
78 | d7731f51 | Iustin Pop | the memory used by the node itself |
79 | d7731f51 | Iustin Pop | |
80 | d7731f51 | Iustin Pop | i_mem |
81 | d7731f51 | Iustin Pop | the memory used by instances |
82 | d7731f51 | Iustin Pop | |
83 | d7731f51 | Iustin Pop | x_mem |
84 | d7731f51 | Iustin Pop | amount memory which seems to be in use but cannot be determined |
85 | d7731f51 | Iustin Pop | why or by which instance; usually this means that the hypervisor |
86 | d7731f51 | Iustin Pop | has some overhead or that there are other reporting errors |
87 | d7731f51 | Iustin Pop | |
88 | d7731f51 | Iustin Pop | f_mem |
89 | d7731f51 | Iustin Pop | the free node memory |
90 | d7731f51 | Iustin Pop | |
91 | d7731f51 | Iustin Pop | r_mem |
92 | d7731f51 | Iustin Pop | the reserved node memory, which is the amount of free memory |
93 | d7731f51 | Iustin Pop | needed for N+1 compliance |
94 | d7731f51 | Iustin Pop | |
95 | d7731f51 | Iustin Pop | t_dsk |
96 | d7731f51 | Iustin Pop | total disk |
97 | d7731f51 | Iustin Pop | |
98 | d7731f51 | Iustin Pop | f_dsk |
99 | d7731f51 | Iustin Pop | free disk |
100 | d7731f51 | Iustin Pop | |
101 | d7731f51 | Iustin Pop | pcpu |
102 | d7731f51 | Iustin Pop | the number of physical cpus on the node |
103 | d7731f51 | Iustin Pop | |
104 | d7731f51 | Iustin Pop | vcpu |
105 | d7731f51 | Iustin Pop | the number of virtual cpus allocated to primary instances |
106 | d7731f51 | Iustin Pop | |
107 | d7731f51 | Iustin Pop | pcnt |
108 | d7731f51 | Iustin Pop | number of primary instances |
109 | d7731f51 | Iustin Pop | |
110 | d7731f51 | Iustin Pop | scnt |
111 | d7731f51 | Iustin Pop | number of secondary instances |
112 | d7731f51 | Iustin Pop | |
113 | d7731f51 | Iustin Pop | p_fmem |
114 | d7731f51 | Iustin Pop | percent of free memory |
115 | d7731f51 | Iustin Pop | |
116 | d7731f51 | Iustin Pop | p_fdsk |
117 | d7731f51 | Iustin Pop | percent of free disk |
118 | d7731f51 | Iustin Pop | |
119 | d7731f51 | Iustin Pop | r_cpu |
120 | d7731f51 | Iustin Pop | ratio of virtual to physical cpus |
121 | d7731f51 | Iustin Pop | |
122 | d7731f51 | Iustin Pop | lCpu |
123 | d7731f51 | Iustin Pop | the dynamic CPU load (if the information is available) |
124 | d7731f51 | Iustin Pop | |
125 | d7731f51 | Iustin Pop | lMem |
126 | d7731f51 | Iustin Pop | the dynamic memory load (if the information is available) |
127 | d7731f51 | Iustin Pop | |
128 | d7731f51 | Iustin Pop | lDsk |
129 | d7731f51 | Iustin Pop | the dynamic disk load (if the information is available) |
130 | d7731f51 | Iustin Pop | |
131 | d7731f51 | Iustin Pop | lNet |
132 | d7731f51 | Iustin Pop | the dynamic net load (if the information is available) |
133 | d7731f51 | Iustin Pop | |
134 | d26d808a | Iustin Pop | -v, --verbose |
135 | d26d808a | Iustin Pop | Increase the output verbosity. Each usage of this option will |
136 | d26d808a | Iustin Pop | increase the verbosity (currently more than 2 doesn't make sense) |
137 | d26d808a | Iustin Pop | from the default of one. |
138 | d26d808a | Iustin Pop | |
139 | d26d808a | Iustin Pop | -q, --quiet |
140 | d26d808a | Iustin Pop | Decrease the output verbosity. Each usage of this option will |
141 | d26d808a | Iustin Pop | decrease the verbosity (less than zero doesn't make sense) from the |
142 | d26d808a | Iustin Pop | default of one. |
143 | d26d808a | Iustin Pop | |
144 | d26d808a | Iustin Pop | -V, --version |
145 | d26d808a | Iustin Pop | Just show the program version and exit. |
146 | d26d808a | Iustin Pop | |
147 | d26d808a | Iustin Pop | UNITS |
148 | d26d808a | Iustin Pop | ~~~~~ |
149 | d26d808a | Iustin Pop | |
150 | d26d808a | Iustin Pop | Some options accept not simply numerical values, but numerical values |
151 | d26d808a | Iustin Pop | together with a unit. By default, such unit-accepting options use |
152 | d26d808a | Iustin Pop | mebibytes. Using the lower-case letters of *m*, *g* and *t* (or their |
153 | d26d808a | Iustin Pop | longer equivalents of *mib*, *gib*, *tib*, for which case doesn't |
154 | d26d808a | Iustin Pop | matter) explicit binary units can be selected. Units in the SI system |
155 | d26d808a | Iustin Pop | can be selected using the upper-case letters of *M*, *G* and *T* (or |
156 | d26d808a | Iustin Pop | their longer equivalents of *MB*, *GB*, *TB*, for which case doesn't |
157 | d26d808a | Iustin Pop | matter). |
158 | d26d808a | Iustin Pop | |
159 | d26d808a | Iustin Pop | More details about the difference between the SI and binary systems can |
160 | d26d808a | Iustin Pop | be read in the *units(7)* man page. |
161 | d26d808a | Iustin Pop | |
162 | d26d808a | Iustin Pop | ENVIRONMENT |
163 | d26d808a | Iustin Pop | ----------- |
164 | d26d808a | Iustin Pop | |
165 | d26d808a | Iustin Pop | The environment variable ``HTOOLS`` can be used instead of |
166 | d26d808a | Iustin Pop | renaming/symlinking the programs; simply set it to the desired role and |
167 | d26d808a | Iustin Pop | then the name of the program is no longer used. |
168 | d26d808a | Iustin Pop | |
169 | d26d808a | Iustin Pop | .. vim: set textwidth=72 : |
170 | d26d808a | Iustin Pop | .. Local Variables: |
171 | d26d808a | Iustin Pop | .. mode: rst |
172 | d26d808a | Iustin Pop | .. fill-column: 72 |
173 | d26d808a | Iustin Pop | .. End: |