Merge ~canonical-bootstack/charm-openstack-service-checks:bug#1818966 into ~canonical-bootstack/charm-openstack-service-checks:master

[Diko Parvanov]

Added option to skip host aggregates from checks

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Alvaro Uria (aluria)]

Please see comment inline. I also understand that an empty value would call "--skip" instead of "--skip <str>", but since the default value is "", that should be ok.

review: Needs Fixing

[Andrew McLeod (admcleod)]

Lgtm +1

review: Approve

[Alvaro Uria (aluria)]

I think there is an error when building the check_command to be passed to nrpe. See comment inline.

review: Needs Fixing

[Diko Parvanov (dparv)]

> I think there is an error when building the check_command to be passed to
> nrpe. See comment inline.

True, have missed the 5th param, now should be fixed.

[David O Neill (dmzoneill)]

all feedback addressed, approved

review: Approve

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision f051594315a9e6678e473eb32dfb3edca3e8144e

diff --git a/config.yaml b/config.yaml
index 6f09823..461bfe1 100644
--- a/config.yaml
+++ b/config.yaml
@@ -22,6 +22,12 @@ options:
     type: int
     description: |
       Critical level for nova aggregate unit count check - setting this to -1 will effectively disable host aggregate checks.
+  skipped_host_aggregates:
+    type: string
+    default: ""
+    description: |
+      Comma separated list of host aggregates that need to be skipped from checks. Example "Agg1,AGg2" or 'Aggregate3'.
+      This is a case-insensitive option.
   nagios_context:
     default: "juju"
     type: string
diff --git a/files/plugins/check_nova_services.py b/files/plugins/check_nova_services.py
index 8a3666d..5e73de9 100755
--- a/files/plugins/check_nova_services.py
+++ b/files/plugins/check_nova_services.py
@@ -59,6 +59,12 @@ def check_nova_services(args, nova):
     status = []
     hosts_checked = []
     for agg in aggregates:
+        # skip the defined host aggregates to be skipped from the config
+        # making it case-insensitive
+        skipped_aggregates = [name.lower() for name in args.skip.split(',')]
+        aggregate_name = agg['name'].lower()
+        if aggregate_name in skipped_aggregates:
+            continue
         # get a list of hosts, pass to the function
         hosts = agg['hosts']
         hosts_checked.append(hosts)
@@ -91,6 +97,8 @@ if __name__ == '__main__':
                         help="Warn at this many hosts running")
     parser.add_argument('--crit', dest='crit', type=int, default=1,
                         help="Critical at this many hosts running or less")
+    parser.add_argument('--skip', dest='skip', type=str, default="",
+                        help="Comma separated list of types of aggregates to skip.")
     parser.add_argument('--env', dest='env',
                         default='/var/lib/nagios/nagios.novarc',
                         help="Novarc file to use for this check")
diff --git a/lib/lib_openstack_service_checks.py b/lib/lib_openstack_service_checks.py
index efdae7c..ca184a6 100644
--- a/lib/lib_openstack_service_checks.py
+++ b/lib/lib_openstack_service_checks.py
@@ -84,6 +84,17 @@ class OSCHelper():
         return self.charm_config.get('nova_crit')
 
     @property
+    def nova_skip(self):
+        skipped_aggregates = self.charm_config.get('skipped_host_aggregates')
+        # We have to make sure there are no malicious injections in the code
+        # as this gets passed to a python script via bash
+        regex = r'(\w+[,\w+]*)'
+        sanitized = ",".join(re.findall(regex, skipped_aggregates))
+        sanitized = [s for s in sanitized.split(',') if s != ""]
+        sanitized = ",".join(sanitized)
+        return sanitized
+
+    @property
     def skip_disabled(self):
         if self.charm_config.get('skip-disabled'):
             return '--skip-disabled'
@@ -111,8 +122,8 @@ class OSCHelper():
 
         nova_check_command = os.path.join(self.plugins_dir,
                                           'check_nova_services.py')
-        check_command = '{} --warn {} --crit {} {}'.format(
-            nova_check_command, self.nova_warn, self.nova_crit,
+        check_command = '{} --warn {} --crit {} --skip {} {}'.format(
+            nova_check_command, self.nova_warn, self.nova_crit, self.nova_skip,
             self.skip_disabled).strip()
         nrpe.add_check(shortname='nova_services',
                        description='Check that enabled Nova services are up',