optional gw replicas field (signalfx#2199)

Author: jinja2

.chloggen/replica-optional.yaml

@@ -0,0 +1,8 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+# The name of the component, or a single word describing the area of concern, (e.g. agent, clusterReceiver, gateway, operator, chart, other)
+component: gateway
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Make replicaCount optional for the gateway deployment to allow HPA to manage replicas without conflicts
+# One or more tracking issues related to the change
+issues: [2198]

Makefile

@@ -62,10 +62,12 @@ dep-update: ## Fetch Helm chart dependency repositories, build the Helm chart wi
 		helm repo add jetstack https://charts.jetstack.io || exit 1; \
 	fi ;\
 	helm repo update open-telemetry jetstack || exit 1; \
-	DEP_OK=true ;\
-	if ! helm dependencies list $$DIR | grep open-telemetry | grep -q ok ; then DEP_OK=false ; fi ;\
-	if ! helm dependencies list $$DIR | grep jetstack | grep -q ok ; then DEP_OK=false ; fi ;\
-	if [ "$$DEP_OK" = "false" ] ; then helm dependencies update $$DIR || exit 1; fi ;\
+	if helm dependencies list $$DIR | grep -q missing ; then \
+		echo "Dependencies missing, updating..."; \
+		helm dependencies update $$DIR || exit 1; \
+	else \
+		echo "All dependencies are up to date."; \
+	fi ;\
 	if [ -f "$$LOCK_FILE" ] ; then \
 		echo "Removing Chart.lock file post-update..."; \
 		rm -f "$$LOCK_FILE" || exit 1; \

helm-charts/splunk-otel-collector/templates/deployment-gateway.yaml

@@ -16,7 +16,9 @@ metadata:
     {{- toYaml .Values.gateway.annotations | nindent 4 }}
   {{- end }}
 spec:
+  {{- if not (kindIs "invalid" .Values.gateway.replicaCount) }}
   replicas: {{ .Values.gateway.replicaCount }}
+  {{- end }}
   selector:
     matchLabels:
       app: {{ template "splunk-otel-collector.name" . }}

helm-charts/splunk-otel-collector/values.schema.json

@@ -1072,7 +1072,10 @@
           "type": "boolean"
         },
         "replicaCount": {
-          "type": "integer"
+          "type": [
+            "integer",
+            "null"
+          ]
         },
         "ports": {
           "type": "object",

helm-charts/splunk-otel-collector/values.yaml

@@ -812,6 +812,7 @@ gateway:
   enabled: false
 
   # Number of collector replicas
+  # Set to null if using HorizontalPodAutoscaler to avoid conflicts
   replicaCount: 3
 
   # The ports exposed by the collector container.

unittests/gateway_deployment_test.yaml

@@ -0,0 +1,55 @@
+suite: splunk-otel-collector.gatewayDeployment
+values:
+  - ./values/basic.yaml
+release:
+  name: test-release
+  namespace: test-ns
+templates:
+  - deployment-gateway.yaml
+  - configmap-gateway.yaml
+
+tests:
+  - it: should not render gateway deployment when gateway.enabled is false
+    set:
+      gateway:
+        enabled: false
+    asserts:
+      - hasDocuments:
+          count: 0
+
+  - it: should render gateway deployment with default replicaCount
+    template: deployment-gateway.yaml
+    set:
+      gateway:
+        enabled: true
+    asserts:
+      - isKind:
+          of: Deployment
+      - equal:
+          path: spec.replicas
+          value: 3
+
+  - it: should render gateway deployment with custom replicaCount
+    template: deployment-gateway.yaml
+    set:
+      gateway:
+        enabled: true
+        replicaCount: 5
+    asserts:
+      - isKind:
+          of: Deployment
+      - equal:
+          path: spec.replicas
+          value: 5
+
+  - it: should not set replicas field when replicaCount is null (for HPA usage)
+    template: deployment-gateway.yaml
+    set:
+      gateway:
+        enabled: true
+        replicaCount: null
+    asserts:
+      - isKind:
+          of: Deployment
+      - isNull:
+          path: spec.replicas