OP#436 add nagios contactgroups

README.md

@@ -7,8 +7,10 @@
   - [Synopsis](#synopsis)
   - [WARNING](#warning)
   - [Features](#features)
-    - [configuring user access](#configuring-user-access)
-    - [Additional users](#additional-users)
+    - [configuring UI user access](#configuring-ui-user-access)
+    - [Additional UI users](#additional-ui-users)
+    - [Adding contacts](#adding-contacts)
+    - [Adding contact groups](#adding-contact-groups)
   - [Repo Documentation](#repo-documentation)
   - [Dependencies](#dependencies)
   - [Deployment](#deployment)
@@ -40,7 +42,7 @@ At this stage, the module is being redeveloped and being built to the latest sta
 - configures the main nagios configuration file and sets values as (pre)configured per values in params, which can be overwritten.
 - if `ng_include_nrpe`is set to `true`, the confdroid_nrpe module is automatically applied on clients ([confdroid_nrpe](https://sourcecode.confdroid.com/confdroid/confdroid_nrpe) must be in the catalogue then)
 
-### configuring user access
+### configuring UI user access
 
 Main access to the user interface requires defining an administrative user and password via `ng_main_user` and `ng_main_password`. The password should be encrypted like this: 
 
@@ -58,7 +60,7 @@ testuser: $2y$05$rNy/P22OfYZlpdEPnCAIg.OUizRD34P7pDRwUGiaYjH44PcRuZ2ia
 
 Use that value to override the default password in ENC or Hiera, if you use it.
 
-### Additional users
+### Additional UI users
 
 The main user is automatically created. If you want to add more users, this should be done via the define confdroid_nagios::server::access. In your control repo, site.pp etc. address the access define like this:
 
@@ -69,6 +71,33 @@ confdroid_nagios::server::access { 'example':
 }
 ```
 
+### Adding contacts
+
+In order to add contacts for the notifications, address the define `confdroid_nagios::nagios::objects::add_contact` in your config repo, site.pp etc. like this:
+
+```puppet
+  confdroid_nagios::nagios::objects::add_contact { 'example_user':
+    ng_contact_name   =>  'example_user',
+    ng_contact_alias  =>  'Example User',
+    ng_contact_groups =>  'admins',
+    ng_contact_email  =>  'example@example.net',
+  }
+```
+
+This requires the contact groups to be in place as well.
+
+### Adding contact groups
+
+In order to add contact groups for the notifications, address the define `confdroid_nagios::nagios::objects::add_contactgroups` in your config repo, site.pp etc. like this:
+
+```puppet
+  confdroid_nagios::nagios::objects::add_contactgroups { 'example_group':
+    ng_contactgroup_name      => 'example_group',
+    ng_contactgroup_alias     => 'Example Group',
+    ng_contactgroup_register  => '1',
+  }
+```
+
 ## Repo Documentation
 
 See the full Puppet documentation including parameters in `docs/index.html`