opuppet/module-icinga2
5
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

updating README

Browse source 
Signed-off-by: Nick Chappell <nick@intronic.org>

Merged from PR #34: https://github.com/Icinga/puppet-icinga2/pull/34
This commit is contained in:
Steven Bambling 2014-10-23 14:08:02 -04:00 committed by Nick Chappell
parent a5ce5144d9
commit 6f7a249841
1 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -237,6 +237,33 @@ class { 'icinga2::server':
This will stop the `icinga2::server` class from trying to install the plugins pacakges, since the `icinga2::nrpe` class will already be installing them and will prevent a resulting duplicate resource error.
### Check Plugins
Agents installed on nodes (such as NRPE ) that Icinga is performing Active checks against often require additional or custom check plugins. In order to deploy these check pluings on a node you can call the checkplugin defined resource.
The checkplugin defined resource can distribute files via both content (templates) and source (files). By default the checkpluin resource will assume your distribution method is content (template) and that your template resides in the icinga2 module
To reference a template that resides in another module you can update the $checkplugin_template_module parameter with the module your template resides
````
$checkplugin_template_module => 'SomeModule',
````
Example 1: Distribute check plugin that is a template
````
icinga2::checkplugin { 'check_diskstats':
checkplugin_template => 'checkplugins/check_diskstats.erb',
}
````
Example 2: Distribute check plugin that is a static file
````
icinga2::checkplugin { 'check_diskstats':
checkplugin_file_distribution_method => 'source',
checkplugin_source_file => 'puppet:///modules/checkplugins/check_diskstats',
}
````
###[Object type usage](id:object_type_usage)
This module includes several defined types that can be used to automatically generate Icinga 2 format object definitions. They function in a similar way to [the built-in Nagios types that are included in Puppet](http://docs.puppetlabs.com/guides/exported_resources.html#exported-resources-with-nagios).