confdroid_nrpe/README.md

Repo Name	version	Build Status
cd_nrpe	0.0.0.2

Synopsis

NRPE allows monitoring tools like NAGIOS or ICINGA to connect to clients for monitoring purposes.

cd_nrpe is a fully parameterized Puppet module to automate NRPE installation and configuration.

WARNING

**__!!! Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previuos configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production!!! __**

Table of Contents

• Features
• Repo Structure
• Dependencies
• Deployment
  • native Puppet deployment
  • through Foreman
• Parameters
• Managing Check Commands
• SELINUX
• Known Problems
• Support
• Tests
• Changelog
• Contact Us
• Disclaimer

Features

INSTALLATION

• install nrpe binaries

CONFIGURATION

• manage NRPE service user properties
• manage directory structure (file system permissions, selinux context) through parameters
• manage configuration files through parameters:
  • nrpe.conf
  • nrpe.cfg
  • commands.cfg (optional)
• manage iptables (optionals )

SERVICE

• manage NRPE service

Repo Structure

Repostructure has moved to REPOSTRUCTURE.md in repo.

Dependencies

All dependencies must be included in the catalogue.

• cd_resources to manage YUM repositories.
• cd_firewall or puppetlabs firewall to manage iptables
• cd_stdlib or puppetlabs stdlib to facilitate concat
• cd_concat or puppetlabs concat for concatenating files

Deployment

cd_nrpe does typically not need to be specifically declared. It will be auto-required by cd_nagios with default settings. Only if you want to override settings declare it specifically.

native Puppet deployment

via site.pp or nodes.pp

node 'example.example.net' {
  include cd_puppetdb
}

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.

See more details about class deployment on 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.

Mandatory Parameters

There are currently no mandatory parameters, i.e. the module will function right out of box as is.

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.

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.

SELINUX

All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.

Known Problems

Support

• OS: CentOS 6, 7
• Puppet 3.x

Tests

• Puppet Lint
  • excluded tests:
    • --no-class_inherits_from_params_class-check:relavant only to non-supported outdated puppet versions
    • --no-variable_scope-check: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters.
    • --no-80chars-check: it is not always possible to stay within 80 characters, although typically only occurring on the parameter vault params.pp.
    • --no-arrow_alignment-check: this check leads to actually not having am easily readable arrow alignment, as this checks per block, not per class.
• Puppet Parser
• ERB Template Parser
• Test for unwanted UTF8 files in the Puppet code as this causes problems with PuppetDB (see tests/UTF_Files)

Contact Us

contact Us

Disclaimer

ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments. The modules are tested and supported only as documented, and require testing in designated environments (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.