feat(helm): Expose labels on volumeClaimTemplates (#13317)

Signed-off-by: Jan-Otto Kröpke <joe@cloudeteer.de> Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de> Signed-off-by: Jay Clifford <45856600+Jayclifford345@users.noreply.github.com> Co-authored-by: Jay Clifford <45856600+Jayclifford345@users.noreply.github.com>
5 months ago · cdefbbf3ac
parent 968e6fe9c3
commit cdefbbf3ac
12 changed files with 183 additions and 83 deletions
--- a/docs/sources/setup/install/helm/reference.md
+++ b/docs/sources/setup/install/helm/reference.md
@ -372,6 +372,7 @@ This is the generated reference for the Loki Helm Chart values.
      "emptyDir": {}
    },
    "enableStatefulSetAutoDeletePVC": true,
+    "labels": {},
    "selector": null,
    "size": "10Gi",
    "storageClass": null,
@ -603,6 +604,15 @@ null
 			<td><pre lang="json">
 true
 </pre>
+</td>
+		</tr>
+		<tr>
+			<td>backend.persistence.labels</td>
+			<td>object</td>
+			<td>Labels for volume claim</td>
+			<td><pre lang="json">
+{}
+</pre>
 </td>
 		</tr>
 		<tr>
@ -1180,6 +1190,7 @@ null
    ],
    "enableStatefulSetAutoDeletePVC": false,
    "enabled": false,
+    "labels": {},
    "whenDeleted": "Retain",
    "whenScaled": "Retain"
  },
@ -1393,6 +1404,15 @@ false
 			<td><pre lang="json">
 false
 </pre>
+</td>
+		</tr>
+		<tr>
+			<td>bloomGateway.persistence.labels</td>
+			<td>object</td>
+			<td>Labels for bloom gateway PVCs</td>
+			<td><pre lang="json">
+{}
+</pre>
 </td>
 		</tr>
 		<tr>
@ -1561,9 +1581,10 @@ null
  "livenessProbe": {},
  "nodeSelector": {},
  "persistence": {
-    "annotations": {},
    "claims": [
      {
+        "annotations": {},
+        "labels": {},
        "name": "data",
        "size": "10Gi",
        "storageClass": null
@ -1742,7 +1763,16 @@ null
 </td>
 		</tr>
 		<tr>
-			<td>bloomPlanner.persistence.annotations</td>
+			<td>bloomPlanner.persistence.claims</td>
+			<td>list</td>
+			<td>List of the bloom-planner PVCs</td>
+			<td><pre lang="list">
+
+</pre>
+</td>
+		</tr>
+		<tr>
+			<td>bloomPlanner.persistence.claims[0].annotations</td>
 			<td>object</td>
 			<td>Annotations for bloom-planner PVCs</td>
 			<td><pre lang="json">
@ -1751,11 +1781,11 @@ null
 </td>
 		</tr>
 		<tr>
-			<td>bloomPlanner.persistence.claims</td>
-			<td>list</td>
-			<td>List of the bloom-planner PVCs</td>
-			<td><pre lang="list">
-
+			<td>bloomPlanner.persistence.claims[0].labels</td>
+			<td>object</td>
+			<td>Labels for bloom planner PVCs</td>
+			<td><pre lang="json">
+{}
 </pre>
 </td>
 		</tr>
@ -2770,9 +2800,10 @@ null
  "livenessProbe": {},
  "nodeSelector": {},
  "persistence": {
-    "annotations": {},
    "claims": [
      {
+        "annotations": {},
+        "labels": {},
        "name": "data",
        "size": "10Gi",
        "storageClass": null
@ -2953,7 +2984,16 @@ null
 </td>
 		</tr>
 		<tr>
-			<td>compactor.persistence.annotations</td>
+			<td>compactor.persistence.claims</td>
+			<td>list</td>
+			<td>List of the compactor PVCs</td>
+			<td><pre lang="list">
+
+</pre>
+</td>
+		</tr>
+		<tr>
+			<td>compactor.persistence.claims[0].annotations</td>
 			<td>object</td>
 			<td>Annotations for compactor PVCs</td>
 			<td><pre lang="json">
@ -2962,11 +3002,11 @@ null
 </td>
 		</tr>
 		<tr>
-			<td>compactor.persistence.claims</td>
-			<td>list</td>
-			<td>List of the compactor PVCs</td>
-			<td><pre lang="list">
-
+			<td>compactor.persistence.claims[0].labels</td>
+			<td>object</td>
+			<td>Labels for compactor PVCs</td>
+			<td><pre lang="json">
+{}
 </pre>
 </td>
 		</tr>
@ -5278,6 +5318,7 @@ null
    "enableStatefulSetAutoDeletePVC": false,
    "enabled": false,
    "inMemory": false,
+    "labels": {},
    "size": "10Gi",
    "storageClass": null,
    "whenDeleted": "Retain",
@ -5480,6 +5521,15 @@ false
 			<td><pre lang="json">
 false
 </pre>
+</td>
+		</tr>
+		<tr>
+			<td>indexGateway.persistence.labels</td>
+			<td>object</td>
+			<td>Labels for index gateway PVCs</td>
+			<td><pre lang="json">
+{}
+</pre>
 </td>
 		</tr>
 		<tr>
@ -8712,9 +8762,10 @@ null
  "maxUnavailable": null,
  "nodeSelector": {},
  "persistence": {
-    "annotations": {},
    "claims": [
      {
+        "annotations": {},
+        "labels": {},
        "name": "data",
        "size": "10Gi",
        "storageClass": null
@ -8905,7 +8956,16 @@ null
 </td>
 		</tr>
 		<tr>
-			<td>patternIngester.persistence.annotations</td>
+			<td>patternIngester.persistence.claims</td>
+			<td>list</td>
+			<td>List of the pattern ingester PVCs</td>
+			<td><pre lang="list">
+
+</pre>
+</td>
+		</tr>
+		<tr>
+			<td>patternIngester.persistence.claims[0].annotations</td>
 			<td>object</td>
 			<td>Annotations for pattern ingester PVCs</td>
 			<td><pre lang="json">
@ -8914,11 +8974,11 @@ null
 </td>
 		</tr>
 		<tr>
-			<td>patternIngester.persistence.claims</td>
-			<td>list</td>
-			<td>List of the pattern ingester PVCs</td>
-			<td><pre lang="list">
-
+			<td>patternIngester.persistence.claims[0].labels</td>
+			<td>object</td>
+			<td>Labels for pattern ingester PVCs</td>
+			<td><pre lang="json">
+{}
 </pre>
 </td>
 		</tr>
@ -9147,12 +9207,6 @@ null
  "maxSurge": 0,
  "maxUnavailable": null,
  "nodeSelector": {},
-  "persistence": {
-    "annotations": {},
-    "enabled": false,
-    "size": "10Gi",
-    "storageClass": null
-  },
  "podAnnotations": {},
  "podLabels": {},
  "priorityClassName": null,
@ -9430,42 +9484,6 @@ null
 			<td><pre lang="json">
 {}
 </pre>
-</td>
-		</tr>
-		<tr>
-			<td>querier.persistence.annotations</td>
-			<td>object</td>
-			<td>Annotations for querier PVCs</td>
-			<td><pre lang="json">
-{}
-</pre>
-</td>
-		</tr>
-		<tr>
-			<td>querier.persistence.enabled</td>
-			<td>bool</td>
-			<td>Enable creating PVCs for the querier cache</td>
-			<td><pre lang="json">
-false
-</pre>
-</td>
-		</tr>
-		<tr>
-			<td>querier.persistence.size</td>
-			<td>string</td>
-			<td>Size of persistent disk</td>
-			<td><pre lang="json">
-"10Gi"
-</pre>
-</td>
-		</tr>
-		<tr>
-			<td>querier.persistence.storageClass</td>
-			<td>string</td>
-			<td>Storage class to be used. If defined, storageClassName: <storageClass>. If set to "-", storageClassName: "", which disables dynamic provisioning. If empty or set to null, no storageClassName spec is set, choosing the default provisioner (gp2 on AWS, standard on GKE, AWS, and OpenStack).</td>
-			<td><pre lang="json">
-null
-</pre>
 </td>
 		</tr>
 		<tr>
@ -10302,6 +10320,7 @@ false
  "persistence": {
    "annotations": {},
    "enableStatefulSetAutoDeletePVC": true,
+    "labels": {},
    "selector": null,
    "size": "10Gi",
    "storageClass": null
@ -10531,6 +10550,7 @@ false
 {
  "annotations": {},
  "enableStatefulSetAutoDeletePVC": true,
+  "labels": {},
  "selector": null,
  "size": "10Gi",
  "storageClass": null
@ -10554,6 +10574,15 @@ false
 			<td><pre lang="json">
 true
 </pre>
+</td>
+		</tr>
+		<tr>
+			<td>read.persistence.labels</td>
+			<td>object</td>
+			<td>Labels for volume claim</td>
+			<td><pre lang="json">
+{}
+</pre>
 </td>
 		</tr>
 		<tr>
@ -11144,6 +11173,7 @@ null
  "persistence": {
    "annotations": {},
    "enabled": false,
+    "labels": {},
    "size": "10Gi",
    "storageClass": null
  },
@ -11351,6 +11381,15 @@ null
 			<td><pre lang="json">
 false
 </pre>
+</td>
+		</tr>
+		<tr>
+			<td>ruler.persistence.labels</td>
+			<td>object</td>
+			<td>Labels for ruler PVCs</td>
+			<td><pre lang="json">
+{}
+</pre>
 </td>
 		</tr>
 		<tr>
@ -11935,6 +11974,15 @@ true
 			<td><pre lang="json">
 true
 </pre>
+</td>
+		</tr>
+		<tr>
+			<td>singleBinary.persistence.labels</td>
+			<td>object</td>
+			<td>Labels for volume claim</td>
+			<td><pre lang="json">
+{}
+</pre>
 </td>
 		</tr>
 		<tr>
@ -12730,6 +12778,15 @@ null
 			<td><pre lang="json">
 false
 </pre>
+</td>
+		</tr>
+		<tr>
+			<td>write.persistence.labels</td>
+			<td>object</td>
+			<td>Labels for volume claim</td>
+			<td><pre lang="json">
+{}
+</pre>
 </td>
 		</tr>
 		<tr>
--- a/production/helm/loki/CHANGELOG.md
+++ b/production/helm/loki/CHANGELOG.md
@ -13,9 +13,9 @@ Entries should include a reference to the pull request that introduced the chang

 [//]: # (<AUTOMATED_UPDATES_LOCATOR> : do not remove this line. This locator is used by the CI pipeline to automatically create a changelog entry for each new Loki release. Add other chart versions and respective changelog entries bellow this line.)

+- [FEATURE] Expose labels on volumeClaimTemplates [#13317](https://github.com/grafana/loki/pull/13317)
 - [ENHANCEMENT] Add configurable `startupProbe` to the loki-sc-rules sidecar container in the backend pods. [#18547](https://github.com/grafana/loki/pull/18547)
 - [ENHANCEMENT] Add configurable `startupProbe` to the loki-sc-rules sidecar container in the single-binary pods. [#18547](https://github.com/grafana/loki/pull/18547)
- [ENHANCEMENT] Add configurable `livenessProbe` and `startupProbe` for admin-api. [#18546](https://github.com/grafana/loki/pull/18546)
 - [BUGFIX] Add validation for loki.storage.bucketNames [#13781](https://github.com/grafana/loki/pull/13781)
 - [BUGFIX] Create missing RBAC for the rules sidecar when RBAC is namespaced
 - [FEATURE] Allow setting custom labels for ingester statefulsets [#18536](https://github.com/grafana/loki/pull/18536)
--- a/production/helm/loki/templates/backend/statefulset-backend.yaml
+++ b/production/helm/loki/templates/backend/statefulset-backend.yaml
@ -273,6 +273,10 @@ spec:
        annotations:
          {{- toYaml . | nindent 10 }}
        {{- end }}
+        {{- with .Values.backend.persistence.labels }}
+        labels:
+          {{- toYaml . | nindent 10 }}
+        {{- end }}
      spec:
        accessModes:
          - ReadWriteOnce
--- a/production/helm/loki/templates/bloom-gateway/statefulset-bloom-gateway.yaml
+++ b/production/helm/loki/templates/bloom-gateway/statefulset-bloom-gateway.yaml
@ -166,6 +166,10 @@ spec:
        annotations:
          {{- . | toYaml | nindent 10 }}
        {{- end }}
+        {{- with .labels }}
+        labels:
+          {{- . | toYaml | nindent 10 }}
+        {{- end }}
      spec:
        accessModes:
          - ReadWriteOnce
--- a/production/helm/loki/templates/compactor/statefulset-compactor.yaml
+++ b/production/helm/loki/templates/compactor/statefulset-compactor.yaml
@ -178,6 +178,10 @@ spec:
        annotations:
          {{- . | toYaml | nindent 10 }}
        {{- end }}
+        {{- with .labels }}
+        labels:
+          {{- . | toYaml | nindent 10 }}
+        {{- end }}
      spec:
        accessModes:
          - ReadWriteOnce
--- a/production/helm/loki/templates/index-gateway/statefulset-index-gateway.yaml
+++ b/production/helm/loki/templates/index-gateway/statefulset-index-gateway.yaml
@ -178,6 +178,10 @@ spec:
        annotations:
          {{- . | toYaml | nindent 10 }}
        {{- end }}
+        {{- with .Values.indexGateway.persistence.labels }}
+        labels:
+          {{- . | toYaml | nindent 10 }}
+        {{- end }}
      spec:
        accessModes:
          - ReadWriteOnce
--- a/production/helm/loki/templates/pattern-ingester/statefulset-pattern-ingester.yaml
+++ b/production/helm/loki/templates/pattern-ingester/statefulset-pattern-ingester.yaml
@ -171,6 +171,10 @@ spec:
        annotations:
          {{- . | toYaml | nindent 10 }}
        {{- end }}
+        {{- with .labels }}
+        labels:
+          {{- . | toYaml | nindent 10 }}
+        {{- end }}
      spec:
        accessModes:
          - ReadWriteOnce
--- a/production/helm/loki/templates/read/statefulset-read.yaml
+++ b/production/helm/loki/templates/read/statefulset-read.yaml
@ -182,6 +182,10 @@ spec:
        annotations:
          {{- toYaml . | nindent 10 }}
        {{- end }}
+        {{- with .Values.read.persistence.labels }}
+        labels:
+          {{- toYaml . | nindent 10 }}
+        {{- end }}
      spec:
        accessModes:
          - ReadWriteOnce
--- a/production/helm/loki/templates/ruler/statefulset-ruler.yaml
+++ b/production/helm/loki/templates/ruler/statefulset-ruler.yaml
@ -253,6 +253,10 @@ spec:
        annotations:
          {{- . | toYaml | nindent 10 }}
        {{- end }}
+        {{- with .Values.ruler.persistence.labels }}
+        labels:
+          {{- . | toYaml | nindent 10 }}
+        {{- end }}
      spec:
        accessModes:
          - ReadWriteOnce
--- a/production/helm/loki/templates/single-binary/statefulset.yaml
+++ b/production/helm/loki/templates/single-binary/statefulset.yaml
@ -266,6 +266,10 @@ spec:
        annotations:
          {{- toYaml . | nindent 10 }}
        {{- end }}
+        {{- with .Values.singleBinary.persistence.labels }}
+        labels:
+          {{- toYaml . | nindent 10 }}
+        {{- end }}
      spec:
        accessModes:
          - ReadWriteOnce
--- a/production/helm/loki/templates/write/statefulset-write.yaml
+++ b/production/helm/loki/templates/write/statefulset-write.yaml
@ -191,6 +191,10 @@ spec:
        annotations:
          {{- toYaml . | nindent 10 }}
        {{- end }}
+        {{- with .Values.write.persistence.labels }}
+        labels:
+          {{- toYaml . | nindent 10 }}
+        {{- end }}
      spec:
        accessModes:
          - ReadWriteOnce
--- a/production/helm/loki/values.yaml
+++ b/production/helm/loki/values.yaml
@ -1500,6 +1500,8 @@ singleBinary:
    selector: null
    # -- Annotations for volume claim
    annotations: {}
+    # -- Labels for volume claim
+    labels: {}
 ######################################################################################################################
 #
 # Simple Scalable Deployment (SSD) Mode
@ -1629,6 +1631,8 @@ write:
    selector: null
    # -- Annotations for volume claim
    annotations: {}
+    # -- Labels for volume claim
+    labels: {}
 # --  Configuration for the read pod(s)
 read:
  # -- Number of replicas for the read
@ -1741,6 +1745,8 @@ read:
    selector: null
    # -- Annotations for volume claim
    annotations: {}
+    # -- Labels for volume claim
+    labels: {}
 # --  Configuration for the backend pod(s)
 backend:
  # -- Number of replicas for the backend
@ -1853,6 +1859,8 @@ backend:
    selector: null
    # -- Annotations for volume claim
    annotations: {}
+    # -- Labels for volume claim
+    labels: {}
 ######################################################################################################################
 #
 # Microservices Mode
@ -2250,19 +2258,6 @@ querier:
  tolerations: []
  # -- DNSConfig for querier pods
  dnsConfig: {}
-  persistence:
-    # -- Enable creating PVCs for the querier cache
-    enabled: false
-    # -- Size of persistent disk
-    size: 10Gi
-    # -- Storage class to be used.
-    # If defined, storageClassName: <storageClass>.
-    # If set to "-", storageClassName: "", which disables dynamic provisioning.
-    # If empty or set to null, no storageClassName spec is
-    # set, choosing the default provisioner (gp2 on AWS, standard on GKE, AWS, and OpenStack).
-    storageClass: null
-    # -- Annotations for querier PVCs
-    annotations: {}
  # -- Adds the appProtocol field to the querier service. This allows querier to work with istio protocol selection.
  appProtocol:
    # -- Set the optional grpc service protocol. Ex: "grpc", "http2" or "https"
@ -2501,6 +2496,8 @@ indexGateway:
    storageClass: null
    # -- Annotations for index gateway PVCs
    annotations: {}
+    # -- Labels for index gateway PVCs
+    labels: {}
    # -- Enable StatefulSetAutoDeletePVC feature
    enableStatefulSetAutoDeletePVC: false
    whenDeleted: Retain
@ -2592,8 +2589,6 @@ compactor:
    # If empty or set to null, no storageClassName spec is
    # set, choosing the default provisioner (gp2 on AWS, standard on GKE, AWS, and OpenStack).
    storageClass: null
-    # -- Annotations for compactor PVCs
-    annotations: {}
    # -- List of the compactor PVCs
    # @notationType -- list
    claims:
@ -2605,6 +2600,10 @@ compactor:
        #   If empty or set to null, no storageClassName spec is
        #   set, choosing the default provisioner (gp2 on AWS, standard on GKE, AWS, and OpenStack).
        storageClass: null
+        # -- Annotations for compactor PVCs
+        annotations: {}
+        # -- Labels for compactor PVCs
+        labels: {}
        # - name: wal
        #   size: 150Gi
    # -- Enable StatefulSetAutoDeletePVC feature
@ -2694,6 +2693,8 @@ bloomGateway:
    enabled: false
    # -- Annotations for bloom-gateway PVCs
    annotations: {}
+    # -- Labels for bloom gateway PVCs
+    labels: {}
    # -- List of the bloom-gateway PVCs
    # @notationType -- list
    claims:
@ -2791,8 +2792,6 @@ bloomPlanner:
  persistence:
    # -- Enable creating PVCs for the bloom-planner
    enabled: false
-    # -- Annotations for bloom-planner PVCs
-    annotations: {}
    # -- List of the bloom-planner PVCs
    # @notationType -- list
    claims:
@ -2805,6 +2804,10 @@ bloomPlanner:
        #   If empty or set to null, no storageClassName spec is
        #   set, choosing the default provisioner (gp2 on AWS, standard on GKE, AWS, and OpenStack).
        storageClass: null
+        # -- Annotations for bloom-planner PVCs
+        annotations: {}
+        # -- Labels for bloom planner PVCs
+        labels: {}
    # -- Enable StatefulSetAutoDeletePVC feature
    enableStatefulSetAutoDeletePVC: false
    whenDeleted: Retain
@ -2992,8 +2995,6 @@ patternIngester:
    # If empty or set to null, no storageClassName spec is
    # set, choosing the default provisioner (gp2 on AWS, standard on GKE, AWS, and OpenStack).
    storageClass: null
-    # -- Annotations for pattern ingester PVCs
-    annotations: {}
    # -- List of the pattern ingester PVCs
    # @notationType -- list
    claims:
@ -3005,6 +3006,10 @@ patternIngester:
        #   If empty or set to null, no storageClassName spec is
        #   set, choosing the default provisioner (gp2 on AWS, standard on GKE, AWS, and OpenStack).
        storageClass: null
+        # -- Annotations for pattern ingester PVCs
+        annotations: {}
+        # -- Labels for pattern ingester PVCs
+        labels: {}
        # - name: wal
        #   size: 150Gi
    # -- Enable StatefulSetAutoDeletePVC feature
@ -3105,6 +3110,8 @@ ruler:
    storageClass: null
    # -- Annotations for ruler PVCs
    annotations: {}
+    # -- Labels for ruler PVCs
+    labels: {}
  # -- Set the optional grpc service protocol. Ex: "grpc", "http2" or "https"
  appProtocol:
    grpc: ""