diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 72 |
1 files changed, 67 insertions, 5 deletions
@@ -12,7 +12,10 @@ In it's current form, this module can be used on CentOS and Debian. Overview ======== -To use the nagios resources, activate storeconfigs on the puppetmaster. +To use the nagios resources, activate storeconfigs on the +puppetmaster. + +You need to be running verison 0.25 or later of puppet. Monitor @@ -28,8 +31,11 @@ Hosts ----- On a node which shall be monitored with nagios, include the "nagios::target". -This just creates a host declaration for this hosts "$fqdn". -Set the $nagios_parent variable in the node scope for enabling the reachability +This just creates a host declaration for this host's "$ipaddress" fact. If +the $ipaddress of your target is not the one you wish to modify, you can use +"nagios::target::fqdn" instead, which will use the $fqdn fact of the host instead. + +Set the $nagios_parents variable in the node scope for enabling the reachability features of nagios. If a node needs more customisation, use the native "@@nagios_host" type directly (the double-ampersand declares the object as an exported resource). @@ -60,6 +66,37 @@ Obviously, the check command must either be defined using nagios_command objects files directly. +Upgrade Notes +============= + +The nagios::target bits have been reworked, the notable changes that +may affect an upgrade are: + +. previous versions had nagios::target::nat which used the $fqdn for +the address part of nagios::target, this has been renamed to +nagios::target::fqdn to be more clear. if you were using +nagios::target::nat then you will need to change those references to +::fqdn + +. previous versions of this module used $fqdn for the nagios::target +address, now it is using $ipaddress. If you need $fqdn, use +nagios::target::fqdn instead of nagios::target + +. previous versions of nagios_host used the parameter named 'ip', that +has been changed to 'address' + + +IRC bot +======= + +Notifications can easily be sent to an IRC channel by using a bot. To do so, +simply include 'nagios::irc_bot' on the nagios server and define the right +$nagios_nsa_* variables (see the 'Variables' section below). + +You can then use the notification commands 'notify-by-irc' and +'host-notify-by-irc' with service and host definitions to make them report +state changes over IRC. + Caveats ======= @@ -102,6 +139,29 @@ Options to change the behavior of the nagios module: may also need to flip "check_external_commands" in "nagios.cfg" to enable this functionality. +- nagios_nsa_socket: This optional variable can be used to specify the path to + the socket file that the IRC daemon should use. + +- nagios_nsa_server: When using the IRC bot, this defines the server address of + the IRC network on which the bot will connect. + +- nagios_nsa_port: Defines the port number on the IRC server on which the bot + should connect. When this variable is not set, the port used + by default is 6667. + +- nagios_nsa_nickname: This is the nickname that the IRC bot will take. + +- nagios_nsa_password: Some networks require a password to connect to them. + This defines such a password. + +- nagios_nsa_channel: The name of the channel that the IRC bot will join and + will post notifications to. + +- nagios_nsa_pidfile: This optional variable can be used to define the path to + the file that will contain the process ID of the IRC bot + daemon. +- nagios_nsa_realname: The IRC bot user's real name that will be displayed. By + default, the real name is 'Nagios'. Examples ======== @@ -137,8 +197,8 @@ $HOSTADDRESS$' node target { - # Monitor this host - $nagios_parent = 'router01' + # Monitor th () is host + $nagios_parents = 'router01' include nagios::target # monitor a service @@ -167,3 +227,5 @@ License Copyright (C) 2007 David Schmitt <david@schmitt.edv-bus.at> See the file LICENSE in the top directory for the full license. +Copyright (C) 2010 Riseup Networks <micah@riseup.net> + |