Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/link0/puppet-nrpe
Puppet module for NRPE
https://github.com/link0/puppet-nrpe
Last synced: about 2 months ago
JSON representation
Puppet module for NRPE
- Host: GitHub
- URL: https://github.com/link0/puppet-nrpe
- Owner: link0
- License: mit
- Created: 2016-09-04T16:56:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-11T09:24:50.000Z (over 6 years ago)
- Last Synced: 2024-10-30T01:55:49.865Z (3 months ago)
- Language: Puppet
- Size: 11.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# link0/puppet-nrpe
[![Build status][build-img]][build-url]
[![License badge][license-img]][license-url]
[![Puppet badge][puppet-img]][puppet-url]
## Overview
The [link0/nrpe](https://forge.puppet.com/link0/nrpe) module installs, configures and manages the NRPE service.
## Usage
###
Basic usage accepting all defaults (installation, configuration, managing the service, etcetera)
```puppet
include ::nrpe
```
Although, if you would like to have more control over the service, you can pass parameters like this:
```puppet
class { '::nrpe':
package_ensure => latest,
service_manage => false,
}
```
These settings can also be overridden by using Hiera
```yaml
nrpe::service_manage: false
```
## Defining commands
This module is all about defining commands to be called remotely.
```puppet
# 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
```puppet
# 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
```puppet
# 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`.
[build-img]: https://travis-ci.org/link0/puppet-nrpe.svg
[build-url]: https://travis-ci.org/link0/puppet-nrpe
[license-img]: https://img.shields.io/badge/license-MIT-blue.svg
[license-url]: https://github.com/link0/puppet-nrpe/blob/master/LICENSE
[puppet-img]: https://img.shields.io/puppetforge/dt/link0/nrpe.svg
[puppet-url]: https://forge.puppetlabs.com/link0/nrpe