Version information
This version is compatible with:
Start using this module
Add this module to your Puppetfile:
mod 'link0-nrpe', '0.0.3'Learn more about managing modules with a PuppetfileDocumentation
link0/puppet-nrpe
Overview
The link0/nrpe module installs, configures and manages the NRPE service.
Usage
Basic usage accepting all defaults (installation, configuration, managing the service, etcetera)
include ::nrpe
Although, if you would like to have more control over the service, you can pass parameters like this:
class { '::nrpe':
package_ensure => latest,
service_manage => false,
}
These settings can also be overridden by using Hiera
nrpe::service_manage: false
Defining commands
This module is all about defining commands to be called remotely.
# This command creates '/etc/nagios/nrpe.d/check_apt.cfg' with the content:
# command[check_apt]=/usr/lib/nagios/plugins/check_apt
nrpe::command { 'check_apt':
}
If you want to add arguments, those can be defined as well
# This command creates '/etc/nagios/nrpe.d/check_procs.cfg' with the content:
# command[check_procs]=/usr/lib/nagios/plugins/check_procs -w 175 -c 200
nrpe::command { 'check_procs':
arguments => '-w 175 -c 200',
}
You can even specify a custom command, but keep the name NRPE calls
# This command creates '/etc/nagios/nrpe.d/check_foo.cfg' with the content:
# command[check_foo]=/usr/bin/foo -w bar -c baz
nrpe::command { 'check_foo':
command => '/usr/bin/foo',
arguments => '-w bar -c baz',
}
Customization
package_manage
Whether the package should be managed by puppet. Type: boolean. Defaults to true
eg package_manage: false will not install the package from your package manager
package_ensure
If the package is managed, how to ensure the package, Type: installed, absent or latest. Defaults to installed
package_name
If the package is available under a different name, you can specify it here. Type: string Defaults to nagios-nrpe-server
service_manage
Whether you want puppet to manage the service. Type: boolean, defaults to true
service_ensure
If the service is managed by puppet, what should be ensured. Type: running or stopped. Defaults to running
service_name
If the service is managed by puppet, what the name of the service should be. Type: string Defaults to 'nagios-nrpe-server'.
config_manage
Whether you want puppet to manage nrpe.cfg. Type: boolean, defaults to true
config_file
If the configuration is managed by puppet, which file should be managed. Type: absolute_path. Defaults to /etc/nagios/nrpe.cfg
config_template
If the configuration is managed by puppet, which template should be used. Type: string. Defaults to nrpe/nrpe.cfg.erb
allowed_hosts
Which hosts are allowed to connect to NRPE. Type: array. Defaults to ['127.0.0.1'].
port
Which port should NRPE be listening on. Type: integer. Defaults to 5666.
user
Which user should NRPE be running under. Type: string. Defaults to nagios.
group
Which group should NRPE be running under. Type: string. Defaults to nagios.
pid_file
Which file should be used to store the PID. Type absolute_path. Defaults to /var/run/nagios/nrpe.pid.
log_facility
Which log facility should NRPE be logging to. Type: string. Defaults to daemon.
command_timeout
What timeout should be set for commands. Type: integer. Defaults to 60.
connection_timeout
What timeout should be set for connection issues. Type: integer. Defaults to 300.
debug
Should NRPE be logging debug output. Type: boolean. Defaults to false.
Dependencies
- puppetlabs/stdlib (>= 3.2.0 <5.0.0)
MIT License Copyright (c) 2016 Link0 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.