confdroid_nagios/README.md

Repo Name	version	Build Status
cd_nagios	0.0.0.7

Synopsis

Nagios is a powerful open source software solution for monitoring your IT environments.

cd_nagios is a Puppet module allowing to fully automate the setup & configuration of the Nagios server, as well as actively adding client hosts and services to the monitoring environment through PuppetDB.

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
  • Mandatory Parameters
  • Optional Parameters
• [PuppetDB]
• SELINUX
• Known Problems
• Support
• Tests
• Changelog
• Contact Us
• Disclaimer

Features

Installation:

• install httpd
• install server binaries on Nagios server
• install client binaries on clients

Configuration

• configure all aspects of Nagios on server
• manage directories (filesystem permissions, selinux )
• manage cgi.cfg through parameters
• manage nagios users through external Puppet rules via define
• configure NRPE on clients (optional)
• configure firewall (optional)
• configure selinux policies (optional)

Service

• manage Nagios service on server
• manage NRPE service on clients (optional)

Repo Structure

Repostructure has moved to REPOSTRUCTURE.md in repo.

Dependencies

All dependencies must be included in the catalogue.

• cd_resources for Yum repos.
• cd_apache for installing httpd
• cd_firewall or puppetlabs firewall (optional)
• cd_selinux for selinux policy adjustments

Deployment

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_nagios::params must be added to the host or hostgroup in question.

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.

Mandatory Parameters

The following parameters must be set to make the module logic work properly:

• $ng_nagios_server : Specify the FQDN of the nagios server host. Must be a proper A-name, no CNAME i.e. on Loadbalancers. When the FQDN matches the configured value, Nagios server components will be installed and the clients will allow to be connected by that host. Impacts also firewall ports (optional).

Optional Parameters

• $ng_include_nrpe : Whether to include NRPE as means for the Nagios server to connect to clients. Defaults to true.
• $ng_include_fw : Whether to include firewall management. Requires puppetlabs firewall or cd_firewall, which is a clone of the puppetlabs firewall but tested to be fully functioning with all our features.

See the full list of all available parameters

PuppetDB

A working instance of PuppetDBconnected to the Puppet master is required for this to work. Installation and configuration of PuppetDB is out of scope for this module, however cd_puppetdb is available to automate this task for you as well within a few minutes.

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.