README: mention how one could reuse nagios resources with their own logic

Some people might want to inject their own logic before including nagios
resources. We can explain that since the nagios resources are in their
own part of the manifests, they can shortcut the module's automatic
handling of it, and call it manually from their own manifests.

1 files changed, 15 insertions, 0 deletions

diff --git a/README b/README
index 509650f..b6a3124 100644
--- a/README
+++ b/README
@@ -59,4 +59,19 @@ 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'.