Merge ~szeestraten/charm-nagios:bug/1864968 into ~nagios-charmers/charm-nagios:master

[Sandor Zeestraten]

[Xav Paice (xavpaice)]

Many thanks for this patch.

I've made a few comments regarding the config options in config.yaml, around documentation. The change itself seems good, and has tested OK via a manual deployment test.

review: Needs Fixing

[Sandor Zeestraten (szeestraten)]

Thanks for the review Xav!

I prepended `_admin` and added comment in description to clarify it is for the default admin contact.

I considered adding similar config options for the pagerduty, but unfortunately it seems that the config option name `pagerduty_notification_levels` was chosen for the `service_notification_options` which breaks the naming convention and changing it for existing deployments is probably not the scope for this bug/patch.

Also commented that the notification_commands is for changing or adding custom notification plugins which is the intended use case for those commands.

[Xav Paice (xavpaice)]

There's some merge conflict markers in hooks/upgrade-charm which need sorting, and likely a rebase against master to ensure there's no further conflicts.

Other than that, lgtm.

review: Needs Fixing

[Sandor Zeestraten (szeestraten)]

Resolved merge conflict and squashed commits.

[Alvaro Uria (aluria)]

Thank you Sandor for your change. I'm going to approve it and merge.

review: Approve

diff --git a/config.yaml b/config.yaml
index a5dd578..e4755ad 100644
--- a/config.yaml
+++ b/config.yaml
@@ -222,3 +222,65 @@ options:
             u - Unknown
             w - Warning
             o - OK
+    admin_service_notification_period:
+        default: "24x7"
+        type: string
+        description: |
+            This directive is used to specify the short name of the time period during
+            which the default admin contact can be notified about service problems or recoveries.
+            You can think of this as an "on call" time for service notifications
+            for the contact.  Read the documentation on time periods for more information
+            on how this works and potential problems that may result from improper use.
+    admin_host_notification_period:
+        default: "24x7"
+        type: string
+        description: |
+            This directive is used to specify the short name of the time period during
+            which the default admin contact can be notified about host problems or recoveries.
+            You can think of this as an "on call" time for host notifications
+            for the contact.  Read the documentation on time periods for more information
+            on how this works and potential problems that may result from improper use.
+    admin_service_notification_options:
+        default: "w,u,c,r"
+        type: string
+        description: |
+            This directive is used to define the service states for which notifications
+            can be sent out to the default admin contact.  Valid options are a combination of one
+            or more of the following:
+            w = notify on WARNING service states,
+            u = notify on UNKNOWN service states,
+            c = notify on CRITICAL service states,
+            r = notify on service recoveries (OK states),
+            f = notify when the service starts and stops flapping.
+            If you specify n (none) as an option, the contact will not receive any type of service notifications.
+    admin_host_notification_options:
+        default: "d,r"
+        type: string
+        description: |
+            This directive is used to define the host states for which notifications
+            can be sent out to the default admin contact.  Valid options are a combination of one
+            or more of the following:
+            d = notify on DOWN host states,
+            u = notify on UNREACHABLE host states,
+            r = notify on host recoveries (UP states),
+            f = notify when the host starts and stops flapping,
+            s = send notifications when host or service scheduled downtime starts and ends.
+            If you specify n (none) as an option, the contact will not receive any type of host notifications.
+    admin_service_notification_commands:
+        default: "notify-service-by-email"
+        type: string
+        description: |
+            This directive is used to define a list of the short names of the commands
+            used to notify the default admin contact of a service problem or recovery.
+            Change this or add commands if you have custom notification plugins.
+            Multiple notification commands should be separated by commas.
+            All notification commands are executed when the contact needs to be notified.
+    admin_host_notification_commands:
+        default: "notify-host-by-email"
+        type: string
+        description: |
+            This directive is used to define a list of the short names of the commands
+            used to notify the default admin contact of a host problem or recovery.
+            Change this or add commands if you have custom notification plugins.
+            Multiple notification commands should be separated by commas.
+            All notification commands are executed when the contact needs to be notified.
diff --git a/hooks/templates/contacts-cfg.tmpl b/hooks/templates/contacts-cfg.tmpl
index 34cf6ff..8f28acf 100644
--- a/hooks/templates/contacts-cfg.tmpl
+++ b/hooks/templates/contacts-cfg.tmpl
@@ -21,12 +21,12 @@
 define contact{
         contact_name                    root
         alias                           Root
-        service_notification_period     24x7
-        host_notification_period        24x7
-        service_notification_options    w,u,c,r
-        host_notification_options       d,r
-        service_notification_commands   notify-service-by-email
-        host_notification_commands      notify-host-by-email
+        service_notification_period     {{ admin_service_notification_period }}
+        host_notification_period        {{ admin_host_notification_period }}
+        service_notification_options    {{ admin_service_notification_options }}
+        host_notification_options       {{ admin_host_notification_options }}
+        service_notification_commands   {{ admin_service_notification_commands }}
+        host_notification_commands      {{ admin_host_notification_commands }}
         email                           {{ admin_email }}
         }
 
diff --git a/hooks/upgrade-charm b/hooks/upgrade-charm
index 167225c..a80743b 100755
--- a/hooks/upgrade-charm
+++ b/hooks/upgrade-charm
@@ -167,7 +167,13 @@ def enable_pagerduty_config():
         if "pagerduty" not in contactgroup_members:
             contactgroup_members += ", pagerduty"
 
-    template_values = {'admin_email': hookenv.config('admin_email'),
+    template_values = {'admin_service_notification_period': hookenv.config('admin_service_notification_period'),
+                       'admin_host_notification_period': hookenv.config('admin_host_notification_period'),
+                       'admin_service_notification_options': hookenv.config('admin_service_notification_options'),
+                       'admin_host_notification_options': hookenv.config('admin_host_notification_options'),
+                       'admin_service_notification_commands': hookenv.config('admin_service_notification_commands'),
+                       'admin_host_notification_commands': hookenv.config('admin_host_notification_commands'),
+                       'admin_email': hookenv.config('admin_email'),
                        'contactgroup_members': contactgroup_members}
 
     with open('hooks/templates/contacts-cfg.tmpl', 'r') as f: