Skip to content

feat: Implement BackendUtilization LB OutOfBand reporting #9593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jukie wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: Implement BackendUtilization LB OutOfBand reporting #9593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
17af668
Implement BackendUtilization OutOfBand ORCA reporting
jukie Jul 29, 2026
637a0f6
Merge branch 'main' into impl-backendutilization-oob
jukie Jul 29, 2026
046e8d1
Merge branch 'main' into impl-backendutilization-oob
jukie Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions api/v1alpha1/loadbalancer_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,35 +237,37 @@ type BackendUtilization struct {
// carried in response headers/trailers.
//
// The backend must implement OpenRcaService for this to take effect.
//
// +optional
// +notImplementedHide
OutOfBand *OutOfBandReporting `json:"outOfBand,omitempty"`
}

// OutOfBandReporting configures out-of-band ORCA load reporting for the
// BackendUtilization load balancer.
//
// +notImplementedHide
type OutOfBandReporting struct {
// ReportingPeriod is how often Envoy requests load reports from the server.
// If omitted, uses Envoy's default of 10s.
// Must be greater than 0. Defaults to 10s.
//
// +kubebuilder:validation:XValidation:rule="duration(self) > duration('0s')",message="reportingPeriod must be greater than 0"
// +optional
// +notImplementedHide
ReportingPeriod *gwapiv1.Duration `json:"reportingPeriod,omitempty"`

// Port overrides the port used for the OutOfBand reporting connection, e.g. to
// reach a separate reporting sidecar. Defaults to the endpoint's port.
//
// +kubebuilder:validation:Minimum=1
// +kubebuilder:validation:Maximum=65535
// +optional
// +notImplementedHide
Port *int32 `json:"port,omitempty"`

@jukie jukie Jul 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CC @zhaohuabing #9400 (comment)

@zhaohuabing I ended up reverting this back to *int32. We only use it in one other place currently vs int32 for 8 other port fields and it breaks the kubebuilder bounds setup.

Let's continue here on whether to use PortNumber instead.


// Authority overrides the :authority header on the OutOfBand gRPC stream.
// If unset, Envoy uses the endpoint hostname, then the dialed address, then
// the cluster name.
//
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=259
// +kubebuilder:validation:Pattern=`^[^\x00\n\r]*$`
// +optional
// +notImplementedHide
Authority *string `json:"authority,omitempty"`
}

Expand Down
13 changes: 10 additions & 3 deletions ...s/gateway-crds-helm/templates/generated/gateway.envoyproxy.io_backendtrafficpolicies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1113,8 +1113,12 @@ spec:
The backend must implement OpenRcaService for this to take effect.
properties:
authority:
description: Authority overrides the :authority header
on the OutOfBand gRPC stream.
description: |-
Authority overrides the :authority header on the OutOfBand gRPC stream.
If unset, Envoy uses the endpoint hostname, then the dialed address, then
the cluster name.
maxLength: 259
minLength: 1
pattern: ^[^\x00\n\r]*$
type: string
port:
Expand All @@ -1128,9 +1132,12 @@ spec:
reportingPeriod:
description: |-
ReportingPeriod is how often Envoy requests load reports from the server.
If omitted, uses Envoy's default of 10s.
Must be greater than 0. Defaults to 10s.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
x-kubernetes-validations:
- message: reportingPeriod must be greater than 0
rule: duration(self) > duration('0s')
type: object
weightExpirationPeriod:
description: If a given endpoint has not reported load metrics
Expand Down
14 changes: 11 additions & 3 deletions ...s/gateway-crds-helm/templates/generated/gateway.envoyproxy.io_envoyextensionpolicies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -988,8 +988,12 @@ spec:
The backend must implement OpenRcaService for this to take effect.
properties:
authority:
description: Authority overrides the :authority
header on the OutOfBand gRPC stream.
description: |-
Authority overrides the :authority header on the OutOfBand gRPC stream.
If unset, Envoy uses the endpoint hostname, then the dialed address, then
the cluster name.
maxLength: 259
minLength: 1
pattern: ^[^\x00\n\r]*$
type: string
port:
Expand All @@ -1003,9 +1007,13 @@ spec:
reportingPeriod:
description: |-
ReportingPeriod is how often Envoy requests load reports from the server.
If omitted, uses Envoy's default of 10s.
Must be greater than 0. Defaults to 10s.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
x-kubernetes-validations:
- message: reportingPeriod must be greater than
0
rule: duration(self) > duration('0s')
type: object
weightExpirationPeriod:
description: If a given endpoint has not reported
Expand Down
59 changes: 44 additions & 15 deletions charts/gateway-crds-helm/templates/generated/gateway.envoyproxy.io_envoyproxies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12330,9 +12330,12 @@ spec:
The backend must implement OpenRcaService for this to take effect.
properties:
authority:
description: Authority overrides
the :authority header on
the OutOfBand gRPC stream.
description: |-
Authority overrides the :authority header on the OutOfBand gRPC stream.
If unset, Envoy uses the endpoint hostname, then the dialed address, then
the cluster name.
maxLength: 259
minLength: 1
pattern: ^[^\x00\n\r]*$
type: string
port:
Expand All @@ -12346,9 +12349,13 @@ spec:
reportingPeriod:
description: |-
ReportingPeriod is how often Envoy requests load reports from the server.
If omitted, uses Envoy's default of 10s.
Must be greater than 0. Defaults to 10s.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
x-kubernetes-validations:
- message: reportingPeriod
must be greater than 0
rule: duration(self) > duration('0s')
type: object
weightExpirationPeriod:
description: If a given endpoint
Expand Down Expand Up @@ -13940,9 +13947,12 @@ spec:
The backend must implement OpenRcaService for this to take effect.
properties:
authority:
description: Authority overrides
the :authority header on
the OutOfBand gRPC stream.
description: |-
Authority overrides the :authority header on the OutOfBand gRPC stream.
If unset, Envoy uses the endpoint hostname, then the dialed address, then
the cluster name.
maxLength: 259
minLength: 1
pattern: ^[^\x00\n\r]*$
type: string
port:
Expand All @@ -13956,9 +13966,13 @@ spec:
reportingPeriod:
description: |-
ReportingPeriod is how often Envoy requests load reports from the server.
If omitted, uses Envoy's default of 10s.
Must be greater than 0. Defaults to 10s.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
x-kubernetes-validations:
- message: reportingPeriod
must be greater than 0
rule: duration(self) > duration('0s')
type: object
weightExpirationPeriod:
description: If a given endpoint
Expand Down Expand Up @@ -15716,9 +15730,12 @@ spec:
The backend must implement OpenRcaService for this to take effect.
properties:
authority:
description: Authority overrides
the :authority header on the OutOfBand
gRPC stream.
description: |-
Authority overrides the :authority header on the OutOfBand gRPC stream.
If unset, Envoy uses the endpoint hostname, then the dialed address, then
the cluster name.
maxLength: 259
minLength: 1
pattern: ^[^\x00\n\r]*$
type: string
port:
Expand All @@ -15732,9 +15749,13 @@ spec:
reportingPeriod:
description: |-
ReportingPeriod is how often Envoy requests load reports from the server.
If omitted, uses Envoy's default of 10s.
Must be greater than 0. Defaults to 10s.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
x-kubernetes-validations:
- message: reportingPeriod must
be greater than 0
rule: duration(self) > duration('0s')
type: object
weightExpirationPeriod:
description: If a given endpoint has
Expand Down Expand Up @@ -17440,8 +17461,12 @@ spec:
The backend must implement OpenRcaService for this to take effect.
properties:
authority:
description: Authority overrides the :authority
header on the OutOfBand gRPC stream.
description: |-
Authority overrides the :authority header on the OutOfBand gRPC stream.
If unset, Envoy uses the endpoint hostname, then the dialed address, then
the cluster name.
maxLength: 259
minLength: 1
pattern: ^[^\x00\n\r]*$
type: string
port:
Expand All @@ -17455,9 +17480,13 @@ spec:
reportingPeriod:
description: |-
ReportingPeriod is how often Envoy requests load reports from the server.
If omitted, uses Envoy's default of 10s.
Must be greater than 0. Defaults to 10s.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
x-kubernetes-validations:
- message: reportingPeriod must be greater
than 0
rule: duration(self) > duration('0s')
type: object
weightExpirationPeriod:
description: If a given endpoint has not reported
Expand Down
Loading
Loading