Refactor component to use projectsyn/jsonnet-libs's alerts.libsonnet

.gitignore

@@ -19,3 +19,4 @@
 /_public
 
 # Additional entries
+jsonnetfile.json

component/alertrules.jsonnet

@@ -5,13 +5,6 @@ local kube = import 'lib/kube.libjsonnet';
 local inv = kap.inventory();
 local params = inv.parameters.topolvm;
 
-local isOpenshift = std.startsWith(inv.parameters.facts.distribution, 'openshift');
-
-assert
-  std.member(inv.applications, 'openshift4-monitoring') ||
-  isOpenshift != true
-  : 'Component openshift4-monitoring is not available';
-
 // Upstream alerts to ignore
 local ignore_alerts = std.set(
   // Add set of alerts that should be ignored from `params.ignore_alerts`
@@ -24,7 +17,7 @@ local alertrules = {
       name: 'topolvm-alert.rules',
       rules: [
         {
-          alert: 'SYN_TopoLVMVolumeGroupAlmostFull',
+          alert: 'TopoLVMVolumeGroupAlmostFull',
           annotations: {
             description: |||
               Utilization of volume group {{ $labels.device_class }}
@@ -39,12 +32,10 @@ local alertrules = {
           'for': '10m',
           labels: {
             severity: 'warning',
-            syn: 'true',
-            syn_component: 'topolvm',
           },
         },
         {
-          alert: 'SYN_TopoLVMVolumeGroupNearFull',
+          alert: 'TopoLVMVolumeGroupNearFull',
           annotations: {
             description: |||
               Utilization of volume group {{ $labels.device_class }}
@@ -59,36 +50,33 @@ local alertrules = {
           'for': '1h',
           labels: {
             severity: 'warning',
-            syn: 'true',
-            syn_component: 'topolvm',
           },
         },
       ],
     },
   ],
 };
 
+local groups = std.filter(
+  function(g) std.length(g.rules) > 0,
+  [
+    alertpatching.filterPatchRules(g, ignoreNames=ignore_alerts)
+    for g in alertrules.groups
+  ]
+);
+
+local has_monitoring = std.member(inv.applications, 'prometheus') || std.member(inv.applications, 'openshift4-monitoring');
+local has_alerts = std.length(groups) > 0;
+
 // Define outputs below
-if isOpenshift then
-  {
-    '20_rules': kube._Object('monitoring.coreos.com/v1', 'PrometheusRule', 'syn-topolvm-rules') {
+{
+  [if has_monitoring && has_alerts then '20_rules']:
+    kube._Object('monitoring.coreos.com/v1', 'PrometheusRule', 'syn-topolvm-rules') {
       metadata+: {
         namespace: params.namespace,
       },
       spec: {
-        groups: std.filter(
-          function(it) it != null,
-          [
-            local r = alertpatching.filterPatchRules(g, ignore_alerts);
-            if std.length(r.rules) > 0 then r
-            for g in alertrules.groups
-          ]
-        ),
+        groups: groups,
       },
     },
-  }
-else
-  std.trace(
-    'Alert handling library not available, not deploying alertrules',
-    {}
-  )
+}

docs/modules/ROOT/pages/references/parameters.adoc

@@ -89,6 +89,25 @@ parameters:
         volumeexpansion: true
 ----
 
+== `ignore_alerts`
+
+[horizontal]
+type:: list
+default:: []
+
+List of alert rule names to be dropped.
+Names are given without the `SYN_` prefix.
+
+=== Example
+
+[source,yaml]
+----
+parameters:
+  topolvm:
+    ignore_alerts:
+      - TopoLVMVolumeGroupNearFull
+----
+
 == `helmValues`
 
 [horizontal]

jsonnetfile.jsonnet

@@ -0,0 +1,16 @@
+{
+  version: 1,
+  dependencies: [
+    {
+      source: {
+        git: {
+          remote: 'https://github.com/projectsyn/jsonnet-libs',
+          subdir: '',
+        },
+      },
+      version: 'main',
+      name: 'syn',
+    },
+  ],
+  legacyImports: true,
+}

tests/defaults.yml

@@ -9,17 +9,12 @@ parameters:
         source: https://raw.githubusercontent.com/projectsyn/component-storageclass/v1.0.0/lib/storageclass.libsonnet
         output_path: vendor/lib/storageclass.libsonnet
       - type: https
-        source: https://raw.githubusercontent.com/appuio/component-openshift4-monitoring/v2.9.0/lib/openshift4-monitoring-alert-patching.libsonnet
+        source: https://raw.githubusercontent.com/appuio/component-openshift4-monitoring/master/lib/openshift4-monitoring-alert-patching.libsonnet
         output_path: vendor/lib/alert-patching.libsonnet
 
   facts:
     distribution: openshift4
 
-  openshift4_monitoring:
-    alerts:
-      ignoreNames: []
-      customAnnotations: {}
-
   storageclass:
     defaults: {}
     defaultClass: ssd-local

tests/legacy.yml

@@ -9,17 +9,12 @@ parameters:
         source: https://raw.githubusercontent.com/projectsyn/component-storageclass/v1.0.0/lib/storageclass.libsonnet
         output_path: vendor/lib/storageclass.libsonnet
       - type: https
-        source: https://raw.githubusercontent.com/appuio/component-openshift4-monitoring/v2.9.0/lib/openshift4-monitoring-alert-patching.libsonnet
+        source: https://raw.githubusercontent.com/appuio/component-openshift4-monitoring/master/lib/openshift4-monitoring-alert-patching.libsonnet
         output_path: vendor/lib/alert-patching.libsonnet
 
   facts:
     distribution: openshift4
 
-  openshift4_monitoring:
-    alerts:
-      ignoreNames: []
-      customAnnotations: {}
-
   storageclass:
     defaults: {}
     defaultClass: ""

tests/noalertrules.yml

@@ -8,15 +8,22 @@ parameters:
       - type: https
         source: https://raw.githubusercontent.com/projectsyn/component-storageclass/v1.0.0/lib/storageclass.libsonnet
         output_path: vendor/lib/storageclass.libsonnet
+      - type: https
+        source: https://raw.githubusercontent.com/projectsyn/component-prometheus/master/lib/prometheus-alert-patching.libsonnet
+        output_path: vendor/lib/alert-patching.libsonnet
 
   facts:
     distribution: eks
 
-  openshift4_monitoring:
-    alerts:
-      ignoreNames: []
-      customAnnotations: {}
-
   storageclass:
     defaults: {}
     defaultClass: ""
+
+  prometheus:
+    alerts:
+      ignoreNames:
+        - TopoLVMVolumeGroupAlmostFull
+
+  topolvm:
+    ignore_alerts:
+      - TopoLVMVolumeGroupNearFull