Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

RSS

nrpe (24) Versions 1.5.2

Installs and configures Nagios NRPE client

Berkshelf/Librarian
Policyfile
Knife
cookbook 'nrpe', '= 1.5.2'
cookbook 'nrpe', '= 1.5.2', :supermarket
knife cookbook site install nrpe
knife cookbook site download nrpe
README
Dependencies
Changelog
Quality

nrpe cookbook

Build Status

Chef cookbook to install Nagios NRPE client (was previously part of the Nagios cookbook)

Requirements

Chef

Chef version 0.10.10+ and Ohai 0.6.12+ are required.

Platform

  • Debian 6.X, 7.X
  • FreeBSD 9.X
  • Ubuntu 10.04, 12.04, 13.04
  • Red Hat Enterprise Linux (CentOS/Amazon/Scientific/Oracle) 5.X, 6.X
  • Fedora

Notes: This cookbook has been tested on the listed platforms. It may work on other platforms with or without modification.

Cookbooks

  • build-essential
  • yum-epel (note: this requires yum cookbook v3.0, which breaks compatibility with many other cookbooks)

Recipes

default

Installs the NRPE client via packages or source depending on platform and attributes set

Attributes

platform specific attributes (auto set based on platform)

  • node['nrpe']['install_method'] - whether to install from package or source. Default chosen by platform based on known packages available for NRPE: debian/ubuntu 'package', Redhat/CentOS/Fedora/Scientific: source
  • node['nrpe']['home'] - home directory of NRPE
  • node['nrpe']['conf_dir'] - location of the nrpe configuration
  • node['nrpe']['ssl_lib_dir'] - ssl directory used by NRPE
  • node['nrpe']['pidfile'] - location to store the NRPE pid file
  • node['nrpe']['conf_dir'] - location of the nrpe configuration, default /etc/nagios
  • node['nrpe']['packages'] - nrpe / plugin packages to install. The default attribute for RHEL/Fedora platforms contains a bare minimum set of packages. The full list of available packages is available at: http://dl.fedoraproject.org/pub/epel/6/x86_64/repoview/letter_n.group.html
  • node['nrpe']['log_facility'] - log facility for nrpe configuration, default nil (not set)
  • node['nrpe']['plugin_dir'] - location where Monitoring plugins (aka Nagios plugins) go, default '/usr/lib/nagios/plugins'.

options for package install

  • node['nrpe']['package']['options'] - options when installing nrpe via package manager. The default value for this attribute is nil.`
  • node['nrpe']['install_yum-epel'] - whether to install the EPEL repo or not. The default value is true. Set this to false if you do not wish to install the EPEL RPM; in this scenario you will need to make the relevant NRPE packages available via another method e.g. local repo.

nrpe.conf attributes

  • node['nrpe']['server_port'] - the port nrpe will listen on, default 5666
  • node['nrpe']['server_address'] - the IP the nrpe server will listen on. This allows you to bind to particular IPs in situations where the system has more than one IP. This is particularly handy in determining if nrpe should bind to the internal or public IP in a cloud environment. Set the attribute to the node attribute for the cloud interface you wish to use. Defaults to nil (not enabled)
  • node['nrpe']['log_facility'] - syslog facility to log to, default nil (not set)
  • node['nrpe']['command_prefix'] - command to prefix to every nrpe command (like perhaps sudo), default nil (not set)
  • node['nrpe']['debug'] - debug level nrpe configuration, default 0
  • node['nrpe']['connection_timeout'] - connection timeout for nrpe configuration, default nil (not set)
  • node['nrpe']['dont_blame_nrpe'] - allows the server to send additional values to NRPE via arguments. this needs to be enabled for most checks to function
  • node['nrpe']['command_timeout'] - the amount of time NRPE will wait for a command to execute before timing out
  • node['nrpe']['allow_bash_command_substitution'] - allows bash command substitution in your nrpe commands - defaults to nil

urls for source installations

  • node['nrpe']['url'] - url to retrieve NRPE source
  • node['nrpe']['version'] - version of NRPE source to download
  • node['nrpe']['checksum'] - checksum of the NRPE source tarball
  • node['nrpe']['plugins']['url'] - url to retrieve the plugins source from
  • node['nrpe']['plugins']['version'] - version of the plugins source to download
  • node['nrpe']['plugins']['checksum'] - checksum of the plugins source tarball

authorization and server discovery

  • node['nrpe']['server_role'] - the role that the Nagios server will have in its run list that the clients can search for.
  • node['nrpe']['allowed_hosts'] - additional hosts that are allowed to connect to this client. Must be an array of strings (i.e. %w(test.host other.host)). These hosts are added in addition to 127.0.0.1 and IPs that are found via search.
  • node['nrpe']['using_solo_search'] - discover server information in node data_bags even with chef solo through the use of solo-search (https://github.com/edelight/chef-solo-search)
  • node['nrpe']['multi_environment_monitoring'] - search for nagios servers in all environments not just that of the node when building the array of allowed hosts, default 'false'

user and group attributes

  • node['nrpe']['user'] - NRPE user, default 'nagios'.
  • node['nrpe']['group'] - NRPE group, default 'nagios'.

Resources/Providers

check

The check LWRP provides an easy way to add and remove NRPE checks from within cookbooks.

Actions

  • :add creates a NRPE configuration file and reloads the NRPE process. Default action.
  • :remove removes the configuration file and reloads the NRPE process

Attribute Parameters

  • command_name The name of the check. This is the command that you will call from your nagios_service data bag check
  • warning_condition String that you will pass to the command with the -w flag
  • critical_condition String that you will pass to the command with the -c flag
  • command The actual command to execute (including the path). If this is not specified, this will use #{node['nrpe']['plugin_dir']}/command_name as the path to the command.
  • parameters Any additional parameters you wish to pass to the plugin.

Examples

# Use LWRP to define check_load
nrpe_check "check_load" do
  command "#{node['nrpe']['plugin_dir']}/check_load"
  warning_condition '10'
  critical_condition '15'
  action :add
end
# Remove the check_load definition
nrpe_check "check_load" do
  action :remove
end

License & Authors

Copyright 2009, 37signals
Copyright 2009-2013, Chef Software, Inc.
Copyright 2012, Webtrends Inc.
Copyright 2013-2014, Limelight Networks, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

CHANGELOG for nrpe

This file is used to list changes made in each version of nrpe

1.5.2

  • Fedora 20+ / RHEL 7+ systems now run the daemon as nrpe/nrpe since the user installed by the package changed
  • Fedora 20+ / RHEL 7+ systems now restart on check updates since the systemd scipt doesn't include a reload action
  • Removed the retry count for starting the NRPE service, which didn't fix the real issue on RHEL 7+

1.5.0

  • Added 3 retries with a delay of 3 to the nrpe service start for RHEL/CentOS 7
  • Added ability to define node['nrpe']['packages'] as a Hash to add version information as sample below. In your environment specific cookbook, this version infomation for each individual package can be overriden for required versions (instead of latest one). If it is nil it will install latest one from repositories.

Sample: default['nrpe']['packages'] = { 'nagios-nrpe-server' => {'version' => nil}, 'nagios-plugins' => {'version' => nil}, 'nagios-plugins-basic' => {'version' => nil}, 'nagios-plugins-standard' => {'version' => nil} }

For backward compatibiility, it will also install packages if it is defined as an array in your env specific cookbook.

1.4.12

  • Added default['nrpe']['checks'] to store all checks as a node attribute
  • Removed Ruby 1.9.3 and added Ruby 2.2.0 to Travis
  • Make the yum-epel recipe optional with default['nrpe']['install_yum-epel']

1.4.10

  • Add support for CentOS / RHEL
  • Update the LWRP to use the default action functionality introduced in Chef 0.10.10

1.4.8

  • Rubocop fixes
  • Remove .DS_Store files in the supermarket file that caused failures on older versions of Berkshelf
  • Remove strainer gem from Gemfile

1.4.6

  • Update specs to Chefspec 4.1
  • Add additional platforms to the Vagrantfile
  • Fix a compile error / logic error when running on Fedora

1.4.4

  • Add a chefignore file so that Berkshelf wont fail on dsstore files

1.4.2

  • NRPE running on a Nagios server would not enable polling from other Nagios servers

1.4.0

  • Update from nagios-plugins to monitoring-plugins in source installs since the project name changed
  • Update nagios-plugins 1.5 to 2.0 for source installs
  • Reorder the attributes so that FreeBSD has log_facility properly set
  • Add additional specs and update specs to the latest Debian / FreeBSD releases
  • Update Berkshelf to 3.1.X and update the Berksfile to the new format

1.3.0

  • Source lsb init-functions in the init script on Ubuntu source installs so the service doesn't start every run
  • Added new attribute node['nrpe']['allow_bash_command_substitution'] to allow using the allow_bash_command_substitution config option
  • When searching the the monitoring role search for roles vs. role so the monitoring role can be nested on the run_list
  • Sort and Unique the array of allowed monitor hosts. This prevents NRPE from restarting on every run when the results come back in a different order
  • Fix deprecated warning when running specs

1.2.0

  • Add status / reload commands to the init script for source installs resolving issues with the service on source installs
  • Add new node['nrpe']['package']['options'] attribute for adding install options to the package install
  • Add Ubuntu 14.04 to the Test Kitchen config and remove Ubuntu 13.04
  • Add source install suite to Test Kitchen

1.1.2

  • Include an example base monitoring recipe with base NRPE checks defined
  • Fix the LWRP example in the Readme to reflect the current state of the cookbook

1.1.0

  • Added a server_address attribute to allow binding NRPE to the IP of a specific interface
  • Added a server_port attribute to allow changing the NRPE port
  • Added a command_prefix attribute to allow prefixing all commands with another command such as sudo
  • Minor fixes to the readme

1.0.6

  • Reload NRPE instead of restarting it when a new check is added
  • Fix log_facility in the NRPE config to write out on its own line vs clobbering the config

1.0.4

  • Expanded the chefspecs to multiple platforms and install methods
  • Fixed a bug where the plugin dir wasn't defined for RHEL platforms causing source install failures

1.0.2

  • Add chefspecs
  • Fix test kitchen setup on FreeBSD
  • Lint fixes with Rubocop
  • Nagios plugin_dir for Debian/Ubuntu was incorrect. Should always be /usr/lib/nagios/plugins regardless of CPU arch
  • Update readme to remove several references to the old Nagios cookbook

1.0.0:

  • Initial release of the cookbook with client functionality split from the existing nagios cookbook

Foodcritic Metric
            

1.5.2 failed this metric

FC003: Check whether you are running with chef server before using server-specific features: /tmp/cook/d067826a80a6d104952d675b/nrpe/recipes/default.rb:36
FC003: Check whether you are running with chef server before using server-specific features: /tmp/cook/d067826a80a6d104952d675b/nrpe/recipes/default.rb:40