helm: clean up logic for autodelete pvcs

grafana · Jan 3, 2024 · 4883cf3 · 4883cf3
1 parent 4171583
commit 4883cf3
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 3 deletions.
diff --git a/operations/helm/charts/grafana-agent/CHANGELOG.md b/operations/helm/charts/grafana-agent/CHANGELOG.md
@@ -10,9 +10,14 @@ internal API changes are not present.
 Unreleased
 ----------
 
+### Bugfixes
+
+- Statefulset should use value `.controller.enableStatefulSetAutoDeletePVC` instead of just `.enableStatefulSetAutoDeletePVC`. (@captncraig)
+
 ### Enhancements
 
 - Update `rbac` to include necessary rules for the `otelcol.processor.k8sattributes` component. (@rlankfo)
+- Add value `.controller.minK8sVersionForAutoDelete` to support earlier k8s versions with beta feature gates enabled. (@captncraig)
 
 0.29.0 (2023-11-30)
 -------------------

diff --git a/operations/helm/charts/grafana-agent/README.md b/operations/helm/charts/grafana-agent/README.md
@@ -81,6 +81,7 @@ use the older mode (called "static mode"), set the `agent.mode` value to
 | controller.hostNetwork | bool | `false` | Configures Pods to use the host network. When set to true, the ports that will be used must be specified. |
 | controller.hostPID | bool | `false` | Configures Pods to use the host PID namespace. |
 | controller.initContainers | list | `[]` |  |
+| controller.minK8sVersionForAutoDelete | string | `">= 1.27"` | The StatefulSetAutoDeletePVC feature gate went into alpha status with k8s 1.27. If you have it enabled on an earlier version, you can lower this value as far as 1.23. |
 | controller.nodeSelector | object | `{}` | nodeSelector to apply to Grafana Agent pods. |
 | controller.parallelRollout | bool | `true` | Whether to deploy pods in parallel. Only used when controller.type is 'statefulset'. |
 | controller.podAnnotations | object | `{}` | Extra pod annotations to add. |

diff --git a/operations/helm/charts/grafana-agent/ci/create-statefulset-autoscaling-values.yaml b/operations/helm/charts/grafana-agent/ci/create-statefulset-autoscaling-values.yaml
@@ -3,6 +3,8 @@ controller:
   type: statefulset
   autoscaling:
     enabled: true
+  enableStatefulSetAutoDeletePVC: true
+  minK8sVersionForAutoDelete: ">= 1.26"
 agent:
   resources:
     requests:

diff --git a/operations/helm/charts/grafana-agent/templates/controllers/statefulset.yaml b/operations/helm/charts/grafana-agent/templates/controllers/statefulset.yaml
@@ -1,4 +1,7 @@
 {{- if eq .Values.controller.type "statefulset" }}
+{{- if .Values.enableStatefulSetAutoDeletePVC }}
+{{- fail "Value 'enableStatefulSetAutoDeletePVC' should be nested inside 'controller' options." }}
+{{- end }}
 apiVersion: apps/v1
 kind: StatefulSet
 metadata:
@@ -35,8 +38,8 @@ spec:
     - {{ toYaml . | nindent 6 }}
     {{- end }}
   {{- end }}
-  {{- if and (semverCompare ">= 1.23-0" .Capabilities.KubeVersion.Version) (.Values.enableStatefulSetAutoDeletePVC)  }}
-  {{/*
+  {{- if and (semverCompare .Values.controller.minK8sVersionForAutoDelete .Capabilities.KubeVersion.Version) (.Values.controller.enableStatefulSetAutoDeletePVC) }}
+  {{- /*
     Data on the read nodes is easy to replace, so we want to always delete PVCs to make
     operation easier, and will rely on re-fetching data when needed.
   */}}

diff --git a/operations/helm/charts/grafana-agent/values.yaml b/operations/helm/charts/grafana-agent/values.yaml
@@ -189,6 +189,9 @@ controller:
   # -- Whether to enable automatic deletion of stale PVCs due to a scale down operation, when controller.type is 'statefulset'.
   enableStatefulSetAutoDeletePVC: false
 
+  # -- The StatefulSetAutoDeletePVC feature gate went into alpha status with k8s 1.27. If you have it enabled on an earlier version, you can lower this value as far as 1.23.
+  minK8sVersionForAutoDelete: ">= 1.27"
+
   autoscaling:
     # -- Creates a HorizontalPodAutoscaler for controller type deployment.
     enabled: false

diff --git a/operations/helm/scripts/rebuild-tests.sh b/operations/helm/scripts/rebuild-tests.sh
@@ -17,7 +17,7 @@ for chart_file in $(find * -name Chart.yaml -print | sort); do
       FILENAME=$(basename ${FILE_PATH})
       TESTNAME=${FILENAME%-values.yaml}
       # Render chart
-      helm template --namespace default --debug ${CHART_NAME} ${CHART_DIR} -f ${FILE_PATH} --output-dir ${TEST_DIR}/${TESTNAME} --set '$chart_tests=true'
+      helm template --namespace default --kube-version 1.26 --debug ${CHART_NAME} ${CHART_DIR} -f ${FILE_PATH} --output-dir ${TEST_DIR}/${TESTNAME} --set '$chart_tests=true'
     done
   fi
 done

diff --git a/...tests/create-statefulset-autoscaling/grafana-agent/templates/controllers/statefulset.yaml b/...tests/create-statefulset-autoscaling/grafana-agent/templates/controllers/statefulset.yaml
@@ -76,3 +76,6 @@ spec:
         - name: config
           configMap:
             name: grafana-agent
+  persistentVolumeClaimRetentionPolicy:
+    whenDeleted: Delete
+    whenScaled: Delete