summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLeLutin <gabster@lelutin.ca>2016-02-25 06:59:19 +0000
committerLeLutin <gabster@lelutin.ca>2016-02-25 06:59:19 +0000
commitc0dee4a2393e23b226e123a427898de94b342141 (patch)
tree449a726cec957808bdc52fd8e46a6acdaead777c /README
parent5163d89155eec6b6b39994d0cd18e6ceeff8b180 (diff)
parent2892e1795a823c2bee2893bc339854dd4f5e5b94 (diff)
Merge branch 'nrpe_params' into 'master'
Nrpe params The nagios::nrpe class is currently completely unusable with puppet 3.x+ This is because it's still relying on global variables. When one tries to setup an nrpe client with nagios::nrpe with puppet 3.x, the following error occurs: ~~~ ==> jessiepuppet: Error: Failed to parse template nagios/nrpe/nrpe.cfg: ==> jessiepuppet: Filepath: /usr/lib/ruby/vendor_ruby/puppet/parser/templatewrapper.rb ==> jessiepuppet: Line: 81 ==> jessiepuppet: Detail: Could not find value for 'nagios_nrpe_pid_file' at /etc/puppet/modules/nagios/templates/nrpe/nrpe.cfg:19 ==> jessiepuppet: at /etc/puppet/modules/nagios/manifests/nrpe/base.pp:22 on node jessie.vagrantup.com ==> jessiepuppet: Error: Failed to parse template nagios/nrpe/nrpe.cfg: ==> jessiepuppet: Filepath: /usr/lib/ruby/vendor_ruby/puppet/parser/templatewrapper.rb ==> jessiepuppet: Line: 81 ==> jessiepuppet: Detail: Could not find value for 'nagios_nrpe_pid_file' at /etc/puppet/modules/nagios/templates/nrpe/nrpe.cfg:19 ==> jessiepuppet: at /etc/puppet/modules/nagios/manifests/nrpe/base.pp:22 on node jessie.vagrantup.com ~~~ This is because the values of variables defined within nagios::nrpe are not propagated into other classes anymore. This series also changes a default behaviour for creating saner configurations by default: the dont_blame_nrpe option is changed to disable command arguments by default. It also adds some documentation for the nagios::nrpe class since it had no explanation whatsoever of how it should be used in the README. See merge request !18
Diffstat (limited to 'README')
-rw-r--r--README37
1 files changed, 36 insertions, 1 deletions
diff --git a/README b/README
index 2b3791d..46b2a85 100644
--- a/README
+++ b/README
@@ -65,7 +65,42 @@ Obviously, the check command must either be defined using nagios_command objects
(some are supplied in nagios::defaults::commands) or in the nagios configuration
files directly.
-NRPE Services
+NRPE client configuration
+=========================
+
+To setup a machine as an NRPE client, the class 'nagios::nrpe' should be used:
+
+ class { 'nagios::nrpe':
+ allowed_hosts => '10.2.3.4,10.5.6.7',
+ }
+
+The class can take the following parameters to change configuration or
+configuration directory:
+
+ * $cfg_dir : Defines the path to the NRPE configuration. The default is to use
+ the path used by packages per your distro.
+
+ * $pid_file : Sets the path of the PID file. The default value is the path
+ used by init script shipped with your distro's packages.
+
+ * $plugin_dir : Defines the path in which nagios plugins that are to be
+ executed with NRPE commands are stored. The default value is the path where
+ your distro's nagios package stores plugins.
+
+ * $server_address : The IP address to which the NRPE client daemon should
+ bind. The default behaviour is to bind to all IPs.
+
+ * $allowed_hosts : A string containing a comma-separated list of host IPs that
+ are allowed to request NRPE commands to be run. The default value is to
+ allow only 127.0.0.1, so you might want to pass in a list of additional host
+ IPs.
+
+ * $dont_blame : A string that enables ('1') or disables ('0') NRPE command
+ arguments. Enabling arguments can lead to potentials of shell escapes so it
+ should be used with caution and only if absolutely needed. This is disabled
+ by default.
+
+NRPE Services
-------------
Some Nagios services need to be checked via NRPE. The following will make the