arif/xcat-core
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

added man pages for the new monitoring commands

Browse Source 
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@2272 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
linggao 2008-10-01 18:52:15 +00:00
parent e9d0f104ad
commit 7df6e838b1
7 changed files with 292 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
xCAT-client/pods/man1/monadd.1.pod Normal file
View File

@ -0,0 +1,79 @@
=head1 NAME
B<monadd> - Registers a monitoring plug-in to the xCAT cluster.
=head1 SYNOPSIS
I<monadd [-h| --help]>
I<monadd [-v| --version]>
I<monadd name [-n|--nodestatmon] [-s|--settings settings]>
=head1 DESCRIPTION
This command is used to register a monitoring plug-in module to monitor the xCAT cluster. The plug-in module will be added to the xCAT I<monitoring> database table and the configuration scripts for the monitoring plug-in, if any, will be added to the I<postscripts> table. A monitoring plug-in module acts as a bridge that connects a 3rd party monitoring software and the xCAT cluster. A configuration script is used to configure the 3rd party software. Once added to the <postscripts> table, it will be invoked on the nodes during node deployment stage.
=head1 Parameters
I<name> is the name of the monitoring plug-in module. For example, if the the I<name> is called I<xxx>, then the actual file name that the xcatd looks for is I</opt/xcat/lib/perl/xCAT_monitoring/xxx.pm>. Use I<monls -a> command to list all the monitoring plug-in modules that can be used.
I<settings> is the monitoring plug-in specific settings. It is used to customize the behavior of the plug-in or configure the 3rd party software. Format: I<[key-value],[key=value]...> Please note that the square brackets are needed here. Use I<monls name -d> command to look for the possbile setting keys for a plug-in module.
=head1 OPTIONS
B<-h | --help> Display usage message.
B<-n | --nodestatmon> Indicate that this monitoring plug-in will be used for feeding the node liveness status to the xCAT I<nodelist> table.
B<-s | --settings> Specifies the plug-in specific settings. These settings will be used by the plug-in to customize certain entities for the plug-in or the third party monitoring software. e.g. [mon_interval=10],[toggle=1].
B<-v | --version > Command Version.
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
1. To register gangliamon plug-in module (which interacts with Ganglia monitoring software) to monitor the xCAT cluster, enter:
monadd gangliamon
2. To register rmcmon plug-in module (which interacts with IBM's RSCT monitoring software) to monitor the xCAT cluster and have it feed the node liveness status to xCAT's I<nodelist> table, enter:
monadd rmcmon -n
This will also add the I<configrmcnode> to the I<postscripts> table. To view the content of the I<postscripts> table, enter:
tabdump postscritps
#node,postscripts,comments,disable
"service","servicenode",,
"xcatdefaults","syslog,remoteshell,configrmcnode",,
3. To register xcatmon plug-in module to feed the node liveness status to xCAT's I<nodelist> table, enter:
monaddt rmcmon -n -s [ping-interval=2]
where 2 is the number of minutes between the pings.
=head1 FILES
/opt/xcat/bin/monadd
=head1 SEE ALSO
L<monls(1)|monls.1>, L<monrm(1)|monrm.1>, L<monstart(1)|monstart.1>, L<monstop(1)|monstop.1>, L<moncfg(1)|moncfg.1>, L<mondecfg(1)|mondecfg.1>

65
xCAT-client/pods/man1/moncfg.1.pod Normal file
View File

@ -0,0 +1,65 @@
=head1 NAME
B<moncfg> - Configures a 3rd party monitoring software to monitor the xCAT cluster.
=head1 SYNOPSIS
I<moncfg [-h| --help]>
I<moncfg [-v| --version]>
I<moncfg name [noderange] [-r|--remote]>
=head1 DESCRIPTION
This command is used to configure a 3rd party monitoring software to monitor the xCAT cluster. For example, it modifies the configration file for the monitoring software so that the nodes can be included in the monitoring domain. The operation is performed on the management node and the service nodes of the given nodes. The operation will also be performed on the nodes if the I<-r> option is specified, though the configuration of the nodes is usually performed during the node deployment stage.
=head1 Parameters
I<name> is the name of the monitoring plug-in module. For example, if the the I<name> is called I<xxx>, then the actual file name that the xcatd looks for is I</opt/xcat/lib/perl/xCAT_monitoring/xxx.pm>. Use I<monls -a> command to list all the monitoring plug-in modules that can be used.
I<noderange> specifies the nodes to be monitored. If omitted, all nodes will be monitored.
=head1 OPTIONS
B<-h | --help> Display usage message.
B<-r | --remote> Specifies that the operation will also be performed on the nodes.
B<-v | --version > Command Version.
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
1. To configure the management node and the service nodes for ganglia monitoring, enter:
moncfg gangliamon
1. To configure the management node, nodes and their service nodes for ganglia monitoring, enter:
moncfg gangliamon -r
=head1 FILES
/opt/xcat/bin/moncfg
=head1 SEE ALSO
L<monls(1)|monls.1>, L<mondecfg(1)|mondecfg.1>, L<monadd(1)|monadd.1>, L<monrm(1)|monrm.1>, L<monstart(1)|monstart.1>, L<monstop(1)|monstop.1>

65
xCAT-client/pods/man1/mondecfg.1.pod Normal file
View File

@ -0,0 +1,65 @@
=head1 NAME
B<mondecfg> - Deconfigures a 3rd party monitoring software from monitoring the xCAT cluster.
=head1 SYNOPSIS
I<moncfg [-h| --help]>
I<moncfg [-v| --version]>
I<moncfg name [noderange] [-r|--remote]>
=head1 DESCRIPTION
This command is used to deconfigure a 3rd party monitoring software from monitoring the xCAT cluster. The operation is performed on the management node and the service nodes of the given nodes. The operation will also be performed on the nodes if the I<-r> option is specified. The deconfigration operation will remove the nodes from the 3rd party software's monitoring domain.
=head1 Parameters
I<name> is the name of the monitoring plug-in module. Use I<monls> command to list all the monitoring plug-in modules that can be used.
I<noderange> specified the nodes to be deconfigured. If omitted, all nodes will be deconfigured.
=head1 OPTIONS
B<-h | --help> Display usage message.
B<-r | --remote> Specifies that the operation will also be performed on the nodes.
B<-v | --version > Command Version.
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
1. To deconfigure the management node and the service nodes from the ganglia monitoring, enter:
mondecfg gangliamon
1. To deconfigure the management node, nodes and their service nodes from the ganglia monitoring, enter:
mondecfg gangliamon -r
=head1 FILES
/opt/xcat/bin/mondecfg
=head1 SEE ALSO
L<monls(1)|monls.1>, L<moncfg(1)|moncfg.1>, L<monadd(1)|monadd.1>, L<monrm(1)|monrm.1>, L<monstart(1)|monstart.1>, L<monstop(1)|monstop.1>

9
xCAT-client/pods/man1/monls.1.pod
View File

@ -17,7 +17,7 @@ I<monls [-a|--all] [-d|--description]>
=head1 DESCRIPTION
This command is used to list the status, desctiption and the settings of one or all of the monitoring plug-in modules.
This command is used to list the status, desctiption, the configuration scripts and the settings of one or all of the monitoring plug-in modules.
=head1 Parameters
@ -34,10 +34,7 @@ B<-d | --description> Display the description of the plug-in modules. The descr
B<-h | --help> Display usage message.
B<-v | -version > Command Version.
B<-V | -verbose> Verbose output.
B<-v | --version > Command Version.
=head1 RETURN VALUE
@ -81,5 +78,5 @@ The output looks like this:
=head1 SEE ALSO
L<monstart(1)|monstart.1>, L<monstop(1)|monstop.1>
L<monadd(1)|monadd.1>, L<monrm(1)|monrm.1>, L<monstart(1)|monstart.1>, L<monstop(1)|monstop.1>, L<moncfg(1)|moncfg.1>, L<mondecfg(1)|mondecfg.1>

58
xCAT-client/pods/man1/monrm.1.pod Normal file
View File

@ -0,0 +1,58 @@
=head1 NAME
B<monrm> - Unregisters a monitoring plug-in module from the xCAT cluster.
=head1 SYNOPSIS
I<monrm [-h| --help]>
I<monrm [-v| --version]>
I<monrm name>
=head1 DESCRIPTION
This command is used to unregister a monitoring plug-in module from the I<monitoring> table. It also removes any configuration scripts associated with the monitoring plug-in from the I<postscripts> table. A monitoring plug-in module acts as a bridge that connects a 3rd party monitoring software and the xCAT cluster. A configuration script is used to configure the 3rd party software. Once added to the I<postscripts> table, it will be invoked on the nodes during node deployment stage.
=head1 Parameters
I<name> is the name of the monitoring plug-in module in the I<monitoring> table. Use I<monls> command to list all the monitoring plug-in modules that can be used.
=head1 OPTIONS
B<-h | --help> Display usage message.
B<-v | --version > Command Version.
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
1.To unregister gangliamon plug-in module (which interacts with Ganglia monitoring software) from the xCAT cluster, enter:
monrm gangliamon
Please note that gangliamon must have been registered in the xCAT I<monitoring> table. For a list of registered plug-in modules, use command I<monls>.
=head1 FILES
/opt/xcat/bin/monrm
=head1 SEE ALSO
L<monls(1)|monls.1>, L<monadd(1)|monadd.1>, L<monstart(1)|monstart.1>, L<monstop(1)|monstop.1>, L<moncfg(1)|moncfg.1>, L<mondecfg(1)|mondecfg.1>

34
xCAT-client/pods/man1/monstart.1.pod
View File

@ -8,35 +8,30 @@ B<monstart> - Starts a plug-in module to monitor the xCAT cluster.
I<monstart [-h| --help]>
I<monstart [-v| --version]>
I<monstart [-v| --version]>
I<monstart I<name> [-n|--nodestatmon] [-s|--settings settings]>
I<monstart name [noderange] [-r|--remote]>
=head1 DESCRIPTION
This command is used to register a monitoring plug-in module and invoke it to monitor the xCAT cluster. A monitoring plug-in module acts as a bridge that connects a 3rd party monitoring software and the xCAT cluster. The plug-in module will be registered in the xCAT I<monitoring> database table. A registered plug-in module is automatically started by the I<xcatd>.
This command is used to start a 3rd party software, (for example start the daemons), to monitor the xCAT cluster. The operation is performed on the management node and the service nodes of the given nodes. The operation will also be performed on the nodes if the I<-r> option is specified.
=head1 Parameters
I<name> is the name of the monitoring plug-in module. For example, if the the I<name> is called I<xxx>, then the actual file name that the xcatd looks for is I</opt/xcat/lib/perl/xCAT_monitoring/xxx.pm>. Use I<monls -a> command to list all the monitoring plug-in modules that can be used.
I<settings> is the monitoring plug-in specific settings. It is used to customize the behavior of the plug-in or configure the 3rd party software. Format: I<[key-value],[key=value]...> Please note that the square brackets are needed here. Use I<monls name -d> command to look for the possbile setting keys for a plug-in module.
I<noderange> is the nodes to be monitored. If omitted, all nodes will be monitored.
=head1 OPTIONS
B<-h | -help> Display usage message.
B<-h | --help> Display usage message.
B<-n | -nodestatmon> Indicate that this monitoring plug-in will be used for feeding the node liveness status to the xCAT I<nodelist> table.
B<-r | --remote> Specifies that the operation will also be performed on the nodes. For example, the3rd party monitoring software daemons on the nodes will also be started.
B<-s | -settings> Specifies the plug-in specific settings. These settings will be used by the plug-in to customize certain entities for the plug-in or the third party monitoring software. e.g. [mon_interval=10],[toggle=1].
B<-v | -version > Command Version.
B<-V | -verbose> Verbose output.
B<-v | --version > Command Version.
=head1 RETURN VALUE
@ -49,18 +44,11 @@ B<-V | -verbose> Verbose output.
1. To start gangliamon plug-in module (which interacts with Ganglia monitoring software) to monitor the xCAT cluster, enter:
monstart gangliamon
monstart gangliamon -r
2. To start rmcmon plug-in module (which interacts with IBM's RSCT monitoring software) to monitor the xCAT cluster and have it feed the node liveness status to xCAT's I<nodelist> table, enter:
monstart rmcmon -n
3. To start xcatmon plug-in module to feed the node liveness status to xCAT's I<nodelist> table, enter:
monstart rmcmon -n -s [ping-interval=2]
where 2 is the number of minutes between the pings.
2. To start xcatmon plug-in module to feed the node liveness status to xCAT's I<nodelist> table, enter:
monstart rmcmon
=head1 FILES
@ -70,7 +58,7 @@ where 2 is the number of minutes between the pings.
=head1 SEE ALSO
L<monls(1)|monls.1>, L<monstop(1)|monstop.1>
L<monls(1)|monls.1>, L<monstop(1)|monstop.1>, L<monadd(1)|monadd.1>, L<monrm(1)|monrm.1>, L<moncfg(1)|moncfg.1>, L<mondecfg(1)|mondecfg.1>

19
xCAT-client/pods/man1/monstop.1.pod
View File

@ -7,28 +7,31 @@ B<monstop> - Stops a monitoring plug-in module to monitor the xCAT cluster.
I<monstop [-h| --help]>
I<monstop [-v| --version]>
I<monstop [-v| --version]>
I<monstop name>
I<monstop name [noderange] [-r|--remote]>
=head1 DESCRIPTION
This command is used to unregister a monitoring plug-in module from the I<monitoring> table. A monitoring plug-in module acts as a bridge that connects a 3rd party monitoring software and the xCAT cluster. Once unregistered, xCAT will ask the monitoring plug-in to stop the 3rd party software to monitor the xCAT cluster.
This command is used to stop a 3rd party software, (for example stop the daemons), from monitoring the xCAT cluster. The operation is performed on the management node and the service nodes of the given nodes. The operation will also be performed on the nodes if the I<-r> option is specified.
=head1 Parameters
I<name> is the name of the monitoring plug-in module in the I<monitoring> table.
I<name> is the name of the monitoring plug-in module in the I<monitoring> table. Use I<monls> command to list all the monitoring plug-in modules that can be used.
I<noderange> is the nodes to be stopped for monitoring. If omitted, all nodes will be stopped.
=head1 OPTIONS
B<-h | -help> Display usage message.
B<-r | --remote> Specifies that the operation will also be performed on the nodes. For example, the3rd party monitoring software daemons on the nodes will also be stopped.
B<-v | -version > Command Version.
B<-V | -verbose> Verbose output.
=head1 RETURN VALUE
@ -43,7 +46,7 @@ B<-V | -verbose> Verbose output.
monstop gangliamon
Please note that gangliamon must have been registered in the xCAT I<monitoring> table. For a list of registered plug-in modules, use command I<tabdump monitoring>.
Please note that gangliamon must have been registered in the xCAT I<monitoring> table. For a list of registered plug-in modules, use command I<monls>.
@ -54,7 +57,7 @@ Please note that gangliamon must have been registered in the xCAT I<monitoring>
=head1 SEE ALSO
L<monstart(1)|monstart.1>, L<monls(1)|monls.1>
L<monls(1)|monls.1>, L<monstart(1)|monstart.1>, L<monadd(1)|monadd.1>, L<monrm(1)|monrm.1>, L<moncfg(1)|moncfg.1>, L<mondecfg(1)|mondecfg.1>