Fix the gnt-instance section in the htools manpage
[ganeti-local] / man / gnt-storage.rst
1 gnt-storage(8) Ganeti | Version @GANETI_VERSION@
2 ================================================
3
4 Name
5 ----
6
7 gnt-storage - Ganeti storage administration
8
9 Synopsis
10 --------
11
12 **gnt-storage** {command} [arguments...]
13
14 DESCRIPTION
15 -----------
16
17 The **gnt-storage** is used for managing the available storage inside
18 the Ganeti cluster. At the moment, it manages only external storage
19 (ExtStorage).
20
21 COMMANDS
22 --------
23
24 DIAGNOSE
25 ~~~~~~~~
26
27 | **diagnose**
28
29 This command provides detailed information about the state of all
30 ExtStorage providers available in the Ganeti cluster. The state of each
31 provider is calculated per nodegroup. This means that a provider may be
32 valid (meaning usable) for some nodegroups, and invalid (not usable) for
33 some others. This command will help you see why an installed ExtStorage
34 provider is not valid for a specific nodegroup. It could be that it is
35 missing from a node, or is only partially installed. This command will
36 show the details of all ExtStorage providers and the reasons they are or
37 aren't valid for every nodegroup in the cluster.
38
39 INFO
40 ~~~~
41
42 | **info**
43 | [*provider*]
44
45 This command will list detailed information about each ExtStorage
46 provider found in the cluster, including its nodegroup validity, the
47 supported parameters (if any) and their documentations, etc.
48
49 For each ExtStorage provider only the valid nodegroups will be listed.
50
51 If run with no arguments, it will display info for all ExtStorage
52 providers found in the cluster. If given ExtStorage provider's names as
53 arguments it will list info only for providers given.
54
55 NOTES
56 -----
57
58 In the future **gnt-storage** can be extended to also handle internal
59 storage (such as lvm, drbd, etc) and also provide diagnostics for them
60 too.
61
62 It can also be extended to handle internal and external storage pools,
63 if/when this kind of abstraction is implemented inside Ganeti.
64
65 .. vim: set textwidth=72 :
66 .. Local Variables:
67 .. mode: rst
68 .. fill-column: 72
69 .. End: