root / hscan.1 @ d0003b35
History | View | Annotate | Download (2.9 kB)
1 |
.TH HSCAN 1 2009-03-23 htools "Ganeti H-tools" |
---|---|
2 |
.SH NAME |
3 |
hscan \- Scan clusters via RAPI and save node/instance data |
4 |
|
5 |
.SH SYNOPSIS |
6 |
.B hscan |
7 |
.B "[-p]" |
8 |
.B "[--no-headers]" |
9 |
.BI "[-d " path "]" |
10 |
.I cluster... |
11 |
|
12 |
.B hscan |
13 |
.B --version |
14 |
|
15 |
.SH DESCRIPTION |
16 |
hscan is a tool for scanning clusters via RAPI and saving their data |
17 |
in the input format used by |
18 |
.BR hbal "(1) and " hn1 "(1)." |
19 |
It will also show a one-line score for each cluster scanned or, if |
20 |
desired, the cluster state as show by the \fB-p\fR option to the other |
21 |
tools. |
22 |
|
23 |
For each cluster, two files named \fIcluster\fB.instances\fR and |
24 |
\fIcluster\fB.nodes\fR will be generated holding the instance and node |
25 |
data. These files can then be used in \fBhbal\fR(1) or \fBhn1\fR(1) |
26 |
via the \fB-i\fR and \fB-n\fR options. |
27 |
|
28 |
The one-line output for each cluster will show the following: |
29 |
.RS |
30 |
.TP |
31 |
.B Name |
32 |
The name of the cluster (or the IP address that was given, etc.) |
33 |
.TP |
34 |
.B Nodes |
35 |
The number of nodes in the cluster |
36 |
.TP |
37 |
.B Inst |
38 |
The number of instances in the cluster |
39 |
.TP |
40 |
.B BNode |
41 |
The number of nodes failing N+1 |
42 |
.TP |
43 |
.B BInst |
44 |
The number of instances living on N+1-failed nodes |
45 |
.TP |
46 |
.B t_mem |
47 |
Total memory in the cluster |
48 |
.TP |
49 |
.B f_mem |
50 |
Free memory in the cluster |
51 |
.TP |
52 |
.B t_disk |
53 |
Total disk in the cluster |
54 |
.TP |
55 |
.B f_disk |
56 |
Free disk space in the cluster |
57 |
.TP |
58 |
.B Score |
59 |
The score of the cluster, as would be reported by \fBhscan\fR(1) if |
60 |
run on the generated data files. |
61 |
|
62 |
.RE |
63 |
|
64 |
In case of errors while collecting data, all fields after the name of |
65 |
the cluster are replaced with the error display. |
66 |
|
67 |
.B Note: |
68 |
this output format is not yet final so it should not be used for |
69 |
scripting yet. |
70 |
|
71 |
.SH OPTIONS |
72 |
The options that can be passed to the program are as follows: |
73 |
|
74 |
.TP |
75 |
.B -p, --print-nodes |
76 |
Prints the node status for each cluster after the cluster's one-line |
77 |
status display, in a format designed to allow the user to understand |
78 |
the node's most important parameters. For details, see the man page |
79 |
for \fBhbal\fR(1). |
80 |
|
81 |
.TP |
82 |
.BI "-d " path |
83 |
Save the node and instance data for each cluster under \fIpath\fR, |
84 |
instead of the current directory. |
85 |
|
86 |
.TP |
87 |
.B -V, --version |
88 |
Just show the program version and exit. |
89 |
|
90 |
.SH EXIT STATUS |
91 |
|
92 |
The exist status of the command will be zero, unless for some reason |
93 |
loading the input data failed fatally (e.g. wrong node or instance |
94 |
data). |
95 |
|
96 |
.SH BUGS |
97 |
|
98 |
The program does not check its input data for consistency, and aborts |
99 |
with cryptic errors messages in this case. |
100 |
|
101 |
The RAPI collection doesn't deal with non-\fBdrbd\fR instances, and |
102 |
chokes on input data which has such instances. |
103 |
|
104 |
.SH EXAMPLE |
105 |
|
106 |
.in +4n |
107 |
.nf |
108 |
.RB "$ " "hscan cluster1" |
109 |
Name Nodes Inst BNode BInst t_mem f_mem t_disk f_disk Score |
110 |
cluster1 2 2 0 0 1008 652 255 253 0.24404762 |
111 |
.RB "$ " "ls -l cluster1.*" |
112 |
-rw-r--r-- 1 root root 163 2009-03-23 07:26 cluster1.instances |
113 |
-rw-r--r-- 1 root root 90 2009-03-23 07:26 cluster1.nodes |
114 |
.fi |
115 |
.in |
116 |
|
117 |
.SH SEE ALSO |
118 |
.BR hbal "(1), " hn1 "(1), " ganeti "(7), " gnt-instance "(8), " gnt-node "(8)" |