fix: rename listener using its protocol and port

.github/workflows/build_and_test.yaml

@@ -102,6 +102,12 @@ jobs:
         - version: v1.33.1
           ipFamily: dual  # only run dual test on latest version to save time
           profile: gateway-namespace-mode
+        - version: v1.33.1
+          ipFamily: ipv4
+          profile: port-as-listener-name
+        - version: v1.32.5
+          ipFamily: ipv6
+          profile: port-as-listener-name
     steps:
     - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
     - uses: ./tools/github-actions/setup-deps
@@ -149,6 +155,12 @@ jobs:
         - version: v1.33.1
           ipFamily: dual  # only run dual test on latest version to save time
           profile: gateway-namespace-mode
+        - version: v1.33.1
+          ipFamily: ipv4
+          profile: port-as-listener-name
+        - version: v1.32.5
+          ipFamily: ipv6
+          profile: port-as-listener-name
     steps:
     - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
     - uses: ./tools/github-actions/setup-deps

api/v1alpha1/envoygateway_helpers.go

@@ -109,6 +109,32 @@ func (e *EnvoyGateway) GatewayNamespaceMode() bool {
 		*e.Provider.Kubernetes.Deploy.Type == KubernetesDeployModeTypeGatewayNamespace
 }
 
+// defaultRuntimeFlags are the default runtime flags for Envoy Gateway.
+var defaultRuntimeFlags = map[RuntimeFlag]bool{
+	UseProtocolPortAsListenerName: false,
+}
+
+// IsEnabled checks if a runtime flag is enabled in the EnvoyGateway configuration.
+func (f *RuntimeFlags) IsEnabled(flag RuntimeFlag) bool {
+	if f != nil {
+		for _, disable := range f.Disabled {
+			if disable == flag {
+				return false
+			}
+		}
+		for _, enable := range f.Enabled {
+			if enable == flag {
+				return true
+			}
+		}
+	}
+
+	if defaultValue, found := defaultRuntimeFlags[flag]; found {
+		return defaultValue
+	}
+	return false
+}
+
 // DefaultLeaderElection returns a new LeaderElection with default configuration parameters.
 func DefaultLeaderElection() *LeaderElection {
 	return &LeaderElection{

api/v1alpha1/envoygateway_types.go

@@ -101,11 +101,13 @@ type EnvoyGatewaySpec struct {
 
 // RuntimeFlag defines a runtime flag used to guard breaking changes or risky experimental features in new Envoy Gateway releases.
 // A runtime flag may be enabled or disabled by default and can be toggled through the EnvoyGateway resource.
+// +enum
+// +kubebuilder:validation:Enum=UseProtocolPortAsListenerName
 type RuntimeFlag string
 
 const (
-	// UseAddressAsListenerName indicates that the listener name should be derived from the address and port.
-	UseAddressAsListenerName RuntimeFlag = "UseAddressAsListenerName"
+	// UseProtocolPortAsListenerName indicates that the listener name should be derived from the protocol and port.
+	UseProtocolPortAsListenerName RuntimeFlag = "UseProtocolPortAsListenerName"
 )
 
 // RuntimeFlags provide a mechanism to guard breaking changes or risky experimental features in new Envoy Gateway releases.

internal/cmd/egctl/testdata/translate/out/default-resources.all.yaml

@@ -1126,6 +1126,14 @@ xds:
                   useRemoteAddress: true
               name: default/eg/http
             maxConnectionsToAcceptPerSocketEvent: 1
+            metadata:
+              filterMetadata:
+                envoy-gateway:
+                  resources:
+                  - kind: Gateway
+                    name: eg
+                    namespace: default
+                    sectionName: http
             name: default/eg/http
             perConnectionBufferLimitBytes: 32768
       - activeState:
@@ -1238,6 +1246,14 @@ xds:
                   useRemoteAddress: true
               name: default/eg/grpc
             maxConnectionsToAcceptPerSocketEvent: 1
+            metadata:
+              filterMetadata:
+                envoy-gateway:
+                  resources:
+                  - kind: Gateway
+                    name: eg
+                    namespace: default
+                    sectionName: grpc
             name: default/eg/grpc
             perConnectionBufferLimitBytes: 32768
       - activeState:

internal/cmd/egctl/testdata/translate/out/from-gateway-api-to-xds.all.json

@@ -978,6 +978,20 @@
                     "name": "default/eg/http"
                   },
                   "maxConnectionsToAcceptPerSocketEvent": 1,
+                  "metadata": {
+                    "filterMetadata": {
+                      "envoy-gateway": {
+                        "resources": [
+                          {
+                            "kind": "Gateway",
+                            "name": "eg",
+                            "namespace": "default",
+                            "sectionName": "http"
+                          }
+                        ]
+                      }
+                    }
+                  },
                   "name": "default/eg/http",
                   "perConnectionBufferLimitBytes": 32768
                 }
@@ -1130,6 +1144,20 @@
                     "name": "default/eg/grpc"
                   },
                   "maxConnectionsToAcceptPerSocketEvent": 1,
+                  "metadata": {
+                    "filterMetadata": {
+                      "envoy-gateway": {
+                        "resources": [
+                          {
+                            "kind": "Gateway",
+                            "name": "eg",
+                            "namespace": "default",
+                            "sectionName": "grpc"
+                          }
+                        ]
+                      }
+                    }
+                  },
                   "name": "default/eg/grpc",
                   "perConnectionBufferLimitBytes": 32768
                 }

internal/cmd/egctl/testdata/translate/out/from-gateway-api-to-xds.all.yaml

@@ -579,6 +579,14 @@ xds:
                   useRemoteAddress: true
               name: default/eg/http
             maxConnectionsToAcceptPerSocketEvent: 1
+            metadata:
+              filterMetadata:
+                envoy-gateway:
+                  resources:
+                  - kind: Gateway
+                    name: eg
+                    namespace: default
+                    sectionName: http
             name: default/eg/http
             perConnectionBufferLimitBytes: 32768
       - activeState:
@@ -691,6 +699,14 @@ xds:
                   useRemoteAddress: true
               name: default/eg/grpc
             maxConnectionsToAcceptPerSocketEvent: 1
+            metadata:
+              filterMetadata:
+                envoy-gateway:
+                  resources:
+                  - kind: Gateway
+                    name: eg
+                    namespace: default
+                    sectionName: grpc
             name: default/eg/grpc
             perConnectionBufferLimitBytes: 32768
       - activeState:

internal/cmd/egctl/testdata/translate/out/from-gateway-api-to-xds.listener.yaml

@@ -143,6 +143,14 @@ xds:
                 useRemoteAddress: true
             name: default/eg/http
           maxConnectionsToAcceptPerSocketEvent: 1
+          metadata:
+            filterMetadata:
+              envoy-gateway:
+                resources:
+                - kind: Gateway
+                  name: eg
+                  namespace: default
+                  sectionName: http
           name: default/eg/http
           perConnectionBufferLimitBytes: 32768
     - activeState:
@@ -255,6 +263,14 @@ xds:
                 useRemoteAddress: true
             name: default/eg/grpc
           maxConnectionsToAcceptPerSocketEvent: 1
+          metadata:
+            filterMetadata:
+              envoy-gateway:
+                resources:
+                - kind: Gateway
+                  name: eg
+                  namespace: default
+                  sectionName: grpc
           name: default/eg/grpc
           perConnectionBufferLimitBytes: 32768
     - activeState:

internal/cmd/egctl/testdata/translate/out/jwt-single-route-single-match-to-xds.all.json

@@ -689,6 +689,20 @@
                     "name": "envoy-gateway-system/eg/http"
                   },
                   "maxConnectionsToAcceptPerSocketEvent": 1,
+                  "metadata": {
+                    "filterMetadata": {
+                      "envoy-gateway": {
+                        "resources": [
+                          {
+                            "kind": "Gateway",
+                            "name": "eg",
+                            "namespace": "envoy-gateway-system",
+                            "sectionName": "http"
+                          }
+                        ]
+                      }
+                    }
+                  },
                   "name": "envoy-gateway-system/eg/http",
                   "perConnectionBufferLimitBytes": 32768
                 }

internal/cmd/egctl/testdata/translate/out/jwt-single-route-single-match-to-xds.all.yaml

@@ -417,6 +417,14 @@ xds:
                   useRemoteAddress: true
               name: envoy-gateway-system/eg/http
             maxConnectionsToAcceptPerSocketEvent: 1
+            metadata:
+              filterMetadata:
+                envoy-gateway:
+                  resources:
+                  - kind: Gateway
+                    name: eg
+                    namespace: envoy-gateway-system
+                    sectionName: http
             name: envoy-gateway-system/eg/http
             perConnectionBufferLimitBytes: 32768
     - '@type': type.googleapis.com/envoy.admin.v3.RoutesConfigDump

internal/cmd/egctl/testdata/translate/out/jwt-single-route-single-match-to-xds.listener.yaml

@@ -163,5 +163,13 @@ xds:
                 useRemoteAddress: true
             name: envoy-gateway-system/eg/http
           maxConnectionsToAcceptPerSocketEvent: 1
+          metadata:
+            filterMetadata:
+              envoy-gateway:
+                resources:
+                - kind: Gateway
+                  name: eg
+                  namespace: envoy-gateway-system
+                  sectionName: http
           name: envoy-gateway-system/eg/http
           perConnectionBufferLimitBytes: 32768

internal/cmd/egctl/testdata/translate/out/no-service-cluster-ip.all.yaml

@@ -352,6 +352,14 @@ xds:
                   useRemoteAddress: true
               name: envoy-gateway-system/eg/http
             maxConnectionsToAcceptPerSocketEvent: 1
+            metadata:
+              filterMetadata:
+                envoy-gateway:
+                  resources:
+                  - kind: Gateway
+                    name: eg
+                    namespace: envoy-gateway-system
+                    sectionName: http
             name: envoy-gateway-system/eg/http
             perConnectionBufferLimitBytes: 32768
     - '@type': type.googleapis.com/envoy.admin.v3.RoutesConfigDump

internal/cmd/egctl/testdata/translate/out/quickstart.all.yaml

@@ -109,6 +109,7 @@ xdsIR:
       - path: /dev/stdout
     http:
     - address: 0.0.0.0
+      externalPort: 80
       hostnames:
       - '*'
       isHTTP2: false

internal/gatewayapi/listener.go

@@ -119,11 +119,12 @@ func (t *Translator) ProcessListeners(gateways []*GatewayContext, xdsIR resource
 			case gwapiv1.HTTPProtocolType, gwapiv1.HTTPSProtocolType:
 				irListener := &ir.HTTPListener{
 					CoreListenerDetails: ir.CoreListenerDetails{
-						Name:     irListenerName(listener),
-						Address:  address,
-						Port:     uint32(containerPort),
-						Metadata: buildListenerMetadata(listener, gateway),
-						IPFamily: ipFamily,
+						Name:         irListenerName(listener),
+						Address:      address,
+						Port:         uint32(containerPort),
+						ExternalPort: uint32(listener.Port),
+						Metadata:     buildListenerMetadata(listener, gateway),
+						IPFamily:     ipFamily,
 					},
 					TLS: irTLSConfigs(listener.tlsSecrets...),
 					Path: ir.PathSettings{
@@ -146,10 +147,11 @@ func (t *Translator) ProcessListeners(gateways []*GatewayContext, xdsIR resource
 			case gwapiv1.TCPProtocolType, gwapiv1.TLSProtocolType:
 				irListener := &ir.TCPListener{
 					CoreListenerDetails: ir.CoreListenerDetails{
-						Name:     irListenerName(listener),
-						Address:  address,
-						Port:     uint32(containerPort),
-						IPFamily: ipFamily,
+						Name:         irListenerName(listener),
+						Address:      address,
+						Port:         uint32(containerPort),
+						ExternalPort: uint32(listener.Port),
+						IPFamily:     ipFamily,
 					},
 
 					// Gateway is processed firstly, then ClientTrafficPolicy, then xRoute.
@@ -162,9 +164,10 @@ func (t *Translator) ProcessListeners(gateways []*GatewayContext, xdsIR resource
 			case gwapiv1.UDPProtocolType:
 				irListener := &ir.UDPListener{
 					CoreListenerDetails: ir.CoreListenerDetails{
-						Name:    irListenerName(listener),
-						Address: address,
-						Port:    uint32(containerPort),
+						Name:         irListenerName(listener),
+						Address:      address,
+						Port:         uint32(containerPort),
+						ExternalPort: uint32(listener.Port),
 					},
 				}
 				xdsIR[irKey].UDP = append(xdsIR[irKey].UDP, irListener)

internal/gatewayapi/testdata/accesslog-als-backend.out.yaml

@@ -200,6 +200,7 @@ xdsIR:
           [%START_TIME%] "%REQ(:METHOD)% %PROTOCOL%" %RESPONSE_CODE% %RESPONSE_FLAGS% %BYTES_RECEIVED% %BYTES_SENT% %DURATION% %RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)% "%REQ(X-FORWARDED-FOR)%" "%REQ(USER-AGENT)%" "%REQ(X-REQUEST-ID)%" "%REQ(:AUTHORITY)%" "%UPSTREAM_HOST%"\n
     http:
     - address: 0.0.0.0
+      externalPort: 80
       hostnames:
       - '*'
       isHTTP2: false

internal/gatewayapi/testdata/accesslog-als-grpc.out.yaml

@@ -102,6 +102,7 @@ xdsIR:
         type: HTTP
     http:
     - address: 0.0.0.0
+      externalPort: 80
       hostnames:
       - '*'
       isHTTP2: false

internal/gatewayapi/testdata/accesslog.out.yaml

@@ -126,6 +126,7 @@ xdsIR:
       - path: /dev/stdout
     http:
     - address: 0.0.0.0
+      externalPort: 80
       hostnames:
       - '*'
       isHTTP2: false

internal/gatewayapi/testdata/backend-invalid-feature-disabled.out.yaml

@@ -158,6 +158,7 @@ xdsIR:
       - path: /dev/stdout
     http:
     - address: 0.0.0.0
+      externalPort: 80
       hostnames:
       - '*'
       isHTTP2: false

internal/gatewayapi/testdata/backend-with-endpoint-zones.out.yaml

@@ -144,6 +144,7 @@ xdsIR:
       - path: /dev/stdout
     http:
     - address: 0.0.0.0
+      externalPort: 80
       hostnames:
       - '*'
       isHTTP2: false

internal/gatewayapi/testdata/backend-with-fallback.out.yaml

@@ -143,6 +143,7 @@ xdsIR:
       - path: /dev/stdout
     http:
     - address: 0.0.0.0
+      externalPort: 80
       hostnames:
       - '*'
       isHTTP2: false

internal/gatewayapi/testdata/backend-with-hostname.out.yaml

@@ -145,6 +145,7 @@ xdsIR:
       - path: /dev/stdout
     http:
     - address: 0.0.0.0
+      externalPort: 80
       hostnames:
       - '*'
       isHTTP2: false

internal/gatewayapi/testdata/backend-with-skip-tls-verify.out.yaml

@@ -159,6 +159,7 @@ xdsIR:
       - path: /dev/stdout
     http:
     - address: 0.0.0.0
+      externalPort: 80
       hostnames:
       - '*'
       isHTTP2: false

internal/gatewayapi/testdata/backendtlspolicy-across-ns.out.yaml

@@ -127,6 +127,7 @@ xdsIR:
       - path: /dev/stdout
     http:
     - address: 0.0.0.0
+      externalPort: 80
       hostnames:
       - '*'
       isHTTP2: false