Helm: support sync-lb-services-endpoints for sync catalog (#3905)

* Helm: support sync-lb-services-endpoints for sync catalog * add test * fix template tag order --------- Co-authored-by: jukie <[email protected]>
hashicorp · Apr 12, 2024 · 8ac97bf · 8ac97bf
1 parent e575eb2
commit 8ac97bf
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 0 deletions.
diff --git a/.changelog/3905.txt b/.changelog/3905.txt
@@ -0,0 +1,3 @@
+```release-note:improvement
+helm: support sync-lb-services-endpoints flag for syncCatalog
+```
diff --git a/charts/consul/templates/sync-catalog-deployment.yaml b/charts/consul/templates/sync-catalog-deployment.yaml
@@ -192,6 +192,9 @@ spec:
             -loadBalancer-ips=true \
             {{- end }}
             {{- end }}
+            {{- if .Values.syncCatalog.syncLoadBalancerEndpoints }}
+            -sync-lb-services-endpoints=true \
+            {{- end }}
         livenessProbe:
           httpGet:
             path: /health/ready

diff --git a/charts/consul/test/unit/sync-catalog-deployment.bats b/charts/consul/test/unit/sync-catalog-deployment.bats
@@ -413,6 +413,29 @@ load _helpers
   [ "${actual}" = "true" ]
 }
 
+#--------------------------------------------------------------------
+# syncLoadBalancerEndpoints
+
+@test "syncCatalog/Deployment: enable LB endpoints sync flag not passed when disabled" {
+  cd `chart_dir`
+  local actual=$(helm template \
+      -s templates/sync-catalog-deployment.yaml  \
+      --set 'syncCatalog.enabled=true' \
+      . | tee /dev/stderr |
+      yq '.spec.template.spec.containers[0].command | any(contains("-sync-lb-services-endpoints=true"))' | tee /dev/stderr)
+  [ "${actual}" = "false" ]
+}
+@test "syncCatalog/Deployment: enable LB endpoints sync flag passed when enabled" {
+  cd `chart_dir`
+  local actual=$(helm template \
+      -s templates/sync-catalog-deployment.yaml  \
+      --set 'syncCatalog.enabled=true' \
+      --set 'syncCatalog.syncLoadBalancerEndpoints=true' \
+      . | tee /dev/stderr |
+      yq '.spec.template.spec.containers[0].command | any(contains("-sync-lb-services-endpoints=true"))' | tee /dev/stderr)
+  [ "${actual}" = "true" ]
+}
+
 #--------------------------------------------------------------------
 # affinity
 

diff --git a/charts/consul/values.yaml b/charts/consul/values.yaml
@@ -2193,6 +2193,10 @@ syncCatalog:
   # Set this to false to skip syncing ClusterIP services.
   syncClusterIPServices: true
 
+  # If true, LoadBalancer service endpoints instead of ingress addresses will be synced to Consul. 
+  # If false, LoadBalancer endpoints are not synced to Consul.
+  syncLoadBalancerEndpoints: false
+
   ingress:
     # Syncs the hostname from a Kubernetes Ingress resource to service registrations
     # when a rule matched a service. Currently only supports host based routing and