diff --git a/README.md b/README.md index 904d222..3e8d704 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ |Repo Name| version | Build Status| |---|---|---|---| -|`cd_nrpe`| 0.0.0.2 | [![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=cd_nrpe)](https://jenkins.confdroid.com/job/cd_nrpe/)| +|`cd_nrpe`| 0.0.1.0 | [![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=cd_nrpe)](https://jenkins.confdroid.com/job/cd_nrpe/)| ### Synopsis NRPE allows monitoring tools like NAGIOS or ICINGA to connect to clients for monitoring purposes. @@ -13,6 +13,7 @@ NRPE allows monitoring tools like NAGIOS or ICINGA to connect to clients for mon ### Table of Contents * [Features](#features) * [Repo Structure](https://gitlab.puppetsoft.com/12WW1160/cd_nrpe/blob/master/REPOSTRUCTURE.md) +* [Repo Documention](#repo-documentation) * [Dependencies](#dependencies) * [Deployment](#deployment) * [native Puppet deployment](#native-puppet-deployment) @@ -49,6 +50,9 @@ SERVICE ### Repo Structure Repostructure has moved to REPOSTRUCTURE.md in repo. +### Repo Documentation +The full puppet html documentation is available in docs/index.html + ### Dependencies All dependencies must be included in the catalogue. @@ -78,6 +82,7 @@ See [more details about class deployment on Confdroid.com](https://confdroid.com ### Parameters The following parameters are editable via params.pp or through ENC (**__recommended__**). Values changed will take immediate effect at next puppet run. Services will be restarted where neccessary. If you want to override parameters, the [module must be specifically declared to hosts when using ENC](#through-foreman). +The [full list of Parameters](https://confdroid.com/2017/07/cd_nrpe-parameters/) is available [here](https://confdroid.com/2017/07/cd_nrpe-parameters/) and in the docs folder in the software repo. ### Mandatory Parameters There are currently no mandatory parameters, i.e. the module will function right out of box as is. @@ -97,12 +102,12 @@ The commands are created within /etc/nrpe.d/command.cfg , every set of instructi Defining commands is as simple as that: ``` -`cd_nrpe::commands::definitions` { 'check_users': - `ne_check_cmd` => 'check_users', - `ne_cmd_argstring` => '-w $ARG1$ -c $ARG2$', +cd_nrpe::commands::definitions { 'check_users': + ne_check_cmd => 'check_users', + 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, while nodes not running the service also do not contain the command check. +It is very recommendable to define such commands directly within Puppet modules or profiles, so any node running the particular service controlled by the module will automatically get the required check commands defined as well, while nodes not running the service also do not contain the command check. The same then is true for Nagios checks, so you would have both the NRPE command definition and the Nagios check contained in Puppet modules or profiles to have it in once location. ### SELINUX @@ -113,9 +118,7 @@ All files and directories are configured with correct selinux context. If selinu ### Troubleshooting * `CHECH_NRPE: Unable to read output`: Nagios sudo access also needs Selinux to allow this. Default settings in this module take care for both through `$ne_allow_sudo` and `$ne_include_selinux`. -* `CHECK_NRPE: Receive header underflow - only 0 bytes received (4 expected): This is down to the new illegal meta characters feature via `nasty_metachars`. - - +* `CHECK_NRPE: Receive header underflow - only 0 bytes received (4 expected): This is down to the new illegal meta characters feature via `nasty_metachars`, i.e. if you included an additional character which actuall be part of a check, or if a custom check contains a default illegal character. ### Support * OS: CentOS 6, 7 diff --git a/manifests/commands/definitions.pp b/manifests/commands/definitions.pp index b4afdce..ec7e9f7 100644 --- a/manifests/commands/definitions.pp +++ b/manifests/commands/definitions.pp @@ -25,7 +25,7 @@ # where the nagis_plugins are located. If you use your own scripts, specify # the custom location **__including the trailing slash__** # @param ne_cmd_argstring Specify the string of valid argument for the command -# , i.e. -w $ARG1$ -c $ARG2$. See the arguments in th eman pages for the +# , i.e. -w $ARG1$ -c $ARG2$. See the arguments in the man pages for the # checks. # @param [string] ne_cmd_comment Specify an optional comment for your command # definition