mimir-distributed: allow components to override their container image (…

…#10340) * mimir-distributed: allow components to override their container image Signed-off-by: Vladimir Varankin <[email protected]> * add test values Signed-off-by: Vladimir Varankin <[email protected]> * rebuild assets Signed-off-by: Vladimir Varankin <[email protected]> * update changelog Signed-off-by: Vladimir Varankin <[email protected]> * update code comments Signed-off-by: Vladimir Varankin <[email protected]> * add default values for component images Signed-off-by: Vladimir Varankin <[email protected]> * update changelog Signed-off-by: Vladimir Varankin <[email protected]> * rebuild assets Signed-off-by: Vladimir Varankin <[email protected]> * fix how build script removes default image from generated manifest Signed-off-by: Vladimir Varankin <[email protected]> * rebuild assets Signed-off-by: Vladimir Varankin <[email protected]> * update values comments Signed-off-by: Vladimir Varankin <[email protected]> --------- Signed-off-by: Vladimir Varankin <[email protected]>
grafana · Jan 10, 2025 · 6c186ae · 6c186ae
1 parent 8bedb97
commit 6c186ae
Show file tree

Hide file tree

Showing 138 changed files with 7,221 additions and 25 deletions.
diff --git a/operations/helm/charts/mimir-distributed/CHANGELOG.md b/operations/helm/charts/mimir-distributed/CHANGELOG.md
@@ -31,6 +31,7 @@ Entries should include a reference to the Pull Request that introduced the chang
 
 * [CHANGE] Memcached: Update to Memcached 1.6.34. #10318
 * [ENHANCEMENT] Minio: update subchart to v5.4.0. #10346
+* [ENHANCEMENT] Individual mimir components can override their container images via the *.image values. The component's image definitions always override the values set in global `image` or `enterprise.image`. #10340
 * [BUGFIX] Fix calculation of `mimir.siToBytes` and use floating point arithmetics. #10044
 
 ## 5.6.0-rc.0

diff --git a/...ions/helm/charts/mimir-distributed/ci/offline/test-enterprise-component-image-values.yaml b/...ions/helm/charts/mimir-distributed/ci/offline/test-enterprise-component-image-values.yaml
@@ -0,0 +1,97 @@
+# General setup
+enterprise:
+  enabled: true
+minio:
+  enabled: false
+
+# Individual components under test
+admin_api:
+  image:
+    repository: test/admin-api
+    tag: 1-admin-api
+
+alertmanager:
+  image:
+    repository: test/alertmanager
+    tag: 1-alertmanager
+
+compactor:
+  image:
+    repository: test/compactor
+    tag: 1-compactor
+
+continuous_test:
+  image:
+    repository: test/continuous_test
+    tag: 1-continuous-test
+
+distributor:
+  image:
+    repository: test/distributor
+    tag: 1-distributor
+
+federation_frontend:
+  enabled: true
+  image:
+    repository: test/federation_frontend
+    tag: 1-federation-frontend
+
+gateway:
+  image:
+    repository: test/gateway
+    tag: 1-gateway
+
+ingester:
+  image:
+    repository: test/ingester
+    tag: 1-ingester
+
+overrides_exporter:
+  image:
+    repository: test/overrides_exporter
+    tag: 1-overrides-exporter
+
+querier:
+  image:
+    repository: test/querier
+    tag: 1-querier
+
+query_frontend:
+  image:
+    repository: test/query_frontend
+    tag: 1-query-frontend
+
+query_scheduler:
+  image:
+    repository: test/query_scheduler
+    tag: 1-query-scheduler
+
+ruler:
+  image:
+    repository: test/ruler
+    tag: 1-ruler
+
+ruler_querier:
+  image:
+    repository: test/ruler_querier
+    tag: 1-ruler-querier
+
+ruler_query_frontend:
+  image:
+    repository: test/ruler_query_frontend
+    tag: 1-ruler-query-frontend
+
+ruler_query_scheduler:
+  image:
+    repository: test/ruler_query_scheduler
+    tag: 1-ruler-query-scheduler
+
+smoke_test:
+  image:
+    repository: test/smoke_test
+    tag: 1-smoke-test
+
+store_gateway:
+  image:
+    repository: test/store_gateway
+    tag: 1-store-gateway
diff --git a/operations/helm/charts/mimir-distributed/ci/offline/test-oss-component-image-values.yaml b/operations/helm/charts/mimir-distributed/ci/offline/test-oss-component-image-values.yaml
@@ -0,0 +1,84 @@
+# General setup
+minio:
+  enabled: false
+
+# Individual components under test
+alertmanager:
+  image:
+    repository: test/alertmanager
+    tag: 1-alertmanager
+
+compactor:
+  image:
+    repository: test/compactor
+    tag: 1-compactor
+
+continuous_test:
+  image:
+    repository: test/continuous_test
+    tag: 1-continuous-test
+
+distributor:
+  image:
+    repository: test/distributor
+    tag: 1-distributor
+
+gateway:
+  image:
+    repository: test/gateway
+    tag: 1-gateway
+
+ingester:
+  image:
+    repository: test/ingester
+    tag: 1-ingester
+
+overrides_exporter:
+  image:
+    repository: test/overrides_exporter
+    tag: 1-overrides-exporter
+
+querier:
+  image:
+    repository: test/querier
+    tag: 1-querier
+
+query_frontend:
+  image:
+    repository: test/query_frontend
+    tag: 1-query-frontend
+
+query_scheduler:
+  image:
+    repository: test/query_scheduler
+    tag: 1-query-scheduler
+
+ruler:
+  image:
+    repository: test/ruler
+    tag: 1-ruler
+
+ruler_querier:
+  image:
+    repository: test/ruler_querier
+    tag: 1-ruler-querier
+
+ruler_query_frontend:
+  image:
+    repository: test/ruler_query_frontend
+    tag: 1-ruler-query-frontend
+
+ruler_query_scheduler:
+  image:
+    repository: test/ruler_query_scheduler
+    tag: 1-ruler-query-scheduler
+
+smoke_test:
+  image:
+    repository: test/smoke_test
+    tag: 1-smoke-test
+
+store_gateway:
+  image:
+    repository: test/store_gateway
+    tag: 1-store-gateway
diff --git a/operations/helm/charts/mimir-distributed/templates/_helpers.tpl b/operations/helm/charts/mimir-distributed/templates/_helpers.tpl
@@ -50,10 +50,20 @@ Create chart name and version as used by the chart label.
 {{- end -}}
 
 {{/*
-Calculate image name based on whether enterprise features are requested
+Build mimir image reference based on whether enterprise features are requested. The component local values always take precedence.
+Params:
+  ctx = . context
+  component = component name
 */}}
 {{- define "mimir.imageReference" -}}
-{{- if .Values.enterprise.enabled -}}{{ .Values.enterprise.image.repository }}:{{ .Values.enterprise.image.tag }}{{- else -}}{{ .Values.image.repository }}:{{ .Values.image.tag }}{{- end -}}
+{{- $componentSection := include "mimir.componentSectionFromName" . | fromYaml -}}
+{{- $image := $componentSection.image | default dict -}}
+{{- if .ctx.Values.enterprise.enabled -}}
+  {{- $image = mustMerge $image .ctx.Values.enterprise.image -}}
+{{- else -}}
+  {{- $image = mustMerge $image .ctx.Values.image -}}
+{{- end -}}
+{{ $image.repository }}:{{ $image.tag }}
 {{- end -}}
 
 {{/*

diff --git a/operations/helm/charts/mimir-distributed/templates/admin-api/admin-api-dep.yaml b/operations/helm/charts/mimir-distributed/templates/admin-api/admin-api-dep.yaml
@@ -41,7 +41,7 @@ spec:
       {{- end }}
       containers:
         - name: admin-api
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "admin-api") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=admin-api"

diff --git a/operations/helm/charts/mimir-distributed/templates/alertmanager/alertmanager-dep.yaml b/operations/helm/charts/mimir-distributed/templates/alertmanager/alertmanager-dep.yaml
@@ -45,7 +45,7 @@ spec:
       {{- end }}
       containers:
         - name: alertmanager
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "alertmanager") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=alertmanager"

diff --git a/...ations/helm/charts/mimir-distributed/templates/alertmanager/alertmanager-statefulset.yaml b/...ations/helm/charts/mimir-distributed/templates/alertmanager/alertmanager-statefulset.yaml
@@ -135,7 +135,7 @@ spec:
         {{ toYaml .Values.alertmanager.extraContainers | nindent 8 }}
         {{- end }}
         - name: alertmanager
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "alertmanager") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=alertmanager"

diff --git a/operations/helm/charts/mimir-distributed/templates/compactor/compactor-statefulset.yaml b/operations/helm/charts/mimir-distributed/templates/compactor/compactor-statefulset.yaml
@@ -115,7 +115,7 @@ spec:
         {{ toYaml .Values.compactor.extraContainers | nindent 8 }}
         {{- end }}
         - name: compactor
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "compactor") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=compactor"

diff --git a/operations/helm/charts/mimir-distributed/templates/continuous_test/continuous-test-dep.yaml b/operations/helm/charts/mimir-distributed/templates/continuous_test/continuous-test-dep.yaml
@@ -41,7 +41,7 @@ spec:
       {{- end }}
       containers:
         - name: continuous-test
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "continuous-test") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=continuous-test"

diff --git a/operations/helm/charts/mimir-distributed/templates/distributor/distributor-dep.yaml b/operations/helm/charts/mimir-distributed/templates/distributor/distributor-dep.yaml
@@ -46,7 +46,7 @@ spec:
       {{- end }}
       containers:
         - name: distributor
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "distributor") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=distributor"

diff --git a/.../helm/charts/mimir-distributed/templates/federation-frontend/federation-frontend-dep.yaml b/.../helm/charts/mimir-distributed/templates/federation-frontend/federation-frontend-dep.yaml
@@ -40,7 +40,7 @@ spec:
       {{- end }}
       containers:
         - name: federation-frontend
-          image: {{ include "mimir.imageReference" . | quote }}
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "federation-frontend") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=federation-frontend"

diff --git a/operations/helm/charts/mimir-distributed/templates/gateway/gateway-dep.yaml b/operations/helm/charts/mimir-distributed/templates/gateway/gateway-dep.yaml
@@ -52,7 +52,7 @@ spec:
       containers:
         {{- if $isGEMGateway }}
         - name: gateway
-          image: {{ include "mimir.imageReference" $ | quote }}
+          image: {{ include "mimir.imageReference" (dict "ctx" $ "component" "gateway") }}
           imagePullPolicy: {{ $.Values.image.pullPolicy }}
           args:
             - "-target=gateway"

diff --git a/...rts/mimir-distributed/templates/graphite-proxy/graphite-querier/graphite-querier-dep.yaml b/...rts/mimir-distributed/templates/graphite-proxy/graphite-querier/graphite-querier-dep.yaml
@@ -44,7 +44,7 @@ spec:
         {{ toYaml .Values.graphite.querier.extraContainers | nindent 8 }}
         {{- end }}
         - name: graphite-querier
-          image: {{ include "mimir.imageReference" . | quote }}
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "graphite-querier") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - -target=graphite-querier

diff --git a/...r-distributed/templates/graphite-proxy/graphite-write-proxy/graphite-write-proxy-dep.yaml b/...r-distributed/templates/graphite-proxy/graphite-write-proxy/graphite-write-proxy-dep.yaml
@@ -44,7 +44,7 @@ spec:
         {{ toYaml .Values.graphite.write_proxy.extraContainers | nindent 8 }}
         {{- end }}
         - name: graphite-write-proxy
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "graphite-write-proxy") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - -target=graphite-write-proxy

diff --git a/operations/helm/charts/mimir-distributed/templates/ingester/ingester-statefulset.yaml b/operations/helm/charts/mimir-distributed/templates/ingester/ingester-statefulset.yaml
@@ -125,7 +125,7 @@ spec:
         {{ toYaml .Values.ingester.extraContainers | nindent 8 }}
         {{- end }}
         - name: ingester
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "ingester") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=ingester"

diff --git a/...ns/helm/charts/mimir-distributed/templates/overrides-exporter/overrides-exporter-dep.yaml b/...ns/helm/charts/mimir-distributed/templates/overrides-exporter/overrides-exporter-dep.yaml
@@ -41,7 +41,7 @@ spec:
       {{- end }}
       containers:
         - name: overrides-exporter
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "overrides-exporter") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=overrides-exporter"

diff --git a/operations/helm/charts/mimir-distributed/templates/querier/querier-dep.yaml b/operations/helm/charts/mimir-distributed/templates/querier/querier-dep.yaml
@@ -45,7 +45,7 @@ spec:
       {{- end }}
       containers:
         - name: querier
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "querier") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=querier"

diff --git a/operations/helm/charts/mimir-distributed/templates/query-frontend/query-frontend-dep.yaml b/operations/helm/charts/mimir-distributed/templates/query-frontend/query-frontend-dep.yaml
@@ -46,7 +46,7 @@ spec:
       {{- end }}
       containers:
         - name: query-frontend
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "query-frontend") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=query-frontend"

diff --git a/operations/helm/charts/mimir-distributed/templates/query-scheduler/query-scheduler-dep.yaml b/operations/helm/charts/mimir-distributed/templates/query-scheduler/query-scheduler-dep.yaml
@@ -40,7 +40,7 @@ spec:
       {{- end }}
       containers:
         - name: query-scheduler
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "query-scheduler") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=query-scheduler"

diff --git a/operations/helm/charts/mimir-distributed/templates/ruler-querier/ruler-querier-dep.yaml b/operations/helm/charts/mimir-distributed/templates/ruler-querier/ruler-querier-dep.yaml
@@ -45,7 +45,7 @@ spec:
       {{- end }}
       containers:
         - name: ruler-querier
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "ruler-querier") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=querier"

diff --git a/...elm/charts/mimir-distributed/templates/ruler-query-frontend/ruler-query-frontend-dep.yaml b/...elm/charts/mimir-distributed/templates/ruler-query-frontend/ruler-query-frontend-dep.yaml
@@ -46,7 +46,7 @@ spec:
       {{- end }}
       containers:
         - name: ruler-query-frontend
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "ruler-query-frontend") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=query-frontend"

diff --git a/...m/charts/mimir-distributed/templates/ruler-query-scheduler/ruler-query-scheduler-dep.yaml b/...m/charts/mimir-distributed/templates/ruler-query-scheduler/ruler-query-scheduler-dep.yaml
@@ -40,7 +40,7 @@ spec:
       {{- end }}
       containers:
         - name: ruler-query-scheduler
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "ruler-query-scheduler") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=query-scheduler"

diff --git a/operations/helm/charts/mimir-distributed/templates/ruler/ruler-dep.yaml b/operations/helm/charts/mimir-distributed/templates/ruler/ruler-dep.yaml
@@ -43,7 +43,7 @@ spec:
       {{- end }}
       containers:
         - name: ruler
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "ruler") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=ruler"

diff --git a/operations/helm/charts/mimir-distributed/templates/smoke-test/smoke-test-job.yaml b/operations/helm/charts/mimir-distributed/templates/smoke-test/smoke-test-job.yaml
@@ -37,7 +37,7 @@ spec:
         {{- toYaml .Values.smoke_test.initContainers | nindent 8 }}
       containers:
         - name: smoke-test
-          image: "{{ include "mimir.imageReference" . }}"
+          image: {{ include "mimir.imageReference" (dict "ctx" . "component" "smoke-test") }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - "-target=continuous-test"