grafana · m1rp · Nov 24, 2023 · Dec 4, 2023 · Dec 5, 2023 · Mar 25, 2024
diff --git a/operations/helm/charts/mimir-distributed/CHANGELOG.md b/operations/helm/charts/mimir-distributed/CHANGELOG.md
@@ -38,6 +38,7 @@ Entries should include a reference to the Pull Request that introduced the chang
 * [ENHANCEMENT] Set resources for smoke-test job. #10608
 * [BUGFIX] Create proper in-cluster remote URLs when gateway and nginx are disabled. #10625
 * [BUGFIX] Fix calculation of `mimir.siToBytes` and use floating point arithmetics. #10044
+* [ENHANCEMENT] Add values for setting annotations and labels for rollout-operator. #6733
 
 ## 5.6.0
 

@@ -606,6 +606,9 @@ which allows us to keep generating everything for the default zone.
   "nodeSelector" ($rolloutZone.nodeSelector | default (dict) )
   "replicas" $replicaPerZone
   "storageClass" $rolloutZone.storageClass
+  "noDownscale"  $rolloutZone.noDownscale
+  "downscaleLeader" $rolloutZone.downscaleLeader
+  "prepareDownscale" $rolloutZone.prepareDownscale
   ) -}}
 {{- end -}}
 {{- if $componentSection.zoneAwareReplication.migration.enabled -}}

@@ -11,8 +11,22 @@ metadata:
   name: {{ include "mimir.resourceName" $args }}
   labels:
     {{- include "mimir.labels" $args | nindent 4 }}
+    {{- if (eq $rolloutZone.noDownscale true )}}
+    grafana.com/no-downscale: {{$rolloutZone.noDownscale}}
+    {{- else }}
+    {{- if (eq $rolloutZone.prepareDownscale true )}}
+    grafana.com/prepare-downscale: {{$rolloutZone.prepareDownscale}}
+    {{- end }}
+    {{- end }}
   annotations:
     {{- include "mimir.componentAnnotations" $args | nindent 4 }}
+    {{- if $rolloutZone.prepareDownscale }}
+    grafana.com/prepare-downscale-http-path: ingester/prepare-shutdown
+    grafana.com/prepare-downscale-http-port: {{ include "mimir.serverHttpListenPort" . }}
+    {{- end -}}
+    {{- if $rolloutZone.downscaleLeader }}
+    grafana.com/rollout-downscale-leader: $rolloutZone.downscaleLeader
+    {{- end }}
   namespace: {{ .Release.Namespace | quote }}
 spec:
   replicas: {{ $rolloutZone.replicas }}

@@ -10,8 +10,23 @@ metadata:
   name: {{ include "mimir.resourceName" $args }}
   labels:
     {{- include "mimir.labels" $args | nindent 4 }}
+    {{- if (eq $rolloutZone.noDownscale true )}}
+    grafana.com/no-downscale: {{$rolloutZone.noDownscale}}
+    {{- else }}
+    {{- if (eq $rolloutZone.prepareDownscale true )}}
+    grafana.com/prepare-downscale: {{$rolloutZone.prepareDownscale}}
+    grafana.com/min-time-between-zones-downscale: 12h
+    {{- end }}
+    {{- end }}
   annotations:
     {{- include "mimir.componentAnnotations" $args | nindent 4 }}
+    {{- if $rolloutZone.prepareDownscale }}
+    grafana.com/prepare-downscale-http-path: ingester/prepare-shutdown
+    grafana.com/prepare-downscale-http-port: {{ include "mimir.serverHttpListenPort" . }}
+    {{- end -}}
+    {{- if $rolloutZone.downscaleLeader }}
+    grafana.com/rollout-downscale-leader: $rolloutZone.downscaleLeader
+    {{- end }}
   namespace: {{ .Release.Namespace | quote }}
 spec:
   podManagementPolicy: {{ .Values.ingester.podManagementPolicy }}

@@ -10,8 +10,23 @@ metadata:
   name: {{ include "mimir.resourceName" $args }}
   labels:
     {{- include "mimir.labels" $args | nindent 4 }}
+    {{- if (eq $rolloutZone.noDownscale true )}}
+    grafana.com/no-downscale: {{$rolloutZone.noDownscale}}
+    {{- else }}
+    {{- if (eq $rolloutZone.prepareDownscale true )}}
+    grafana.com/prepare-downscale: {{$rolloutZone.prepareDownscale}}
+    grafana.com/min-time-between-zones-downscale: 30m
+    {{- end }}
+    {{- end }}
   annotations:
     {{- include "mimir.componentAnnotations" $args | nindent 4 }}
+    {{- if $rolloutZone.prepareDownscale }}
+    grafana.com/prepare-downscale-http-path: ingester/prepare-shutdown
+    grafana.com/prepare-downscale-http-port: {{ include "mimir.serverHttpListenPort" . }}
+    {{- end -}}
+    {{- if $rolloutZone.downscaleLeader }}
+    grafana.com/rollout-downscale-leader: $rolloutZone.downscaleLeader
+    {{- end }}
   namespace: {{ .Release.Namespace | quote }}
 spec:
   podManagementPolicy: {{ .Values.store_gateway.podManagementPolicy }}

@@ -268,3 +268,9 @@
 {{- if and (not .Values.enterprise.enabled) .Values.federation_frontend.enabled -}}
 {{- fail "You have federation_frontend.enabled=true, but enterprise.enabled=false. Federation Frontend is an enterprise-only feature and requires enterprise mode to be enabled." }}
 {{- end -}}
+
+{{- range .Values.ingester.zoneAwareReplication.zones }}
+  {{- if and (eq .noDownscale true) (eq .prepareDownscale true) }}
+    {{- fail (printf "For ingester zone '%s': noDownscale and prepareDownscale cannot be used simultaneously." .name) -}}
+  {{- end }}
+{{- end }}
@@ -793,6 +793,14 @@ alertmanager:
         # If set to "-", then use `storageClassName: ""`, which disables dynamic provisioning
         # If undefined or set to null (the default), then fall back to the value of `alertmanager.persistentVolume.storageClass`.
         storageClass: null
+        # -- noDownscale adds a label that can be used by the rollout-operator as documented in the rollout-operator repo: https://github.com/grafana/rollout-operator#webhooks
+        noDownscale: false
+        # -- downscaleLeader is an Annotation used by the rollout-operator
+        # If defined, downscaleLeader: <downscaleLeader>
+        # If undefined or set to null (the default), no Annotation is set
+        downscaleLeader: null
+        # -- prepareDownscale adds labels and annotations for the rollout-operator to prepare downscaling: https://github.com/grafana/rollout-operator#how-scaling-up-and-down-works
+        prepareDownscale: false
       # -- Name of the zone, used in labels and selectors. Must follow Kubernetes naming restrictions: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
       - name: zone-b
         # -- nodeselector to restrict where pods of this zone can be placed. E.g.:
@@ -806,6 +814,14 @@ alertmanager:
         # If set to "-", then use `storageClassName: ""`, which disables dynamic provisioning
         # If undefined or set to null (the default), then fall back to the value of `alertmanager.persistentVolume.storageClass`.
         storageClass: null
+        # -- noDownscale adds a label that can be used by the rollout-operator as documented in the rollout-operator repo: https://github.com/grafana/rollout-operator#webhooks
+        noDownscale: false
+        # -- downscaleLeader is an Annotation used by the rollout-operator
+        # If defined, downscaleLeader: <downscaleLeader>
+        # If undefined or set to null (the default), no Annotation is set
+        downscaleLeader: null
+        # -- prepareDownscale adds labels and annotations for the rollout-operator to prepare downscaling: https://github.com/grafana/rollout-operator#how-scaling-up-and-down-works
+        prepareDownscale: false
       # -- Name of the zone, used in labels and selectors. Must follow Kubernetes naming restrictions: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
       - name: zone-c
         # -- nodeselector to restrict where pods of this zone can be placed. E.g.:
@@ -819,6 +835,14 @@ alertmanager:
         # If set to "-", then use `storageClassName: ""`, which disables dynamic provisioning
         # If undefined or set to null (the default), then fall back to the value of `alertmanager.persistentVolume.storageClass`.
         storageClass: null
+        # -- noDownscale adds a label that can be used by the rollout-operator as documented in the rollout-operator repo: https://github.com/grafana/rollout-operator#webhooks
+        noDownscale: false
+        # -- downscaleLeader is an Annotation used by the rollout-operator
+        # If defined, downscaleLeader: <downscaleLeader>
+        # If undefined or set to null (the default), no Annotation is set
+        downscaleLeader: null
+        # -- prepareDownscale adds labels and annotations for the rollout-operator to prepare downscaling: https://github.com/grafana/rollout-operator#how-scaling-up-and-down-works
+        prepareDownscale: false
 
 distributor:
   # -- Whether to render the manifests related to the distributor component.
@@ -1149,6 +1173,14 @@ ingester:
         # If set to "-", then use `storageClassName: ""`, which disables dynamic provisioning
         # If undefined or set to null (the default), then fall back to the value of `ingester.persistentVolume.storageClass`.
         storageClass: null
+        # -- noDownscale adds a label that can be used by the rollout-operator as documented in the rollout-operator repo: https://github.com/grafana/rollout-operator#webhooks
+        noDownscale: false
+        # -- downscaleLeader is an Annotation used by the rollout-operator
+        # If defined, downscaleLeader: <downscaleLeader>
+        # If undefined or set to null (the default), no Annotation is set
+        downscaleLeader: null
+        # -- prepareDownscale adds labels and annotations for the rollout-operator to prepare downscaling: https://github.com/grafana/rollout-operator#how-scaling-up-and-down-works
+        prepareDownscale: true
       # -- Name of the zone, used in labels and selectors. Must follow Kubernetes naming restrictions: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
       - name: zone-b
         # -- nodeselector to restrict where pods of this zone can be placed. E.g.:
@@ -1162,6 +1194,14 @@ ingester:
         # If set to "-", then use `storageClassName: ""`, which disables dynamic provisioning
         # If undefined or set to null (the default), then fall back to the value of `ingester.persistentVolume.storageClass`.
         storageClass: null
+        # -- noDownscale adds a label that can be used by the rollout-operator as documented in the rollout-operator repo: https://github.com/grafana/rollout-operator#webhooks
+        noDownscale: false
+        # -- downscaleLeader is an Annotation used by the rollout-operator
+        # If defined, downscaleLeader: <downscaleLeader>
+        # If undefined or set to null (the default), no Annotation is set
+        downscaleLeader: mimir-ingester-zone-a
+        # -- prepareDownscale adds labels and annotations for the rollout-operator to prepare downscaling: https://github.com/grafana/rollout-operator#how-scaling-up-and-down-works
+        prepareDownscale: true
       # -- Name of the zone, used in labels and selectors. Must follow Kubernetes naming restrictions: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
       - name: zone-c
         # -- nodeselector to restrict where pods of this zone can be placed. E.g.:
@@ -1175,6 +1215,14 @@ ingester:
         # If set to "-", then use `storageClassName: ""`, which disables dynamic provisioning
         # If undefined or set to null (the default), then fall back to the value of `ingester.persistentVolume.storageClass`.
         storageClass: null
+        # -- noDownscale adds a label that can be used by the rollout-operator as documented in the rollout-operator repo: https://github.com/grafana/rollout-operator#webhooks
+        noDownscale: false
+        # -- downscaleLeader is an Annotation used by the rollout-operator
+        # If defined, downscaleLeader: <downscaleLeader>
+        # If undefined or set to null (the default), no Annotation is set
+        downscaleLeader: mimir-ingester-zone-b
+        # -- prepareDownscale adds labels and annotations for the rollout-operator to prepare downscaling: https://github.com/grafana/rollout-operator#how-scaling-up-and-down-works
+        prepareDownscale: true
 
 overrides_exporter:
   enabled: true
@@ -2283,6 +2331,14 @@ store_gateway:
         # If set to "-", then use `storageClassName: ""`, which disables dynamic provisioning
         # If undefined or set to null (the default), then fall back to the value of `store_gateway.persistentVolume.storageClass`.
         storageClass: null
+        # -- noDownscale adds a label that can be used by the rollout-operator as documented in the rollout-operator repo: https://github.com/grafana/rollout-operator#webhooks
+        noDownscale: false
+        # -- downscaleLeader is an Annotation used by the rollout-operator
+        # If defined, downscaleLeader: <downscaleLeader>
+        # If undefined or set to null (the default), no Annotation is set
+        downscaleLeader: null
+        # -- prepareDownscale adds labels and annotations for the rollout-operator to prepare downscaling: https://github.com/grafana/rollout-operator#how-scaling-up-and-down-works
+        prepareDownscale: false
       # -- Name of the zone, used in labels and selectors. Must follow Kubernetes naming restrictions: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
       - name: zone-b
         # -- nodeselector to restrict where pods of this zone can be placed. E.g.:
@@ -2296,6 +2352,14 @@ store_gateway:
         # If set to "-", then use `storageClassName: ""`, which disables dynamic provisioning
         # If undefined or set to null (the default), then fall back to the value of `store_gateway.persistentVolume.storageClass`.
         storageClass: null
+        # -- noDownscale adds a label that can be used by the rollout-operator as documented in the rollout-operator repo: https://github.com/grafana/rollout-operator#webhooks
+        noDownscale: false
+        # -- downscaleLeader is an Annotation used by the rollout-operator
+        # If defined, downscaleLeader: <downscaleLeader>
+        # If undefined or set to null (the default), no Annotation is set
+        downscaleLeader: null
+        # -- prepareDownscale adds labels and annotations for the rollout-operator to prepare downscaling: https://github.com/grafana/rollout-operator#how-scaling-up-and-down-works
+        prepareDownscale: false
       # -- Name of the zone, used in labels and selectors. Must follow Kubernetes naming restrictions: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
       - name: zone-c
         # -- nodeselector to restrict where pods of this zone can be placed. E.g.:
@@ -2309,6 +2373,14 @@ store_gateway:
         # If set to "-", then use `storageClassName: ""`, which disables dynamic provisioning
         # If undefined or set to null (the default), then fall back to the value of `store_gateway.persistentVolume.storageClass`.
         storageClass: null
+        # -- noDownscale adds a label that can be used by the rollout-operator as documented in the rollout-operator repo: https://github.com/grafana/rollout-operator#webhooks
+        noDownscale: false
+        # -- downscaleLeader is an Annotation used by the rollout-operator
+        # If defined, downscaleLeader: <downscaleLeader>
+        # If undefined or set to null (the default), no Annotation is set
+        downscaleLeader: null
+        # -- prepareDownscale adds labels and annotations for the rollout-operator to prepare downscaling: https://github.com/grafana/rollout-operator#how-scaling-up-and-down-works
+        prepareDownscale: false
 
 compactor:
   # -- Whether to render the manifests related to the compactor component.

@@ -13,8 +13,12 @@ metadata:
     name: "ingester-zone-a"
     rollout-group: ingester
     zone: zone-a
+    grafana.com/prepare-downscale: true
+    grafana.com/min-time-between-zones-downscale: 12h
   annotations:
     rollout-max-unavailable: "50"
+    grafana.com/prepare-downscale-http-path: ingester/prepare-shutdown
+    grafana.com/prepare-downscale-http-port: 8080
   namespace: "citestns"
 spec:
   podManagementPolicy: Parallel
@@ -163,8 +167,13 @@ metadata:
     name: "ingester-zone-b"
     rollout-group: ingester
     zone: zone-b
+    grafana.com/prepare-downscale: true
+    grafana.com/min-time-between-zones-downscale: 12h
   annotations:
     rollout-max-unavailable: "50"
+    grafana.com/prepare-downscale-http-path: ingester/prepare-shutdown
+    grafana.com/prepare-downscale-http-port: 8080
+    grafana.com/rollout-downscale-leader: $rolloutZone.downscaleLeader
   namespace: "citestns"
 spec:
   podManagementPolicy: Parallel
@@ -313,8 +322,13 @@ metadata:
     name: "ingester-zone-c"
     rollout-group: ingester
     zone: zone-c
+    grafana.com/prepare-downscale: true
+    grafana.com/min-time-between-zones-downscale: 12h
   annotations:
     rollout-max-unavailable: "50"
+    grafana.com/prepare-downscale-http-path: ingester/prepare-shutdown
+    grafana.com/prepare-downscale-http-port: 8080
+    grafana.com/rollout-downscale-leader: $rolloutZone.downscaleLeader
   namespace: "citestns"
 spec:
   podManagementPolicy: Parallel

@@ -13,8 +13,12 @@ metadata:
     name: "ingester-zone-a"
     rollout-group: ingester
     zone: zone-a
+    grafana.com/prepare-downscale: true
+    grafana.com/min-time-between-zones-downscale: 12h
   annotations:
     rollout-max-unavailable: "50"
+    grafana.com/prepare-downscale-http-path: ingester/prepare-shutdown
+    grafana.com/prepare-downscale-http-port: 8080
   namespace: "citestns"
 spec:
   podManagementPolicy: Parallel
@@ -154,8 +158,13 @@ metadata:
     name: "ingester-zone-b"
     rollout-group: ingester
     zone: zone-b
+    grafana.com/prepare-downscale: true
+    grafana.com/min-time-between-zones-downscale: 12h
   annotations:
     rollout-max-unavailable: "50"
+    grafana.com/prepare-downscale-http-path: ingester/prepare-shutdown
+    grafana.com/prepare-downscale-http-port: 8080
+    grafana.com/rollout-downscale-leader: $rolloutZone.downscaleLeader
   namespace: "citestns"
 spec:
   podManagementPolicy: Parallel
@@ -295,8 +304,13 @@ metadata:
     name: "ingester-zone-c"
     rollout-group: ingester
     zone: zone-c
+    grafana.com/prepare-downscale: true
+    grafana.com/min-time-between-zones-downscale: 12h
   annotations:
     rollout-max-unavailable: "50"
+    grafana.com/prepare-downscale-http-path: ingester/prepare-shutdown
+    grafana.com/prepare-downscale-http-port: 8080
+    grafana.com/rollout-downscale-leader: $rolloutZone.downscaleLeader
   namespace: "citestns"
 spec:
   podManagementPolicy: Parallel

@@ -13,8 +13,12 @@ metadata:
     name: "ingester-zone-a"
     rollout-group: ingester
     zone: zone-a
+    grafana.com/prepare-downscale: true
+    grafana.com/min-time-between-zones-downscale: 12h
   annotations:
     rollout-max-unavailable: "50"
+    grafana.com/prepare-downscale-http-path: ingester/prepare-shutdown
+    grafana.com/prepare-downscale-http-port: 8080
   namespace: "citestns"
 spec:
   podManagementPolicy: Parallel
@@ -149,8 +153,13 @@ metadata:
     name: "ingester-zone-b"
     rollout-group: ingester
     zone: zone-b
+    grafana.com/prepare-downscale: true
+    grafana.com/min-time-between-zones-downscale: 12h
   annotations:
     rollout-max-unavailable: "50"
+    grafana.com/prepare-downscale-http-path: ingester/prepare-shutdown
+    grafana.com/prepare-downscale-http-port: 8080
+    grafana.com/rollout-downscale-leader: $rolloutZone.downscaleLeader
   namespace: "citestns"
 spec:
   podManagementPolicy: Parallel
@@ -285,8 +294,13 @@ metadata:
     name: "ingester-zone-c"
     rollout-group: ingester
     zone: zone-c
+    grafana.com/prepare-downscale: true
+    grafana.com/min-time-between-zones-downscale: 12h
   annotations:
     rollout-max-unavailable: "50"
+    grafana.com/prepare-downscale-http-path: ingester/prepare-shutdown
+    grafana.com/prepare-downscale-http-port: 8080
+    grafana.com/rollout-downscale-leader: $rolloutZone.downscaleLeader
   namespace: "citestns"
 spec:
   podManagementPolicy: Parallel