Skip to content

Commit 159b4e2

Browse files
muwaqarmuwaqar
committed
api: rename BackendClusterSettings to BackendSettings
Address reviewer feedback to use a shorter, clearer name. Signed-off-by: Muhammad Waqar <waqar.hameed08@gmail.com>
1 parent 25c7c4b commit 159b4e2

5 files changed

Lines changed: 156 additions & 156 deletions

File tree

‎api/v1alpha1/shared_types.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -636,9 +636,9 @@ type BackendCluster struct {
636636
BackendSettings *ClusterSettings `json:"backendSettings,omitempty"`
637637
}
638638

639-
// BackendClusterSettings contains CDS-only fields that configure the upstream Envoy Cluster.
639+
// BackendSettings contains CDS-only fields that configure the upstream Envoy Cluster.
640640
// +kubebuilder:validation:XValidation:rule="!((has(self.connection) && has(self.connection.preconnect) && has(self.connection.preconnect.predictivePercent)) && !(has(self.loadBalancer) && has(self.loadBalancer.type) && self.loadBalancer.type in ['Random', 'RoundRobin']))",message="predictivePercent in preconnect policy only works with RoundRobin or Random load balancers"
641-
type BackendClusterSettings struct {
641+
type BackendSettings struct {
642642
// LoadBalancer policy to apply when routing traffic from the gateway to
643643
// the backend endpoints. Defaults to `LeastRequest`.
644644
// +optional
@@ -687,10 +687,10 @@ type BackendClusterSettings struct {
687687
}
688688

689689
// ClusterSettings provides the various knobs that can be set to control how traffic to a given
690-
// backend will be configured. It embeds BackendClusterSettings (CDS-only fields) and adds
690+
// backend will be configured. It embeds BackendSettings (CDS-only fields) and adds
691691
// route-level fields like Retry.
692692
type ClusterSettings struct {
693-
BackendClusterSettings `json:",inline"`
693+
BackendSettings `json:",inline"`
694694

695695
// Retry provides more advanced usage, allowing users to customize the number of retries, retry fallback strategy, and retry triggering conditions.
696696
// If not set, retry will be disabled.

‎api/v1alpha1/zz_generated.deepcopy.go‎

Lines changed: 61 additions & 61 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎internal/gatewayapi/clustersettings_backendutilization_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ func TestBuildLoadBalancer_BackendUtilization(t *testing.T) {
2626
}
2727

2828
policy := &egv1a1.ClusterSettings{
29-
BackendClusterSettings: egv1a1.BackendClusterSettings{
29+
BackendSettings: egv1a1.BackendSettings{
3030
LoadBalancer: &egv1a1.LoadBalancer{
3131
Type: egv1a1.BackendUtilizationLoadBalancerType,
3232
BackendUtilization: backendUtilization,

‎site/content/en/latest/api/extension_types.md‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -370,29 +370,6 @@ _Appears in:_
370370
| `backendSettings` | _[ClusterSettings](#clustersettings)_ | false | | BackendSettings holds configuration for managing the connection<br />to the backend. |
371371

372372

373-
#### BackendClusterSettings
374-
375-
376-
377-
BackendClusterSettings contains CDS-only fields that configure the upstream Envoy Cluster.
378-
379-
_Appears in:_
380-
- [BackendTrafficPolicySpec](#backendtrafficpolicyspec)
381-
- [ClusterSettings](#clustersettings)
382-
383-
| Field | Type | Required | Default | Description |
384-
| --- | --- | --- | --- | --- |
385-
| `loadBalancer` | _[LoadBalancer](#loadbalancer)_ | false | | LoadBalancer policy to apply when routing traffic from the gateway to<br />the backend endpoints. Defaults to `LeastRequest`. |
386-
| `proxyProtocol` | _[ProxyProtocol](#proxyprotocol)_ | false | | ProxyProtocol enables the Proxy Protocol when communicating with the backend. |
387-
| `tcpKeepalive` | _[TCPKeepalive](#tcpkeepalive)_ | false | | TcpKeepalive settings associated with the upstream client connection.<br />Disabled by default. |
388-
| `healthCheck` | _[HealthCheck](#healthcheck)_ | false | | HealthCheck allows gateway to perform active health checking on backends. |
389-
| `circuitBreaker` | _[CircuitBreaker](#circuitbreaker)_ | false | | Circuit Breaker settings for the upstream connections and requests.<br />If not set, circuit breakers will be enabled with the default thresholds |
390-
| `timeout` | _[Timeout](#timeout)_ | false | | Timeout settings for the backend connections. |
391-
| `connection` | _[BackendConnection](#backendconnection)_ | false | | Connection includes backend connection settings. |
392-
| `dns` | _[DNS](#dns)_ | false | | DNS includes dns resolution settings. |
393-
| `http2` | _[HTTP2Settings](#http2settings)_ | false | | HTTP2 provides HTTP/2 configuration for backend connections. |
394-
395-
396373

397374

398375

@@ -404,7 +381,7 @@ _Appears in:_
404381
BackendConnection allows users to configure connection-level settings of backend
405382

406383
_Appears in:_
407-
- [BackendClusterSettings](#backendclustersettings)
384+
- [BackendSettings](#backendsettings)
408385
- [BackendTrafficPolicySpec](#backendtrafficpolicyspec)
409386
- [ClusterSettings](#clustersettings)
410387

@@ -477,6 +454,29 @@ _Appears in:_
477454
| `fallback` | _boolean_ | false | | Fallback indicates whether the backend is designated as a fallback.<br />Multiple fallback backends can be configured.<br />It is highly recommended to configure active or passive health checks to ensure that failover can be detected<br />when the active backends become unhealthy and to automatically readjust once the primary backends are healthy again.<br />The overprovisioning factor is set to 1.4, meaning the fallback backends will only start receiving traffic when<br />the health of the active backends falls below 72%. |
478455

479456

457+
#### BackendSettings
458+
459+
460+
461+
BackendSettings contains CDS-only fields that configure the upstream Envoy Cluster.
462+
463+
_Appears in:_
464+
- [BackendTrafficPolicySpec](#backendtrafficpolicyspec)
465+
- [ClusterSettings](#clustersettings)
466+
467+
| Field | Type | Required | Default | Description |
468+
| --- | --- | --- | --- | --- |
469+
| `loadBalancer` | _[LoadBalancer](#loadbalancer)_ | false | | LoadBalancer policy to apply when routing traffic from the gateway to<br />the backend endpoints. Defaults to `LeastRequest`. |
470+
| `proxyProtocol` | _[ProxyProtocol](#proxyprotocol)_ | false | | ProxyProtocol enables the Proxy Protocol when communicating with the backend. |
471+
| `tcpKeepalive` | _[TCPKeepalive](#tcpkeepalive)_ | false | | TcpKeepalive settings associated with the upstream client connection.<br />Disabled by default. |
472+
| `healthCheck` | _[HealthCheck](#healthcheck)_ | false | | HealthCheck allows gateway to perform active health checking on backends. |
473+
| `circuitBreaker` | _[CircuitBreaker](#circuitbreaker)_ | false | | Circuit Breaker settings for the upstream connections and requests.<br />If not set, circuit breakers will be enabled with the default thresholds |
474+
| `timeout` | _[Timeout](#timeout)_ | false | | Timeout settings for the backend connections. |
475+
| `connection` | _[BackendConnection](#backendconnection)_ | false | | Connection includes backend connection settings. |
476+
| `dns` | _[DNS](#dns)_ | false | | DNS includes dns resolution settings. |
477+
| `http2` | _[HTTP2Settings](#http2settings)_ | false | | HTTP2 provides HTTP/2 configuration for backend connections. |
478+
479+
480480
#### BackendSpec
481481

482482

@@ -856,7 +856,7 @@ _Appears in:_
856856
CircuitBreaker defines the Circuit Breaker configuration.
857857

858858
_Appears in:_
859-
- [BackendClusterSettings](#backendclustersettings)
859+
- [BackendSettings](#backendsettings)
860860
- [BackendTrafficPolicySpec](#backendtrafficpolicyspec)
861861
- [ClusterSettings](#clustersettings)
862862

@@ -1066,7 +1066,7 @@ _Appears in:_
10661066

10671067

10681068
ClusterSettings provides the various knobs that can be set to control how traffic to a given
1069-
backend will be configured. It embeds BackendClusterSettings (CDS-only fields) and adds
1069+
backend will be configured. It embeds BackendSettings (CDS-only fields) and adds
10701070
route-level fields like Retry.
10711071

10721072
_Appears in:_
@@ -1425,7 +1425,7 @@ _Appears in:_
14251425

14261426

14271427
_Appears in:_
1428-
- [BackendClusterSettings](#backendclustersettings)
1428+
- [BackendSettings](#backendsettings)
14291429
- [BackendTrafficPolicySpec](#backendtrafficpolicyspec)
14301430
- [ClusterSettings](#clustersettings)
14311431

@@ -2936,7 +2936,7 @@ _Appears in:_
29362936
HTTP2Settings provides HTTP/2 configuration for listeners and backends.
29372937

29382938
_Appears in:_
2939-
- [BackendClusterSettings](#backendclustersettings)
2939+
- [BackendSettings](#backendsettings)
29402940
- [BackendTrafficPolicySpec](#backendtrafficpolicyspec)
29412941
- [ClientTrafficPolicySpec](#clienttrafficpolicyspec)
29422942
- [ClusterSettings](#clustersettings)
@@ -3354,7 +3354,7 @@ HealthCheck configuration to decide which endpoints
33543354
are healthy and can be used for routing.
33553355

33563356
_Appears in:_
3357-
- [BackendClusterSettings](#backendclustersettings)
3357+
- [BackendSettings](#backendsettings)
33583358
- [BackendTrafficPolicySpec](#backendtrafficpolicyspec)
33593359
- [ClusterSettings](#clustersettings)
33603360

@@ -3981,7 +3981,7 @@ _Appears in:_
39813981
LoadBalancer defines the load balancer policy to be applied.
39823982

39833983
_Appears in:_
3984-
- [BackendClusterSettings](#backendclustersettings)
3984+
- [BackendSettings](#backendsettings)
39853985
- [BackendTrafficPolicySpec](#backendtrafficpolicyspec)
39863986
- [ClusterSettings](#clustersettings)
39873987

@@ -4947,7 +4947,7 @@ ProxyProtocol defines the configuration related to the proxy protocol
49474947
when communicating with the backend.
49484948

49494949
_Appears in:_
4950-
- [BackendClusterSettings](#backendclustersettings)
4950+
- [BackendSettings](#backendsettings)
49514951
- [BackendTrafficPolicySpec](#backendtrafficpolicyspec)
49524952
- [ClusterSettings](#clustersettings)
49534953

@@ -6132,7 +6132,7 @@ _Appears in:_
61326132
TCPKeepalive define the TCP Keepalive configuration.
61336133

61346134
_Appears in:_
6135-
- [BackendClusterSettings](#backendclustersettings)
6135+
- [BackendSettings](#backendsettings)
61366136
- [BackendTrafficPolicySpec](#backendtrafficpolicyspec)
61376137
- [ClientTrafficPolicySpec](#clienttrafficpolicyspec)
61386138
- [ClusterSettings](#clustersettings)
@@ -6276,7 +6276,7 @@ _Appears in:_
62766276
Timeout defines configuration for timeouts related to connections.
62776277

62786278
_Appears in:_
6279-
- [BackendClusterSettings](#backendclustersettings)
6279+
- [BackendSettings](#backendsettings)
62806280
- [BackendTrafficPolicySpec](#backendtrafficpolicyspec)
62816281
- [ClusterSettings](#clustersettings)
62826282

0 commit comments

Comments
 (0)