root / man / hscan.rst @ 440351f8
History | View | Annotate | Download (2.8 kB)
1 | 5a19bd35 | Iustin Pop | HSCAN(1) Ganeti | Version @GANETI_VERSION@ |
---|---|---|---|
2 | 5a19bd35 | Iustin Pop | ========================================== |
3 | 49148d15 | Iustin Pop | |
4 | 49148d15 | Iustin Pop | NAME |
5 | 49148d15 | Iustin Pop | ---- |
6 | 49148d15 | Iustin Pop | |
7 | 49148d15 | Iustin Pop | hscan - Scan clusters via RAPI and save node/instance data |
8 | 49148d15 | Iustin Pop | |
9 | 49148d15 | Iustin Pop | SYNOPSIS |
10 | 49148d15 | Iustin Pop | -------- |
11 | 49148d15 | Iustin Pop | |
12 | 49148d15 | Iustin Pop | **hscan** [-p] [--no-headers] [-d *path* ] *cluster...* |
13 | 49148d15 | Iustin Pop | |
14 | 49148d15 | Iustin Pop | **hscan** --version |
15 | 49148d15 | Iustin Pop | |
16 | 49148d15 | Iustin Pop | DESCRIPTION |
17 | 49148d15 | Iustin Pop | ----------- |
18 | 49148d15 | Iustin Pop | |
19 | 49148d15 | Iustin Pop | hscan is a tool for scanning clusters via RAPI and saving their data |
20 | 49148d15 | Iustin Pop | in the input format used by **hbal**(1) and **hspace**(1). It will |
21 | 49148d15 | Iustin Pop | also show a one-line score for each cluster scanned or, if desired, |
22 | 49148d15 | Iustin Pop | the cluster state as show by the **-p** option to the other tools. |
23 | 49148d15 | Iustin Pop | |
24 | 49148d15 | Iustin Pop | For each cluster, one file named *cluster***.data** will be generated |
25 | 49148d15 | Iustin Pop | holding the node and instance data. This file can then be used in |
26 | 49148d15 | Iustin Pop | **hbal**(1) or **hspace**(1) via the *-t* option. In case the |
27 | 49148d15 | Iustin Pop | cluster name contains slashes (as it can happen when the cluster is a |
28 | 49148d15 | Iustin Pop | fully-specified URL), these will be replaced with underscores. |
29 | 49148d15 | Iustin Pop | |
30 | 49148d15 | Iustin Pop | The one-line output for each cluster will show the following: |
31 | 49148d15 | Iustin Pop | |
32 | 49148d15 | Iustin Pop | Name |
33 | 49148d15 | Iustin Pop | The name of the cluster (or the IP address that was given, etc.) |
34 | 49148d15 | Iustin Pop | |
35 | 49148d15 | Iustin Pop | Nodes |
36 | 49148d15 | Iustin Pop | The number of nodes in the cluster |
37 | 49148d15 | Iustin Pop | |
38 | 49148d15 | Iustin Pop | Inst |
39 | 49148d15 | Iustin Pop | The number of instances in the cluster |
40 | 49148d15 | Iustin Pop | |
41 | 49148d15 | Iustin Pop | BNode |
42 | 49148d15 | Iustin Pop | The number of nodes failing N+1 |
43 | 49148d15 | Iustin Pop | |
44 | 49148d15 | Iustin Pop | BInst |
45 | 49148d15 | Iustin Pop | The number of instances living on N+1-failed nodes |
46 | 49148d15 | Iustin Pop | |
47 | 49148d15 | Iustin Pop | t_mem |
48 | 49148d15 | Iustin Pop | Total memory in the cluster |
49 | 49148d15 | Iustin Pop | |
50 | 49148d15 | Iustin Pop | f_mem |
51 | 49148d15 | Iustin Pop | Free memory in the cluster |
52 | 49148d15 | Iustin Pop | |
53 | 49148d15 | Iustin Pop | t_disk |
54 | 49148d15 | Iustin Pop | Total disk in the cluster |
55 | 49148d15 | Iustin Pop | |
56 | 49148d15 | Iustin Pop | f_disk |
57 | 49148d15 | Iustin Pop | Free disk space in the cluster |
58 | 49148d15 | Iustin Pop | |
59 | 49148d15 | Iustin Pop | Score |
60 | 49148d15 | Iustin Pop | The score of the cluster, as would be reported by **hbal**(1) if run |
61 | 49148d15 | Iustin Pop | on the generated data files. |
62 | 49148d15 | Iustin Pop | |
63 | 49148d15 | Iustin Pop | In case of errors while collecting data, all fields after the name of |
64 | 49148d15 | Iustin Pop | the cluster are replaced with the error display. |
65 | 49148d15 | Iustin Pop | |
66 | 49148d15 | Iustin Pop | **Note:** this output format is not yet final so it should not be used |
67 | 49148d15 | Iustin Pop | for scripting yet. |
68 | 49148d15 | Iustin Pop | |
69 | 49148d15 | Iustin Pop | OPTIONS |
70 | 49148d15 | Iustin Pop | ------- |
71 | 49148d15 | Iustin Pop | |
72 | 49148d15 | Iustin Pop | The options that can be passed to the program are as follows: |
73 | 49148d15 | Iustin Pop | |
74 | 49148d15 | Iustin Pop | -p, --print-nodes |
75 | 49148d15 | Iustin Pop | Prints the node status for each cluster after the cluster's one-line |
76 | 49148d15 | Iustin Pop | status display, in a format designed to allow the user to understand |
77 | 49148d15 | Iustin Pop | the node's most important parameters. For details, see the man page |
78 | d7731f51 | Iustin Pop | for **htools**(1). |
79 | 49148d15 | Iustin Pop | |
80 | 49148d15 | Iustin Pop | -d *path* |
81 | 49148d15 | Iustin Pop | Save the node and instance data for each cluster under *path*, |
82 | 49148d15 | Iustin Pop | instead of the current directory. |
83 | 49148d15 | Iustin Pop | |
84 | 49148d15 | Iustin Pop | -V, --version |
85 | 49148d15 | Iustin Pop | Just show the program version and exit. |
86 | 49148d15 | Iustin Pop | |
87 | 49148d15 | Iustin Pop | EXIT STATUS |
88 | 49148d15 | Iustin Pop | ----------- |
89 | 49148d15 | Iustin Pop | |
90 | 49148d15 | Iustin Pop | The exist status of the command will be zero, unless for some reason |
91 | 49148d15 | Iustin Pop | loading the input data failed fatally (e.g. wrong node or instance |
92 | 49148d15 | Iustin Pop | data). |
93 | 49148d15 | Iustin Pop | |
94 | 49148d15 | Iustin Pop | BUGS |
95 | 49148d15 | Iustin Pop | ---- |
96 | 49148d15 | Iustin Pop | |
97 | 49148d15 | Iustin Pop | The program does not check its input data for consistency, and aborts |
98 | 49148d15 | Iustin Pop | with cryptic errors messages in this case. |
99 | 49148d15 | Iustin Pop | |
100 | 49148d15 | Iustin Pop | EXAMPLE |
101 | 49148d15 | Iustin Pop | ------- |
102 | 49148d15 | Iustin Pop | |
103 | 49148d15 | Iustin Pop | :: |
104 | 49148d15 | Iustin Pop | |
105 | 49148d15 | Iustin Pop | $ hscan cluster1 |
106 | 49148d15 | Iustin Pop | Name Nodes Inst BNode BInst t_mem f_mem t_disk f_disk Score |
107 | 49148d15 | Iustin Pop | cluster1 2 2 0 0 1008 652 255 253 0.24404762 |
108 | 49148d15 | Iustin Pop | $ ls -l cluster1.data |
109 | 49148d15 | Iustin Pop | -rw-r--r-- 1 root root 364 2009-03-23 07:26 cluster1.data |
110 | 9ff4f2c0 | Michael Hanselmann | |
111 | 9ff4f2c0 | Michael Hanselmann | .. vim: set textwidth=72 : |
112 | 9ff4f2c0 | Michael Hanselmann | .. Local Variables: |
113 | 9ff4f2c0 | Michael Hanselmann | .. mode: rst |
114 | 9ff4f2c0 | Michael Hanselmann | .. fill-column: 72 |
115 | 9ff4f2c0 | Michael Hanselmann | .. End: |