Revision acd9fa11

b/man/hail.rst
68 68
  man page **htools**(1) for more details about this option.
69 69

  
70 70
-t *datafile*, --text-data=*datafile*
71
  The name of the file holding cluster information, to override the
72
  data in the JSON request itself. This is mostly used for debugging.
71
  The name of the file holding cluster information, to override the data
72
  in the JSON request itself. This is mostly used for debugging. The
73
  format of the file is described in the man page **htools**(1).
73 74

  
74 75
--simulate *description*
75
  Similar to the **-t** option, this allows overriding the cluster
76
  data with a simulated cluster. For details about the description,
77
  see the man page **hspace**(1).
76
  Backend specification: similar to the **-t** option, this allows
77
  overriding the cluster data with a simulated cluster. For details
78
  about the description, see the man page **htools**(1).
78 79

  
79 80
-S *filename*, --save-cluster=*filename*
80 81
  If given, the state of the cluster before and the iallocator run is
81 82
  saved to a file named *filename.pre-ialloc*, respectively
82 83
  *filename.post-ialloc*. This allows re-feeding the cluster state to
83
  any of the htools utilities.
84
  any of the htools utilities via the ``-t`` option.
84 85

  
85 86
-v
86 87
  This option increases verbosity and can be used for debugging in order
b/man/hbal.rst
325 325
  metrics and thus the influence of the dynamic utilisation will be
326 326
  practically insignificant.
327 327

  
328
-t *datafile*, --text-data=*datafile*
329
  The name of the file holding node and instance information (if not
330
  collecting via RAPI or LUXI). This or one of the other backends must
331
  be selected.
332

  
333 328
-S *filename*, --save-cluster=*filename*
334 329
  If given, the state of the cluster before the balancing is saved to
335 330
  the given file plus the extension "original"
336 331
  (i.e. *filename*.original), and the state at the end of the
337 332
  balancing is saved to the given file plus the extension "balanced"
338 333
  (i.e. *filename*.balanced). This allows re-feeding the cluster state
339
  to either hbal itself or for example hspace.
334
  to either hbal itself or for example hspace via the ``-t`` option.
335

  
336
-t *datafile*, --text-data=*datafile*
337
  Backend specification: the name of the file holding node and instance
338
  information (if not collecting via RAPI or LUXI). This or one of the
339
  other backends must be selected. The option is described in the man
340
  page **htools**(1).
340 341

  
341 342
-m *cluster*
342
 Collect data directly from the *cluster* given as an argument via
343
 RAPI. If the argument doesn't contain a colon (:), then it is
344
 converted into a fully-built URL via prepending ``https://`` and
345
 appending the default RAPI port, otherwise it's considered a
346
 fully-specified URL and is used as-is.
343
  Backend specification: collect data directly from the *cluster* given
344
  as an argument via RAPI. The option is described in the man page
345
  **htools**(1).
347 346

  
348 347
-L [*path*]
349
  Collect data directly from the master daemon, which is to be
350
  contacted via the luxi (an internal Ganeti protocol). An optional
351
  *path* argument is interpreted as the path to the unix socket on
352
  which the master daemon listens; otherwise, the default path used by
353
  ganeti when installed with *--localstatedir=/var* is used.
348
  Backend specification: collect data directly from the master daemon,
349
  which is to be contacted via LUXI (an internal Ganeti protocol). The
350
  option is described in the man page **htools**(1).
354 351

  
355 352
-X
356 353
  When using the Luxi backend, hbal can also execute the given
b/man/hspace.rst
250 250
  are reported by RAPI as such, or that have "?" in file-based input
251 251
  in any numeric fields.
252 252

  
253
-t *datafile*, --text-data=*datafile*
254
  The name of the file holding node and instance information (if not
255
  collecting via RAPI or LUXI). This or one of the other backends must
256
  be selected.
257

  
258 253
-S *filename*, --save-cluster=*filename*
259 254
  If given, the state of the cluster at the end of the allocation is
260 255
  saved to a file named *filename.alloc*, and if tiered allocation is
261 256
  enabled, the state after tiered allocation will be saved to
262 257
  *filename.tiered*. This allows re-feeding the cluster state to
263 258
  either hspace itself (with different parameters) or for example
264
  hbal.
259
  hbal, via the ``-t`` option.
260

  
261
-t *datafile*, --text-data=*datafile*
262
  Backend specification: the name of the file holding node and instance
263
  information (if not collecting via RAPI or LUXI). This or one of the
264
  other backends must be selected. The option is described in the man
265
  page **htools**(1).
265 266

  
266 267
-m *cluster*
267
 Collect data directly from the *cluster* given as an argument via
268
 RAPI. If the argument doesn't contain a colon (:), then it is
269
 converted into a fully-built URL via prepending ``https://`` and
270
 appending the default RAPI port, otherwise it's considered a
271
 fully-specified URL and is used as-is.
268
  Backend specification: collect data directly from the *cluster* given
269
  as an argument via RAPI. The option is described in the man page
270
  **htools**(1).
272 271

  
273 272
-L [*path*]
274
  Collect data directly from the master daemon, which is to be
275
  contacted via the luxi (an internal Ganeti protocol). An optional
276
  *path* argument is interpreted as the path to the unix socket on
277
  which the master daemon listens; otherwise, the default path used by
278
  ganeti when installed with *--localstatedir=/var* is used.
273
  Backend specification: collect data directly from the master daemon,
274
  which is to be contacted via LUXI (an internal Ganeti protocol). The
275
  option is described in the man page **htools**(1).
279 276

  
280 277
--simulate *description*
281
  Instead of using actual data, build an empty cluster given a node
282
  description. The *description* parameter must be a comma-separated
283
  list of five elements, describing in order:
284

  
285
  - the allocation policy for this node group (*preferred*, *allocable*
286
    or *unallocable*, or alternatively the short forms *p*, *a* or *u*)
287
  - the number of nodes in the cluster
288
  - the disk size of the nodes (default in mebibytes, units can be used)
289
  - the memory size of the nodes (default in mebibytes, units can be used)
290
  - the cpu core count for the nodes
291

  
292
  An example description would be **preferred,B20,100G,16g,4**
293
  describing a 20-node cluster where each node has 100GB of disk
294
  space, 16GiB of memory and 4 CPU cores. Note that all nodes must
295
  have the same specs currently.
296

  
297
  This option can be given multiple times, and each new use defines a
298
  new node group. Hence different node groups can have different
299
  allocation policies and node count/specifications.
278
  Backend specification: similar to the **-t** option, this allows
279
  overriding the cluster data with a simulated cluster. For details
280
  about the description, see the man page **htools**(1).
300 281

  
301 282
--tiered-alloc *spec*
302 283
  Besides the standard, fixed-size allocation, also do a tiered
b/man/htools.rst
131 131
  lNet
132 132
    the dynamic net load (if the information is available)
133 133

  
134
-t *datafile*, --text-data=*datafile*
135
  Backend specification: the name of the file holding node and instance
136
  information (if not collecting via RAPI or LUXI). This or one of the
137
  other backends must be selected. The option is described in the man
138
  page **htools**(1).
139

  
140
  The file should contain text data, line-based, with two empty lines
141
  separating sections. The lines themselves are column-based, with the
142
  pipe symbol (``|``) acting as separator.
143

  
144
  The first section contains group data, with two columns:
145

  
146
  - group name
147
  - group uuid
148

  
149
  The second sections contains node data, with the following columns:
150

  
151
  - node name
152
  - node total memory
153
  - node free memory
154
  - node total disk
155
  - node free disk
156
  - node physical cores
157
  - offline field (as ``Y`` or ``N``)
158
  - group UUID
159

  
160
  The third section contains instance data, with the fields:
161

  
162
  - instance name
163
  - instance memory
164
  - instance disk size
165
  - instance vcpus
166
  - instance status (in Ganeti's format, e.g. ``running`` or ``ERROR_down``)
167
  - instance ``auto_balance`` flag (see man page **gnt-instance** (7))
168
  - instance primary node
169
  - instance secondary node(s), if any
170
  - instance disk type (e.g. ``plain`` or ``drbd``)
171
  - instance tags
172

  
173
  The fourth and last section contains the cluster tags, with one tag
174
  per line (no columns/no column processing).
175

  
176
-m *cluster*
177
  Backend specification: collect data directly from the *cluster* given
178
  as an argument via RAPI. If the argument doesn't contain a colon (:),
179
  then it is converted into a fully-built URL via prepending
180
  ``https://`` and appending the default RAPI port, otherwise it is
181
  considered a fully-specified URL and used as-is.
182

  
183
-L [*path*]
184
  Backend specification: collect data directly from the master daemon,
185
  which is to be contacted via LUXI (an internal Ganeti protocol). An
186
  optional *path* argument is interpreted as the path to the unix socket
187
  on which the master daemon listens; otherwise, the default path used
188
  by Ganeti (configured at build time) is used.
189

  
190
--simulate *description*
191
  Backend specification: instead of using actual data, build an empty
192
  cluster given a node description. The *description* parameter must be
193
  a comma-separated list of five elements, describing in order:
194

  
195
  - the allocation policy for this node group (*preferred*, *allocable*
196
    or *unallocable*, or alternatively the short forms *p*, *a* or *u*)
197
  - the number of nodes in the cluster
198
  - the disk size of the nodes (default in mebibytes, units can be used)
199
  - the memory size of the nodes (default in mebibytes, units can be used)
200
  - the cpu core count for the nodes
201

  
202
  An example description would be **preferred,B20,100G,16g,4**
203
  describing a 20-node cluster where each node has 100GB of disk
204
  space, 16GiB of memory and 4 CPU cores. Note that all nodes must
205
  have the same specs currently.
206

  
207
  This option can be given multiple times, and each new use defines a
208
  new node group. Hence different node groups can have different
209
  allocation policies and node count/specifications.
210

  
134 211
-v, --verbose
135 212
  Increase the output verbosity. Each usage of this option will
136 213
  increase the verbosity (currently more than 2 doesn't make sense)

Also available in: Unified diff