Add support for GEP-1713: ListenerSets #11255

davidjumani · 2025-05-20T14:03:45Z

Description

Adds support for ListenerSets laid out in https://gateway-api.sigs.k8s.io/geps/gep-1713.

This works around the restriction of a maximum of 64 listeners defined on a gateway. Users can now define multiple listenersets and map them to the appropriate parent gateway

Fixes #10662

This PR also adds policy support for listener sets

Added tests for the same

--- PASS: TestListenerSet (61.70s)
    --- PASS: TestListenerSet/ListenerSet (46.42s)
        --- PASS: TestListenerSet/ListenerSet/TestInvalidListenerSetNonExistingGW (3.48s)
        --- PASS: TestListenerSet/ListenerSet/TestInvalidListenerSetNotAllowed (5.46s)
        --- PASS: TestListenerSet/ListenerSet/TestPolicies (11.37s)
        --- PASS: TestListenerSet/ListenerSet/TestValidListenerSet (13.49s)

Change Type

/kind new_feature

Changelog

Allows a Kubernetes gateway to have more than 64 listeners by implementing ListenerSets defined in https://gateway-api.sigs.k8s.io/geps/gep-1713. Listener Sets can define their own listeners and be mapped to a parent gateway via their parentRef. The Kubernetes gateway will have the merged list of all listeners from itself and attached ListenerSets. This experimental feature requires the `xlistenersets.gateway.networking.x-k8s.io` CRD to be present.

internal/kgateway/controller/controller.go

davidjumani · 2025-05-22T23:43:40Z

internal/kgateway/controller/controller.go

 	)

+	// Trigger an event when the gateway changes. This can even be a change in listener sets attached to the gateway
+	go func() {


Does this need to be in a goroutine ?

No, will create a goroutine under the hood

i think we need to call Register only after krt has started. @stevenctl do you know if that issue was fixed?

Ah, it's letting me respond here. For posterity: I believe the only issue is if we need the initial state, and luckily in this case we do not.

Signed-off-by: David Jumani <[email protected]>

davidjumani · 2025-05-23T14:53:52Z

pkg/pluginsdk/reporter/types.go

+type ListenerSetReporter interface {
+	Listener(listener *gwv1.Listener) ListenerReporter
+	ListenerName(listenerName string) ListenerReporter
+	SetCondition(condition GatewayCondition)
+}


Decided to keep this the same as the GatewayReporter since they are pretty much the same thing. This avoids too many changes in the code, especially around status reporting

stevenctl · 2025-05-23T17:04:43Z

internal/kgateway/deployer/deployer.go

+		Name:      gw.GetName(),
+		Namespace: gw.GetNamespace(),
+	}
+	irGW := d.inputs.CommonCollections.GatewayIndex.Gateways.GetKey(gwKey.ResourceName())


it might be possible that we miss the krt lookup and only have the api.Gateway here if we hit this path before translation finishes; we're guaranteed to eventually get it though

i think this should work because the controller should start only after krt is warm, IIRC.

I added the WaitUntilSynced above in an attempt to fix that

internal/kgateway/krtcollections/policy.go

stevenctl · 2025-05-23T17:25:49Z

internal/kgateway/krtcollections/policy.go

 	return h
 }

+func allowedListenerSet(gw *gwv1.Gateway, listenerSet *gwxv1a1.XListenerSet, namespaces krt.Collection[NamespaceMetadata]) (func(krt.HandlerContext, string) bool, error) {


style nit: alias the returned func or give it's args names

Good idea, added!

stevenctl · 2025-05-23T17:35:58Z

internal/kgateway/translator/gateway/gateway_translator_test.go

 			Name:      "example-gateway",
 		},
 	}),
+	// TODO: Add this once istio adds support for listener sets


we should eventually make our test translator handle getting istio-unknown types into krt clients so we can test for our own CRs too..

Signed-off-by: David Jumani <[email protected]>

yuval-k · 2025-05-20T14:18:26Z

internal/kgateway/controller/controller.go

 	})
 }

+func ResolveNamespace(namespace *apiv1.Namespace) string {


why is this exported?

Forgot to remove it in the cleanup. Fixed

yuval-k · 2025-05-23T18:03:26Z

internal/kgateway/deployer/deployer.go

+		Name:      gw.GetName(),
+		Namespace: gw.GetNamespace(),
+	}
+	irGW := d.inputs.CommonCollections.GatewayIndex.Gateways.GetKey(gwKey.ResourceName())


i think this should work because the controller should start only after krt is warm, IIRC.

internal/kgateway/deployer/deployer.go

yuval-k · 2025-05-23T18:04:47Z

internal/kgateway/controller/controller.go

 	)

+	// Trigger an event when the gateway changes. This can even be a change in listener sets attached to the gateway
+	go func() {


i think we need to call Register only after krt has started. @stevenctl do you know if that issue was fixed?

Signed-off-by: David Jumani <[email protected]>

yuval-k · 2025-05-28T14:06:50Z

internal/kgateway/controller/controller.go

+	// Trigger an event when the gateway changes. This can even be a change in listener sets attached to the gateway
+	c.cfg.CommonCollections.GatewayIndex.Gateways.Register(func(o krt.Event[ir.Gateway]) {
+		gw := o.Latest()
+		c.reconciler.customEvents <- event.TypedGenericEvent[ir.Gateway]{


consider adding select with default clause; so if the channel is full it won't get stuck.
i think the channel would then just need capacity of 1

Would that lead to missed events when a gateway is modified ?

KRT handles a slow/blocking callback internally; it won't make other Register/dependent collections get stuck.
While we can do something like go func() { events <- ev }() here, I think the current code is fine.

Signed-off-by: David Jumani <[email protected]>

lgadban · 2025-05-29T03:58:19Z

internal/kgateway/krtcollections/policy.go

+			listenerSetPolicies := h.policies.getTargetingPolicies(kctx, extensionsplug.GatewayAttachmentPoint, lsIR.ObjectSource, "", ls.GetLabels())
+
+			for _, l := range ls.Spec.Listeners {
+				listenerSpecificPolicies := h.policies.getTargetingPolicies(kctx, extensionsplug.RouteAttachmentPoint, lsIR.ObjectSource, string(l.Name), ls.GetLabels())


why are we getting route attached policies here?

This is similar to fetching policies for listeners in the gateway
Ref:

kgateway/internal/kgateway/krtcollections/policy.go

Line 290 in 56d7672

AttachedPolicies: toAttachedPolicies(h.policies.getTargetingPolicies(kctx, extensionsplug.RouteAttachmentPoint, out.ObjectSource, string(l.Name), i.GetLabels())),

Signed-off-by: David Jumani <[email protected]>

github-actions bot added do-not-merge/kind-invalid Indicates a PR lacks a `kind/foo` label and requires one. do-not-merge/release-note-invalid Indicates that a PR should not merge because it's missing one of the release note labels. labels May 20, 2025

yuval-k reviewed May 20, 2025

View reviewed changes

internal/kgateway/controller/controller.go Outdated Show resolved Hide resolved

davidjumani force-pushed the listner-sets branch from 3df7a6e to 4d3721e Compare May 20, 2025 15:26

davidjumani commented May 22, 2025

View reviewed changes

davidjumani force-pushed the listner-sets branch from 709fdc0 to c3e0f12 Compare May 23, 2025 00:05

add support for listener sets

018d2bb

Signed-off-by: David Jumani <[email protected]>

davidjumani force-pushed the listner-sets branch from c3e0f12 to 018d2bb Compare May 23, 2025 00:08

davidjumani changed the title ~~[WIP] Add support for GEP-1713: ListenerSets~~ Add support for GEP-1713: ListenerSets May 23, 2025

yuval-k self-assigned this May 23, 2025

davidjumani commented May 23, 2025

View reviewed changes

stevenctl reviewed May 23, 2025

View reviewed changes

internal/kgateway/krtcollections/policy.go Outdated Show resolved Hide resolved

stevenctl reviewed May 23, 2025

View reviewed changes

add support for policies

d65d2a7

Signed-off-by: David Jumani <[email protected]>

yuval-k reviewed May 23, 2025

View reviewed changes

davidjumani added 8 commits May 23, 2025 14:57

fix policies and add tets

a7d9548

Signed-off-by: David Jumani <[email protected]>

Merge branch 'main' into listner-sets

775cb44

add more policy tests

01bfabc

Signed-off-by: David Jumani <[email protected]>

address review comments

28d9c30

Signed-off-by: David Jumani <[email protected]>

address another comment

f5e6882

Signed-off-by: David Jumani <[email protected]>

cleanup

45edcd2

Signed-off-by: David Jumani <[email protected]>

Merge branch 'main' into listner-sets

1c8614a

fix tests

cf790b0

Signed-off-by: David Jumani <[email protected]>

yuval-k reviewed May 28, 2025

View reviewed changes

Merge branch 'main' into listner-sets

850c0db

stevenctl approved these changes May 28, 2025

View reviewed changes

davidjumani added 4 commits May 28, 2025 17:58

fix failing test

ece9191

Signed-off-by: David Jumani <[email protected]>

Merge branch 'main' into listner-sets

121c60d

update golden yamls

a3a347b

Signed-off-by: David Jumani <[email protected]>

Merge remote-tracking branch 'origin/main' into listner-sets

5841877

Signed-off-by: David Jumani <[email protected]>

lgadban reviewed May 29, 2025

View reviewed changes

davidjumani added 2 commits May 29, 2025 11:33

fix yamls

d4993df

Signed-off-by: David Jumani <[email protected]>

Merge branch 'main' into listner-sets

1885340

stevenctl approved these changes May 29, 2025

View reviewed changes

stevenctl added this pull request to the merge queue May 29, 2025

Merged via the queue into kgateway-dev:main with commit 3913ba2 May 29, 2025
20 checks passed

yuval-k pushed a commit that referenced this pull request May 29, 2025

Add support for GEP-1713: ListenerSets (#11255)

57a48ac

Signed-off-by: David Jumani <[email protected]>

lgadban mentioned this pull request Jul 25, 2025

Review AttachmentPoints=RouteAttachmentPoint for listener policies #11775

Closed

puertomontt mentioned this pull request Dec 15, 2025

Data Plane Deployment Fails With Long Listener Name #11926

Closed

Add support for GEP-1713: ListenerSets #11255

Add support for GEP-1713: ListenerSets #11255

Uh oh!

Conversation

davidjumani commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Change Type

Changelog

Uh oh!

Uh oh!

davidjumani May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

davidjumani May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

davidjumani commented May 20, 2025 •

edited

Loading

davidjumani May 22, 2025 •

edited

Loading

davidjumani May 28, 2025 •

edited

Loading