From 9989233beac4e5267400ca83571fcf00c7fe6d3c Mon Sep 17 00:00:00 2001 From: Arne Teuke Date: Sun, 30 Jul 2017 19:46:01 +0100 Subject: [PATCH 1/2] edited README --- README.md | 19 +++++++++++-------- manifests/commands/definitions.pp | 2 +- 2 files changed, 12 insertions(+), 9 deletions(-) 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 From fb0875786c496b8b0a9d3f1f09d922429d83b41a Mon Sep 17 00:00:00 2001 From: Jenkins Server Date: Sun, 30 Jul 2017 20:45:56 +0200 Subject: [PATCH 2/2] recommit for updates in build 60 --- CHANGELOG.md | 10 +++++ doc/_index.html | 2 +- doc/file.README.html | 43 +++++++++++++------ doc/index.html | 43 +++++++++++++------ doc/puppet_classes/cd_nrpe.html | 2 +- ...e_3A_3Acommands_3A_3Adefinition_rules.html | 2 +- .../cd_nrpe_3A_3Afirewall_3A_3Aiptables.html | 2 +- .../cd_nrpe_3A_3Amain_3A_3Aconfig.html | 2 +- .../cd_nrpe_3A_3Amain_3A_3Adirs.html | 2 +- .../cd_nrpe_3A_3Amain_3A_3Afiles.html | 2 +- .../cd_nrpe_3A_3Amain_3A_3Ainstall.html | 2 +- .../cd_nrpe_3A_3Amain_3A_3Aservice.html | 2 +- .../cd_nrpe_3A_3Amain_3A_3Auser.html | 2 +- doc/puppet_classes/cd_nrpe_3A_3Aparams.html | 2 +- .../cd_nrpe_3A_3Aselinux_3A_3Aconfig.html | 2 +- ...d_nrpe_3A_3Acommands_3A_3Adefinitions.html | 4 +- doc/top-level-namespace.html | 2 +- 17 files changed, 83 insertions(+), 43 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9bdb698..c14e3e4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,16 @@ Changelog of Git Changelog.

No issue

+eb321fc56246dca Arne Teuke 2017-07-30 18:25:18 +

+

changed default illegal characters

+ +

+6f93ac1b07efbf0 Jenkins Server 2017-07-30 18:25:15 +

+

recommit for updates in build 59

+ +

f39c1e36b56e589 Arne Teuke 2017-07-30 18:06:33

changed default illegal characters

diff --git a/doc/_index.html b/doc/_index.html index 1ed27e5..efd44fc 100644 --- a/doc/_index.html +++ b/doc/_index.html @@ -176,7 +176,7 @@ diff --git a/doc/file.README.html b/doc/file.README.html index 6cccb93..235fbcc 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -61,7 +61,7 @@

|Repo Name| version | Build Status| |---|---|---|---| -|cd_nrpe| 0.0.0.2 | cd_nrpe| 0.0.1.0 | {Build Status/]|

@@ -91,6 +91,8 @@ production!!! __**

href="https://gitlab.puppetsoft.com/12WW1160/cd_nrpe/blob/master/REPOSTRUCTURE.md">Repo Structure

  • +

    Repo Documention

    +

  • Dependencies

  • Deployment

    @@ -147,6 +149,10 @@ rule exceptions (optional)

    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.

    @@ -201,6 +207,11 @@ 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.

    +

    The full list +of Parameters is available here and in +the docs folder in the software repo.

    +

    Mandatory Parameters

    There are currently no mandatory parameters, i.e. the module will function @@ -244,19 +255,21 @@ instructions creates a new line.

    Defining commands is as simple as that: <code> -`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$', } </code> -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

    @@ -286,7 +299,9 @@ both through $ne_allow_sudo and

  • CHECK_NRPE: Receive header underflow - only 0 bytes received (4 expected): This is down to the new illegal meta characters feature -vianasty_metachars`.

    +vianasty_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

    @@ -342,7 +357,7 @@ environments.

    diff --git a/doc/index.html b/doc/index.html index 1cd61e2..c11081c 100644 --- a/doc/index.html +++ b/doc/index.html @@ -61,7 +61,7 @@

    |Repo Name| version | Build Status| |---|---|---|---| -|cd_nrpe| 0.0.0.2 | cd_nrpe| 0.0.1.0 | {Build Status/]|

    @@ -91,6 +91,8 @@ production!!! __**

    href="https://gitlab.puppetsoft.com/12WW1160/cd_nrpe/blob/master/REPOSTRUCTURE.md">Repo Structure

  • +

    Repo Documention

    +

  • Dependencies

  • Deployment

    @@ -147,6 +149,10 @@ rule exceptions (optional)

    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.

    @@ -201,6 +207,11 @@ 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.

    +

    The full list +of Parameters is available here and in +the docs folder in the software repo.

    +

    Mandatory Parameters

    There are currently no mandatory parameters, i.e. the module will function @@ -244,19 +255,21 @@ instructions creates a new line.

    Defining commands is as simple as that: <code> -`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$', } </code> -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

    @@ -286,7 +299,9 @@ both through $ne_allow_sudo and

  • CHECK_NRPE: Receive header underflow - only 0 bytes received (4 expected): This is down to the new illegal meta characters feature -vianasty_metachars`.

    +vianasty_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

    @@ -342,7 +357,7 @@ environments.

    diff --git a/doc/puppet_classes/cd_nrpe.html b/doc/puppet_classes/cd_nrpe.html index be47f32..d63eb72 100644 --- a/doc/puppet_classes/cd_nrpe.html +++ b/doc/puppet_classes/cd_nrpe.html @@ -140,7 +140,7 @@ class cd_nrpe { diff --git a/doc/puppet_classes/cd_nrpe_3A_3Acommands_3A_3Adefinition_rules.html b/doc/puppet_classes/cd_nrpe_3A_3Acommands_3A_3Adefinition_rules.html index 795b14a..4b458c2 100644 --- a/doc/puppet_classes/cd_nrpe_3A_3Acommands_3A_3Adefinition_rules.html +++ b/doc/puppet_classes/cd_nrpe_3A_3Acommands_3A_3Adefinition_rules.html @@ -267,7 +267,7 @@ class cd_nrpe::commands::definition_rules ( diff --git a/doc/puppet_classes/cd_nrpe_3A_3Afirewall_3A_3Aiptables.html b/doc/puppet_classes/cd_nrpe_3A_3Afirewall_3A_3Aiptables.html index 870f902..ff1c3c9 100644 --- a/doc/puppet_classes/cd_nrpe_3A_3Afirewall_3A_3Aiptables.html +++ b/doc/puppet_classes/cd_nrpe_3A_3Afirewall_3A_3Aiptables.html @@ -165,7 +165,7 @@ class cd_nrpe::firewall::iptables ( diff --git a/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Aconfig.html b/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Aconfig.html index a4c1624..22f339a 100644 --- a/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Aconfig.html +++ b/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Aconfig.html @@ -154,7 +154,7 @@ class cd_nrpe::main::config ( diff --git a/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Adirs.html b/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Adirs.html index 69c7f36..904b128 100644 --- a/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Adirs.html +++ b/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Adirs.html @@ -205,7 +205,7 @@ class cd_nrpe::main::dirs ( diff --git a/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Afiles.html b/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Afiles.html index b20107c..edffee0 100644 --- a/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Afiles.html +++ b/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Afiles.html @@ -247,7 +247,7 @@ class cd_nrpe::main::files ( diff --git a/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Ainstall.html b/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Ainstall.html index 662c698..6557f23 100644 --- a/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Ainstall.html +++ b/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Ainstall.html @@ -160,7 +160,7 @@ class cd_nrpe::main::install ( diff --git a/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Aservice.html b/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Aservice.html index fd1e9ba..2fc3e59 100644 --- a/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Aservice.html +++ b/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Aservice.html @@ -191,7 +191,7 @@ class cd_nrpe::main::service ( diff --git a/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Auser.html b/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Auser.html index 0fe1cf3..0b48be9 100644 --- a/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Auser.html +++ b/doc/puppet_classes/cd_nrpe_3A_3Amain_3A_3Auser.html @@ -193,7 +193,7 @@ class cd_nrpe::main::user ( diff --git a/doc/puppet_classes/cd_nrpe_3A_3Aparams.html b/doc/puppet_classes/cd_nrpe_3A_3Aparams.html index ff34e1c..ff41999 100644 --- a/doc/puppet_classes/cd_nrpe_3A_3Aparams.html +++ b/doc/puppet_classes/cd_nrpe_3A_3Aparams.html @@ -1067,7 +1067,7 @@ $ne_sudo_rule_erb = 'cd_nrpe/sudo_rule.erb' diff --git a/doc/puppet_classes/cd_nrpe_3A_3Aselinux_3A_3Aconfig.html b/doc/puppet_classes/cd_nrpe_3A_3Aselinux_3A_3Aconfig.html index 06310a1..3587bbb 100644 --- a/doc/puppet_classes/cd_nrpe_3A_3Aselinux_3A_3Aconfig.html +++ b/doc/puppet_classes/cd_nrpe_3A_3Aselinux_3A_3Aconfig.html @@ -170,7 +170,7 @@ class cd_nrpe::selinux::config ( diff --git a/doc/puppet_defined_types/cd_nrpe_3A_3Acommands_3A_3Adefinitions.html b/doc/puppet_defined_types/cd_nrpe_3A_3Acommands_3A_3Adefinitions.html index 40d8aa0..56b79c7 100644 --- a/doc/puppet_defined_types/cd_nrpe_3A_3Acommands_3A_3Adefinitions.html +++ b/doc/puppet_defined_types/cd_nrpe_3A_3Acommands_3A_3Adefinitions.html @@ -171,7 +171,7 @@ the custom location

    Specify the string of valid argument for the command , i.e. -w $ARG1$ -c -$ARG2$. See the arguments in th eman pages for the +$ARG2$. See the arguments in the man pages for the checks.

    @@ -259,7 +259,7 @@ $ne_manage_cmds = $::cd_nrpe::params::ne_manage_cmds diff --git a/doc/top-level-namespace.html b/doc/top-level-namespace.html index fa53777..fcf84c6 100644 --- a/doc/top-level-namespace.html +++ b/doc/top-level-namespace.html @@ -90,7 +90,7 @@