update API doc

Signed-off-by: zirain <zirain2009@gmail.com>

api/v1alpha1/envoyproxy_types.go

@@ -136,14 +136,15 @@ type EnvoyProxySpec struct {
 	// These settings are applied on backends for which TLS policies are specified.
 	// +optional
 	BackendTLS *BackendTLSConfig `json:"backendTLS,omitempty"`
-
 	// IPFamily specifies the IP family for the EnvoyProxy fleet.
-	// This setting only affects the Gateway listener port and does not impact
-	// other aspects of the Envoy proxy configuration.
-	// If not specified, the system will operate as follows:
-	// - It defaults to IPv4 only.
-	// - IPv6 and dual-stack environments are not supported in this default configuration.
-	// Note: To enable IPv6 or dual-stack functionality, explicit configuration is required.
+	// This setting affects the DNS resolver for the EnvoyProxy fleet.
+	//
+	// - On IPv4 gateway, the DNS resolver will only perform a lookup for addresses in the IPv4 family.
+	// - On IPv6 gateway, the DNS resolver will only perform a lookup for addresses in the IPv6 family.
+	// - On DualStack gateway, the DNS resolver will perform a lookup for both IPv4 and IPv6 families.
+	// - If unspecified, the DNS resolver will first perform a lookup for addresses in the IPv4 family
+	//   and fallback to a lookup for addresses in the IPv6 family.
+	//
 	// +kubebuilder:validation:Enum=IPv4;IPv6;DualStack
 	// +optional
 	IPFamily *IPFamily `json:"ipFamily,omitempty"`

charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyproxies.yaml

@@ -390,12 +390,13 @@ spec:
               ipFamily:
                 description: |-
                   IPFamily specifies the IP family for the EnvoyProxy fleet.
-                  This setting only affects the Gateway listener port and does not impact
-                  other aspects of the Envoy proxy configuration.
-                  If not specified, the system will operate as follows:
-                  - It defaults to IPv4 only.
-                  - IPv6 and dual-stack environments are not supported in this default configuration.
-                  Note: To enable IPv6 or dual-stack functionality, explicit configuration is required.
+                  This setting affects the DNS resolver for the EnvoyProxy fleet.
+
+                  - On IPv4 gateway, the DNS resolver will only perform a lookup for addresses in the IPv4 family.
+                  - On IPv6 gateway, the DNS resolver will only perform a lookup for addresses in the IPv6 family.
+                  - On dual stack gateway, the DNS resolver will perform a lookup for both IPv4 and IPv6 families.
+                  - If unspecified, the DNS resolver will first perform a lookup for addresses in the IPv4 family
+                    and fallback to a lookup for addresses in the IPv6 family.
                 enum:
                 - IPv4
                 - IPv6

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

@@ -1432,7 +1432,7 @@ _Appears in:_
 | `shutdown` | _[ShutdownConfig](#shutdownconfig)_ |  false  | Shutdown defines configuration for graceful envoy shutdown process. |
 | `filterOrder` | _[FilterPosition](#filterposition) array_ |  false  | FilterOrder defines the order of filters in the Envoy proxy's HTTP filter chain.<br />The FilterPosition in the list will be applied in the order they are defined.<br />If unspecified, the default filter order is applied.<br />Default filter order is:<br /><br />- envoy.filters.http.health_check<br /><br />- envoy.filters.http.fault<br /><br />- envoy.filters.http.cors<br /><br />- envoy.filters.http.ext_authz<br /><br />- envoy.filters.http.basic_auth<br /><br />- envoy.filters.http.oauth2<br /><br />- envoy.filters.http.jwt_authn<br /><br />- envoy.filters.http.stateful_session<br /><br />- envoy.filters.http.ext_proc<br /><br />- envoy.filters.http.wasm<br /><br />- envoy.filters.http.rbac<br /><br />- envoy.filters.http.local_ratelimit<br /><br />- envoy.filters.http.ratelimit<br /><br />- envoy.filters.http.custom_response<br /><br />- envoy.filters.http.router<br /><br />Note: "envoy.filters.http.router" cannot be reordered, it's always the last filter in the chain. |
 | `backendTLS` | _[BackendTLSConfig](#backendtlsconfig)_ |  false  | BackendTLS is the TLS configuration for the Envoy proxy to use when connecting to backends.<br />These settings are applied on backends for which TLS policies are specified. |
-| `ipFamily` | _[IPFamily](#ipfamily)_ |  false  | IPFamily specifies the IP family for the EnvoyProxy fleet.<br />This setting only affects the Gateway listener port and does not impact<br />other aspects of the Envoy proxy configuration.<br />If not specified, the system will operate as follows:<br />- It defaults to IPv4 only.<br />- IPv6 and dual-stack environments are not supported in this default configuration.<br />Note: To enable IPv6 or dual-stack functionality, explicit configuration is required. |
+| `ipFamily` | _[IPFamily](#ipfamily)_ |  false  | IPFamily specifies the IP family for the EnvoyProxy fleet.<br />This setting affects the DNS resolver for the EnvoyProxy fleet.<br /><br />- On IPv4 gateway, the DNS resolver will only perform a lookup for addresses in the IPv4 family.<br />- On IPv6 gateway, the DNS resolver will only perform a lookup for addresses in the IPv6 family.<br />- On DualStack gateway, the DNS resolver will perform a lookup for both IPv4 and IPv6 families.<br />- If unspecified, the DNS resolver will first perform a lookup for addresses in the IPv4 family<br />  and fallback to a lookup for addresses in the IPv6 family. |
 
 
 #### EnvoyProxyStatus

site/content/zh/latest/api/extension_types.md

@@ -1432,7 +1432,7 @@ _Appears in:_
 | `shutdown` | _[ShutdownConfig](#shutdownconfig)_ |  false  | Shutdown defines configuration for graceful envoy shutdown process. |
 | `filterOrder` | _[FilterPosition](#filterposition) array_ |  false  | FilterOrder defines the order of filters in the Envoy proxy's HTTP filter chain.<br />The FilterPosition in the list will be applied in the order they are defined.<br />If unspecified, the default filter order is applied.<br />Default filter order is:<br /><br />- envoy.filters.http.health_check<br /><br />- envoy.filters.http.fault<br /><br />- envoy.filters.http.cors<br /><br />- envoy.filters.http.ext_authz<br /><br />- envoy.filters.http.basic_auth<br /><br />- envoy.filters.http.oauth2<br /><br />- envoy.filters.http.jwt_authn<br /><br />- envoy.filters.http.stateful_session<br /><br />- envoy.filters.http.ext_proc<br /><br />- envoy.filters.http.wasm<br /><br />- envoy.filters.http.rbac<br /><br />- envoy.filters.http.local_ratelimit<br /><br />- envoy.filters.http.ratelimit<br /><br />- envoy.filters.http.custom_response<br /><br />- envoy.filters.http.router<br /><br />Note: "envoy.filters.http.router" cannot be reordered, it's always the last filter in the chain. |
 | `backendTLS` | _[BackendTLSConfig](#backendtlsconfig)_ |  false  | BackendTLS is the TLS configuration for the Envoy proxy to use when connecting to backends.<br />These settings are applied on backends for which TLS policies are specified. |
-| `ipFamily` | _[IPFamily](#ipfamily)_ |  false  | IPFamily specifies the IP family for the EnvoyProxy fleet.<br />This setting only affects the Gateway listener port and does not impact<br />other aspects of the Envoy proxy configuration.<br />If not specified, the system will operate as follows:<br />- It defaults to IPv4 only.<br />- IPv6 and dual-stack environments are not supported in this default configuration.<br />Note: To enable IPv6 or dual-stack functionality, explicit configuration is required. |
+| `ipFamily` | _[IPFamily](#ipfamily)_ |  false  | IPFamily specifies the IP family for the EnvoyProxy fleet.<br />This setting affects the DNS resolver for the EnvoyProxy fleet.<br /><br />- On IPv4 gateway, the DNS resolver will only perform a lookup for addresses in the IPv4 family.<br />- On IPv6 gateway, the DNS resolver will only perform a lookup for addresses in the IPv6 family.<br />- On DualStack gateway, the DNS resolver will perform a lookup for both IPv4 and IPv6 families.<br />- If unspecified, the DNS resolver will first perform a lookup for addresses in the IPv4 family<br />  and fallback to a lookup for addresses in the IPv6 family. |
 
 
 #### EnvoyProxyStatus