api: split ClusterSettings into BackendSettings and ClusterSettings by muwaqar-cflt · Pull Request #8899 · envoyproxy/gateway

muwaqar-cflt · 2026-04-30T18:59:06Z

Summary

Extract CDS-only fields from the existing ClusterSettings into a dedicated ClusterSettings struct, and rename the wrapper (which adds Retry) to BackendSettings.

BackendSettings embeds ClusterSettings inline and adds Retry. JSON field paths are unchanged — this is a non-breaking refactor.

Closes #8898

Fields in `ClusterSettings` (CDS-only)

loadBalancer
proxyProtocol
tcpKeepalive
healthCheck
circuitBreaker
timeout
connection
dns
http2

Fields in `BackendSettings` (wrapper)

Embeds ClusterSettings inline
retry (RDS concern, not applicable to Backend targets)

Test plan

netlify · 2026-04-30T18:59:12Z

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

Name	Link
🔨 Latest commit	`45f2f80`
🔍 Latest deploy log	https://app.netlify.com/projects/cerulean-figolla-1f9435/deploys/6a999e01c6d7ef000724c5c7
😎 Deploy Preview	https://deploy-preview-8899--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.

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3d5671b0a1

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

zhaohuabing · 2026-05-01T00:51:48Z

Hi @muwaqar-cflt, the new API shape looks good to me. Thanks for the quick PR!

A couple of questions:

The YAML CRDs are still compatible, but downstream projects would need to update their code if they construct BackendTrafficPolicy in Go using the old type. Is that acceptable?
Do we have better names to distinguish “CDS-only settings” from “non-route backend traffic settings”?

cc @envoyproxy/gateway-maintainers , please chime in.

codecov · 2026-05-01T01:02:02Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.33%. Comparing base (e56c0ff) to head (45f2f80).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8899   +/-   ##
=======================================
  Coverage   81.32%   81.33%           
=======================================
  Files         264      264           
  Lines       40964    40964           
=======================================
+ Hits        33315    33318    +3     
+ Misses       7648     7645    -3     
  Partials        1        1

☔ View full report in Codecov by Harness.
📢 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.

zhaohuabing

LGTM thanks!

kkk777-7 · 2026-07-22T14:08:59Z

LGTM, thanks!

zhaohuabing · 2026-08-06T02:17:39Z

LGTM. Deferring to @guydc

I'm also OK with delaying this to EG API graduating to V1.

guydc · 2026-08-13T16:08:28Z

Can we roll out this change gradually and give users some grace to upgrade, e.g. at least one version where both exist side-by-side? If the effort is too large, I'm fine with this. Let's still document it as a breaking change though, so that users that rely on go types programtically are aware...

…ields Extract CDS-only fields (LoadBalancer, ProxyProtocol, TCPKeepalive, HealthCheck, CircuitBreaker, Timeout, Connection, DNS, HTTP2) into BackendClusterSettings. ClusterSettings embeds it inline and adds Retry. JSON field paths are unchanged (non-breaking). Closes envoyproxy#8898 Signed-off-by: Muhammad Waqar <waqar.hameed08@gmail.com>

Address reviewer feedback to use a shorter, clearer name. Signed-off-by: Muhammad Waqar <waqar.hameed08@gmail.com>

… BackendSettings Swap type names per reviewer feedback: the CDS-only struct becomes ClusterSettings and the wrapper (with Retry) becomes BackendSettings. Also rename clustersettings.go to backendsettings.go. Signed-off-by: Muhammad Waqar <waqar.hameed08@gmail.com>

…s after rebase Rebasing onto main picked up test cases that construct BackendTrafficPolicySpec with a direct ClusterSettings field, which this branch's split moved one level deeper under the new BackendSettings field. git's auto-merge didn't flag these as conflicts since the surrounding lines didn't textually overlap. Signed-off-by: Muhammad Waqar <mwaqar@confluent.io>

…king Addresses guydc's review comment on envoyproxy#8899 by documenting the Go-type impact instead of maintaining both types side-by-side for a release. Signed-off-by: Muhammad Waqar <mwaqar@confluent.io>

muwaqar-cflt · 2026-09-03T16:23:55Z

@guydc Rebased the PR onto current main and added a release note (release-notes/current/breaking_changes/8899-backend-cluster-settings-split.md) documenting the Go-type impact for downstream consumers.

I looked at doing a real side-by-side transition, but it's more than it looks like: since ClusterSettings is inlined directly into BackendTrafficPolicySpec's JSON, the old and new types can't coexist inline (both would claim the same JSON keys). A genuine grace period would mean adding a second, differently-named field, adding validation to keep the two from disagreeing, and rewriting every internal reader to check both — then unwinding all of that next release. Given that, a documented breaking change with a release note seemed like the better tradeoff here.

zirain · 2026-09-04T02:55:14Z

/retest

muwaqar-cflt requested a review from a team as a code owner April 30, 2026 18:59

chatgpt-codex-connector Bot reviewed Apr 30, 2026

View reviewed changes

Comment thread api/v1alpha1/shared_types.go Outdated

zhaohuabing reviewed May 25, 2026

View reviewed changes

Comment thread api/v1alpha1/shared_types.go Outdated

zhaohuabing previously approved these changes May 25, 2026

View reviewed changes

zhaohuabing reviewed May 25, 2026

View reviewed changes

Comment thread api/v1alpha1/shared_types.go Outdated

zhaohuabing self-requested a review May 25, 2026 02:48

muwaqar-cflt dismissed zhaohuabing’s stale review via 74b8411 June 10, 2026 14:22

muwaqar-cflt changed the title ~~api: split ClusterSettings into BackendClusterSettings~~ api: split ClusterSettings into BackendSettings Jun 10, 2026

muwaqar-cflt force-pushed the backend-cluster-settings branch from 74b8411 to 5e69afc Compare June 11, 2026 19:49

zhaohuabing requested a review from arkodg June 16, 2026 13:12

muwaqar-cflt force-pushed the backend-cluster-settings branch from 5e69afc to 159b4e2 Compare June 16, 2026 15:44

muwaqar-cflt changed the title ~~api: split ClusterSettings into BackendSettings~~ api: split ClusterSettings into BackendSettings and ClusterSettings Jun 19, 2026

zhaohuabing approved these changes Jun 22, 2026

View reviewed changes

zhaohuabing added this to the v1.9.0-rc.1 Release milestone Jun 22, 2026

zhaohuabing requested review from a team and zhaohuabing June 22, 2026 09:10

zhaohuabing approved these changes Jun 25, 2026

View reviewed changes

zhaohuabing force-pushed the backend-cluster-settings branch from a08ab35 to 9084c06 Compare June 25, 2026 13:48

zhaohuabing previously approved these changes Jun 25, 2026

View reviewed changes

zhaohuabing requested a review from guydc June 25, 2026 14:11

kkk777-7 previously approved these changes Jul 22, 2026

View reviewed changes

zhaohuabing modified the milestones: v1.9.0-rc.1 Release, Backlog Jul 24, 2026

muwaqar-cflt mentioned this pull request Aug 4, 2026

refactor: only include cluster-scoped traffic features in BackendCluster #9642

Merged

muwaqar-cflt closed this Aug 4, 2026

muwaqar-cflt reopened this Aug 4, 2026

muwaqar-cflt dismissed stale reviews from kkk777-7 and zhaohuabing via e3a3351 August 5, 2026 15:21

muwaqar-cflt force-pushed the backend-cluster-settings branch from 9084c06 to e3a3351 Compare August 5, 2026 15:21

zhaohuabing previously approved these changes Aug 6, 2026

View reviewed changes

zirain previously approved these changes Aug 6, 2026

View reviewed changes

muwaqar and others added 5 commits September 3, 2026 12:00

api: rename BackendClusterSettings to BackendSettings

8d1f299

Address reviewer feedback to use a shorter, clearer name. Signed-off-by: Muhammad Waqar <waqar.hameed08@gmail.com>

release-notes: document ClusterSettings/BackendSettings split as brea…

45f2f80

…king Addresses guydc's review comment on envoyproxy#8899 by documenting the Go-type impact instead of maintaining both types side-by-side for a release. Signed-off-by: Muhammad Waqar <mwaqar@confluent.io>

muwaqar-cflt dismissed stale reviews from zirain and zhaohuabing via 45f2f80 September 3, 2026 16:19

muwaqar-cflt force-pushed the backend-cluster-settings branch from e3a3351 to 45f2f80 Compare September 3, 2026 16:19

zhaohuabing approved these changes Sep 4, 2026

View reviewed changes

zhaohuabing requested review from kkk777-7 and zirain September 4, 2026 02:54

Navigation Menu

Uh oh!

api: split ClusterSettings into BackendSettings and ClusterSettings - #8899

api: split ClusterSettings into BackendSettings and ClusterSettings#8899
muwaqar-cflt wants to merge 5 commits into
envoyproxy:mainfrom
muwaqar:backend-cluster-settings

muwaqar-cflt commented Apr 30, 2026 •

edited

Loading

Uh oh!

netlify Bot commented Apr 30, 2026 •

edited

Loading

Uh oh!

chatgpt-codex-connector Bot left a comment

Uh oh!

Uh oh!

zhaohuabing commented May 1, 2026 •

edited

Loading

Uh oh!

codecov Bot commented May 1, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

zhaohuabing left a comment

Uh oh!

kkk777-7 commented Jul 22, 2026

Uh oh!

zhaohuabing commented Aug 6, 2026

Uh oh!

guydc commented Aug 13, 2026 •

edited

Loading

Uh oh!

muwaqar-cflt commented Sep 3, 2026

Uh oh!

zirain commented Sep 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Uh oh!

Conversation

muwaqar-cflt commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Fields in ClusterSettings (CDS-only)

Fields in BackendSettings (wrapper)

Test plan

Uh oh!

netlify Bot commented Apr 30, 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!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

codecov Bot commented May 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

zhaohuabing left a comment

Choose a reason for hiding this comment

Uh oh!

kkk777-7 commented Jul 22, 2026

Uh oh!

zhaohuabing commented Aug 6, 2026

Uh oh!

guydc commented Aug 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

muwaqar-cflt commented Sep 3, 2026

Uh oh!

zirain commented Sep 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

muwaqar-cflt commented Apr 30, 2026 •

edited

Loading

Fields in `ClusterSettings` (CDS-only)

Fields in `BackendSettings` (wrapper)

netlify Bot commented Apr 30, 2026 •

edited

Loading

zhaohuabing commented May 1, 2026 •

edited

Loading

codecov Bot commented May 1, 2026 •

edited

Loading

guydc commented Aug 13, 2026 •

edited

Loading