root / hscan.1 @ 691dcd2a
History | View | Annotate | Download (3.2 kB)
1 | d0003b35 | Iustin Pop | .TH HSCAN 1 2009-03-23 htools "Ganeti H-tools" |
---|---|---|---|
2 | d2ac5526 | Iustin Pop | .SH NAME |
3 | d2ac5526 | Iustin Pop | hscan \- Scan clusters via RAPI and save node/instance data |
4 | d2ac5526 | Iustin Pop | |
5 | d2ac5526 | Iustin Pop | .SH SYNOPSIS |
6 | d2ac5526 | Iustin Pop | .B hscan |
7 | d2ac5526 | Iustin Pop | .B "[-p]" |
8 | d2ac5526 | Iustin Pop | .B "[--no-headers]" |
9 | d2ac5526 | Iustin Pop | .BI "[-d " path "]" |
10 | d2ac5526 | Iustin Pop | .I cluster... |
11 | d2ac5526 | Iustin Pop | |
12 | d2ac5526 | Iustin Pop | .B hscan |
13 | d2ac5526 | Iustin Pop | .B --version |
14 | d2ac5526 | Iustin Pop | |
15 | d2ac5526 | Iustin Pop | .SH DESCRIPTION |
16 | d2ac5526 | Iustin Pop | hscan is a tool for scanning clusters via RAPI and saving their data |
17 | d2ac5526 | Iustin Pop | in the input format used by |
18 | 266aea94 | Iustin Pop | .BR hbal "(1) and " hspace "(1)." |
19 | 1cd133d6 | Iustin Pop | It will also show a one\(hyline score for each cluster scanned or, if |
20 | d2ac5526 | Iustin Pop | desired, the cluster state as show by the \fB-p\fR option to the other |
21 | d2ac5526 | Iustin Pop | tools. |
22 | d2ac5526 | Iustin Pop | |
23 | 66ea8434 | Iustin Pop | For each cluster, one file named \fIcluster\fB.data\ will be generated |
24 | 66ea8434 | Iustin Pop | holding the node and instance data. This file can then be used in |
25 | 66ea8434 | Iustin Pop | \fBhbal\fR(1) or \fBhspace\fR(1) via the \fB-t\fR option. In case the |
26 | 66ea8434 | Iustin Pop | cluster name contains slashes (as it can happen when the cluster is a |
27 | 0944090a | Iustin Pop | fully-specified URL), these will be replaced with underscores. |
28 | d2ac5526 | Iustin Pop | |
29 | 1cd133d6 | Iustin Pop | The one\(hyline output for each cluster will show the following: |
30 | d0003b35 | Iustin Pop | .RS |
31 | d0003b35 | Iustin Pop | .TP |
32 | d0003b35 | Iustin Pop | .B Name |
33 | d0003b35 | Iustin Pop | The name of the cluster (or the IP address that was given, etc.) |
34 | d0003b35 | Iustin Pop | .TP |
35 | d0003b35 | Iustin Pop | .B Nodes |
36 | d0003b35 | Iustin Pop | The number of nodes in the cluster |
37 | d0003b35 | Iustin Pop | .TP |
38 | d0003b35 | Iustin Pop | .B Inst |
39 | d0003b35 | Iustin Pop | The number of instances in the cluster |
40 | d0003b35 | Iustin Pop | .TP |
41 | d0003b35 | Iustin Pop | .B BNode |
42 | d0003b35 | Iustin Pop | The number of nodes failing N+1 |
43 | d0003b35 | Iustin Pop | .TP |
44 | d0003b35 | Iustin Pop | .B BInst |
45 | 1cd133d6 | Iustin Pop | The number of instances living on N+1\(hyfailed nodes |
46 | d0003b35 | Iustin Pop | .TP |
47 | d0003b35 | Iustin Pop | .B t_mem |
48 | d0003b35 | Iustin Pop | Total memory in the cluster |
49 | d0003b35 | Iustin Pop | .TP |
50 | d0003b35 | Iustin Pop | .B f_mem |
51 | d0003b35 | Iustin Pop | Free memory in the cluster |
52 | d0003b35 | Iustin Pop | .TP |
53 | d0003b35 | Iustin Pop | .B t_disk |
54 | d0003b35 | Iustin Pop | Total disk in the cluster |
55 | d0003b35 | Iustin Pop | .TP |
56 | d0003b35 | Iustin Pop | .B f_disk |
57 | d0003b35 | Iustin Pop | Free disk space in the cluster |
58 | d0003b35 | Iustin Pop | .TP |
59 | d0003b35 | Iustin Pop | .B Score |
60 | 66ea8434 | Iustin Pop | The score of the cluster, as would be reported by \fBhbal\fR(1) if |
61 | d0003b35 | Iustin Pop | run on the generated data files. |
62 | d0003b35 | Iustin Pop | |
63 | d0003b35 | Iustin Pop | .RE |
64 | d0003b35 | Iustin Pop | |
65 | d0003b35 | Iustin Pop | In case of errors while collecting data, all fields after the name of |
66 | d0003b35 | Iustin Pop | the cluster are replaced with the error display. |
67 | d0003b35 | Iustin Pop | |
68 | d0003b35 | Iustin Pop | .B Note: |
69 | d0003b35 | Iustin Pop | this output format is not yet final so it should not be used for |
70 | d0003b35 | Iustin Pop | scripting yet. |
71 | d0003b35 | Iustin Pop | |
72 | d2ac5526 | Iustin Pop | .SH OPTIONS |
73 | d2ac5526 | Iustin Pop | The options that can be passed to the program are as follows: |
74 | d2ac5526 | Iustin Pop | |
75 | d2ac5526 | Iustin Pop | .TP |
76 | d2ac5526 | Iustin Pop | .B -p, --print-nodes |
77 | 1cd133d6 | Iustin Pop | Prints the node status for each cluster after the cluster's one\(hyline |
78 | d2ac5526 | Iustin Pop | status display, in a format designed to allow the user to understand |
79 | d2ac5526 | Iustin Pop | the node's most important parameters. For details, see the man page |
80 | d2ac5526 | Iustin Pop | for \fBhbal\fR(1). |
81 | d2ac5526 | Iustin Pop | |
82 | d2ac5526 | Iustin Pop | .TP |
83 | d2ac5526 | Iustin Pop | .BI "-d " path |
84 | d2ac5526 | Iustin Pop | Save the node and instance data for each cluster under \fIpath\fR, |
85 | d2ac5526 | Iustin Pop | instead of the current directory. |
86 | d2ac5526 | Iustin Pop | |
87 | d2ac5526 | Iustin Pop | .TP |
88 | d2ac5526 | Iustin Pop | .B -V, --version |
89 | d2ac5526 | Iustin Pop | Just show the program version and exit. |
90 | d2ac5526 | Iustin Pop | |
91 | d2ac5526 | Iustin Pop | .SH EXIT STATUS |
92 | d2ac5526 | Iustin Pop | |
93 | d2ac5526 | Iustin Pop | The exist status of the command will be zero, unless for some reason |
94 | d2ac5526 | Iustin Pop | loading the input data failed fatally (e.g. wrong node or instance |
95 | d2ac5526 | Iustin Pop | data). |
96 | d2ac5526 | Iustin Pop | |
97 | d2ac5526 | Iustin Pop | .SH BUGS |
98 | d2ac5526 | Iustin Pop | |
99 | d2ac5526 | Iustin Pop | The program does not check its input data for consistency, and aborts |
100 | d2ac5526 | Iustin Pop | with cryptic errors messages in this case. |
101 | d2ac5526 | Iustin Pop | |
102 | d0003b35 | Iustin Pop | .SH EXAMPLE |
103 | d0003b35 | Iustin Pop | |
104 | d0003b35 | Iustin Pop | .in +4n |
105 | d0003b35 | Iustin Pop | .nf |
106 | d0003b35 | Iustin Pop | .RB "$ " "hscan cluster1" |
107 | d0003b35 | Iustin Pop | Name Nodes Inst BNode BInst t_mem f_mem t_disk f_disk Score |
108 | d0003b35 | Iustin Pop | cluster1 2 2 0 0 1008 652 255 253 0.24404762 |
109 | 66ea8434 | Iustin Pop | .RB "$ " "ls -l cluster1.data" |
110 | 66ea8434 | Iustin Pop | \-rw\-r\-\-r\-\- 1 root root 364 2009\-03\-23 07:26 cluster1.data |
111 | d0003b35 | Iustin Pop | .fi |
112 | d0003b35 | Iustin Pop | .in |
113 | d0003b35 | Iustin Pop | |
114 | d2ac5526 | Iustin Pop | .SH SEE ALSO |
115 | 266aea94 | Iustin Pop | .BR hbal "(1), " hspace "(1), " hail "(1), " |
116 | 266aea94 | Iustin Pop | .BR ganeti "(7), " gnt-instance "(8), " gnt-node "(8)" |
117 | e2fa2baf | Iustin Pop | |
118 | e2fa2baf | Iustin Pop | .SH "COPYRIGHT" |
119 | e2fa2baf | Iustin Pop | .PP |
120 | e2fa2baf | Iustin Pop | Copyright (C) 2009 Google Inc. Permission is granted to copy, |
121 | e2fa2baf | Iustin Pop | distribute and/or modify under the terms of the GNU General Public |
122 | e2fa2baf | Iustin Pop | License as published by the Free Software Foundation; either version 2 |
123 | e2fa2baf | Iustin Pop | of the License, or (at your option) any later version. |
124 | e2fa2baf | Iustin Pop | .PP |
125 | e2fa2baf | Iustin Pop | On Debian systems, the complete text of the GNU General Public License |
126 | e2fa2baf | Iustin Pop | can be found in /usr/share/common-licenses/GPL. |