feature: implement the ListenerSets experimental API by zhaohuabing · Pull Request #7998 · envoyproxy/gateway

zhaohuabing · 2026-01-20T12:17:29Z

This PR implements the experimental XListenerSet API, as proposed in GEP-1713, allowing listeners to be defined in a separate resource and attached to a Gateway. This feature is enabled via the XListenerSet feature flag in the EnvoyGateway configuration.

Changes

New controller logic is added to watch and process XListenerSet resources.
XListenerSet resources are attached to a parent Gateway, and their listeners are processed and merged with the Gateway's own listeners.
The status of the XListenerSet and its listeners is updated to reflect whether they have been accepted and programmed.
RBAC: New RBAC permissions for xlistenersets and xlistenersets/status have been added to the Helm charts and config/rbac/role.yaml.
Testing: Unit tests and End-to-end tests have been added to validate XListenerSet functionality for HTTPRoute(HTTP and HTTPS), gRPCRoute, TLSRoute, TCPRoute and UDPRoute.

TODOs

Support XListenerSet as TargetRef for xPolicies.
Add attached XListenerSets to the Gateway status - depend on the next Gateway API release.

To keep this PR focused, these TODOs will be tracked in separate issues and implemented in follow-up PRs.

implement: #5323
release note: yes

netlify · 2026-01-20T12:17:38Z

✅ Deploy Preview for cerulean-figolla-1f9435 ready!

Name	Link
🔨 Latest commit	`3fe28d7`
🔍 Latest deploy log	https://app.netlify.com/projects/cerulean-figolla-1f9435/deploys/697aa091b53b6f0008ec57b8
😎 Deploy Preview	https://deploy-preview-7998--cerulean-figolla-1f9435.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

codecov · 2026-01-20T12:27:28Z

Codecov Report

❌ Patch coverage is 58.16464% with 310 lines in your changes missing coverage. Please review.
✅ Project coverage is 73.69%. Comparing base (8452270) to head (3fe28d7).
⚠️ Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
internal/provider/kubernetes/routes.go	42.08%	118 Missing and 32 partials ⚠️
internal/provider/kubernetes/controller.go	40.25%	39 Missing and 7 partials ⚠️
internal/provider/kubernetes/indexers.go	51.13%	34 Missing and 9 partials ⚠️
internal/gatewayapi/xlistenerset.go	81.73%	16 Missing and 5 partials ⚠️
internal/provider/kubernetes/status.go	19.23%	20 Missing and 1 partial ⚠️
internal/gatewayapi/runner/runner.go	5.55%	14 Missing and 3 partials ⚠️
internal/gatewayapi/resource/resource.go	14.28%	5 Missing and 1 partial ⚠️
internal/gatewayapi/validate.go	88.46%	3 Missing ⚠️
api/v1alpha1/envoygateway_helpers.go	0.00%	1 Missing ⚠️
internal/gatewayapi/helpers.go	96.77%	1 Missing ⚠️
... and 1 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7998      +/-   ##
==========================================
- Coverage   73.84%   73.69%   -0.15%     
==========================================
  Files         237      239       +2     
  Lines       35847    36311     +464     
==========================================
+ Hits        26471    26760     +289     
- Misses       7512     7660     +148     
- Partials     1864     1891      +27

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

internal/gatewayapi/xlistenerset.go

jukie · 2026-01-22T15:55:00Z

Support XListenerSet as TargetRef for xPolicies.
Support XListenerSet as ParentRef for TCPRoute, TLSRoute, and UDPRoute.

Should we include extra status handling to communicate lack of support for these?

Edit: SupportedKinds is probably good enough

zhaohuabing · 2026-01-23T07:14:05Z

Support XListenerSet as TargetRef for xPolicies.
Support XListenerSet as ParentRef for TCPRoute, TLSRoute, and UDPRoute.

Should we include extra status handling to communicate lack of support for these?

Edit: SupportedKinds is probably good enough

Added support to all the other route types in this PR.

internal/gatewayapi/runner/runner.go

arkodg · 2026-01-24T17:30:31Z

internal/provider/kubernetes/controller.go

+
+		// Drop Status to reduce memory
+		xls.Status = gwapixv1a1.ListenerSetStatus{}
+		resourceMap.allAssociatedNamespaces.Insert(xls.Namespace)


we should insert in the resoureTree only when it doesnt exist in the resourceMap, this is what we've done for other resources afaik

It returns early at line 1879 to avoid unnecessary processing.

line 1879

if resourceMap.allAssociatedXListenerSets.Has(key) { continue } for _, listener := range xls.Spec.Listeners { ....

release-notes/current.yaml

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

arkodg

LGTM thanks

jukie · 2026-01-28T12:40:14Z

/retest

kkk777-7 · 2026-01-28T17:29:40Z

LGTM, thanks Great work!

jukie · 2026-01-28T19:35:53Z

Can we make the e2e's more reliable?

jukie · 2026-01-28T19:35:58Z

/retest

jukie

LGTM thanks, we can improve the E2Es before full release

* implement XListenerSet Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * add e2e test Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * update status Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * add debug info Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * fix routes Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * fix lint Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * support GRPCRoute Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * add https test Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * fix https test Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * fix test Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * update provider Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * update e2e Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * update gateway api translator Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * simplify status udpate Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * update xlistenerset status Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * update release note Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * remove debugging log Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * rename API Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * add gateway api test for UDPRoute, TCPRoute, and TLSRoute Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * feat(kubernetes): add XListenerSet support for TCPRoute, TLSRoute, and UDPRoute fix lint Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> fix test Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> add TCPRoute test Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * add udp test Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * polish code Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * fix lint Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * add tls test Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * add debug info Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * add debug info Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * add debug info Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * fix test Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * fix tls route Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * remove debugging log Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * fixt test Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * fix gateway name extraction logic Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * add test for no matching section Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * fix test Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * address comments Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> * fix gen Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> --------- Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> Signed-off-by: Sadmi Bouhafs <sadmibouhafs@gmail.com>

zhaohuabing requested a review from a team as a code owner January 20, 2026 12:17

zhaohuabing marked this pull request as draft January 20, 2026 12:17

zhaohuabing added this to the v1.7.0-rc.1 Release milestone Jan 20, 2026

zhaohuabing force-pushed the feat-5323 branch 7 times, most recently from bf1ce64 to 9811829 Compare January 22, 2026 04:23

zhaohuabing marked this pull request as ready for review January 22, 2026 05:10

zhaohuabing force-pushed the feat-5323 branch from 7a6cfe1 to 1b7027b Compare January 22, 2026 10:28

jukie reviewed Jan 22, 2026

View reviewed changes

internal/gatewayapi/xlistenerset.go Outdated Show resolved Hide resolved

zhaohuabing force-pushed the feat-5323 branch 4 times, most recently from cc3858a to 115ca97 Compare January 23, 2026 07:05

zhaohuabing force-pushed the feat-5323 branch from 6093336 to 8d5b078 Compare January 23, 2026 08:16

zhaohuabing marked this pull request as draft January 23, 2026 08:35

zhaohuabing force-pushed the feat-5323 branch from 5feb815 to 4018ea0 Compare January 23, 2026 10:08

zhaohuabing requested review from a team and jukie January 23, 2026 10:08

zhaohuabing marked this pull request as ready for review January 23, 2026 10:08

arkodg reviewed Jan 24, 2026

View reviewed changes

internal/gatewayapi/runner/runner.go Outdated Show resolved Hide resolved

arkodg reviewed Jan 24, 2026

View reviewed changes

release-notes/current.yaml Outdated Show resolved Hide resolved

zhaohuabing added 10 commits January 28, 2026 12:22

add debug info

b2bba6d

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

add debug info

713d2fc

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

fix test

ba982f5

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

fix tls route

9926f44

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

remove debugging log

6f9113a

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

fixt test

1049b70

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

fix gateway name extraction logic

9b60a43

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

add test for no matching section

c9102f5

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

fix test

40e44db

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

address comments

be2689a

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

zhaohuabing force-pushed the feat-5323 branch from 6e068f8 to be2689a Compare January 28, 2026 04:22

fix gen

adc3ea1

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

arkodg approved these changes Jan 28, 2026

View reviewed changes

arkodg requested review from a team January 28, 2026 06:09

arkodg approved these changes Jan 28, 2026

View reviewed changes

zirain approved these changes Jan 28, 2026

View reviewed changes

Merge branch 'main' into feat-5323

deeec7a

kkk777-7 approved these changes Jan 28, 2026

View reviewed changes

jukie approved these changes Jan 28, 2026

View reviewed changes

Merge branch 'main' into feat-5323

3fe28d7

zhaohuabing merged commit ea1a322 into envoyproxy:main Jan 29, 2026
86 of 92 checks passed

zhaohuabing deleted the feat-5323 branch January 29, 2026 01:40

schmitch mentioned this pull request Feb 3, 2026

Implement gep-1713 (ListenerSets) #5323

Closed

norman-zon mentioned this pull request Mar 4, 2026

Support ListenerSet #8409

Closed

Conversation

zhaohuabing commented Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

TODOs

Uh oh!

netlify bot commented Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for cerulean-figolla-1f9435 ready!

Uh oh!

codecov bot commented Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

jukie commented Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zhaohuabing commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

arkodg Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

zhaohuabing Jan 26, 2026 • 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!

arkodg Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

arkodg left a comment

Choose a reason for hiding this comment

Uh oh!

jukie commented Jan 28, 2026

Uh oh!

kkk777-7 commented Jan 28, 2026

Uh oh!

jukie commented Jan 28, 2026

Uh oh!

jukie commented Jan 28, 2026

Uh oh!

jukie left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

zhaohuabing commented Jan 20, 2026 •

edited

Loading

netlify bot commented Jan 20, 2026 •

edited

Loading

codecov bot commented Jan 20, 2026 •

edited

Loading

jukie commented Jan 22, 2026 •

edited

Loading

zhaohuabing commented Jan 23, 2026 •

edited

Loading

zhaohuabing Jan 26, 2026 •

edited

Loading