diff --git a/CHANGELOG.md b/CHANGELOG.md index 52d21b2..53fb27b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,21 @@ Changelog of Git Changelog.

No issue

+c0a5382d2c4cd88 Arne Teuke 2017-07-30 12:07:53 +

+

added basic command examples

+ +

+2e89f817d99fb64 Jenkins Server 2017-07-30 12:07:49 +

+

recommit for updates in build 43

+ +

+5f91d2a4715fe48 Arne Teuke 2017-07-30 12:06:19 +

+

added basic command examples

+ +

5c0374245dc1e72 Arne Teuke 2017-07-30 11:50:55

added test command

diff --git a/README.md b/README.md index 0c11d85..2f48d87 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,10 @@ CONFIGURATION * manage configuration files through parameters: * nrpe.conf * nrpe.cfg - * commands.cfg (optional) -* manage iptables (optionals ) +* manage sudo role for nagios user on NRPE clients +* manage dynamic NRPE check command definitions +* manage iptables (optional) +* manage selinux rule exceptions (optional) SERVICE * manage NRPE service @@ -82,13 +84,16 @@ There are currently no mandatory parameters, i.e. the module will function right ### Optional Parameters -* `$ne_manage_cmds` : Whether to manage check command definitions dynamically through a define, i.e. from other Puppet modules or profiles. Defaults to `true`. -* `$ne_incl_fw` : Whether to manage relevant firewall rules through this modules. Defaults to `true`. -* `$ne_include_selinux` : Whether to manage selinux exception rules. Defaults to `true`. +* `$ne_manage_cmds` : Whether to manage check command definitions dynamically through a define, i.e. from other Puppet modules or profiles. Defaults to `true`. +* `$ne_incl_fw` : Whether to manage relevant firewall rules through this modules. Defaults to `true`. +* `$ne_include_selinux` : Whether to manage selinux exception rules. Defaults to `true`. +* `$ne_enable_ssl` : Whether to allow SSL settings. See [known problems](#konwn-problems) for more details. ### Managing Check Commands In order to connect a Nagios monitoring server to clients through NRPE, you must define commands and the desired argument strings on the clients. The default NRPE installation comes with a few examples of such commands, which are also included in this module. However, every environment is very different in their requirements and Nagios via Puppet is all about the ability to dynamicically set command arguments based on default variables / overrides. For that reason no hard-coded commands are included, but instead all commands are set via argument strings, where possible. +The commands are created within /etc/nrpe.d/command.cfg , every set of instructions creates a new line. + Defining commands is as simple as that: ``` `cd_nrpe::commands::definitions` { 'check_users': @@ -96,13 +101,14 @@ Defining commands is as simple as that: `ne_cmd_argstring` => '-w $ARG1$ -c $ARG2$', } ``` -It is very recommendable to define such commands within Puppet modules controlling services, so any node running the particular service will automatically get the required check commands defined as well. +It is very recommendable to define such commands within Puppet modules controlling services, so any node running the particular service will automatically get the required check commands defined as well, while nodes not running the service also do not contain the command check. ### SELINUX All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored. ### Known Problems +* SSL/TLS support: Version 3 of NRPE supposedly has support for SSL/ TLs. However, at the time of writing this module, this seems to be buggy, as I was unable to start the NRPE service as soon as the `ssl_cert_file` line was uncommented in teh configuration file, despite having valid certs in the right position on the node. This happened when installing manually, not through this Puppet module. For that reason I included the `$ne_enable_ssl` boolean parameter, which is set to `false` by default, hence disabling SSL/TLS options until this has been fixed upstream, or a valid workaround has been found. Setting this option to `true` will include all SSL / TLS settings. ### Support * OS: CentOS 6, 7 diff --git a/REPOSTRUCTURE.md b/REPOSTRUCTURE.md index 75fc289..2c32000 100644 --- a/REPOSTRUCTURE.md +++ b/REPOSTRUCTURE.md @@ -50,7 +50,8 @@ | |-- cmd_head.erb | |-- cmd_rule.erb | |-- nrpe_cfg.erb -| `-- nrpe_conf.erb +| |-- nrpe_conf.erb +| `-- sudo_rule.erb |-- tests | `-- UTF_Files |-- CHANGELOG.md @@ -61,4 +62,4 @@ |-- README.md `-- REPOSTRUCTURE.md -11 directories, 50 files +11 directories, 51 files diff --git a/doc/_index.html b/doc/_index.html index 26d55f9..9457811 100644 --- a/doc/_index.html +++ b/doc/_index.html @@ -171,7 +171,7 @@ diff --git a/doc/file.README.html b/doc/file.README.html index 0ec7a80..ecfad14 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -132,9 +132,13 @@ structure (file system permissions, selinux context) through parameters manage configuration files through parameters: * nrpe.conf * nrpe.cfg - * -commands.cfg (optional) -* manage iptables (optionals )

+* +manage sudo role for nagios user on NRPE clients +* manage dynamic NRPE +check command definitions +* manage iptables (optional) +* manage selinux +rule exceptions (optional)

SERVICE * manage NRPE service

@@ -213,6 +217,9 @@ through this modules. Defaults to true.

  • $ne_include_selinux : Whether to manage selinux exception rules. Defaults to true.

    +
  • +

    $ne_enable_ssl : Whether to allow SSL settings. See known problems for more details.

    • Managing Check Commands

    @@ -226,6 +233,9 @@ ability to dynamicically set command arguments based on default variables / overrides. For that reason no hard-coded commands are included, but instead all commands are set via argument strings, where possible.

    +

    The commands are created within /etc/nrpe.d/command.cfg , every set of +instructions creates a new line.

    +

    Defining commands is as simple as that: <code> @@ -240,7 +250,8 @@ $ARG2$', It is very recommendable to define such commands within Puppet modules controlling services, so any node running the particular service will automatically get the required check commands -defined as well.

    +defined as well, while nodes not running the service also do not contain +the command check.

    SELINUX

    @@ -248,6 +259,18 @@ defined as well.

    selinux is disabled, these contexts are ignored.

    Known Problems

    +

    Support

    Managing Check Commands

    @@ -226,6 +233,9 @@ ability to dynamicically set command arguments based on default variables / overrides. For that reason no hard-coded commands are included, but instead all commands are set via argument strings, where possible.

    +

    The commands are created within /etc/nrpe.d/command.cfg , every set of +instructions creates a new line.

    +

    Defining commands is as simple as that: <code> @@ -240,7 +250,8 @@ $ARG2$', It is very recommendable to define such commands within Puppet modules controlling services, so any node running the particular service will automatically get the required check commands -defined as well.

    +defined as well, while nodes not running the service also do not contain +the command check.

    SELINUX

    @@ -248,6 +259,18 @@ defined as well.

    selinux is disabled, these contexts are ignored.

    Known Problems

    +

    Support