[kube-prometheus-stack] Parameterize job names (#6228)

Author: abelfodil

charts/kube-prometheus-stack/Chart.yaml

@@ -31,7 +31,7 @@ name: kube-prometheus-stack
 sources:
   - https://github.com/prometheus-community/helm-charts
   - https://github.com/prometheus-operator/kube-prometheus
-version: 78.3.0
+version: 78.3.1
 # renovate: github=prometheus-operator/prometheus-operator
 appVersion: v0.86.0
 kubeVersion: ">=1.25.0-0"

charts/kube-prometheus-stack/hack/sync_grafana_dashboards.py

@@ -113,6 +113,18 @@ def new_representer(dumper, data):
     'job=\\"prometheus-k8s\\",namespace=\\"monitoring\\"': {
         'replacement': '',
     },
+    'job=\\"kubelet\\"': {
+        'replacement': 'job=\\"`}}{{ $kubeletJob }}{{`\\"',
+        'init': '{{- $kubeletJob := include "kube-prometheus-stack-kubelet.name" . }}'},
+    'job=\\"kube-controller-manager\\"': {
+        'replacement': 'job=\\"`}}{{ $kubeControllerManagerJob }}{{`\\"',
+        'init': '{{- $kubeControllerManagerJob := include "kube-prometheus-stack-kube-controller-manager.name" . }}'},
+    'job=\\"kube-scheduler\\"': {
+        'replacement': 'job=\\"`}}{{ $kubeSchedulerJob }}{{`\\"',
+        'init': '{{- $kubeSchedulerJob := include "kube-prometheus-stack-kube-scheduler.name" . }}'},
+    'job=\\"kube-proxy\\"': {
+        'replacement': 'job=\\"`}}{{ $kubeProxyJob }}{{`\\"',
+        'init': '{{- $kubeProxyJob := include "kube-prometheus-stack-kube-proxy.name" . }}'},
 }
 
 # standard header
@@ -122,7 +134,7 @@ def new_representer(dumper, data):
 https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack/hack
 */ -}}
 {{- $kubeTargetVersion := default .Capabilities.KubeVersion.GitVersion .Values.kubeTargetVersionOverride }}
-{{- if and (or .Values.grafana.enabled .Values.grafana.forceDeployDashboards) (semverCompare ">=%(min_kubernetes)s" $kubeTargetVersion) (semverCompare "<%(max_kubernetes)s" $kubeTargetVersion) .Values.grafana.defaultDashboardsEnabled%(condition)s }}
+{{- if and (or .Values.grafana.enabled .Values.grafana.forceDeployDashboards) (semverCompare ">=%(min_kubernetes)s" $kubeTargetVersion) (semverCompare "<%(max_kubernetes)s" $kubeTargetVersion) .Values.grafana.defaultDashboardsEnabled%(condition)s }}%(init_line)s
 apiVersion: v1
 kind: ConfigMap
 metadata:
@@ -218,13 +230,16 @@ def patch_dashboards_json(content, multicluster_key):
 
         content = json.dumps(content_struct, separators=(',', ':'))
         content = content.replace('":multicluster:"', '`}}{{ if %s }}0{{ else }}2{{ end }}{{`' % multicluster_key,)
+        init_line = ''
 
         for line in replacement_map:
+            if line in content and replacement_map[line].get('init'):
+                init_line += '\n' + replacement_map[line]['init']
             content = content.replace(line, replacement_map[line]['replacement'])
     except (ValueError, KeyError):
         pass
 
-    return "{{`" + content + "`}}"
+    return init_line, "{{`" + content + "`}}"
 
 
 def patch_json_set_timezone_as_variable(content):
@@ -261,16 +276,18 @@ def jsonnet_import_callback(base, rel):
 
 
 def write_group_to_file(resource_name, content, url, destination, min_kubernetes, max_kubernetes, multicluster_key):
+    init_line, content = patch_dashboards_json(content, multicluster_key)
+
     # initialize header
     lines = header % {
         'name': resource_name,
         'url': url,
         'condition': condition_map.get(resource_name, ''),
         'min_kubernetes': min_kubernetes,
-        'max_kubernetes': max_kubernetes
+        'max_kubernetes': max_kubernetes,
+        'init_line': init_line,
     }
 
-    content = patch_dashboards_json(content, multicluster_key)
     content = patch_json_set_timezone_as_variable(content)
     content = patch_json_set_editable_as_variable(content)
     content = patch_json_set_interval_as_variable(content)

charts/kube-prometheus-stack/hack/sync_prometheus_rules.py

@@ -205,10 +205,22 @@ def new_representer(dumper, data):
         'replacement': 'job="{{ $kubeStateMetricsJob }}", namespace{{ $namespaceOperator }}"{{ $targetNamespace }}"',
         'limitGroup': ['kubernetes-apps'],
         'init': '{{- $targetNamespace := .Values.defaultRules.appNamespacesTarget }}{{- $namespaceOperator := .Values.defaultRules.appNamespacesOperator | default "=~" }}'},
-    'job="kubelet"': {
-        'replacement': 'job="kubelet", namespace{{ $namespaceOperator }}"{{ $targetNamespace }}"',
+    'job="kubelet", metrics_path="/metrics': {
+        'replacement': 'job="{{ $kubeletJob }}", namespace{{ $namespaceOperator }}"{{ $targetNamespace }}", metrics_path="/metrics',
         'limitGroup': ['kubernetes-storage'],
-        'init': '{{- $targetNamespace := .Values.defaultRules.appNamespacesTarget }}{{- $namespaceOperator := .Values.defaultRules.appNamespacesOperator | default "=~" }}'},
+        'init': '{{- $kubeletJob := include "kube-prometheus-stack-kubelet.name" . }}\n{{- $targetNamespace := .Values.defaultRules.appNamespacesTarget }}\n{{- $namespaceOperator := .Values.defaultRules.appNamespacesOperator | default "=~" }}'},
+    'job="kubelet"': {
+        'replacement': 'job="{{ $kubeletJob }}"',
+        'init': '{{- $kubeletJob := include "kube-prometheus-stack-kubelet.name" . }}'},
+    'job="kube-controller-manager"': {
+        'replacement': 'job="{{ $kubeControllerManagerJob }}"',
+        'init': '{{- $kubeControllerManagerJob := include "kube-prometheus-stack-kube-controller-manager.name" . }}'},
+    'job="kube-scheduler"': {
+        'replacement': 'job="{{ $kubeSchedulerJob }}"',
+        'init': '{{- $kubeSchedulerJob := include "kube-prometheus-stack-kube-scheduler.name" . }}'},
+    'job="kube-proxy"': {
+        'replacement': 'job="{{ $kubeProxyJob }}"',
+        'init': '{{- $kubeProxyJob := include "kube-prometheus-stack-kube-proxy.name" . }}'},
     'runbook_url: https://runbooks.prometheus-operator.dev/runbooks/': {
         'replacement': 'runbook_url: {{ .Values.defaultRules.runbookUrl }}/',
         'init': ''},

charts/kube-prometheus-stack/templates/_helpers.tpl

@@ -165,6 +165,53 @@ Use the Alertmanager namespace override for multi-namespace deployments in combi
   {{- end -}}
 {{- end -}}
 
+{{/*
+Allow kubelet job name to be overridden
+*/}}
+{{- define "kube-prometheus-stack-kubelet.name" -}}
+  {{- if index .Values "kubelet" "jobNameOverride" -}}
+    {{- index .Values "kubelet" "jobNameOverride" -}}
+  {{- else -}}
+    {{- print "kubelet" -}}
+  {{- end -}}
+{{- end -}}
+
+
+{{/*
+Allow kube-controller-manager job name to be overridden
+*/}}
+{{- define "kube-prometheus-stack-kube-controller-manager.name" -}}
+  {{- if index .Values "kubeControllerManager" "jobNameOverride" -}}
+    {{- index .Values "kubeControllerManager" "jobNameOverride" -}}
+  {{- else -}}
+    {{- print "kube-controller-manager" -}}
+  {{- end -}}
+{{- end -}}
+
+
+{{/*
+Allow kube-scheduler job name to be overridden
+*/}}
+{{- define "kube-prometheus-stack-kube-scheduler.name" -}}
+  {{- if index .Values "kubeScheduler" "jobNameOverride" -}}
+    {{- index .Values "kubeScheduler" "jobNameOverride" -}}
+  {{- else -}}
+    {{- print "kube-scheduler" -}}
+  {{- end -}}
+{{- end -}}
+
+
+{{/*
+Allow kube-proxy job name to be overridden
+*/}}
+{{- define "kube-prometheus-stack-kube-proxy.name" -}}
+  {{- if index .Values "kubeProxy" "jobNameOverride" -}}
+    {{- index .Values "kubeProxy" "jobNameOverride" -}}
+  {{- else -}}
+    {{- print "kube-proxy" -}}
+  {{- end -}}
+{{- end -}}
+
 {{/*
 Allow kube-state-metrics job name to be overridden
 */}}