Add support to configure kubeStateMetrics arguments

projectsyn · Nov 26, 2024 · 3cae78e · 3cae78e
1 parent c57aac8
commit 3cae78e
Show file tree

Hide file tree

Showing 30 changed files with 22,368 additions and 2 deletions.
diff --git a/.cruft.json b/.cruft.json
@@ -7,7 +7,7 @@
       "name": "prometheus",
       "slug": "prometheus",
       "parameter_key": "prometheus",
-      "test_cases": "defaults multi rewrite-registries thanos cluster-monitoring additional_rules resourcequota kubernetes_1.25 grafana-ingress additional_nodeexporter_args grafana-storage additional-netpols kubernetes_1.26 kubernetes_1.27 kubernetes_1.28 kubernetes_1.29",
+      "test_cases": "defaults multi rewrite-registries thanos cluster-monitoring additional_rules resourcequota kubernetes_1.25 grafana-ingress additional_nodeexporter_args additional_kubestatemetrics_args grafana-storage additional-netpols kubernetes_1.26 kubernetes_1.27 kubernetes_1.28 kubernetes_1.29",
       "add_lib": "y",
       "add_pp": "n",
       "add_golden": "y",

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -42,6 +42,7 @@ jobs:
           - kubernetes_1.25
           - grafana-ingress
           - additional_nodeexporter_args
+          - additional_kubestatemetrics_args
           - grafana-storage
           - additional-netpols
           - kubernetes_1.26
@@ -72,6 +73,7 @@ jobs:
           - kubernetes_1.25
           - grafana-ingress
           - additional_nodeexporter_args
+          - additional_kubestatemetrics_args
           - grafana-storage
           - additional-netpols
           - kubernetes_1.26

diff --git a/class/defaults.yml b/class/defaults.yml
@@ -112,6 +112,9 @@ parameters:
         enabled: false
         config: {}
         overrides: {}
+        containers:
+          kubeStateMetrics:
+            additionalArgs: []
       kubePrometheus:
         enabled: false
         config: {}

diff --git a/component/common.libsonnet b/component/common.libsonnet
@@ -269,6 +269,28 @@ local grafanaStorage(instanceName, instanceParams) = if instanceParams.grafana.p
     },
   } else {};
 
+local addKubeStateMetricsContainerArgs(instanceName, instanceParams) = {
+  kubeStateMetrics+: {
+    deployment+: {
+      spec+: {
+        template+: {
+          spec+: {
+            containers: [
+              if c.name == 'kube-state-metrics' then
+                c {
+                  args+: instanceParams.kubeStateMetrics.containers.kubeStateMetrics.additionalArgs,
+                }
+              else
+                c
+              for c in super.containers
+            ],
+          },
+        },
+      },
+    },
+  },
+};
+
 local patchKubeControlPlaneSelectors(instanceName) = {
   kubernetesControlPlane+:: {
     // We override the default kube-state-metrics and node-exporter job selectors defined by the library because
@@ -301,7 +323,7 @@ local stackForInstance = function(instanceName)
         [if std.objectHas(confWithBase.prometheus.config, 'thanos') then 'thanos']: confWithBase.prometheus.config.thanos,
       },
     } + resetAlertManagerConfig + patchGrafanaDataSource(instanceName) + patchKubeControlPlaneSelectors(instanceName) + com.makeMergeable(cm),
-  } + grafanaStorage(instanceName, confWithBase) + grafanaIngress(instanceName, confWithBase) + addNodeExporterContainerArgs(instanceName, confWithBase) + patchPrometheusNetworkPolicy(instanceName) + patchNetworkPolicy('prometheus', confWithBase) + patchNetworkPolicy('grafana', confWithBase) + patchNetworkPolicy('alertmanager', confWithBase) + com.makeMergeable(overrides) + removeNamespace;
+  } + grafanaStorage(instanceName, confWithBase) + grafanaIngress(instanceName, confWithBase) + addNodeExporterContainerArgs(instanceName, confWithBase) + addKubeStateMetricsContainerArgs(instanceName, confWithBase) + patchPrometheusNetworkPolicy(instanceName) + patchNetworkPolicy('prometheus', confWithBase) + patchNetworkPolicy('grafana', confWithBase) + patchNetworkPolicy('alertmanager', confWithBase) + com.makeMergeable(overrides) + removeNamespace;
 
 local render_component(configuredStack, component, prefix, instance) =
   local kp = configuredStack[component];

diff --git a/docs/modules/ROOT/pages/references/parameters.adoc b/docs/modules/ROOT/pages/references/parameters.adoc
@@ -216,6 +216,9 @@ kubeStateMetrics:
   enabled: false
   config: {}
   overrides: {}
+  containers:
+    nodeExporter:
+      additionalArgs: []
 kubePrometheus:
   enabled: false
   config: {}

diff --git a/tests/additional_kubestatemetrics_args.yml b/tests/additional_kubestatemetrics_args.yml
@@ -0,0 +1,11 @@
+---
+parameters:
+  prometheus:
+    instances:
+      default-instance:
+        kubeStateMetrics:
+          enabled: true
+          containers:
+            kubeStateMetrics:
+              additionalArgs:
+                - --metric-labels-allowlist=nodes=[kube_node_labes, kube_node_role]
diff --git a/tests/golden/additional_kubestatemetrics_args/prometheus/apps/prometheus.yaml b/tests/golden/additional_kubestatemetrics_args/prometheus/apps/prometheus.yaml
@@ -0,0 +1,6 @@
+spec:
+  ignoreDifferences:
+    - group: ''
+      jsonPointers:
+        - /imagePullSecrets
+      kind: ServiceAccount
diff --git a/.../golden/additional_kubestatemetrics_args/prometheus/prometheus/00_operator_namespace.yaml b/.../golden/additional_kubestatemetrics_args/prometheus/prometheus/00_operator_namespace.yaml
@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: Namespace
+metadata:
+  annotations: {}
+  labels:
+    SYNMonitoring: main
+    name: syn-prometheus-operator
+  name: syn-prometheus-operator