From bcb162ba492e9af2ae65d2505f0fb0cfc361b615 Mon Sep 17 00:00:00 2001 From: Arne Teuke Date: Mon, 27 Sep 2021 13:47:51 +0200 Subject: [PATCH] spelling --- .spelling | 2 ++ README.md | 10 +++++----- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.spelling b/.spelling index 5d3da51..80c479b 100644 --- a/.spelling +++ b/.spelling @@ -116,3 +116,5 @@ cd_puppetdb SSL vhost nrpe +nrpe.conf +nrpe.cfg diff --git a/README.md b/README.md index 0b60105..024875f 100644 --- a/README.md +++ b/README.md @@ -65,15 +65,15 @@ node 'example.example.net' { * through Foreman: -In order to apply parameters through Foreman, **__cd_nrpe::params__** must be added to the host or hostgroup in question, unless the defaults are fully acceptable across the estate. +In order to apply parameters through Foreman, **__cd_nrpe::params__** must be added to the host or host group in question, unless the defaults are fully acceptable across the estate. See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/). ## 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. +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 dynamiccally 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. +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: @@ -92,12 +92,12 @@ All files and directories are configured with correct selinux context. If selinu ## 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. +* 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 the 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. ## Troubleshooting * `CHECK_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`, 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. +* `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 actually be part of a check, or if a custom check contains a default illegal character. ## Support