Expose new options for API Gateway's High Availability feature

CHANGELOG.md

@@ -5,6 +5,7 @@ IMPROVEMENTS:
   * Enable the configuring of snapshot intervals in the client snapshot agent via `client.snapshotAgent.interval`. [[GH-1235](https://github.com/hashicorp/consul-k8s/pull/1235)]
   * Enable configuring the pod topologySpreadConstraints for mesh, terminating, and ingress gateways. [[GH-1257](https://github.com/hashicorp/consul-k8s/pull/1257)]
   * Present Consul server CA chain when using Vault secrets backend. [[GH-1251](https://github.com/hashicorp/consul-k8s/pull/1251)]
+  * API Gateway: Enable configuring of the new High Availability feature (requires Consul API Gateway v0.3.0+). [[GH-1261](https://github.com/hashicorp/consul-k8s/pull/1261)]
 * Control Plane
   * Bump Dockerfile base image for RedHat UBI `consul-k8s-control-plane` image to `ubi-minimal:8.6`. [[GH-1244](https://github.com/hashicorp/consul-k8s/pull/1244)]
   * Add additional metadata to service instances registered via catalog sync. [[GH-447](https://github.com/hashicorp/consul-k8s/pull/447)]

charts/consul/templates/api-gateway-gatewayclassconfig.yaml

@@ -28,6 +28,10 @@ spec:
     {{- else }}
       http: 8500
     {{- end }}
+  {{- with .Values.apiGateway.managedGatewayClass.deployment }}
+  deployment:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
   image:
     consulAPIGateway: {{ .Values.apiGateway.image }}
     envoy: {{ .Values.global.imageEnvoy }}

charts/consul/test/unit/api-gateway-gatewayclassconfig.bats

@@ -0,0 +1,68 @@
+#!/usr/bin/env bats
+
+load _helpers
+
+@test "apiGateway/GatewayClassConfig: disabled by default" {
+  cd `chart_dir`
+  assert_empty helm template \
+      -s templates/api-gateway-gatewayclassconfig.yaml \
+      .
+}
+
+@test "apiGateway/GatewayClassConfig: enabled with apiGateway.enabled=true" {
+  cd `chart_dir`
+  local actual=$(helm template \
+      -s templates/api-gateway-gatewayclassconfig.yaml  \
+      --set 'apiGateway.enabled=true' \
+      --set 'apiGateway.image=foo' \
+      . | tee /dev/stderr |
+      yq 'length > 0' | tee /dev/stderr)
+  [ "${actual}" = "true" ]
+}
+
+@test "apiGateway/GatewayClassConfig: deployment config disabled by default" {
+  cd `chart_dir`
+  local actual=$(helm template \
+      -s templates/api-gateway-gatewayclassconfig.yaml \
+      --set 'apiGateway.enabled=true' \
+      --set 'apiGateway.image=foo' \
+      . | tee /dev/stderr |
+      yq '.spec | has("deployment") | not' | tee /dev/stderr)
+  [ "${actual}" = "true" ]
+}
+
+@test "apiGateway/GatewayClassConfig: deployment config enabled with defaultInstances=3" {
+  cd `chart_dir`
+  local actual=$(helm template \
+      -s templates/api-gateway-gatewayclassconfig.yaml \
+      --set 'apiGateway.enabled=true' \
+      --set 'apiGateway.image=foo' \
+      --set 'apiGateway.managedGatewayClass.deployment.defaultInstances=3' \
+      . | tee /dev/stderr |
+      yq '.spec.deployment.defaultInstances == 3' | tee /dev/stderr)
+  [ "${actual}" = "true" ]
+}
+
+@test "apiGateway/GatewayClassConfig: deployment config enabled with maxInstances=3" {
+  cd `chart_dir`
+  local actual=$(helm template \
+      -s templates/api-gateway-gatewayclassconfig.yaml \
+      --set 'apiGateway.enabled=true' \
+      --set 'apiGateway.image=foo' \
+      --set 'apiGateway.managedGatewayClass.deployment.maxInstances=3' \
+      . | tee /dev/stderr |
+      yq '.spec.deployment.maxInstances == 3' | tee /dev/stderr)
+  [ "${actual}" = "true" ]
+}
+
+@test "apiGateway/GatewayClassConfig: deployment config enabled with minInstances=3" {
+  cd `chart_dir`
+  local actual=$(helm template \
+      -s templates/api-gateway-gatewayclassconfig.yaml \
+      --set 'apiGateway.enabled=true' \
+      --set 'apiGateway.image=foo' \
+      --set 'apiGateway.managedGatewayClass.deployment.minInstances=3' \
+      . | tee /dev/stderr |
+      yq '.spec.deployment.minInstances == 3' | tee /dev/stderr)
+  [ "${actual}" = "true" ]
+}

charts/consul/values.yaml

@@ -2708,6 +2708,20 @@ apiGateway:
       # @type: string
       service: null
 
+    # This value defines the number of pods to deploy for each Gateway as well as a min and max number of pods for all Gateways
+    #
+    # Example:
+    #
+    # ```yaml
+    # deployment:
+    #   defaultInstances: 3
+    #   maxInstances: 8
+    #   minInstances: 1
+    # ```
+    #
+    # @type: map
+    deployment: null
+
   # Configuration for the ServiceAccount created for the api-gateway component
   serviceAccount:
     # This value defines additional annotations for the client service account. This should be formatted as a multi-line