Make replicas optional for Deployment and StatefulSet (#12)

Adding the ability to not include the `replicas` field on the Deployment/StatefulSet definition. Including it can cause issues in certain situations like when using HorizontalPodAutoscaler.
spacelift-io · Nov 10, 2022 · fd5bf8c · fd5bf8c
1 parent 3afdc6a
commit fd5bf8c
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/templates/deployment.yaml b/templates/deployment.yaml
@@ -9,7 +9,9 @@ metadata:
       {{- toYaml . | nindent 4 }}
     {{- end }}
 spec:
+  {{- if .Values.replicasEnabled  }}
   replicas: {{ .Values.replicaCount }}
+  {{- end }}
   selector:
     matchLabels:
       {{- include "spacelift-worker.selectorLabels" . | nindent 6 }}

diff --git a/templates/statefulset.yaml b/templates/statefulset.yaml
@@ -9,7 +9,9 @@ metadata:
       {{- toYaml . | nindent 4 }}
     {{- end }}
 spec:
+  {{- if .Values.replicasEnabled  }}
   replicas: {{ .Values.replicaCount }}
+  {{- end }}
   selector:
     matchLabels:
       {{- include "spacelift-worker.selectorLabels" . | nindent 6 }}

diff --git a/values.yaml b/values.yaml
@@ -1,3 +1,5 @@
+# replicas.enabled defines whether the `replicas` field is set against the Deployment or StatefulSet. This allows you to prevent the field from being set when using a HPA, as recommended in the Kubernetes documentation: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#migrating-deployments-and-statefulsets-to-horizontal-autoscaling.
+replicasEnabled : true
 # replicaCount defines the number of Spacelift workers that will be created.
 replicaCount: 1
 # terminationGracePeriodSeconds specifies how long Kubernetes gives a worker pod to gracefully