diff options
| -rw-r--r-- | doc/smokeping_extend.pod | 12 | ||||
| -rw-r--r-- | doc/smokeping_install.pod | 23 | ||||
| -rw-r--r-- | doc/smokeping_master_slave.pod | 30 |
3 files changed, 34 insertions, 31 deletions
diff --git a/doc/smokeping_extend.pod b/doc/smokeping_extend.pod index 3fde6ba..144e998 100644 --- a/doc/smokeping_extend.pod +++ b/doc/smokeping_extend.pod @@ -15,11 +15,13 @@ source of this document are most appreciated. =head1 CHOOSING A BASE CLASS -The first thing you should decide is which base class you should -use for your probe. For most (if not all) uses it's a choice between -L<Smokeping::probes::base|Smokeping::probes::base> and L<Smokeping::probes::basefork|Smokeping::probes::basefork>. The former is intended for probes -that can measure their targets all in one go, while the latter is for -probing them one at a time, possibly in several concurrent subprocesses. +The first thing you should decide is which base class you should use for +your probe. For most (if not all) uses it's a choice between +L<Smokeping::probes::base|Smokeping::probes::base> and +L<Smokeping::probes::basefork|Smokeping::probes::basefork>. The former is +intended for probes that can measure their targets all in one go, while the +latter is for probing them one at a time, possibly in several concurrent +subprocesses. At the moment, the only probes that use C<Smokeping::probes::base> are the FPing derivatives. All the others use C<Smokeping::probes::basefork>, and chances are diff --git a/doc/smokeping_install.pod b/doc/smokeping_install.pod index 484b787..f3b81bd 100644 --- a/doc/smokeping_install.pod +++ b/doc/smokeping_install.pod @@ -61,7 +61,7 @@ You need this for the SSH probe. L<http://httpd.apache.org/> -Well I wont get much into this. The important thing is, to have a webserver +Well I won't get much into this. The important thing is, to have a webserver which allows you to run CGI and preferably FastCGI scripts. If you are using Apache I strongly recommend using the F<suexec> system for running CGI scripts as a particular user. @@ -76,9 +76,10 @@ If you still have an older version, maybe have a look at perlbrew. =item Various Perl modules (Many are optional) -The modules are all available from L<http://www.cpan.org> and you may be able to get them as -packages from your distros repository. There is also a script provided in the setup -folder to install the missing bits. You will be instructed later on how to use the script. +The modules are all available from L<http://www.cpan.org> and you may be +able to get them as packages from your distro's repository. There is also a +script provided in the setup folder to install the missing bits. You will +be instructed later on how to use the script. =over @@ -97,8 +98,8 @@ The configuration file parser used in smokeping =item LWP The master/slave functionality introduced a dependency on LWP::UserAgent -from the libwww-perl (also known as LWP) library. The module -is required even if the master/slave mode is not enabled. +from the libwww-perl (also known as LWP) library. The module is required +even if the master/slave mode is not enabled. =item Socket6 (optional) @@ -171,9 +172,9 @@ F<smokeping.cgi> script. =item F<etc/basepage.html> Edit the html template to your likings. Please do not remove the link to the -SmokePing counter and my name from the template. The content of the template -will be renderd by the smokeping.cgi. This means that all embedded links must -be relative to smokeping.cgi. +SmokePing counter and my name from the template. The content of the +template will be renderd by smokeping.cgi. This means that all embedded +links must be relative to smokeping.cgi. =item F<etc/smokemail> @@ -189,8 +190,8 @@ it is doing ./bin/smokeping --config=/opt/smokeping/etc/config --debug -once all is well, start it up as a daemon. I would recomend to enable the logfile -option so that you can see if it runs into trouble. +once all is well, start it up as a daemon. I would recomend you enable the +logfile option so that you can see if it runs into trouble. ./bin/smokeping --config=/opt/smokeping/etc/config --logfile=smoke.log diff --git a/doc/smokeping_master_slave.pod b/doc/smokeping_master_slave.pod index 14da56f..8f7d2bd 100644 --- a/doc/smokeping_master_slave.pod +++ b/doc/smokeping_master_slave.pod @@ -1,6 +1,6 @@ =head1 NAME -smokeping_master_slave - How run multiple distributed instances of SmokePing +smokeping_master_slave - How to run multiple distributed instances of SmokePing =head1 OVERVIEW @@ -47,12 +47,12 @@ communication can run over ssl. +---------------+ The slave is a normal smokeping instance setup where the configuration comes -from the master instead of a local configuration file. The slave tries to +from the master instead of a local configuration file. The slave tries to contact the master server after every round of probing, supplying its -results. If the master server can not be reached, the results will be sent -to the server together with the next round of results. Results will be -stored in a perl storable so that they survive a restart of the smokeping -instance. +results. If the master server can not be reached, the results will be sent +to the server together with the next round of results. Results will be +stored in a file in Perl storable form so that they survive a restart of the +smokeping instance. =head2 Master Configuration @@ -62,7 +62,7 @@ master configuration file. The section name must match the hostname of the slave. If some configuration parameter must be set to a special value for the slave, use an override section to configure this. -The slave names must be the names the hosts think they have not their +The slave names must be the names the hosts think they have, not their outside hostnames or ip addresses or anything like that. When the slave calls the master to get its config or report its measurements it will tell the master its 'hostname'. This together with the shared secret is used to @@ -98,8 +98,8 @@ A slave will then get the appropriate configuration assigned by the server. +dest3 ... -The data from the slaves will be stored in F<TargetName~SlaveName.rrd>. So the example above would -create the following files: +The data from the slaves will be stored in F<TargetName~SlaveName.rrd>. So +the example above would create the following files: dest1.rrd dest2.rrd @@ -130,12 +130,12 @@ is NOT the same as the F<slavesecrets.conf> file the master uses. =head1 SECURITY CONSIDERATIONS -The master effectively has full access to slave hosts as the user the -slave smokeping instance is run as. The configuration is transferred as -Perl code that is evaluated on the slave. While this is done inside a -restricted C<Safe> compartment, there are various ways that a malicious -master could use to embed arbitrary commands in the configuration and -get them to run when the slave probes its targets. +The master effectively has full access to slave hosts as the user running +the slave smokeping instance. The configuration is transferred as Perl code +that is evaluated on the slave. While this is done inside a restricted +C<Safe> compartment, there are various ways that a malicious master could +embed arbitrary commands in the configuration and get them to run when the +slave probes its targets. The strength of the shared secret is thus of paramount importance. Brute forcing the secret would enable a man-in-the-middle to inject a malicious |