From 619109b15c4cbbc57ef1c29a83725f521dd3dca7 Mon Sep 17 00:00:00 2001 From: "Huabing (Robin) Zhao" Date: Mon, 27 Apr 2026 19:33:35 +0800 Subject: [PATCH] update api docs for the default EnvoyProxy Signed-off-by: Huabing (Robin) Zhao --- api/v1alpha1/envoygateway_types.go | 7 ++++--- site/content/en/latest/api/extension_types.md | 4 ++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/api/v1alpha1/envoygateway_types.go b/api/v1alpha1/envoygateway_types.go index 8d3fa614af..b92fd735d8 100644 --- a/api/v1alpha1/envoygateway_types.go +++ b/api/v1alpha1/envoygateway_types.go @@ -124,9 +124,10 @@ type EnvoyGatewaySpec struct { // 2. GatewayClass-level EnvoyProxy (referenced via GatewayClass.spec.parametersRef) // 3. This EnvoyProxy default spec // - // Currently, the most specific EnvoyProxy configuration wins completely (replace semantics). - // A future release will introduce merge semantics to allow combining configurations - // across multiple levels. + // The merge strategy for a more specific EnvoyProxy is controlled by its + // spec.mergeType field. If mergeType is unset, the more specific EnvoyProxy + // completely replaces less specific settings. + // Note: mergeType has no effect in this default EnvoyProxySpec. // // +optional EnvoyProxy *EnvoyProxySpec `json:"envoyProxy,omitempty"` diff --git a/site/content/en/latest/api/extension_types.md b/site/content/en/latest/api/extension_types.md index 33bd5d1825..f363370aaf 100644 --- a/site/content/en/latest/api/extension_types.md +++ b/site/content/en/latest/api/extension_types.md @@ -1616,7 +1616,7 @@ EnvoyGateway is the schema for the envoygateways API. | `extensionApis` | _[ExtensionAPISettings](#extensionapisettings)_ | false | | ExtensionAPIs defines the settings related to specific Gateway API Extensions
implemented by Envoy Gateway | | `gatewayAPI` | _[GatewayAPISettings](#gatewayapisettings)_ | false | | GatewayAPI defines feature flags for experimental Gateway API resources.
These APIs live under the gateway.networking.x-k8s.io group and are opt-in. | | `runtimeFlags` | _[RuntimeFlags](#runtimeflags)_ | true | | RuntimeFlags defines the runtime flags for Envoy Gateway.
Unlike ExtensionAPIs, these flags are temporary and will be removed in future releases once the related features are stable. | -| `envoyProxy` | _[EnvoyProxySpec](#envoyproxyspec)_ | false | | EnvoyProxy defines the default EnvoyProxy configuration that applies
to all managed Envoy Proxy fleet. This is an optional field and when
provided, the settings from this EnvoyProxySpec serve as the base
defaults for all Envoy Proxy instances.
The hierarchy for EnvoyProxy configuration is (highest to lowest priority):
1. Gateway-level EnvoyProxy (referenced via Gateway.spec.infrastructure.parametersRef)
2. GatewayClass-level EnvoyProxy (referenced via GatewayClass.spec.parametersRef)
3. This EnvoyProxy default spec
Currently, the most specific EnvoyProxy configuration wins completely (replace semantics).
A future release will introduce merge semantics to allow combining configurations
across multiple levels. | +| `envoyProxy` | _[EnvoyProxySpec](#envoyproxyspec)_ | false | | EnvoyProxy defines the default EnvoyProxy configuration that applies
to all managed Envoy Proxy fleet. This is an optional field and when
provided, the settings from this EnvoyProxySpec serve as the base
defaults for all Envoy Proxy instances.
The hierarchy for EnvoyProxy configuration is (highest to lowest priority):
1. Gateway-level EnvoyProxy (referenced via Gateway.spec.infrastructure.parametersRef)
2. GatewayClass-level EnvoyProxy (referenced via GatewayClass.spec.parametersRef)
3. This EnvoyProxy default spec
The merge strategy for a more specific EnvoyProxy is controlled by its
spec.mergeType field. If mergeType is unset, the more specific EnvoyProxy
completely replaces less specific settings.
Note: mergeType has no effect in this default EnvoyProxySpec. | #### EnvoyGatewayAdmin @@ -1905,7 +1905,7 @@ _Appears in:_ | `extensionApis` | _[ExtensionAPISettings](#extensionapisettings)_ | false | | ExtensionAPIs defines the settings related to specific Gateway API Extensions
implemented by Envoy Gateway | | `gatewayAPI` | _[GatewayAPISettings](#gatewayapisettings)_ | false | | GatewayAPI defines feature flags for experimental Gateway API resources.
These APIs live under the gateway.networking.x-k8s.io group and are opt-in. | | `runtimeFlags` | _[RuntimeFlags](#runtimeflags)_ | true | | RuntimeFlags defines the runtime flags for Envoy Gateway.
Unlike ExtensionAPIs, these flags are temporary and will be removed in future releases once the related features are stable. | -| `envoyProxy` | _[EnvoyProxySpec](#envoyproxyspec)_ | false | | EnvoyProxy defines the default EnvoyProxy configuration that applies
to all managed Envoy Proxy fleet. This is an optional field and when
provided, the settings from this EnvoyProxySpec serve as the base
defaults for all Envoy Proxy instances.
The hierarchy for EnvoyProxy configuration is (highest to lowest priority):
1. Gateway-level EnvoyProxy (referenced via Gateway.spec.infrastructure.parametersRef)
2. GatewayClass-level EnvoyProxy (referenced via GatewayClass.spec.parametersRef)
3. This EnvoyProxy default spec
Currently, the most specific EnvoyProxy configuration wins completely (replace semantics).
A future release will introduce merge semantics to allow combining configurations
across multiple levels. | +| `envoyProxy` | _[EnvoyProxySpec](#envoyproxyspec)_ | false | | EnvoyProxy defines the default EnvoyProxy configuration that applies
to all managed Envoy Proxy fleet. This is an optional field and when
provided, the settings from this EnvoyProxySpec serve as the base
defaults for all Envoy Proxy instances.
The hierarchy for EnvoyProxy configuration is (highest to lowest priority):
1. Gateway-level EnvoyProxy (referenced via Gateway.spec.infrastructure.parametersRef)
2. GatewayClass-level EnvoyProxy (referenced via GatewayClass.spec.parametersRef)
3. This EnvoyProxy default spec
The merge strategy for a more specific EnvoyProxy is controlled by its
spec.mergeType field. If mergeType is unset, the more specific EnvoyProxy
completely replaces less specific settings.
Note: mergeType has no effect in this default EnvoyProxySpec. | #### EnvoyGatewayTelemetry