[prometheus] Apply templating to remote_read & remote_write config (p…

…rometheus-community#3777) * Apply templating to remote_read & remote_write config Signed-off-by: Garry O'Donnell <garry.o'[email protected]> * Add migration instructions for prometheus 25.0 Signed-off-by: Garry O'Donnell <garry.o'[email protected]> Signed-off-by: Garry O'Donnell <[email protected]> * Only template URLs Signed-off-by: Garry O'Donnell <garry.o'[email protected]> Signed-off-by: Garry O'Donnell <[email protected]> * Fix whitespace Co-authored-by: zeritti <[email protected]> Signed-off-by: Garry O'Donnell <[email protected]> --------- Signed-off-by: Garry O'Donnell <garry.o'[email protected]> Signed-off-by: Garry O'Donnell <[email protected]> Co-authored-by: zeritti <[email protected]>
giffgaff · Mar 20, 2024 · 8c5b8c0 · 8c5b8c0
1 parent c406d24
commit 8c5b8c0
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 3 deletions.
diff --git a/charts/prometheus/Chart.yaml b/charts/prometheus/Chart.yaml
@@ -1,7 +1,7 @@
 apiVersion: v2
 name: prometheus
 appVersion: v2.47.0
-version: 24.5.0
+version: 25.0.0
 kubeVersion: ">=1.19.0-0"
 description: Prometheus is a monitoring system and time series database.
 home: https://prometheus.io/

diff --git a/charts/prometheus/README.md b/charts/prometheus/README.md
@@ -65,6 +65,12 @@ helm upgrade [RELEASE_NAME] prometheus-community/prometheus --install
 
 _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._
 
+### To 25.0
+
+The `server.remoteRead[].url` and `server.remoteWrite[].url` fields now support templating. Allowing for `url` values such as `https://{{ .Release.Name }}.example.com`.
+
+Any entries in these which previously included `{{` or `}}` must be escaped with `{{ "{{" }}` and `{{ "}}" }}` respectively. Entries which did not previously include the template-like syntax will not be affected.
+
 ### To 24.0
 
 Require Kubernetes 1.19+

diff --git a/charts/prometheus/templates/_helpers.tpl b/charts/prometheus/templates/_helpers.tpl
@@ -211,3 +211,26 @@ Define template prometheus.namespaces producing a list of namespaces to monitor
 {{- end -}}
 {{ mustToJson $namespaces }}
 {{- end -}}
+
+{{/*
+Define prometheus.server.remoteWrite producing a list of remoteWrite configurations with URL templating
+*/}}
+{{- define "prometheus.server.remoteWrite" -}}
+{{- $remoteWrites := list }}
+{{- range $remoteWrite := .Values.server.remoteWrite }}
+  {{- $remoteWrites = tpl $remoteWrite.url $ | set $remoteWrite "url" | append $remoteWrites }}
+{{- end -}}
+{{ toYaml $remoteWrites }}
+{{- end -}}
+
+{{/*
+Define prometheus.server.remoteRead producing a list of remoteRead configurations with URL templating
+*/}}
+{{- define "prometheus.server.remoteRead" -}}
+{{- $remoteReads := list }}
+{{- range $remoteRead := .Values.server.remoteRead }}
+  {{- $remoteReads = tpl $remoteRead.url $ | set $remoteRead "url" | append $remoteReads }}
+{{- end -}}
+{{ toYaml $remoteReads }}
+{{- end -}}
+
diff --git a/charts/prometheus/templates/cm.yaml b/charts/prometheus/templates/cm.yaml
@@ -22,11 +22,11 @@ data:
 {{ $root.Values.server.global | toYaml | trimSuffix "\n" | indent 6 }}
 {{- if $root.Values.server.remoteWrite }}
     remote_write:
-{{ $root.Values.server.remoteWrite | toYaml | indent 4 }}
+{{- include "prometheus.server.remoteWrite" $root | nindent 4 }}
 {{- end }}
 {{- if $root.Values.server.remoteRead }}
     remote_read:
-{{ $root.Values.server.remoteRead | toYaml | indent 4 }}
+{{- include "prometheus.server.remoteRead" $root | nindent 4 }}
 {{- end }}
 {{- if or $root.Values.server.tsdb $root.Values.server.exemplars }}
     storage: