Documentation added in the mon-collector man page. Signed-off-by: Michele Tartara <[email protected]> --- man/mon-collector.rst | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+)
diff --git a/man/mon-collector.rst b/man/mon-collector.rst index d985117..046a20e 100644 --- a/man/mon-collector.rst +++ b/man/mon-collector.rst @@ -67,3 +67,38 @@ one: -p *port-number*, \--port=*port-number* The port the ConfD deamon is listening on. + +LOGICAL VOLUMES +~~~~~~~~~~~~~~~ + +| lv [ [ **-a** | **\--address** ] = *ip-address* ] [ [ **-p** | **\--port** ] + = *port-number* ] [ [ **-f** | **\--file** ] = *input-file* ] + [ [ **-i** | **\--instances** ] = *instances-file* ] + +Collects the information about the logical volumes of the current node. + +In order to perform this task, it needs to interact with the ``lvs`` command +line tool and to connect to the ConfD daemon to fetch some configuration +information. The following parameters allow the user to specify the position +where the daemon is listening, in case it's not the default one: + +-a *ip-address*, \--address=*ip-address* + The IP address the ConfD daemon is listening on. + +-p *port-number*, \--port=*port-number* + The port the ConfD deamon is listening on. + +Instead of accessing the live data on the cluster, the tool can also read data +serialized on files (mainly for testing purposes). Namely: + +-f *input-file*, \--file *input-file* + The name of the file containing a recorded output of the ``lvs`` tool. + +-i *instances-file*, \--instances=*instances-file* + The name of the file containing a JSON serialization of instances the + current node is primary and secondary for, listed as:: + + ([Instance], [Instance]) + + where the first list contains the instances the node is primary for, the + second list those the node is secondary for. -- 1.8.3
