[Feature] [Gateway] Dynamic Configuration (#1718)

Author: ajanikow

CHANGELOG.md

@@ -26,6 +26,7 @@
 - (Feature) (Gateway) ArangoDB JWT Auth Integration
 - (Feature) Scheduler Handler
 - (Feature) (Gateway) ArangoDB Auth Token
+- (Feature) (Gateway) Dynamic Configuration
 
 ## [1.2.42](https://github.com/arangodb/kube-arangodb/tree/1.2.42) (2024-07-23)
 - (Maintenance) Go 1.22.4 & Kubernetes 1.29.6 libraries

docs/api/ArangoDeployment.V1.md

@@ -3043,6 +3043,17 @@ Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.
 
 ***
 
+### .spec.gateway.dynamic
+
+Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/deployment/v1/deployment_spec_gateway.go#L38)</sup>
+
+Dynamic setting enables/disables support dynamic configuration of the gateway in the cluster.
+When enabled, gateway config will be reloaded by ConfigMap live updates.
+
+Default Value: `false`
+
+***
+
 ### .spec.gateway.enabled
 
 Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/deployment/v1/deployment_spec_gateway.go#L33)</sup>
@@ -3056,7 +3067,7 @@ Default Value: `false`
 
 ### .spec.gateway.image
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/deployment/v1/deployment_spec_gateway.go#L37)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/deployment/v1/deployment_spec_gateway.go#L42)</sup>
 
 Image is the image to use for the gateway.
 By default, the image is determined by the operator.

pkg/apis/deployment/v1/deployment_spec_gateway.go

@@ -32,6 +32,11 @@ type DeploymentSpecGateway struct {
 	// +doc/default: false
 	Enabled *bool `json:"enabled,omitempty"`
 
+	// Dynamic setting enables/disables support dynamic configuration of the gateway in the cluster.
+	// When enabled, gateway config will be reloaded by ConfigMap live updates.
+	// +doc/default: false
+	Dynamic *bool `json:"dynamic,omitempty"`
+
 	// Image is the image to use for the gateway.
 	// By default, the image is determined by the operator.
 	Image *string `json:"image"`
@@ -49,6 +54,15 @@ func (d *DeploymentSpecGateway) IsEnabled() bool {
 	return *d.Enabled
 }
 
+// IsDynamic returns whether the gateway dynamic config is enabled.
+func (d *DeploymentSpecGateway) IsDynamic() bool {
+	if d == nil || d.Dynamic == nil {
+		return false
+	}
+
+	return *d.Dynamic
+}
+
 func (d *DeploymentSpecGateway) GetSidecar() *schedulerApi.IntegrationSidecar {
 	if d == nil || d.Sidecar == nil {
 		return nil

pkg/apis/deployment/v1/zz_generated.deepcopy.go

@@ -32,6 +32,11 @@ type DeploymentSpecGateway struct {
 	// +doc/default: false
 	Enabled *bool `json:"enabled,omitempty"`
 
+	// Dynamic setting enables/disables support dynamic configuration of the gateway in the cluster.
+	// When enabled, gateway config will be reloaded by ConfigMap live updates.
+	// +doc/default: false
+	Dynamic *bool `json:"dynamic,omitempty"`
+
 	// Image is the image to use for the gateway.
 	// By default, the image is determined by the operator.
 	Image *string `json:"image"`
@@ -49,6 +54,15 @@ func (d *DeploymentSpecGateway) IsEnabled() bool {
 	return *d.Enabled
 }
 
+// IsDynamic returns whether the gateway dynamic config is enabled.
+func (d *DeploymentSpecGateway) IsDynamic() bool {
+	if d == nil || d.Dynamic == nil {
+		return false
+	}
+
+	return *d.Dynamic
+}
+
 func (d *DeploymentSpecGateway) GetSidecar() *schedulerApi.IntegrationSidecar {
 	if d == nil || d.Sidecar == nil {
 		return nil

pkg/apis/deployment/v2alpha1/deployment_spec_gateway.go

@@ -6567,6 +6567,11 @@ v1:
           gateway:
             description: Gateway defined main Gateway configuration.
             properties:
+              dynamic:
+                description: |-
+                  Dynamic setting enables/disables support dynamic configuration of the gateway in the cluster.
+                  When enabled, gateway config will be reloaded by ConfigMap live updates.
+                type: boolean
               enabled:
                 description: |-
                   Enabled setting enables/disables support for gateway in the cluster.
@@ -23084,6 +23089,11 @@ v1alpha:
           gateway:
             description: Gateway defined main Gateway configuration.
             properties:
+              dynamic:
+                description: |-
+                  Dynamic setting enables/disables support dynamic configuration of the gateway in the cluster.
+                  When enabled, gateway config will be reloaded by ConfigMap live updates.
+                type: boolean
               enabled:
                 description: |-
                   Enabled setting enables/disables support for gateway in the cluster.

pkg/apis/deployment/v2alpha1/zz_generated.deepcopy.go

@@ -55,7 +55,26 @@ func (r *Resources) ensureGatewayConfig(ctx context.Context, cachedStatus inspec
 		return errors.WithStack(errors.Wrapf(err, "Failed to generate gateway config"))
 	}
 
-	gatewayCfgYaml, gatewayCfgChecksum, _, err := cfg.RenderYAML()
+	gatewayCfgYaml, _, _, err := cfg.RenderYAML()
+	if err != nil {
+		return errors.WithStack(errors.Wrapf(err, "Failed to render gateway config"))
+	}
+
+	gatewayCfgCDSYaml, _, _, err := cfg.RenderCDSYAML()
+	if err != nil {
+		return errors.WithStack(errors.Wrapf(err, "Failed to render gateway cds config"))
+	}
+
+	gatewayCfgLDSYaml, _, _, err := cfg.RenderLDSYAML()
+	if err != nil {
+		return errors.WithStack(errors.Wrapf(err, "Failed to render gateway lds config"))
+	}
+
+	elements, err := r.renderConfigMap(map[string]string{
+		GatewayConfigFileName:    string(gatewayCfgYaml),
+		GatewayCDSConfigFileName: string(gatewayCfgCDSYaml),
+		GatewayLDSConfigFileName: string(gatewayCfgLDSYaml),
+	})
 	if err != nil {
 		return errors.WithStack(errors.Wrapf(err, "Failed to render gateway config"))
 	}
@@ -66,10 +85,7 @@ func (r *Resources) ensureGatewayConfig(ctx context.Context, cachedStatus inspec
 			ObjectMeta: meta.ObjectMeta{
 				Name: configMapName,
 			},
-			Data: map[string]string{
-				GatewayConfigFileName:         string(gatewayCfgYaml),
-				GatewayConfigChecksumFileName: gatewayCfgChecksum,
-			},
+			Data: elements,
 		}
 
 		owner := r.context.GetAPIObject().AsOwner()
@@ -88,17 +104,14 @@ func (r *Resources) ensureGatewayConfig(ctx context.Context, cachedStatus inspec
 		return errors.Reconcile()
 	} else {
 		// CM Exists, checks checksum - if key is not in the map we return empty string
-		if existingSha, existingChecksumSha := util.SHA256FromString(cm.Data[GatewayConfigFileName]), cm.Data[GatewayConfigChecksumFileName]; existingSha != gatewayCfgChecksum || existingChecksumSha != gatewayCfgChecksum {
+		if currentSha, expectedSha := util.Optional(cm.Data, ConfigMapChecksumKey, ""), util.Optional(elements, ConfigMapChecksumKey, ""); currentSha != expectedSha || currentSha == "" {
 			// We need to do the update
 			if _, changed, err := patcher.Patcher[*core.ConfigMap](ctx, cachedStatus.ConfigMapsModInterface().V1(), cm, meta.PatchOptions{},
-				patcher.PatchConfigMapData(map[string]string{
-					GatewayConfigFileName:         string(gatewayCfgYaml),
-					GatewayConfigChecksumFileName: gatewayCfgChecksum,
-				})); err != nil {
+				patcher.PatchConfigMapData(elements)); err != nil {
 				log.Err(err).Debug("Failed to patch GatewayConfig ConfigMap")
 				return errors.WithStack(err)
 			} else if changed {
-				log.Str("service", cm.GetName()).Str("before", existingSha).Str("after", gatewayCfgChecksum).Info("Updated GatewayConfig")
+				log.Str("configmap", cm.GetName()).Str("before", currentSha).Str("after", expectedSha).Info("Updated GatewayConfig")
 			}
 		}
 	}

pkg/crd/crds/database-deployment.schema.generated.yaml

@@ -0,0 +1,50 @@
+//
+// DISCLAIMER
+//
+// Copyright 2024 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+
+package resources
+
+import (
+	"context"
+
+	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
+	"github.com/arangodb/kube-arangodb/pkg/deployment/resources/gateway"
+	inspectorInterface "github.com/arangodb/kube-arangodb/pkg/util/k8sutil/inspector"
+)
+
+func (r *Resources) ensureMemberConfigGatewayConfig(ctx context.Context, cachedStatus inspectorInterface.Inspector, member api.DeploymentStatusMemberElement) (map[string]string, error) {
+	if member.Group != api.ServerGroupGateways {
+		return nil, nil
+	}
+
+	data, _, _, err := gateway.NodeDynamicConfig("arangodb", member.Member.ID, &gateway.DynamicConfig{
+		Path: GatewayVolumeMountDir,
+		File: GatewayCDSConfigFileName,
+	}, &gateway.DynamicConfig{
+		Path: GatewayVolumeMountDir,
+		File: GatewayLDSConfigFileName,
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	return map[string]string{
+		GatewayDynamicConfigFileName: string(data),
+	}, nil
+}

pkg/deployment/resources/config_map_gateway.go

@@ -54,6 +54,9 @@ func (r *Resources) EnsureConfigMaps(ctx context.Context, cachedStatus inspector
 		if err := reconcileRequired.WithError(r.ensureGatewayConfig(ctx, cachedStatus, configMaps)); err != nil {
 			return errors.Section(err, "Gateway ConfigMap")
 		}
+		if err := reconcileRequired.WithError(r.ensureMemberConfig(ctx, cachedStatus, configMaps)); err != nil {
+			return errors.Section(err, "Member ConfigMap")
+		}
 	}
 	return reconcileRequired.Reconcile(ctx)
 }