Initial commit for introducting hcheck tool
[ganeti-github.git] / man / hcheck.rst
1 HCHECK(1) Ganeti | Version @GANETI_VERSION@
2 ===========================================
3
4 NAME
5 ----
6
7 hcheck \- Cluster checker
8
9 SYNOPSIS
10 --------
11
12 **hcheck** {backend options...} [algorithm options...] [reporting options...]
13
14 **hcheck** \--version
15
16
17 Backend options:
18
19 { **-m** *cluster* | **-L[** *path* **] | **-t** *data-file* |
20 **-I** *path* }
21
22 Algorithm options:
23
24 **[ \--no-simulation ]**
25 **[ \--max-cpu *cpu-ratio* ]**
26 **[ \--min-disk *disk-ratio* ]**
27 **[ -l *limit* ]**
28 **[ -e *score* ]**
29 **[ -g *delta* ]** **[ \--min-gain-limit *threshold* ]**
30 **[ -O *name...* ]**
31 **[ \--no-disk-moves ]**
32 **[ \--no-instance-moves ]**
33 **[ -U *util-file* ]**
34 **[ \--evac-mode ]**
35 **[ \--select-instances *inst...* ]**
36 **[ \--exclude-instances *inst...* ]**
37
38 Reporting options:
39
40 **[\--machine-readable**[=*CHOICE*] **]**
41 **[ -p[ *fields* ] ]**
42 **[ \--print-instances ]**
43 **[ -v... | -q ]**
44
45
46 DESCRIPTION
47 -----------
48
49 hcheck is the cluster checker. It prints information about cluster's
50 health and checks whether a rebalance done using **hbal** would help.
51 This information can be presented in both human-readable and
52 machine-readable way.
53 Note that it does not take any action, only performs a rebalance
54 simulation if necessary.
55 For more information about the algorithm details check **hbal(1)**.
56
57 OPTIONS
58 -------
59
60 \--no-simulation
61   Only perform checks based on current cluster state, without trying
62   to simulate rebalancing.
63
64 For a detailed description about the options listed above have a look at
65 **htools(7)**, **hspace(1)** and **hbal(1)**.
66
67 .. vim: set textwidth=72 :
68 .. Local Variables:
69 .. mode: rst
70 .. fill-column: 72
71 .. End: