Merge branch 'document_nagios_custom_logic' into 'master'

Document nagios custom logic

Add some note for ppl who need to inject their own logic before creating nagios-related checks.

See merge request !1

3 files changed, 34 insertions, 9 deletions

diff --git a/README b/README
index 32698b3..b6a3124 100644
--- a/README
+++ b/README
@@ -55,8 +55,23 @@ stunnel configuration variable (see manifests/server.pp) which will be used to
 create the /etc/stunnel/${name}.conf file, and then notify the stunnel service
 so it will restart.
 
-If you pass $use_nagios to this define, it will create a nagios::service entry
-for stunnel_${name} which will watch for the appropriate number processes with
-that configuration name
+If you pass $manage_nagios to this define, it will create a nagios::service
+entry for stunnel_${name} which will watch for the appropriate number processes
+with that configuration name
+
+Note that if you need to use some specific logic to decide whether or not to
+create a nagios service check, you should set $manage_nagios to false, and
+use stunnel::service::nagios from within your own manifests.
+
+stunnel::service::nagios
+------------------------
+
+This define creates a nagios service check for a specific tunnel. The resource
+name should be the name of the tunnel's configuration file without the '.conf'
+suffix. For example:
+
+    stunnel::service::nagios { 'carpal': }
+
+The above example would verify that the tunnel defined in
+`/etc/stunnel/carpal.conf'.
 
-  
\ No newline at end of file
diff --git a/manifests/service.pp b/manifests/service.pp
index 666826d..fe36c2f 100644
--- a/manifests/service.pp
+++ b/manifests/service.pp
@@ -51,7 +51,7 @@ define stunnel::service (
   $timeoutconnect = false,
   $timeoutidle = false,
   $transparent = false,
-  $use_nagios = false,
+  $manage_nagios = false,
   $verify = false
 ) {
 
@@ -71,9 +71,7 @@ define stunnel::service (
       mode    => '0600';
   }
 
-  if $use_nagios {
-    nagios::service { "stunnel_${name}":
-      check_command => "nagios-stat-proc!/usr/bin/stunnel4 /etc/stunnel/${name}.conf!6!5!proc";
-    }
+  if $manage_nagios {
+    stunnel::service::nagios { $name: }
   }
 }
diff --git a/manifests/service/nagios.pp b/manifests/service/nagios.pp
new file mode 100644
index 0000000..578b417
--- /dev/null
+++ b/manifests/service/nagios.pp
@@ -0,0 +1,12 @@
+# Put a Nagios service check in place for a specific tunnel.
+#
+# The resource name will be used to point to the corresponding stunnel
+# configuration file.
+#
+define stunnel::service::nagios () {
+
+    nagios::service { "stunnel_${name}":
+      check_command => "nagios-stat-proc!/usr/bin/stunnel4 /etc/stunnel/${name}.conf!6!5!proc";
+    }
+
+}