Update ZoneSync main config,add validation, add dynamic domain

Author: AlexFenlon

internal/configs/config_params.go

@@ -90,9 +90,7 @@ type ConfigParams struct {
 	UseClusterIP                           bool
 	VariablesHashBucketSize                uint64
 	VariablesHashMaxSize                   uint64
-
-	ZoneSync     bool
-	ZoneSyncPort int
+	ZoneSync                               ZoneSync
 
 	RealIPHeader    string
 	RealIPRecursive bool
@@ -178,6 +176,13 @@ type Listener struct {
 	Protocol string
 }
 
+// ZoneSync holds zone sync values for state sharing.
+type ZoneSync struct {
+	EnableZoneSync bool
+	Port           int
+	Domain         string
+}
+
 // MGMTSecrets holds mgmt block secret names
 type MGMTSecrets struct {
 	License     string

internal/configs/configmaps.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"os"
 	"strings"
 	"time"
 
@@ -406,7 +407,14 @@ func ParseConfigMap(ctx context.Context, cfgm *v1.ConfigMap, nginxPlus bool, has
 			eventLog.Event(cfgm, v1.EventTypeWarning, invalidValueReason, err.Error())
 			configOk = false
 		} else {
-			cfgParams.ZoneSync = zoneSync
+			if nginxPlus {
+				cfgParams.ZoneSync.EnableZoneSync = zoneSync
+			} else {
+				errorText := fmt.Sprintf("ConfigMap %s/%s key %s requires NGINX Plus", cfgm.Namespace, cfgm.Name, "zone-sync")
+				nl.Warn(l, errorText)
+				eventLog.Event(cfgm, v1.EventTypeWarning, invalidValueReason, errorText)
+				configOk = false
+			}
 		}
 	}
 
@@ -416,13 +424,20 @@ func ParseConfigMap(ctx context.Context, cfgm *v1.ConfigMap, nginxPlus bool, has
 			eventLog.Event(cfgm, v1.EventTypeWarning, invalidValueReason, err.Error())
 			configOk = false
 		} else {
-			statusPortValidationError := validation.ValidatePort(zoneSyncPort)
-			if statusPortValidationError != nil {
-				nl.Error(l, statusPortValidationError)
-				eventLog.Event(cfgm, v1.EventTypeWarning, invalidValueReason, statusPortValidationError.Error())
-				configOk = false
+			if cfgParams.ZoneSync.EnableZoneSync {
+				portValidationError := validation.ValidatePort(zoneSyncPort)
+				if portValidationError != nil {
+					nl.Error(l, portValidationError)
+					eventLog.Event(cfgm, v1.EventTypeWarning, invalidValueReason, portValidationError.Error())
+					configOk = false
+				} else {
+					cfgParams.ZoneSync.Port = zoneSyncPort
+				}
 			} else {
-				cfgParams.ZoneSyncPort = zoneSyncPort
+				errorText := fmt.Sprintf("ConfigMap %s/%s key %s requires 'zone-sync' to be enabled", cfgm.Namespace, cfgm.Name, "zone-sync-port")
+				nl.Warn(l, errorText)
+				eventLog.Event(cfgm, v1.EventTypeWarning, invalidValueReason, errorText)
+				configOk = false
 			}
 		}
 	}
@@ -805,9 +820,11 @@ func GenerateNginxMainConfig(staticCfgParams *StaticConfigParams, config *Config
 		}
 	}
 
-	var zoneSyncConfig version1.ZoneSyncConfig = version1.ZoneSyncConfig{
-		ZoneSync:     config.ZoneSync,
-		ZoneSyncPort: config.ZoneSyncPort,
+	podNamespace := os.Getenv("POD_NAMESPACE")
+	zoneSyncConfig := version1.ZoneSyncConfig{
+		EnableZoneSync: config.ZoneSync.EnableZoneSync,
+		Port:           config.ZoneSync.Port,
+		Domain:         fmt.Sprintf("%s-headless.%s.svc.cluster.local", podNamespace, podNamespace),
 	}
 
 	nginxCfg := &version1.MainConfig{

internal/configs/configmaps_test.go

@@ -2,8 +2,12 @@ package configs
 
 import (
 	"context"
+	"fmt"
+	"os"
 	"testing"
 
+	"github.com/nginx/kubernetes-ingress/internal/configs/version1"
+
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/client-go/tools/record"
 )
@@ -792,7 +796,7 @@ func TestParseZoneSync(t *testing.T) {
 	t.Parallel()
 	tests := []struct {
 		configMap *v1.ConfigMap
-		want      *ConfigParams
+		want      *ZoneSync
 		msg       string
 	}{
 		{
@@ -801,8 +805,8 @@ func TestParseZoneSync(t *testing.T) {
 					"zone-sync": "true",
 				},
 			},
-			want: &ConfigParams{
-				ZoneSync: true,
+			want: &ZoneSync{
+				EnableZoneSync: true,
 			},
 			msg: "zone-sync set to true",
 		},
@@ -812,8 +816,8 @@ func TestParseZoneSync(t *testing.T) {
 					"zone-sync": "false",
 				},
 			},
-			want: &ConfigParams{
-				ZoneSync: false,
+			want: &ZoneSync{
+				EnableZoneSync: false,
 			},
 			msg: "zone-sync set to false",
 		},
@@ -822,8 +826,8 @@ func TestParseZoneSync(t *testing.T) {
 	for _, test := range tests {
 		t.Run(test.msg, func(t *testing.T) {
 			result, _ := ParseConfigMap(context.Background(), test.configMap, true, false, false, false, makeEventLogger())
-			if result.ZoneSync != test.want.ZoneSync {
-				t.Errorf("ZoneSync: want %v, got %v", test.want.ZoneSync, result.ZoneSync)
+			if result.ZoneSync.EnableZoneSync != test.want.EnableZoneSync {
+				t.Errorf("EnableZoneSync: want %v, got %v", test.want.EnableZoneSync, result.ZoneSync)
 			}
 		})
 	}
@@ -833,7 +837,7 @@ func TestParseZoneSyncPort(t *testing.T) {
 	t.Parallel()
 	tests := []struct {
 		configMap *v1.ConfigMap
-		want      *ConfigParams
+		want      *ZoneSync
 		msg       string
 	}{
 		{
@@ -842,8 +846,8 @@ func TestParseZoneSyncPort(t *testing.T) {
 					"zone-sync-port": "1234",
 				},
 			},
-			want: &ConfigParams{
-				ZoneSyncPort: 1234,
+			want: &ZoneSync{
+				Port: 1234,
 			},
 			msg: "zone-sync-port set to 1234",
 		},
@@ -857,8 +861,8 @@ func TestParseZoneSyncPort(t *testing.T) {
 	for _, test := range tests {
 		t.Run(test.msg, func(t *testing.T) {
 			result, _ := ParseConfigMap(context.Background(), test.configMap, nginxPlus, hasAppProtect, hasAppProtectDos, hasTLSPassthrough, makeEventLogger())
-			if result.ZoneSyncPort != test.want.ZoneSyncPort {
-				t.Errorf("ZoneSyncPort: want %v, got %v", test.want.ZoneSyncPort, result.ZoneSyncPort)
+			if result.ZoneSync.Port != test.want.Port {
+				t.Errorf("Port: want %v, got %v", test.want.Port, result.ZoneSync.EnableZoneSync)
 			}
 		})
 	}
@@ -933,6 +937,42 @@ func TestParseZoneSyncPortErrors(t *testing.T) {
 	}
 }
 
+func TestMultipleNamespaces(t *testing.T) {
+	testCases := []struct {
+		name      string
+		namespace string
+		want      string
+	}{
+		{
+			name:      "nginx-ingress",
+			namespace: "nginx-ingress",
+			want:      "nginx-ingress-headless.nginx-ingress.svc.cluster.local",
+		},
+		{
+			name:      "my-release-nginx-ingress",
+			namespace: "my-release-nginx-ingress",
+			want:      "my-release-nginx-ingress-headless.my-release-nginx-ingress.svc.cluster.local",
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			_ = os.Setenv("POD_NAMESPACE", tc.namespace)
+
+			zoneSyncConfig := version1.ZoneSyncConfig{
+				EnableZoneSync: true,
+				Domain: fmt.Sprintf("%s-headless.%s.svc.cluster.local",
+					os.Getenv("POD_NAMESPACE"),
+					os.Getenv("POD_NAMESPACE")),
+			}
+
+			if zoneSyncConfig.Domain != tc.want {
+				t.Errorf("want %q, got %q", tc.want, zoneSyncConfig.Domain)
+			}
+		})
+	}
+}
+
 func makeEventLogger() record.EventRecorder {
 	return record.NewFakeRecorder(1024)
 }

internal/configs/version1/config.go

@@ -191,8 +191,9 @@ type Location struct {
 
 // ZoneSyncConfig is tbe configuration for the zone_sync directives for state sharing.
 type ZoneSyncConfig struct {
-	ZoneSync     bool
-	ZoneSyncPort int
+	EnableZoneSync bool
+	Port           int
+	Domain         string
 }
 
 // MGMTConfig is tbe configuration for the MGMT block.