API Reference

103 minute read

Packages

gateway.envoyproxy.io/v1alpha1

gateway.envoyproxy.io/v1alpha1

Package v1alpha1 contains API schema definitions for the gateway.envoyproxy.io API group.

Resource Types

ALPNProtocol

Underlying type: string

ALPNProtocol specifies the protocol to be negotiated using ALPN

Appears in:

Value	Description
`http/1.0`	HTTPProtocolVersion1_0 specifies that HTTP/1.0 should be negotiable with ALPN
`http/1.1`	HTTPProtocolVersion1_1 specifies that HTTP/1.1 should be negotiable with ALPN
`h2`	HTTPProtocolVersion2 specifies that HTTP/2 should be negotiable with ALPN

ALSEnvoyProxyAccessLog

ALSEnvoyProxyAccessLog defines the gRPC Access Log Service (ALS) sink. The service must implement the Envoy gRPC Access Log Service streaming API: https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/accesslog/v3/als.proto Access log format information is passed in the form of gRPC metadata when the stream is established. Specifically, the following metadata is passed:

x-accesslog-text - The access log format string when a Text format is used.
x-accesslog-attr - JSON encoded key/value pairs when a JSON format is used.

Appears in:

ProxyAccessLogSink

Field	Type	Required	Description
`backendRef`	BackendObjectReference	false	BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.
`backendRefs`	BackendRef array	false	BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.
`backendSettings`	ClusterSettings	false	BackendSettings holds configuration for managing the connection to the backend.
`logName`	string	false	LogName defines the friendly name of the access log to be returned in StreamAccessLogsMessage.Identifier. This allows the access log server to differentiate between different access logs coming from the same Envoy.
`type`	ALSEnvoyProxyAccessLogType	true	Type defines the type of accesslog. Supported types are “HTTP” and “TCP”.
`http`	ALSEnvoyProxyHTTPAccessLogConfig	false	HTTP defines additional configuration specific to HTTP access logs.

ALSEnvoyProxyAccessLogType

Underlying type: string

Appears in:

ALSEnvoyProxyAccessLog

Value	Description
`HTTP`	ALSEnvoyProxyAccessLogTypeHTTP defines the HTTP access log type and will populate StreamAccessLogsMessage.http_logs.
`TCP`	ALSEnvoyProxyAccessLogTypeTCP defines the TCP access log type and will populate StreamAccessLogsMessage.tcp_logs.

ALSEnvoyProxyHTTPAccessLogConfig

Appears in:

ALSEnvoyProxyAccessLog

Field	Type	Required	Description
`requestHeaders`	string array	false	RequestHeaders defines request headers to include in log entries sent to the access log service.
`responseHeaders`	string array	false	ResponseHeaders defines response headers to include in log entries sent to the access log service.
`responseTrailers`	string array	false	ResponseTrailers defines response trailers to include in log entries sent to the access log service.

ActiveHealthCheck

ActiveHealthCheck defines the active health check configuration. EG supports various types of active health checking including HTTP, TCP.

Appears in:

HealthCheck

Field	Type	Required	Description
`timeout`	Duration	false	Timeout defines the time to wait for a health check response.
`interval`	Duration	false	Interval defines the time between active health checks.
`unhealthyThreshold`	integer	false	UnhealthyThreshold defines the number of unhealthy health checks required before a backend host is marked unhealthy.
`healthyThreshold`	integer	false	HealthyThreshold defines the number of healthy health checks required before a backend host is marked healthy.
`type`	ActiveHealthCheckerType	true	Type defines the type of health checker.
`http`	HTTPActiveHealthChecker	false	HTTP defines the configuration of http health checker. It’s required while the health checker type is HTTP.
`tcp`	TCPActiveHealthChecker	false	TCP defines the configuration of tcp health checker. It’s required while the health checker type is TCP.
`grpc`	GRPCActiveHealthChecker	false	GRPC defines the configuration of the GRPC health checker. It’s optional, and can only be used if the specified type is GRPC.

ActiveHealthCheckPayload

ActiveHealthCheckPayload defines the encoding of the payload bytes in the payload.

Appears in:

Field	Type	Required	Description
`type`	ActiveHealthCheckPayloadType	true	Type defines the type of the payload.
`text`	string	false	Text payload in plain text.
`binary`	integer array	false	Binary payload base64 encoded.

ActiveHealthCheckPayloadType

Underlying type: string

ActiveHealthCheckPayloadType is the type of the payload.

Appears in:

ActiveHealthCheckPayload

Value	Description
`Text`	ActiveHealthCheckPayloadTypeText defines the Text type payload.
`Binary`	ActiveHealthCheckPayloadTypeBinary defines the Binary type payload.

ActiveHealthCheckerType

Underlying type: string

ActiveHealthCheckerType is the type of health checker.

Appears in:

ActiveHealthCheck

Value	Description
`HTTP`	ActiveHealthCheckerTypeHTTP defines the HTTP type of health checking.
`TCP`	ActiveHealthCheckerTypeTCP defines the TCP type of health checking.
`GRPC`	ActiveHealthCheckerTypeGRPC defines the GRPC type of health checking.

AppProtocolType

Underlying type: string

AppProtocolType defines various backend applications protocols supported by Envoy Gateway

Appears in:

BackendSpec

Value	Description
`gateway.envoyproxy.io/h2c`	AppProtocolTypeH2C defines the HTTP/2 application protocol.
`gateway.envoyproxy.io/ws`	AppProtocolTypeWS defines the WebSocket over HTTP protocol.
`gateway.envoyproxy.io/wss`	AppProtocolTypeWSS defines the WebSocket over HTTPS protocol.

Authorization

Authorization defines the authorization configuration.

Note: if neither Rules nor DefaultAction is specified, the default action is to deny all requests.

Appears in:

SecurityPolicySpec

Field	Type	Required	Description
`rules`	AuthorizationRule array	false	Rules defines a list of authorization rules. These rules are evaluated in order, the first matching rule will be applied, and the rest will be skipped. For example, if there are two rules: the first rule allows the request and the second rule denies it, when a request matches both rules, it will be allowed.
`defaultAction`	AuthorizationAction	false	DefaultAction defines the default action to be taken if no rules match. If not specified, the default action is Deny.

AuthorizationAction

Underlying type: string

AuthorizationAction defines the action to be taken if a rule matches.

Appears in:

Value	Description
`Allow`	AuthorizationActionAllow is the action to allow the request.
`Deny`	AuthorizationActionDeny is the action to deny the request.

AuthorizationRule

AuthorizationRule defines a single authorization rule.

Appears in:

Authorization

Field	Type	Required	Description
`name`	string	false	Name is a user-friendly name for the rule. If not specified, Envoy Gateway will generate a unique name for the rule.
`action`	AuthorizationAction	true	Action defines the action to be taken if the rule matches.
`principal`	Principal	true	Principal specifies the client identity of a request. If there are multiple principal types, all principals must match for the rule to match. For example, if there are two principals: one for client IP and one for JWT claim, the rule will match only if both the client IP and the JWT claim match.

BackOffPolicy

Appears in:

PerRetryPolicy

Field	Type	Required	Description
`baseInterval`	Duration	true	BaseInterval is the base interval between retries.
`maxInterval`	Duration	false	MaxInterval is the maximum interval between retries. This parameter is optional, but must be greater than or equal to the base_interval if set. The default is 10 times the base_interval

Backend

Backend allows the user to configure the endpoints of a backend and the behavior of the connection from Envoy Proxy to the backend.

Field	Type	Required	Description
`apiVersion`	string		`gateway.envoyproxy.io/v1alpha1`
`kind`	string		`Backend`
`metadata`	ObjectMeta	true	Refer to Kubernetes API documentation for fields of `metadata`.
`spec`	BackendSpec	true	Spec defines the desired state of Backend.
`status`	BackendStatus	true	Status defines the current status of Backend.

BackendCluster

BackendCluster contains all the configuration required for configuring access to a backend. This can include multiple endpoints, and settings that apply for managing the connection to all these endpoints.

Appears in:

Field	Type	Required	Description
`backendRef`	BackendObjectReference	false	BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.
`backendRefs`	BackendRef array	false	BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.
`backendSettings`	ClusterSettings	false	BackendSettings holds configuration for managing the connection to the backend.

BackendConnection

BackendConnection allows users to configure connection-level settings of backend

Appears in:

Field	Type	Required	Description
`bufferLimit`	Quantity	false	BufferLimit Soft limit on size of the cluster’s connections read and write buffers. BufferLimit applies to connection streaming (maybe non-streaming) channel between processes, it’s in user space. If unspecified, an implementation defined default is applied (32768 bytes). For example, 20Mi, 1Gi, 256Ki etc. Note: that when the suffix is not provided, the value is interpreted as bytes.

BackendEndpoint

BackendEndpoint describes a backend endpoint, which can be either a fully-qualified domain name, IP address or unix domain socket corresponding to Envoy’s Address: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/address.proto#config-core-v3-address

Appears in:

Field	Type	Required	Description
`fqdn`	FQDNEndpoint	false	FQDN defines a FQDN endpoint
`ip`	IPEndpoint	false	IP defines an IP endpoint. Supports both IPv4 and IPv6 addresses.
`unix`	UnixSocket	false	Unix defines the unix domain socket endpoint

BackendRef

BackendRef defines how an ObjectReference that is specific to BackendRef.

Appears in:

Field	Type	Required	Description
`group`	Group	false	Group is the group of the referent. For example, “gateway.networking.k8s.io”. When unspecified or empty string, core API group is inferred.
`kind`	Kind	false	Kind is the Kubernetes resource kind of the referent. For example “Service”. Defaults to “Service” when not specified. ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services. Support: Core (Services with a type other than ExternalName) Support: Implementation-specific (Services with type ExternalName)
`name`	ObjectName	true	Name is the name of the referent.
`namespace`	Namespace	false	Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace’s owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core
`port`	PortNumber	false	Port specifies the destination port number to use for this resource. Port is required when the referent is a Kubernetes Service. In this case, the port number is the service port number, not the target port. For other resources, destination port might be derived from the referent resource or this field.
`fallback`	boolean	false	Fallback indicates whether the backend is designated as a fallback. Multiple fallback backends can be configured. It is highly recommended to configure active or passive health checks to ensure that failover can be detected when the active backends become unhealthy and to automatically readjust once the primary backends are healthy again. The overprovisioning factor is set to 1.4, meaning the fallback backends will only start receiving traffic when the health of the active backends falls below 72%.

BackendSpec

BackendSpec describes the desired state of BackendSpec.

Appears in:

Backend

Field	Type	Required	Description
`endpoints`	BackendEndpoint array	true	Endpoints defines the endpoints to be used when connecting to the backend.
`appProtocols`	AppProtocolType array	false	AppProtocols defines the application protocols to be supported when connecting to the backend.
`fallback`	boolean	false	Fallback indicates whether the backend is designated as a fallback. It is highly recommended to configure active or passive health checks to ensure that failover can be detected when the active backends become unhealthy and to automatically readjust once the primary backends are healthy again. The overprovisioning factor is set to 1.4, meaning the fallback backends will only start receiving traffic when the health of the active backends falls below 72%.

BackendStatus

BackendStatus defines the state of Backend

Appears in:

Backend

Field	Type	Required	Description
`conditions`	Condition array	false	Conditions describe the current conditions of the Backend.

BackendTLSConfig

BackendTLSConfig describes the BackendTLS configuration for Envoy Proxy.

Appears in:

EnvoyProxySpec

Field	Type	Required	Description
`clientCertificateRef`	SecretObjectReference	false	ClientCertificateRef defines the reference to a Kubernetes Secret that contains the client certificate and private key for Envoy to use when connecting to backend services and external services, such as ExtAuth, ALS, OpenTelemetry, etc. This secret should be located within the same namespace as the Envoy proxy resource that references it.
`minVersion`	TLSVersion	false	Min specifies the minimal TLS protocol version to allow. The default is TLS 1.2 if this is not specified.
`maxVersion`	TLSVersion	false	Max specifies the maximal TLS protocol version to allow The default is TLS 1.3 if this is not specified.
`ciphers`	string array	false	Ciphers specifies the set of cipher suites supported when negotiating TLS 1.0 - 1.2. This setting has no effect for TLS 1.3. In non-FIPS Envoy Proxy builds the default cipher list is: - [ECDHE-ECDSA-AES128-GCM-SHA256\|ECDHE-ECDSA-CHACHA20-POLY1305] - [ECDHE-RSA-AES128-GCM-SHA256\|ECDHE-RSA-CHACHA20-POLY1305] - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 In builds using BoringSSL FIPS the default cipher list is: - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384
`ecdhCurves`	string array	false	ECDHCurves specifies the set of supported ECDH curves. In non-FIPS Envoy Proxy builds the default curves are: - X25519 - P-256 In builds using BoringSSL FIPS the default curve is: - P-256
`signatureAlgorithms`	string array	false	SignatureAlgorithms specifies which signature algorithms the listener should support.
`alpnProtocols`	ALPNProtocol array	false	ALPNProtocols supplies the list of ALPN protocols that should be exposed by the listener. By default h2 and http/1.1 are enabled. Supported values are: - http/1.0 - http/1.1 - h2

BackendTrafficPolicy

BackendTrafficPolicy allows the user to configure the behavior of the connection between the Envoy Proxy listener and the backend service.

Field	Type	Required	Description
`apiVersion`	string		`gateway.envoyproxy.io/v1alpha1`
`kind`	string		`BackendTrafficPolicy`
`metadata`	ObjectMeta	true	Refer to Kubernetes API documentation for fields of `metadata`.
`spec`	BackendTrafficPolicySpec	true	spec defines the desired state of BackendTrafficPolicy.
`status`	PolicyStatus	true	status defines the current status of BackendTrafficPolicy.

BackendTrafficPolicySpec

BackendTrafficPolicySpec defines the desired state of BackendTrafficPolicy.

Appears in:

BackendTrafficPolicy

Field	Type	Required	Description
`targetRef`	LocalPolicyTargetReferenceWithSectionName	true	TargetRef is the name of the resource this policy is being attached to. This policy and the TargetRef MUST be in the same namespace for this Policy to have effect Deprecated: use targetRefs/targetSelectors instead
`targetRefs`	LocalPolicyTargetReferenceWithSectionName array	true	TargetRefs are the names of the Gateway resources this policy is being attached to.
`targetSelectors`	TargetSelector array	true	TargetSelectors allow targeting resources for this policy based on labels
`loadBalancer`	LoadBalancer	false	LoadBalancer policy to apply when routing traffic from the gateway to the backend endpoints. Defaults to `LeastRequest`.
`retry`	Retry	false	Retry provides more advanced usage, allowing users to customize the number of retries, retry fallback strategy, and retry triggering conditions. If not set, retry will be disabled.
`proxyProtocol`	ProxyProtocol	false	ProxyProtocol enables the Proxy Protocol when communicating with the backend.
`tcpKeepalive`	TCPKeepalive	false	TcpKeepalive settings associated with the upstream client connection. Disabled by default.
`healthCheck`	HealthCheck	false	HealthCheck allows gateway to perform active health checking on backends.
`circuitBreaker`	CircuitBreaker	false	Circuit Breaker settings for the upstream connections and requests. If not set, circuit breakers will be enabled with the default thresholds
`timeout`	Timeout	false	Timeout settings for the backend connections.
`connection`	BackendConnection	false	Connection includes backend connection settings.
`dns`	DNS	false	DNS includes dns resolution settings.
`http2`	HTTP2Settings	false	HTTP2 provides HTTP/2 configuration for backend connections.
`rateLimit`	RateLimitSpec	false	RateLimit allows the user to limit the number of incoming requests to a predefined value based on attributes within the traffic flow.
`faultInjection`	FaultInjection	false	FaultInjection defines the fault injection policy to be applied. This configuration can be used to inject delays and abort requests to mimic failure scenarios such as service failures and overloads
`useClientProtocol`	boolean	false	UseClientProtocol configures Envoy to prefer sending requests to backends using the same HTTP protocol that the incoming request used. Defaults to false, which means that Envoy will use the protocol indicated by the attached BackendRef.
`responseOverride`	ResponseOverride array	false	ResponseOverride defines the configuration to override specific responses with a custom one. If multiple configurations are specified, the first one to match wins.

BasicAuth

BasicAuth defines the configuration for the HTTP Basic Authentication.

Appears in:

SecurityPolicySpec

Field	Type	Required	Description
`users`	SecretObjectReference	true	The Kubernetes secret which contains the username-password pairs in htpasswd format, used to verify user credentials in the “Authorization” header. This is an Opaque secret. The username-password pairs should be stored in the key “.htpasswd”. As the key name indicates, the value needs to be the htpasswd format, for example: “user1:{SHA}hashed_user1_password”. Right now, only SHA hash algorithm is supported. Reference to https://httpd.apache.org/docs/2.4/programs/htpasswd.html for more details. Note: The secret must be in the same namespace as the SecurityPolicy.

BootstrapType

Underlying type: string

BootstrapType defines the types of bootstrap supported by Envoy Gateway.

Appears in:

ProxyBootstrap

Value	Description
`Merge`	Merge merges the provided bootstrap with the default one. The provided bootstrap can add or override a value within a map, or add a new value to a list. Please note that the provided bootstrap can’t override a value within a list.
`Replace`	Replace replaces the default bootstrap with the provided one.
`JSONPatch`	JSONPatch applies the provided JSONPatches to the default bootstrap.

CIDR

Underlying type: string

CIDR defines a CIDR Address range. A CIDR can be an IPv4 address range such as “192.168.1.0/24” or an IPv6 address range such as “2001:0db8:11a3:09d7::/64”.

Appears in:

CORS

CORS defines the configuration for Cross-Origin Resource Sharing (CORS).

Appears in:

SecurityPolicySpec

Field	Type	Required	Description
`allowOrigins`	Origin array	false	AllowOrigins defines the origins that are allowed to make requests. It specifies the allowed origins in the Access-Control-Allow-Origin CORS response header. The value “*” allows any origin to make requests.
`allowMethods`	string array	false	AllowMethods defines the methods that are allowed to make requests. It specifies the allowed methods in the Access-Control-Allow-Methods CORS response header.. The value “*” allows any method to be used.
`allowHeaders`	string array	false	AllowHeaders defines the headers that are allowed to be sent with requests. It specifies the allowed headers in the Access-Control-Allow-Headers CORS response header.. The value “*” allows any header to be sent.
`exposeHeaders`	string array	false	ExposeHeaders defines which response headers should be made accessible to scripts running in the browser. It specifies the headers in the Access-Control-Expose-Headers CORS response header.. The value “*” allows any header to be exposed.
`maxAge`	Duration	false	MaxAge defines how long the results of a preflight request can be cached. It specifies the value in the Access-Control-Max-Age CORS response header..
`allowCredentials`	boolean	false	AllowCredentials indicates whether a request can include user credentials like cookies, authentication headers, or TLS client certificates. It specifies the value in the Access-Control-Allow-Credentials CORS response header.

CircuitBreaker

CircuitBreaker defines the Circuit Breaker configuration.

Appears in:

Field	Type	Required	Description
`maxConnections`	integer	false	The maximum number of connections that Envoy will establish to the referenced backend defined within a xRoute rule.
`maxPendingRequests`	integer	false	The maximum number of pending requests that Envoy will queue to the referenced backend defined within a xRoute rule.
`maxParallelRequests`	integer	false	The maximum number of parallel requests that Envoy will make to the referenced backend defined within a xRoute rule.
`maxParallelRetries`	integer	false	The maximum number of parallel retries that Envoy will make to the referenced backend defined within a xRoute rule.
`maxRequestsPerConnection`	integer	false	The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule. Default: unlimited.

ClaimToHeader

ClaimToHeader defines a configuration to convert JWT claims into HTTP headers

Appears in:

JWTProvider

Field	Type	Required	Description
`header`	string	true	Header defines the name of the HTTP request header that the JWT Claim will be saved into.
`claim`	string	true	Claim is the JWT Claim that should be saved into the header : it can be a nested claim of type (eg. “claim.nested.key”, “sub”). The nested claim name must use dot “." to separate the JSON name path.

ClientConnection

ClientConnection allows users to configure connection-level settings of client

Appears in:

ClientTrafficPolicySpec

Field	Type	Required	Description
`connectionLimit`	ConnectionLimit	false	ConnectionLimit defines limits related to connections
`bufferLimit`	Quantity	false	BufferLimit provides configuration for the maximum buffer size in bytes for each incoming connection. BufferLimit applies to connection streaming (maybe non-streaming) channel between processes, it’s in user space. For example, 20Mi, 1Gi, 256Ki etc. Note that when the suffix is not provided, the value is interpreted as bytes. Default: 32768 bytes.

ClientIPDetectionSettings

ClientIPDetectionSettings provides configuration for determining the original client IP address for requests.

Appears in:

ClientTrafficPolicySpec

Field	Type	Required	Description
`xForwardedFor`	XForwardedForSettings	false	XForwardedForSettings provides configuration for using X-Forwarded-For headers for determining the client IP address.
`customHeader`	CustomHeaderExtensionSettings	false	CustomHeader provides configuration for determining the client IP address for a request based on a trusted custom HTTP header. This uses the custom_header original IP detection extension. Refer to https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/http/original_ip_detection/custom_header/v3/custom_header.proto for more details.

ClientTLSSettings

Appears in:

ClientTrafficPolicySpec

Field	Type	Required	Description
`clientValidation`	ClientValidationContext	false	ClientValidation specifies the configuration to validate the client initiating the TLS connection to the Gateway listener.
`minVersion`	TLSVersion	false	Min specifies the minimal TLS protocol version to allow. The default is TLS 1.2 if this is not specified.
`maxVersion`	TLSVersion	false	Max specifies the maximal TLS protocol version to allow The default is TLS 1.3 if this is not specified.
`ciphers`	string array	false	Ciphers specifies the set of cipher suites supported when negotiating TLS 1.0 - 1.2. This setting has no effect for TLS 1.3. In non-FIPS Envoy Proxy builds the default cipher list is: - [ECDHE-ECDSA-AES128-GCM-SHA256\|ECDHE-ECDSA-CHACHA20-POLY1305] - [ECDHE-RSA-AES128-GCM-SHA256\|ECDHE-RSA-CHACHA20-POLY1305] - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 In builds using BoringSSL FIPS the default cipher list is: - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384
`ecdhCurves`	string array	false	ECDHCurves specifies the set of supported ECDH curves. In non-FIPS Envoy Proxy builds the default curves are: - X25519 - P-256 In builds using BoringSSL FIPS the default curve is: - P-256
`signatureAlgorithms`	string array	false	SignatureAlgorithms specifies which signature algorithms the listener should support.
`alpnProtocols`	ALPNProtocol array	false	ALPNProtocols supplies the list of ALPN protocols that should be exposed by the listener. By default h2 and http/1.1 are enabled. Supported values are: - http/1.0 - http/1.1 - h2
`session`	Session	false	Session defines settings related to TLS session management.

ClientTimeout

Appears in:

ClientTrafficPolicySpec

Field	Type	Required	Description
`tcp`	TCPClientTimeout	false	Timeout settings for TCP.
`http`	HTTPClientTimeout	false	Timeout settings for HTTP.

ClientTrafficPolicy

ClientTrafficPolicy allows the user to configure the behavior of the connection between the downstream client and Envoy Proxy listener.

Field	Type	Required	Description
`apiVersion`	string		`gateway.envoyproxy.io/v1alpha1`
`kind`	string		`ClientTrafficPolicy`
`metadata`	ObjectMeta	true	Refer to Kubernetes API documentation for fields of `metadata`.
`spec`	ClientTrafficPolicySpec	true	Spec defines the desired state of ClientTrafficPolicy.
`status`	PolicyStatus	true	Status defines the current status of ClientTrafficPolicy.

ClientTrafficPolicySpec

ClientTrafficPolicySpec defines the desired state of ClientTrafficPolicy.

Appears in:

ClientTrafficPolicy

Field	Type	Required	Description
`targetRef`	LocalPolicyTargetReferenceWithSectionName	true	TargetRef is the name of the resource this policy is being attached to. This policy and the TargetRef MUST be in the same namespace for this Policy to have effect Deprecated: use targetRefs/targetSelectors instead
`targetRefs`	LocalPolicyTargetReferenceWithSectionName array	true	TargetRefs are the names of the Gateway resources this policy is being attached to.
`targetSelectors`	TargetSelector array	true	TargetSelectors allow targeting resources for this policy based on labels
`tcpKeepalive`	TCPKeepalive	false	TcpKeepalive settings associated with the downstream client connection. If defined, sets SO_KEEPALIVE on the listener socket to enable TCP Keepalives. Disabled by default.
`enableProxyProtocol`	boolean	false	EnableProxyProtocol interprets the ProxyProtocol header and adds the Client Address into the X-Forwarded-For header. Note Proxy Protocol must be present when this field is set, else the connection is closed.
`clientIPDetection`	ClientIPDetectionSettings	false	ClientIPDetectionSettings provides configuration for determining the original client IP address for requests.
`tls`	ClientTLSSettings	false	TLS settings configure TLS termination settings with the downstream client.
`path`	PathSettings	false	Path enables managing how the incoming path set by clients can be normalized.
`headers`	HeaderSettings	false	HeaderSettings provides configuration for header management.
`timeout`	ClientTimeout	false	Timeout settings for the client connections.
`connection`	ClientConnection	false	Connection includes client connection settings.
`http1`	HTTP1Settings	false	HTTP1 provides HTTP/1 configuration on the listener.
`http2`	HTTP2Settings	false	HTTP2 provides HTTP/2 configuration on the listener.
`http3`	HTTP3Settings	false	HTTP3 provides HTTP/3 configuration on the listener.
`healthCheck`	HealthCheckSettings	false	HealthCheck provides configuration for determining whether the HTTP/HTTPS listener is healthy.

ClientValidationContext

ClientValidationContext holds configuration that can be used to validate the client initiating the TLS connection to the Gateway. By default, no client specific configuration is validated.

Appears in:

ClientTLSSettings

Field	Type	Required	Description
`optional`	boolean	false	Optional set to true accepts connections even when a client doesn’t present a certificate. Defaults to false, which rejects connections without a valid client certificate.
`caCertificateRefs`	SecretObjectReference array	false	CACertificateRefs contains one or more references to Kubernetes objects that contain TLS certificates of the Certificate Authorities that can be used as a trust anchor to validate the certificates presented by the client. A single reference to a Kubernetes ConfigMap or a Kubernetes Secret, with the CA certificate in a key named `ca.crt` is currently supported. References to a resource in different namespace are invalid UNLESS there is a ReferenceGrant in the target namespace that allows the certificate to be attached.

ClusterSettings

ClusterSettings provides the various knobs that can be set to control how traffic to a given backend will be configured.

Appears in:

Field	Type	Required	Description
`loadBalancer`	LoadBalancer	false	LoadBalancer policy to apply when routing traffic from the gateway to the backend endpoints. Defaults to `LeastRequest`.
`retry`	Retry	false	Retry provides more advanced usage, allowing users to customize the number of retries, retry fallback strategy, and retry triggering conditions. If not set, retry will be disabled.
`proxyProtocol`	ProxyProtocol	false	ProxyProtocol enables the Proxy Protocol when communicating with the backend.
`tcpKeepalive`	TCPKeepalive	false	TcpKeepalive settings associated with the upstream client connection. Disabled by default.
`healthCheck`	HealthCheck	false	HealthCheck allows gateway to perform active health checking on backends.
`circuitBreaker`	CircuitBreaker	false	Circuit Breaker settings for the upstream connections and requests. If not set, circuit breakers will be enabled with the default thresholds
`timeout`	Timeout	false	Timeout settings for the backend connections.
`connection`	BackendConnection	false	Connection includes backend connection settings.
`dns`	DNS	false	DNS includes dns resolution settings.
`http2`	HTTP2Settings	false	HTTP2 provides HTTP/2 configuration for backend connections.

Compression

Compression defines the config of enabling compression. This can help reduce the bandwidth at the expense of higher CPU.

Appears in:

Field	Type	Required	Description
`type`	CompressorType	true	CompressorType defines the compressor type to use for compression.
`gzip`	GzipCompressor	false	The configuration for GZIP compressor.

CompressorType

Underlying type: string

CompressorType defines the types of compressor library supported by Envoy Gateway.

Appears in:

Compression

ConnectionLimit

Appears in:

ClientConnection

Field	Type	Required	Description
`value`	integer	true	Value of the maximum concurrent connections limit. When the limit is reached, incoming connections will be closed after the CloseDelay duration.
`closeDelay`	Duration	false	CloseDelay defines the delay to use before closing connections that are rejected once the limit value is reached. Default: none.

ConsistentHash

ConsistentHash defines the configuration related to the consistent hash load balancer policy.

Appears in:

LoadBalancer

Field	Type	Required	Description
`type`	ConsistentHashType	true	ConsistentHashType defines the type of input to hash on. Valid Type values are “SourceIP”, “Header”, “Cookie”.
`header`	Header	false	Header configures the header hash policy when the consistent hash type is set to Header.
`cookie`	Cookie	false	Cookie configures the cookie hash policy when the consistent hash type is set to Cookie.
`tableSize`	integer	false	The table size for consistent hashing, must be prime number limited to 5000011.

ConsistentHashType

Underlying type: string

ConsistentHashType defines the type of input to hash on.

Appears in:

ConsistentHash

Value	Description
`SourceIP`	SourceIPConsistentHashType hashes based on the source IP address.
`Header`	HeaderConsistentHashType hashes based on a request header.
`Cookie`	CookieConsistentHashType hashes based on a cookie.

Cookie defines the cookie hashing configuration for consistent hash based load balancing.

Appears in:

ConsistentHash

Field	Type	Required	Description
`name`	string	true	Name of the cookie to hash. If this cookie does not exist in the request, Envoy will generate a cookie and set the TTL on the response back to the client based on Layer 4 attributes of the backend endpoint, to ensure that these future requests go to the same backend endpoint. Make sure to set the TTL field for this case.
`ttl`	Duration	false	TTL of the generated cookie if the cookie is not present. This value sets the Max-Age attribute value.
`attributes`	object (keys:string, values:string)	false	Additional Attributes to set for the generated cookie.

CustomHeaderExtensionSettings

CustomHeaderExtensionSettings provides configuration for determining the client IP address for a request based on a trusted custom HTTP header. This uses the the custom_header original IP detection extension. Refer to https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/http/original_ip_detection/custom_header/v3/custom_header.proto for more details.

Appears in:

ClientIPDetectionSettings

Field	Type	Required	Description
`name`	string	true	Name of the header containing the original downstream remote address, if present.
`failClosed`	boolean	false	FailClosed is a switch used to control the flow of traffic when client IP detection fails. If set to true, the listener will respond with 403 Forbidden when the client IP address cannot be determined.

CustomResponse

CustomResponse defines the configuration for returning a custom response.

Appears in:

ResponseOverride

Field	Type	Required	Description
`contentType`	string	false	Content Type of the response. This will be set in the Content-Type header.
`body`	CustomResponseBody	true	Body of the Custom Response

CustomResponseBody

Appears in:

Field	Type	Required	Description
`type`	ResponseValueType	true	Type is the type of method to use to read the body value. Valid values are Inline and ValueRef, default is Inline.
`inline`	string	false	Inline contains the value as an inline string.
`valueRef`	LocalObjectReference	false	ValueRef contains the contents of the body specified as a local object reference. Only a reference to ConfigMap is supported. The value of key `response.body` in the ConfigMap will be used as the response body. If the key is not found, the first value in the ConfigMap will be used.

CustomResponseMatch

CustomResponseMatch defines the configuration for matching a user response to return a custom one.

Appears in:

ResponseOverride

Field	Type	Required	Description
`statusCodes`	StatusCodeMatch array	true	Status code to match on. The match evaluates to true if any of the matches are successful.

CustomTag

Appears in:

ProxyTracing

Field	Type	Required	Description
`type`	CustomTagType	true	Type defines the type of custom tag.
`literal`	LiteralCustomTag	true	Literal adds hard-coded value to each span. It’s required when the type is “Literal”.
`environment`	EnvironmentCustomTag	true	Environment adds value from environment variable to each span. It’s required when the type is “Environment”.
`requestHeader`	RequestHeaderCustomTag	true	RequestHeader adds value from request header to each span. It’s required when the type is “RequestHeader”.

CustomTagType

Underlying type: string

Appears in:

CustomTag

Value	Description
`Literal`	CustomTagTypeLiteral adds hard-coded value to each span.
`Environment`	CustomTagTypeEnvironment adds value from environment variable to each span.
`RequestHeader`	CustomTagTypeRequestHeader adds value from request header to each span.

DNS

Appears in:

Field	Type	Required	Description
`dnsRefreshRate`	Duration	true	DNSRefreshRate specifies the rate at which DNS records should be refreshed. Defaults to 30 seconds.
`respectDnsTtl`	boolean	true	RespectDNSTTL indicates whether the DNS Time-To-Live (TTL) should be respected. If the value is set to true, the DNS refresh rate will be set to the resource record’s TTL. Defaults to true.

EnvironmentCustomTag

EnvironmentCustomTag adds value from environment variable to each span.

Appears in:

CustomTag

Field	Type	Required	Description
`name`	string	true	Name defines the name of the environment variable which to extract the value from.
`defaultValue`	string	false	DefaultValue defines the default value to use if the environment variable is not set.

EnvoyExtensionPolicy

EnvoyExtensionPolicy allows the user to configure various envoy extensibility options for the Gateway.

Field	Type	Required	Description
`apiVersion`	string		`gateway.envoyproxy.io/v1alpha1`
`kind`	string		`EnvoyExtensionPolicy`
`metadata`	ObjectMeta	true	Refer to Kubernetes API documentation for fields of `metadata`.
`spec`	EnvoyExtensionPolicySpec	true	Spec defines the desired state of EnvoyExtensionPolicy.
`status`	PolicyStatus	true	Status defines the current status of EnvoyExtensionPolicy.

EnvoyExtensionPolicySpec

EnvoyExtensionPolicySpec defines the desired state of EnvoyExtensionPolicy.

Appears in:

EnvoyExtensionPolicy

Field	Type	Required	Description
`targetRef`	LocalPolicyTargetReferenceWithSectionName	true	TargetRef is the name of the resource this policy is being attached to. This policy and the TargetRef MUST be in the same namespace for this Policy to have effect Deprecated: use targetRefs/targetSelectors instead
`targetRefs`	LocalPolicyTargetReferenceWithSectionName array	true	TargetRefs are the names of the Gateway resources this policy is being attached to.
`targetSelectors`	TargetSelector array	true	TargetSelectors allow targeting resources for this policy based on labels
`wasm`	Wasm array	false	Wasm is a list of Wasm extensions to be loaded by the Gateway. Order matters, as the extensions will be loaded in the order they are defined in this list.
`extProc`	ExtProc array	false	ExtProc is an ordered list of external processing filters that should added to the envoy filter chain

EnvoyFilter

Underlying type: string

EnvoyFilter defines the type of Envoy HTTP filter.

Appears in:

FilterPosition

Value	Description
`envoy.filters.http.health_check`	EnvoyFilterHealthCheck defines the Envoy HTTP health check filter.
`envoy.filters.http.fault`	EnvoyFilterFault defines the Envoy HTTP fault filter.
`envoy.filters.http.cors`	EnvoyFilterCORS defines the Envoy HTTP CORS filter.
`envoy.filters.http.ext_authz`	EnvoyFilterExtAuthz defines the Envoy HTTP external authorization filter.
`envoy.filters.http.basic_auth`	EnvoyFilterBasicAuth defines the Envoy HTTP basic authentication filter.
`envoy.filters.http.oauth2`	EnvoyFilterOAuth2 defines the Envoy HTTP OAuth2 filter.
`envoy.filters.http.jwt_authn`	EnvoyFilterJWTAuthn defines the Envoy HTTP JWT authentication filter.
`envoy.filters.http.stateful_session`	EnvoyFilterSessionPersistence defines the Envoy HTTP session persistence filter.
`envoy.filters.http.ext_proc`	EnvoyFilterExtProc defines the Envoy HTTP external process filter.
`envoy.filters.http.wasm`	EnvoyFilterWasm defines the Envoy HTTP WebAssembly filter.
`envoy.filters.http.rbac`	EnvoyFilterRBAC defines the Envoy RBAC filter.
`envoy.filters.http.local_ratelimit`	EnvoyFilterLocalRateLimit defines the Envoy HTTP local rate limit filter.
`envoy.filters.http.ratelimit`	EnvoyFilterRateLimit defines the Envoy HTTP rate limit filter.
`envoy.filters.http.custom_response`	EnvoyFilterCustomResponse defines the Envoy HTTP custom response filter.
`envoy.filters.http.router`	EnvoyFilterRouter defines the Envoy HTTP router filter.

EnvoyGateway

EnvoyGateway is the schema for the envoygateways API.

Field	Type	Required	Description
`apiVersion`	string		`gateway.envoyproxy.io/v1alpha1`
`kind`	string		`EnvoyGateway`
`gateway`	Gateway	false	Gateway defines desired Gateway API specific configuration. If unset, default configuration parameters will apply.
`provider`	EnvoyGatewayProvider	false	Provider defines the desired provider and provider-specific configuration. If unspecified, the Kubernetes provider is used with default configuration parameters.
`logging`	EnvoyGatewayLogging	false	Logging defines logging parameters for Envoy Gateway.
`admin`	EnvoyGatewayAdmin	false	Admin defines the desired admin related abilities. If unspecified, the Admin is used with default configuration parameters.
`telemetry`	EnvoyGatewayTelemetry	false	Telemetry defines the desired control plane telemetry related abilities. If unspecified, the telemetry is used with default configuration.
`rateLimit`	RateLimit	false	RateLimit defines the configuration associated with the Rate Limit service deployed by Envoy Gateway required to implement the Global Rate limiting functionality. The specific rate limit service used here is the reference implementation in Envoy. For more details visit https://github.com/envoyproxy/ratelimit. This configuration is unneeded for “Local” rate limiting.
`extensionManager`	ExtensionManager	false	ExtensionManager defines an extension manager to register for the Envoy Gateway Control Plane.
`extensionApis`	ExtensionAPISettings	false	ExtensionAPIs defines the settings related to specific Gateway API Extensions implemented by Envoy Gateway

EnvoyGatewayAdmin

EnvoyGatewayAdmin defines the Envoy Gateway Admin configuration.

Appears in:

Field	Type	Required	Description
`address`	EnvoyGatewayAdminAddress	false	Address defines the address of Envoy Gateway Admin Server.
`enableDumpConfig`	boolean	false	EnableDumpConfig defines if enable dump config in Envoy Gateway logs.
`enablePprof`	boolean	false	EnablePprof defines if enable pprof in Envoy Gateway Admin Server.

EnvoyGatewayAdminAddress

EnvoyGatewayAdminAddress defines the Envoy Gateway Admin Address configuration.

Appears in:

EnvoyGatewayAdmin

Field	Type	Required	Description
`port`	integer	false	Port defines the port the admin server is exposed on.
`host`	string	false	Host defines the admin server hostname.

EnvoyGatewayCustomProvider

EnvoyGatewayCustomProvider defines configuration for the Custom provider.

Appears in:

EnvoyGatewayProvider

Field	Type	Required	Description
`resource`	EnvoyGatewayResourceProvider	true	Resource defines the desired resource provider. This provider is used to specify the provider to be used to retrieve the resource configurations such as Gateway API resources
`infrastructure`	EnvoyGatewayInfrastructureProvider	false	Infrastructure defines the desired infrastructure provider. This provider is used to specify the provider to be used to provide an environment to deploy the out resources like the Envoy Proxy data plane. Infrastructure is optional, if provider is not specified, No infrastructure provider is available.

EnvoyGatewayFileResourceProvider

EnvoyGatewayFileResourceProvider defines configuration for the File Resource provider.

Appears in:

EnvoyGatewayResourceProvider

Field	Type	Required	Description
`paths`	string array	true	Paths are the paths to a directory or file containing the resource configuration. Recursive subdirectories are not currently supported.

EnvoyGatewayHostInfrastructureProvider

EnvoyGatewayHostInfrastructureProvider defines configuration for the Host Infrastructure provider.

Appears in:

EnvoyGatewayInfrastructureProvider

EnvoyGatewayInfrastructureProvider

EnvoyGatewayInfrastructureProvider defines configuration for the Custom Infrastructure provider.

Appears in:

EnvoyGatewayCustomProvider

Field	Type	Required	Description
`type`	InfrastructureProviderType	true	Type is the type of infrastructure providers to use. Supported types are “Host”.
`host`	EnvoyGatewayHostInfrastructureProvider	false	Host defines the configuration of the Host provider. Host provides runtime deployment of the data plane as a child process on the host environment.

EnvoyGatewayKubernetesProvider

EnvoyGatewayKubernetesProvider defines configuration for the Kubernetes provider.

Appears in:

EnvoyGatewayProvider

Field	Type	Required	Description
`rateLimitDeployment`	KubernetesDeploymentSpec	false	RateLimitDeployment defines the desired state of the Envoy ratelimit deployment resource. If unspecified, default settings for the managed Envoy ratelimit deployment resource are applied.
`watch`	KubernetesWatchMode	false	Watch holds configuration of which input resources should be watched and reconciled.
`deploy`	KubernetesDeployMode	false	Deploy holds configuration of how output managed resources such as the Envoy Proxy data plane should be deployed
`overwriteControlPlaneCerts`	boolean	false	OverwriteControlPlaneCerts updates the secrets containing the control plane certs, when set.
`leaderElection`	LeaderElection	false	LeaderElection specifies the configuration for leader election. If it’s not set up, leader election will be active by default, using Kubernetes’ standard settings.
`shutdownManager`	ShutdownManager	false	ShutdownManager defines the configuration for the shutdown manager.

EnvoyGatewayLogComponent

Underlying type: string

EnvoyGatewayLogComponent defines a component that supports a configured logging level.

Appears in:

EnvoyGatewayLogging

Value	Description
`default`	LogComponentGatewayDefault defines the “default”-wide logging component. When specified, all other logging components are ignored.
`provider`	LogComponentProviderRunner defines the “provider” runner component.
`gateway-api`	LogComponentGatewayAPIRunner defines the “gateway-api” runner component.
`xds-translator`	LogComponentXdsTranslatorRunner defines the “xds-translator” runner component.
`xds-server`	LogComponentXdsServerRunner defines the “xds-server” runner component.
`infrastructure`	LogComponentInfrastructureRunner defines the “infrastructure” runner component.
`global-ratelimit`	LogComponentGlobalRateLimitRunner defines the “global-ratelimit” runner component.

EnvoyGatewayLogging

EnvoyGatewayLogging defines logging for Envoy Gateway.

Appears in:

Field	Type	Required	Description
`level`	object (keys:EnvoyGatewayLogComponent, values:LogLevel)	true	Level is the logging level. If unspecified, defaults to “info”. EnvoyGatewayLogComponent options: default/provider/gateway-api/xds-translator/xds-server/infrastructure/global-ratelimit. LogLevel options: debug/info/error/warn.

EnvoyGatewayMetricSink

EnvoyGatewayMetricSink defines control plane metric sinks where metrics are sent to.

Appears in:

EnvoyGatewayMetrics

Field	Type	Required	Description
`type`	MetricSinkType	true	Type defines the metric sink type. EG control plane currently supports OpenTelemetry.
`openTelemetry`	EnvoyGatewayOpenTelemetrySink	true	OpenTelemetry defines the configuration for OpenTelemetry sink. It’s required if the sink type is OpenTelemetry.

EnvoyGatewayMetrics

EnvoyGatewayMetrics defines control plane push/pull metrics configurations.

Appears in:

EnvoyGatewayTelemetry

Field	Type	Required	Description
`sinks`	EnvoyGatewayMetricSink array	true	Sinks defines the metric sinks where metrics are sent to.
`prometheus`	EnvoyGatewayPrometheusProvider	true	Prometheus defines the configuration for prometheus endpoint.

EnvoyGatewayOpenTelemetrySink

Appears in:

EnvoyGatewayMetricSink

Field	Type	Required	Description
`host`	string	true	Host define the sink service hostname.
`protocol`	string	true	Protocol define the sink service protocol.
`port`	integer	false	Port defines the port the sink service is exposed on.
`exportInterval`	Duration	true	ExportInterval configures the intervening time between exports for a Sink. This option overrides any value set for the OTEL_METRIC_EXPORT_INTERVAL environment variable. If ExportInterval is less than or equal to zero, 60 seconds is used as the default.
`exportTimeout`	Duration	true	ExportTimeout configures the time a Sink waits for an export to complete before canceling it. This option overrides any value set for the OTEL_METRIC_EXPORT_TIMEOUT environment variable. If ExportTimeout is less than or equal to zero, 30 seconds is used as the default.

EnvoyGatewayPrometheusProvider

EnvoyGatewayPrometheusProvider will expose prometheus endpoint in pull mode.

Appears in:

EnvoyGatewayMetrics

Field	Type	Required	Description
`disable`	boolean	true	Disable defines if disables the prometheus metrics in pull mode.

EnvoyGatewayProvider

EnvoyGatewayProvider defines the desired configuration of a provider.

Appears in:

Field	Type	Required	Description
`type`	ProviderType	true	Type is the type of provider to use. Supported types are “Kubernetes”, “Custom”.
`kubernetes`	EnvoyGatewayKubernetesProvider	false	Kubernetes defines the configuration of the Kubernetes provider. Kubernetes provides runtime configuration via the Kubernetes API.
`custom`	EnvoyGatewayCustomProvider	false	Custom defines the configuration for the Custom provider. This provider allows you to define a specific resource provider and an infrastructure provider.

EnvoyGatewayResourceProvider

EnvoyGatewayResourceProvider defines configuration for the Custom Resource provider.

Appears in:

EnvoyGatewayCustomProvider

Field	Type	Required	Description
`type`	ResourceProviderType	true	Type is the type of resource provider to use. Supported types are “File”.
`file`	EnvoyGatewayFileResourceProvider	false	File defines the configuration of the File provider. File provides runtime configuration defined by one or more files.

EnvoyGatewaySpec

EnvoyGatewaySpec defines the desired state of Envoy Gateway.

Appears in:

EnvoyGateway

Field	Type	Required	Description
`gateway`	Gateway	false	Gateway defines desired Gateway API specific configuration. If unset, default configuration parameters will apply.
`provider`	EnvoyGatewayProvider	false	Provider defines the desired provider and provider-specific configuration. If unspecified, the Kubernetes provider is used with default configuration parameters.
`logging`	EnvoyGatewayLogging	false	Logging defines logging parameters for Envoy Gateway.
`admin`	EnvoyGatewayAdmin	false	Admin defines the desired admin related abilities. If unspecified, the Admin is used with default configuration parameters.
`telemetry`	EnvoyGatewayTelemetry	false	Telemetry defines the desired control plane telemetry related abilities. If unspecified, the telemetry is used with default configuration.
`rateLimit`	RateLimit	false	RateLimit defines the configuration associated with the Rate Limit service deployed by Envoy Gateway required to implement the Global Rate limiting functionality. The specific rate limit service used here is the reference implementation in Envoy. For more details visit https://github.com/envoyproxy/ratelimit. This configuration is unneeded for “Local” rate limiting.
`extensionManager`	ExtensionManager	false	ExtensionManager defines an extension manager to register for the Envoy Gateway Control Plane.
`extensionApis`	ExtensionAPISettings	false	ExtensionAPIs defines the settings related to specific Gateway API Extensions implemented by Envoy Gateway

EnvoyGatewayTelemetry

EnvoyGatewayTelemetry defines telemetry configurations for envoy gateway control plane. Control plane will focus on metrics observability telemetry and tracing telemetry later.

Appears in:

Field	Type	Required	Description
`metrics`	EnvoyGatewayMetrics	true	Metrics defines metrics configuration for envoy gateway.

EnvoyJSONPatchConfig

EnvoyJSONPatchConfig defines the configuration for patching a Envoy xDS Resource using JSONPatch semantic

Appears in:

EnvoyPatchPolicySpec

Field	Type	Required	Description
`type`	EnvoyResourceType	true	Type is the typed URL of the Envoy xDS Resource
`name`	string	true	Name is the name of the resource
`operation`	JSONPatchOperation	true	Patch defines the JSON Patch Operation

EnvoyPatchPolicy

EnvoyPatchPolicy allows the user to modify the generated Envoy xDS resources by Envoy Gateway using this patch API

Field	Type	Required	Description
`apiVersion`	string		`gateway.envoyproxy.io/v1alpha1`
`kind`	string		`EnvoyPatchPolicy`
`metadata`	ObjectMeta	true	Refer to Kubernetes API documentation for fields of `metadata`.
`spec`	EnvoyPatchPolicySpec	true	Spec defines the desired state of EnvoyPatchPolicy.
`status`	PolicyStatus	true	Status defines the current status of EnvoyPatchPolicy.

EnvoyPatchPolicySpec

EnvoyPatchPolicySpec defines the desired state of EnvoyPatchPolicy.

Appears in:

EnvoyPatchPolicy

Field	Type	Required	Description
`type`	EnvoyPatchType	true	Type decides the type of patch. Valid EnvoyPatchType values are “JSONPatch”.
`jsonPatches`	EnvoyJSONPatchConfig array	false	JSONPatch defines the JSONPatch configuration.
`targetRef`	LocalPolicyTargetReference	true	TargetRef is the name of the Gateway API resource this policy is being attached to. By default, attaching to Gateway is supported and when mergeGateways is enabled it should attach to GatewayClass. This Policy and the TargetRef MUST be in the same namespace for this Policy to have effect and be applied to the Gateway TargetRef
`priority`	integer	true	Priority of the EnvoyPatchPolicy. If multiple EnvoyPatchPolicies are applied to the same TargetRef, they will be applied in the ascending order of the priority i.e. int32.min has the highest priority and int32.max has the lowest priority. Defaults to 0.

EnvoyPatchType

Underlying type: string

EnvoyPatchType specifies the types of Envoy patching mechanisms.

Appears in:

EnvoyPatchPolicySpec

Value	Description
`JSONPatch`	JSONPatchEnvoyPatchType allows the user to patch the generated xDS resources using JSONPatch semantics. For more details on the semantics, please refer to https://datatracker.ietf.org/doc/html/rfc6902

EnvoyProxy

EnvoyProxy is the schema for the envoyproxies API.

Field	Type	Required	Description
`apiVersion`	string		`gateway.envoyproxy.io/v1alpha1`
`kind`	string		`EnvoyProxy`
`metadata`	ObjectMeta	true	Refer to Kubernetes API documentation for fields of `metadata`.
`spec`	EnvoyProxySpec	true	EnvoyProxySpec defines the desired state of EnvoyProxy.
`status`	EnvoyProxyStatus	true	EnvoyProxyStatus defines the actual state of EnvoyProxy.

EnvoyProxyKubernetesProvider

EnvoyProxyKubernetesProvider defines configuration for the Kubernetes resource provider.

Appears in:

EnvoyProxyProvider

Field	Type	Required	Description
`envoyDeployment`	KubernetesDeploymentSpec	false	EnvoyDeployment defines the desired state of the Envoy deployment resource. If unspecified, default settings for the managed Envoy deployment resource are applied.
`envoyDaemonSet`	KubernetesDaemonSetSpec	false	EnvoyDaemonSet defines the desired state of the Envoy daemonset resource. Disabled by default, a deployment resource is used instead to provision the Envoy Proxy fleet
`envoyService`	KubernetesServiceSpec	false	EnvoyService defines the desired state of the Envoy service resource. If unspecified, default settings for the managed Envoy service resource are applied.
`envoyHpa`	KubernetesHorizontalPodAutoscalerSpec	false	EnvoyHpa defines the Horizontal Pod Autoscaler settings for Envoy Proxy Deployment. Once the HPA is being set, Replicas field from EnvoyDeployment will be ignored.
`useListenerPortAsContainerPort`	boolean	false	UseListenerPortAsContainerPort disables the port shifting feature in the Envoy Proxy. When set to false (default value), if the service port is a privileged port (1-1023), add a constant to the value converting it into an ephemeral port. This allows the container to bind to the port without needing a CAP_NET_BIND_SERVICE capability.
`envoyPDB`	KubernetesPodDisruptionBudgetSpec	false	EnvoyPDB allows to control the pod disruption budget of an Envoy Proxy.

EnvoyProxyProvider

EnvoyProxyProvider defines the desired state of a resource provider.

Appears in:

EnvoyProxySpec

Field	Type	Required	Description
`type`	ProviderType	true	Type is the type of resource provider to use. A resource provider provides infrastructure resources for running the data plane, e.g. Envoy proxy, and optional auxiliary control planes. Supported types are “Kubernetes”.
`kubernetes`	EnvoyProxyKubernetesProvider	false	Kubernetes defines the desired state of the Kubernetes resource provider. Kubernetes provides infrastructure resources for running the data plane, e.g. Envoy proxy. If unspecified and type is “Kubernetes”, default settings for managed Kubernetes resources are applied.

EnvoyProxySpec

EnvoyProxySpec defines the desired state of EnvoyProxy.

Appears in:

EnvoyProxy

Field	Type	Required	Description
`provider`	EnvoyProxyProvider	false	Provider defines the desired resource provider and provider-specific configuration. If unspecified, the “Kubernetes” resource provider is used with default configuration parameters.
`logging`	ProxyLogging	true	Logging defines logging parameters for managed proxies.
`telemetry`	ProxyTelemetry	false	Telemetry defines telemetry parameters for managed proxies.
`bootstrap`	ProxyBootstrap	false	Bootstrap defines the Envoy Bootstrap as a YAML string. Visit https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/bootstrap/v3/bootstrap.proto#envoy-v3-api-msg-config-bootstrap-v3-bootstrap to learn more about the syntax. If set, this is the Bootstrap configuration used for the managed Envoy Proxy fleet instead of the default Bootstrap configuration set by Envoy Gateway. Some fields within the Bootstrap that are required to communicate with the xDS Server (Envoy Gateway) and receive xDS resources from it are not configurable and will result in the `EnvoyProxy` resource being rejected. Backward compatibility across minor versions is not guaranteed. We strongly recommend using `egctl x translate` to generate a `EnvoyProxy` resource with the `Bootstrap` field set to the default Bootstrap configuration used. You can edit this configuration, and rerun `egctl x translate` to ensure there are no validation errors.
`concurrency`	integer	false	Concurrency defines the number of worker threads to run. If unset, it defaults to the number of cpuset threads on the platform.
`routingType`	RoutingType	false	RoutingType can be set to “Service” to use the Service Cluster IP for routing to the backend, or it can be set to “Endpoint” to use Endpoint routing. The default is “Endpoint”.
`extraArgs`	string array	false	ExtraArgs defines additional command line options that are provided to Envoy. More info: https://www.envoyproxy.io/docs/envoy/latest/operations/cli#command-line-options Note: some command line options are used internally(e.g. –log-level) so they cannot be provided here.
`mergeGateways`	boolean	false	MergeGateways defines if Gateway resources should be merged onto the same Envoy Proxy Infrastructure. Setting this field to true would merge all Gateway Listeners under the parent Gateway Class. This means that the port, protocol and hostname tuple must be unique for every listener. If a duplicate listener is detected, the newer listener (based on timestamp) will be rejected and its status will be updated with a “Accepted=False” condition.
`shutdown`	ShutdownConfig	false	Shutdown defines configuration for graceful envoy shutdown process.
`filterOrder`	FilterPosition array	false	FilterOrder defines the order of filters in the Envoy proxy’s HTTP filter chain. The FilterPosition in the list will be applied in the order they are defined. If unspecified, the default filter order is applied. Default filter order is: - envoy.filters.http.health_check - envoy.filters.http.fault - envoy.filters.http.cors - envoy.filters.http.ext_authz - envoy.filters.http.basic_auth - envoy.filters.http.oauth2 - envoy.filters.http.jwt_authn - envoy.filters.http.stateful_session - envoy.filters.http.ext_proc - envoy.filters.http.wasm - envoy.filters.http.rbac - envoy.filters.http.local_ratelimit - envoy.filters.http.ratelimit - envoy.filters.http.custom_response - envoy.filters.http.router Note: “envoy.filters.http.router” cannot be reordered, it’s always the last filter in the chain.
`backendTLS`	BackendTLSConfig	false	BackendTLS is the TLS configuration for the Envoy proxy to use when connecting to backends. These settings are applied on backends for which TLS policies are specified.
`ipFamily`	IPFamily	false	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.

EnvoyProxyStatus

EnvoyProxyStatus defines the observed state of EnvoyProxy. This type is not implemented until https://github.com/envoyproxy/gateway/issues/1007 is fixed.

Appears in:

EnvoyProxy

EnvoyResourceType

Underlying type: string

EnvoyResourceType specifies the type URL of the Envoy resource.

Appears in:

EnvoyJSONPatchConfig

Value	Description
`type.googleapis.com/envoy.config.listener.v3.Listener`	ListenerEnvoyResourceType defines the Type URL of the Listener resource
`type.googleapis.com/envoy.config.route.v3.RouteConfiguration`	RouteConfigurationEnvoyResourceType defines the Type URL of the RouteConfiguration resource
`type.googleapis.com/envoy.config.cluster.v3.Cluster`	ClusterEnvoyResourceType defines the Type URL of the Cluster resource
`type.googleapis.com/envoy.config.endpoint.v3.ClusterLoadAssignment`	ClusterLoadAssignmentEnvoyResourceType defines the Type URL of the ClusterLoadAssignment resource

ExtAuth

ExtAuth defines the configuration for External Authorization.

Appears in:

SecurityPolicySpec

Field	Type	Required	Description
`grpc`	GRPCExtAuthService	true	GRPC defines the gRPC External Authorization service. Either GRPCService or HTTPService must be specified, and only one of them can be provided.
`http`	HTTPExtAuthService	true	HTTP defines the HTTP External Authorization service. Either GRPCService or HTTPService must be specified, and only one of them can be provided.
`headersToExtAuth`	string array	false	HeadersToExtAuth defines the client request headers that will be included in the request to the external authorization service. Note: If not specified, the default behavior for gRPC and HTTP external authorization services is different due to backward compatibility reasons. All headers will be included in the check request to a gRPC authorization server. Only the following headers will be included in the check request to an HTTP authorization server: Host, Method, Path, Content-Length, and Authorization. And these headers will always be included to the check request to an HTTP authorization server by default, no matter whether they are specified in HeadersToExtAuth or not.
`failOpen`	boolean	false	FailOpen is a switch used to control the behavior when a response from the External Authorization service cannot be obtained. If FailOpen is set to true, the system allows the traffic to pass through. Otherwise, if it is set to false or not set (defaulting to false), the system blocks the traffic and returns a HTTP 5xx error, reflecting a fail-closed approach. This setting determines whether to prioritize accessibility over strict security in case of authorization service failure.
`recomputeRoute`	boolean	false	RecomputeRoute clears the route cache and recalculates the routing decision. This field must be enabled if the headers added or modified by the ExtAuth are used for route matching decisions. If the recomputation selects a new route, features targeting the new matched route will be applied.

ExtProc

ExtProc defines the configuration for External Processing filter.

Appears in:

EnvoyExtensionPolicySpec

Field	Type	Required	Description
`backendRef`	BackendObjectReference	false	BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.
`backendRefs`	BackendRef array	false	BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.
`backendSettings`	ClusterSettings	false	BackendSettings holds configuration for managing the connection to the backend.
`messageTimeout`	Duration	false	MessageTimeout is the timeout for a response to be returned from the external processor Default: 200ms
`failOpen`	boolean	false	FailOpen defines if requests or responses that cannot be processed due to connectivity to the external processor are terminated or passed-through. Default: false
`processingMode`	ExtProcProcessingMode	false	ProcessingMode defines how request and response body is processed Default: header and body are not sent to the external processor

ExtProcBodyProcessingMode

Underlying type: string

Appears in:

ProcessingModeOptions

Value	Description
`Streamed`	StreamedExtProcBodyProcessingMode will stream the body to the server in pieces as they arrive at the proxy.
`Buffered`	BufferedExtProcBodyProcessingMode will buffer the message body in memory and send the entire body at once. If the body exceeds the configured buffer limit, then the downstream system will receive an error.
`BufferedPartial`	BufferedPartialExtBodyHeaderProcessingMode will buffer the message body in memory and send the entire body in one chunk. If the body exceeds the configured buffer limit, then the body contents up to the buffer limit will be sent.

ExtProcProcessingMode

ExtProcProcessingMode defines if and how headers and bodies are sent to the service. https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/http/ext_proc/v3/processing_mode.proto#envoy-v3-api-msg-extensions-filters-http-ext-proc-v3-processingmode

Appears in:

ExtProc

Field	Type	Required	Description
`request`	ProcessingModeOptions	false	Defines processing mode for requests. If present, request headers are sent. Request body is processed according to the specified mode.
`response`	ProcessingModeOptions	false	Defines processing mode for responses. If present, response headers are sent. Response body is processed according to the specified mode.

ExtensionAPISettings

ExtensionAPISettings defines the settings specific to Gateway API Extensions.

Appears in:

Field	Type	Required	Description
`enableEnvoyPatchPolicy`	boolean	true	EnableEnvoyPatchPolicy enables Envoy Gateway to reconcile and implement the EnvoyPatchPolicy resources.
`enableBackend`	boolean	true	EnableBackend enables Envoy Gateway to reconcile and implement the Backend resources.

ExtensionHooks

ExtensionHooks defines extension hooks across all supported runners

Appears in:

ExtensionManager

Field	Type	Required	Description
`xdsTranslator`	XDSTranslatorHooks	true	XDSTranslator defines all the supported extension hooks for the xds-translator runner

ExtensionManager

ExtensionManager defines the configuration for registering an extension manager to the Envoy Gateway control plane.

Appears in:

Field	Type	Required	Description
`resources`	GroupVersionKind array	false	Resources defines the set of K8s resources the extension will handle as route filter resources
`policyResources`	GroupVersionKind array	false	PolicyResources defines the set of K8S resources the extension server will handle as directly attached GatewayAPI policies
`hooks`	ExtensionHooks	true	Hooks defines the set of hooks the extension supports
`service`	ExtensionService	true	Service defines the configuration of the extension service that the Envoy Gateway Control Plane will call through extension hooks.

ExtensionService

ExtensionService defines the configuration for connecting to a registered extension service.

Appears in:

ExtensionManager

Field	Type	Required	Description
`fqdn`	FQDNEndpoint	false	FQDN defines a FQDN endpoint
`ip`	IPEndpoint	false	IP defines an IP endpoint. Supports both IPv4 and IPv6 addresses.
`unix`	UnixSocket	false	Unix defines the unix domain socket endpoint
`host`	string	false	Host define the extension service hostname. Deprecated: use the appropriate transport attribute instead (FQDN,IP,Unix)
`port`	integer	false	Port defines the port the extension service is exposed on. Deprecated: use the appropriate transport attribute instead (FQDN,IP,Unix)
`tls`	ExtensionTLS	false	TLS defines TLS configuration for communication between Envoy Gateway and the extension service.

ExtensionTLS

ExtensionTLS defines the TLS configuration when connecting to an extension service

Appears in:

ExtensionService

Field	Type	Required	Description
`certificateRef`	SecretObjectReference	true	CertificateRef contains a references to objects (Kubernetes objects or otherwise) that contains a TLS certificate and private keys. These certificates are used to establish a TLS handshake to the extension server. CertificateRef can only reference a Kubernetes Secret at this time.

FQDNEndpoint

FQDNEndpoint describes TCP/UDP socket address, corresponding to Envoy’s Socket Address https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/address.proto#config-core-v3-socketaddress

Appears in:

Field	Type	Required	Description
`hostname`	string	true	Hostname defines the FQDN hostname of the backend endpoint.
`port`	integer	true	Port defines the port of the backend endpoint.

FaultInjection

FaultInjection defines the fault injection policy to be applied. This configuration can be used to inject delays and abort requests to mimic failure scenarios such as service failures and overloads

Appears in:

BackendTrafficPolicySpec

Field	Type	Required	Description
`delay`	FaultInjectionDelay	false	If specified, a delay will be injected into the request.
`abort`	FaultInjectionAbort	false	If specified, the request will be aborted if it meets the configuration criteria.

FaultInjectionAbort

FaultInjectionAbort defines the abort fault injection configuration

Appears in:

FaultInjection

Field	Type	Required	Description
`httpStatus`	integer	false	StatusCode specifies the HTTP status code to be returned
`grpcStatus`	integer	false	GrpcStatus specifies the GRPC status code to be returned
`percentage`	float	false	Percentage specifies the percentage of requests to be aborted. Default 100%, if set 0, no requests will be aborted. Accuracy to 0.0001%.

FaultInjectionDelay

FaultInjectionDelay defines the delay fault injection configuration

Appears in:

FaultInjection

Field	Type	Required	Description
`fixedDelay`	Duration	true	FixedDelay specifies the fixed delay duration
`percentage`	float	false	Percentage specifies the percentage of requests to be delayed. Default 100%, if set 0, no requests will be delayed. Accuracy to 0.0001%.

FileEnvoyProxyAccessLog

Appears in:

ProxyAccessLogSink

Field	Type	Required	Description
`path`	string	true	Path defines the file path used to expose envoy access log(e.g. /dev/stdout).

FilterPosition

FilterPosition defines the position of an Envoy HTTP filter in the filter chain.

Appears in:

EnvoyProxySpec

Field	Type	Required	Description
`name`	EnvoyFilter	true	Name of the filter.
`before`	EnvoyFilter	true	Before defines the filter that should come before the filter. Only one of Before or After must be set.
`after`	EnvoyFilter	true	After defines the filter that should come after the filter. Only one of Before or After must be set.

GRPCActiveHealthChecker

GRPCActiveHealthChecker defines the settings of the GRPC health check.

Appears in:

ActiveHealthCheck

Field	Type	Required	Description
`service`	string	false	Service to send in the health check request. If this is not specified, then the health check request applies to the entire server and not to a specific service.

GRPCExtAuthService

GRPCExtAuthService defines the gRPC External Authorization service The authorization request message is defined in https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/auth/v3/external_auth.proto

Appears in:

ExtAuth

Field	Type	Required	Description
`backendRef`	BackendObjectReference	false	BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.
`backendRefs`	BackendRef array	false	BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.
`backendSettings`	ClusterSettings	false	BackendSettings holds configuration for managing the connection to the backend.

Gateway

Gateway defines the desired Gateway API configuration of Envoy Gateway.

Appears in:

Field	Type	Required	Description
`controllerName`	string	false	ControllerName defines the name of the Gateway API controller. If unspecified, defaults to “gateway.envoyproxy.io/gatewayclass-controller”. See the following for additional details: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayClass

GlobalRateLimit

GlobalRateLimit defines global rate limit configuration.

Appears in:

RateLimitSpec

Field	Type	Required	Description
`rules`	RateLimitRule array	true	Rules are a list of RateLimit selectors and limits. Each rule and its associated limit is applied in a mutually exclusive way. If a request matches multiple rules, each of their associated limits get applied, so a single request might increase the rate limit counters for multiple rules if selected. The rate limit service will return a logical OR of the individual rate limit decisions of all matching rules. For example, if a request matches two rules, one rate limited and one not, the final decision will be to rate limit the request.

GroupVersionKind

GroupVersionKind unambiguously identifies a Kind. It can be converted to k8s.io/apimachinery/pkg/runtime/schema.GroupVersionKind

Appears in:

ExtensionManager

Field	Type	Required
`group`	string	true
`version`	string	true
`kind`	string	true

GzipCompressor

GzipCompressor defines the config for the Gzip compressor. The default values can be found here: https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/compression/gzip/compressor/v3/gzip.proto#extension-envoy-compression-gzip-compressor

Appears in:

Compression

HTTP10Settings

HTTP10Settings provides HTTP/1.0 configuration on the listener.

Appears in:

HTTP1Settings

Field	Type	Required	Description
`useDefaultHost`	boolean	false	UseDefaultHost defines if the HTTP/1.0 request is missing the Host header, then the hostname associated with the listener should be injected into the request. If this is not set and an HTTP/1.0 request arrives without a host, then it will be rejected.

HTTP1Settings

HTTP1Settings provides HTTP/1 configuration on the listener.

Appears in:

ClientTrafficPolicySpec

Field	Type	Required	Description
`enableTrailers`	boolean	false	EnableTrailers defines if HTTP/1 trailers should be proxied by Envoy.
`preserveHeaderCase`	boolean	false	PreserveHeaderCase defines if Envoy should preserve the letter case of headers. By default, Envoy will lowercase all the headers.
`http10`	HTTP10Settings	false	HTTP10 turns on support for HTTP/1.0 and HTTP/0.9 requests.

HTTP2Settings

HTTP2Settings provides HTTP/2 configuration for listeners and backends.

Appears in:

Field	Type	Required	Description
`initialStreamWindowSize`	Quantity	false	InitialStreamWindowSize sets the initial window size for HTTP/2 streams. If not set, the default value is 64 KiB(64*1024).
`initialConnectionWindowSize`	Quantity	false	InitialConnectionWindowSize sets the initial window size for HTTP/2 connections. If not set, the default value is 1 MiB.
`maxConcurrentStreams`	integer	false	MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection. If not set, the default value is 100.
`onInvalidMessage`	InvalidMessageAction	false	OnInvalidMessage determines if Envoy will terminate the connection or just the offending stream in the event of HTTP messaging error It’s recommended for L2 Envoy deployments to set this value to TerminateStream. https://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/level_two Default: TerminateConnection

HTTP3Settings

HTTP3Settings provides HTTP/3 configuration on the listener.

Appears in:

ClientTrafficPolicySpec

HTTPActiveHealthChecker

HTTPActiveHealthChecker defines the settings of http health check.

Appears in:

ActiveHealthCheck

Field	Type	Required	Description
`path`	string	true	Path defines the HTTP path that will be requested during health checking.
`method`	string	false	Method defines the HTTP method used for health checking. Defaults to GET
`expectedStatuses`	HTTPStatus array	false	ExpectedStatuses defines a list of HTTP response statuses considered healthy. Defaults to 200 only
`expectedResponse`	ActiveHealthCheckPayload	false	ExpectedResponse defines a list of HTTP expected responses to match.

HTTPClientTimeout

Appears in:

ClientTimeout

Field	Type	Required	Description
`requestReceivedTimeout`	Duration	false	RequestReceivedTimeout is the duration envoy waits for the complete request reception. This timer starts upon request initiation and stops when either the last byte of the request is sent upstream or when the response begins.
`idleTimeout`	Duration	false	IdleTimeout for an HTTP connection. Idle time is defined as a period in which there are no active requests in the connection. Default: 1 hour.

HTTPDirectResponseFilter

HTTPDirectResponseFilter defines the configuration to return a fixed response.

Appears in:

HTTPRouteFilterSpec

Field	Type	Required	Description
`contentType`	string	false	Content Type of the response. This will be set in the Content-Type header.
`body`	CustomResponseBody	false	Body of the Response
`statusCode`	integer	false	Status Code of the HTTP response If unset, defaults to 200.

HTTPExtAuthService

HTTPExtAuthService defines the HTTP External Authorization service

Appears in:

ExtAuth

Field	Type	Required	Description
`backendRef`	BackendObjectReference	false	BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.
`backendRefs`	BackendRef array	false	BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.
`backendSettings`	ClusterSettings	false	BackendSettings holds configuration for managing the connection to the backend.
`path`	string	true	Path is the path of the HTTP External Authorization service. If path is specified, the authorization request will be sent to that path, or else the authorization request will be sent to the root path.
`headersToBackend`	string array	false	HeadersToBackend are the authorization response headers that will be added to the original client request before sending it to the backend server. Note that coexisting headers will be overridden. If not specified, no authorization response headers will be added to the original client request.

HTTPHostnameModifier

Appears in:

HTTPURLRewriteFilter

Field	Type	Required	Description
`type`	HTTPHostnameModifierType	true
`header`	string	false	Header is the name of the header whose value would be used to rewrite the Host header

HTTPHostnameModifierType

Underlying type: string

HTTPPathModifierType defines the type of Hostname rewrite.

Appears in:

HTTPHostnameModifier

Value	Description
`Header`	HeaderHTTPHostnameModifier indicates that the Host header value would be replaced with the value of the header specified in header. https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/route/v3/route_components.proto#envoy-v3-api-field-config-route-v3-routeaction-host-rewrite-header
`Backend`	BackendHTTPHostnameModifier indicates that the Host header value would be replaced by the DNS name of the backend if it exists. https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/route/v3/route_components.proto#envoy-v3-api-field-config-route-v3-routeaction-auto-host-rewrite

HTTPPathModifier

Appears in:

HTTPURLRewriteFilter

Field	Type	Required	Description
`type`	HTTPPathModifierType	true
`replaceRegexMatch`	ReplaceRegexMatch	false	ReplaceRegexMatch defines a path regex rewrite. The path portions matched by the regex pattern are replaced by the defined substitution. https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/route/v3/route_components.proto#envoy-v3-api-field-config-route-v3-routeaction-regex-rewrite Some examples: (1) replaceRegexMatch: pattern: ^/service/([^/]+)(/.)$ substitution: \2/instance/\1 Would transform /service/foo/v1/api into /v1/api/instance/foo. (2) replaceRegexMatch: pattern: one substitution: two Would transform /xxx/one/yyy/one/zzz into /xxx/two/yyy/two/zzz. (3) replaceRegexMatch: pattern: ^(.?)one(.*)$ substitution: \1two\2 Would transform /xxx/one/yyy/one/zzz into /xxx/two/yyy/one/zzz. (3) replaceRegexMatch: pattern: (?i)/xxx/ substitution: /yyy/ Would transform path /aaa/XxX/bbb into /aaa/yyy/bbb (case-insensitive).

HTTPPathModifierType

Underlying type: string

HTTPPathModifierType defines the type of path redirect or rewrite.

Appears in:

HTTPPathModifier

Value	Description
`ReplaceRegexMatch`	RegexHTTPPathModifier This type of modifier indicates that the portions of the path that match the specified regex would be substituted with the specified substitution value https://www.envoyproxy.io/docs/envoy/latest/api-v3/type/matcher/v3/regex.proto#type-matcher-v3-regexmatchandsubstitute

HTTPRouteFilter

HTTPRouteFilter is a custom Envoy Gateway HTTPRouteFilter which provides extended traffic processing options such as path regex rewrite, direct response and more.

Field	Type	Required	Description
`apiVersion`	string		`gateway.envoyproxy.io/v1alpha1`
`kind`	string		`HTTPRouteFilter`
`metadata`	ObjectMeta	true	Refer to Kubernetes API documentation for fields of `metadata`.
`spec`	HTTPRouteFilterSpec	true	Spec defines the desired state of HTTPRouteFilter.

HTTPRouteFilterSpec

HTTPRouteFilterSpec defines the desired state of HTTPRouteFilter.

Appears in:

HTTPRouteFilter

Field	Type	Required	Description
`urlRewrite`	HTTPURLRewriteFilter	false
`directResponse`	HTTPDirectResponseFilter	false

HTTPStatus

Underlying type: integer

HTTPStatus defines the http status code.

Appears in:

HTTPTimeout

Appears in:

Timeout

Field	Type	Required	Description
`connectionIdleTimeout`	Duration	false	The idle timeout for an HTTP connection. Idle time is defined as a period in which there are no active requests in the connection. Default: 1 hour.
`maxConnectionDuration`	Duration	false	The maximum duration of an HTTP connection. Default: unlimited.
`requestTimeout`	Duration	false	RequestTimeout is the time until which entire response is received from the upstream.

HTTPURLRewriteFilter

HTTPURLRewriteFilter define rewrites of HTTP URL components such as path and host

Appears in:

HTTPRouteFilterSpec

Field	Type	Required	Description
`hostname`	HTTPHostnameModifier	false	Hostname is the value to be used to replace the Host header value during forwarding.
`path`	HTTPPathModifier	false	Path defines a path rewrite.

HTTPWasmCodeSource

HTTPWasmCodeSource defines the HTTP URL containing the Wasm code.

Appears in:

WasmCodeSource

Field	Type	Required	Description
`url`	string	true	URL is the URL containing the Wasm code.
`sha256`	string	false	SHA256 checksum that will be used to verify the Wasm code. If not specified, Envoy Gateway will not verify the downloaded Wasm code. kubebuilder:validation:Pattern=`^[a-f0-9]\{64\}$`

Header defines the header hashing configuration for consistent hash based load balancing.

Appears in:

ConsistentHash

Field	Type	Required	Description
`name`	string	true	Name of the header to hash.

HeaderMatch

HeaderMatch defines the match attributes within the HTTP Headers of the request.

Appears in:

RateLimitSelectCondition

Field	Type	Required	Description
`type`	HeaderMatchType	false	Type specifies how to match against the value of the header.
`name`	string	true	Name of the HTTP header.
`value`	string	false	Value within the HTTP header. Due to the case-insensitivity of header names, “foo” and “Foo” are considered equivalent. Do not set this field when Type=“Distinct”, implying matching on any/all unique values within the header.
`invert`	boolean	false	Invert specifies whether the value match result will be inverted. Do not set this field when Type=“Distinct”, implying matching on any/all unique values within the header.

HeaderMatchType

Underlying type: string

HeaderMatchType specifies the semantics of how HTTP header values should be compared. Valid HeaderMatchType values are “Exact”, “RegularExpression”, and “Distinct”.

Appears in:

HeaderMatch

Value	Description
`Exact`	HeaderMatchExact matches the exact value of the Value field against the value of the specified HTTP Header.
`RegularExpression`	HeaderMatchRegularExpression matches a regular expression against the value of the specified HTTP Header. The regex string must adhere to the syntax documented in https://github.com/google/re2/wiki/Syntax.
`Distinct`	HeaderMatchDistinct matches any and all possible unique values encountered in the specified HTTP Header. Note that each unique value will receive its own rate limit bucket. Note: This is only supported for Global Rate Limits.

HeaderSettings

HeaderSettings provides configuration options for headers on the listener.

Appears in:

ClientTrafficPolicySpec

Field	Type	Required	Description
`enableEnvoyHeaders`	boolean	false	EnableEnvoyHeaders configures Envoy Proxy to add the “X-Envoy-” headers to requests and responses.
`disableRateLimitHeaders`	boolean	false	DisableRateLimitHeaders configures Envoy Proxy to omit the “X-RateLimit-” response headers when rate limiting is enabled.
`xForwardedClientCert`	XForwardedClientCert	false	XForwardedClientCert configures how Envoy Proxy handle the x-forwarded-client-cert (XFCC) HTTP header. x-forwarded-client-cert (XFCC) is an HTTP header used to forward the certificate information of part or all of the clients or proxies that a request has flowed through, on its way from the client to the server. Envoy proxy may choose to sanitize/append/forward the XFCC header before proxying the request. If not set, the default behavior is sanitizing the XFCC header.
`withUnderscoresAction`	WithUnderscoresAction	false	WithUnderscoresAction configures the action to take when an HTTP header with underscores is encountered. The default action is to reject the request.
`preserveXRequestID`	boolean	false	PreserveXRequestID configures Envoy to keep the X-Request-ID header if passed for a request that is edge (Edge request is the request from external clients to front Envoy) and not reset it, which is the current Envoy behaviour. It defaults to false.
`earlyRequestHeaders`	HTTPHeaderFilter	false	EarlyRequestHeaders defines settings for early request header modification, before envoy performs routing, tracing and built-in header manipulation.

HealthCheck

HealthCheck configuration to decide which endpoints are healthy and can be used for routing.

Appears in:

Field	Type	Required	Description
`active`	ActiveHealthCheck	false	Active health check configuration
`passive`	PassiveHealthCheck	false	Passive passive check configuration

HealthCheckSettings

HealthCheckSettings provides HealthCheck configuration on the HTTP/HTTPS listener.

Appears in:

ClientTrafficPolicySpec

Field	Type	Required	Description
`path`	string	true	Path specifies the HTTP path to match on for health check requests.

IPEndpoint

IPEndpoint describes TCP/UDP socket address, corresponding to Envoy’s Socket Address https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/address.proto#config-core-v3-socketaddress

Appears in:

Field	Type	Required	Description
`address`	string	true	Address defines the IP address of the backend endpoint. Supports both IPv4 and IPv6 addresses.
`port`	integer	true	Port defines the port of the backend endpoint.

IPFamily

Underlying type: string

IPFamily defines the IP family to use for the Envoy proxy.

Appears in:

EnvoyProxySpec

Value	Description
`IPv4`	IPv4 defines the IPv4 family.
`IPv6`	IPv6 defines the IPv6 family.
`DualStack`	DualStack defines the dual-stack family. When set to DualStack, Envoy proxy will listen on both IPv4 and IPv6 addresses for incoming client traffic, enabling support for both IP protocol versions.

ImagePullPolicy

Underlying type: string

ImagePullPolicy defines the policy to use when pulling an OIC image.

Appears in:

WasmCodeSource

Value	Description
`IfNotPresent`	ImagePullPolicyIfNotPresent will only pull the image if it does not already exist in the EG cache.
`Always`	ImagePullPolicyAlways will pull the image when the EnvoyExtension resource version changes. Note: EG does not update the Wasm module every time an Envoy proxy requests the Wasm module.

ImageWasmCodeSource

ImageWasmCodeSource defines the OCI image containing the Wasm code.

Appears in:

WasmCodeSource

Field	Type	Required	Description
`url`	string	true	URL is the URL of the OCI image. URL can be in the format of `registry/image:tag` or `registry/image@sha256:digest`.
`sha256`	string	false	SHA256 checksum that will be used to verify the OCI image. It must match the digest of the OCI image. If not specified, Envoy Gateway will not verify the downloaded OCI image. kubebuilder:validation:Pattern=`^[a-f0-9]\{64\}$`
`pullSecretRef`	SecretObjectReference	false	PullSecretRef is a reference to the secret containing the credentials to pull the image. Only support Kubernetes Secret resource from the same namespace.

InfrastructureProviderType

Underlying type: string

InfrastructureProviderType defines the types of custom infrastructure providers supported by Envoy Gateway.

Appears in:

EnvoyGatewayInfrastructureProvider

Value	Description
`Host`	InfrastructureProviderTypeHost defines the “Host” provider.

InvalidMessageAction

Underlying type: string

Appears in:

HTTP2Settings

Value	Description
`TerminateConnection`
`TerminateStream`

JSONPatchOperation

JSONPatchOperation defines the JSON Patch Operation as defined in https://datatracker.ietf.org/doc/html/rfc6902

Appears in:

Field	Type	Required	Description
`op`	JSONPatchOperationType	true	Op is the type of operation to perform
`path`	string	false	Path is a JSONPointer expression. Refer to https://datatracker.ietf.org/doc/html/rfc6901 for more details. It specifies the location of the target document/field where the operation will be performed
`jsonPath`	string	false	JSONPath is a JSONPath expression. Refer to https://datatracker.ietf.org/doc/rfc9535/ for more details. It produces one or more JSONPointer expressions based on the given JSON document. If no JSONPointer is found, it will result in an error. If the ‘Path’ property is also set, it will be appended to the resulting JSONPointer expressions from the JSONPath evaluation. This is useful when creating a property that does not yet exist in the JSON document. The final JSONPointer expressions specifies the locations in the target document/field where the operation will be applied.
`from`	string	false	From is the source location of the value to be copied or moved. Only valid for move or copy operations Refer to https://datatracker.ietf.org/doc/html/rfc6901 for more details.
`value`	JSON	false	Value is the new value of the path location. The value is only used by the `add` and `replace` operations.

JSONPatchOperationType

Underlying type: string

JSONPatchOperationType specifies the JSON Patch operations that can be performed.

Appears in:

JSONPatchOperation

JWT

JWT defines the configuration for JSON Web Token (JWT) authentication.

Appears in:

SecurityPolicySpec

Field	Type	Required	Description
`optional`	boolean	true	Optional determines whether a missing JWT is acceptable, defaulting to false if not specified. Note: Even if optional is set to true, JWT authentication will still fail if an invalid JWT is presented.
`providers`	JWTProvider array	true	Providers defines the JSON Web Token (JWT) authentication provider type. When multiple JWT providers are specified, the JWT is considered valid if any of the providers successfully validate the JWT. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html.

JWTClaim

JWTClaim specifies a claim in a JWT token.

Appears in:

JWTPrincipal

Field	Type	Required	Description
`name`	string	true	Name is the name of the claim. If it is a nested claim, use a dot (.) separated string as the name to represent the full path to the claim. For example, if the claim is in the “department” field in the “organization” field, the name should be “organization.department”.
`valueType`	JWTClaimValueType	false	ValueType is the type of the claim value. Only String and StringArray types are supported for now.
`values`	string array	true	Values are the values that the claim must match. If the claim is a string type, the specified value must match exactly. If the claim is a string array type, the specified value must match one of the values in the array. If multiple values are specified, one of the values must match for the rule to match.

JWTClaimValueType

Underlying type: string

Appears in:

JWTClaim

Value	Description
`String`
`StringArray`

JWTExtractor

JWTExtractor defines a custom JWT token extraction from HTTP request. If specified, Envoy will extract the JWT token from the listed extractors (headers, cookies, or params) and validate each of them. If any value extracted is found to be an invalid JWT, a 401 error will be returned.

Appears in:

JWTProvider

Field	Type	Required	Description
`headers`	JWTHeaderExtractor array	false	Headers represents a list of HTTP request headers to extract the JWT token from.
`cookies`	string array	false	Cookies represents a list of cookie names to extract the JWT token from.
`params`	string array	false	Params represents a list of query parameters to extract the JWT token from.

JWTHeaderExtractor

JWTHeaderExtractor defines an HTTP header location to extract JWT token

Appears in:

JWTExtractor

Field	Type	Required	Description
`name`	string	true	Name is the HTTP header name to retrieve the token
`valuePrefix`	string	false	ValuePrefix is the prefix that should be stripped before extracting the token. The format would be used by Envoy like “{ValuePrefix}”. For example, “Authorization: Bearer ”, then the ValuePrefix=“Bearer " with a space at the end.

JWTPrincipal

JWTPrincipal specifies the client identity of a request based on the JWT claims and scopes. At least one of the claims or scopes must be specified. Claims and scopes are And-ed together if both are specified.

Appears in:

Principal

Field	Type	Required	Description
`provider`	string	true	Provider is the name of the JWT provider that used to verify the JWT token. In order to use JWT claims for authorization, you must configure the JWT authentication with the same provider in the same `SecurityPolicy`.
`claims`	JWTClaim array	false	Claims are the claims in a JWT token. If multiple claims are specified, all claims must match for the rule to match. For example, if there are two claims: one for the audience and one for the issuer, the rule will match only if both the audience and the issuer match.
`scopes`	JWTScope array	false	Scopes are a special type of claim in a JWT token that represents the permissions of the client. The value of the scopes field should be a space delimited string that is expected in the scope parameter, as defined in RFC 6749: https://datatracker.ietf.org/doc/html/rfc6749#page-23. If multiple scopes are specified, all scopes must match for the rule to match.

JWTProvider

JWTProvider defines how a JSON Web Token (JWT) can be verified.

Appears in:

Field	Type	Required	Description
`name`	string	true	Name defines a unique name for the JWT provider. A name can have a variety of forms, including RFC1123 subdomains, RFC 1123 labels, or RFC 1035 labels.
`issuer`	string	false	Issuer is the principal that issued the JWT and takes the form of a URL or email address. For additional details, see https://tools.ietf.org/html/rfc7519#section-4.1.1 for URL format and https://rfc-editor.org/rfc/rfc5322.html for email format. If not provided, the JWT issuer is not checked.
`audiences`	string array	false	Audiences is a list of JWT audiences allowed access. For additional details, see https://tools.ietf.org/html/rfc7519#section-4.1.3. If not provided, JWT audiences are not checked.
`remoteJWKS`	RemoteJWKS	true	RemoteJWKS defines how to fetch and cache JSON Web Key Sets (JWKS) from a remote HTTP/HTTPS endpoint.
`claimToHeaders`	ClaimToHeader array	false	ClaimToHeaders is a list of JWT claims that must be extracted into HTTP request headers For examples, following config: The claim must be of type; string, int, double, bool. Array type claims are not supported
`recomputeRoute`	boolean	false	RecomputeRoute clears the route cache and recalculates the routing decision. This field must be enabled if the headers generated from the claim are used for route matching decisions. If the recomputation selects a new route, features targeting the new matched route will be applied.
`extractFrom`	JWTExtractor	false	ExtractFrom defines different ways to extract the JWT token from HTTP request. If empty, it defaults to extract JWT token from the Authorization HTTP request header using Bearer schema or access_token from query parameters.

JWTScope

Underlying type: string

Appears in:

JWTPrincipal

KubernetesContainerSpec

KubernetesContainerSpec defines the desired state of the Kubernetes container resource.

Appears in:

Field	Type	Required	Description
`env`	EnvVar array	false	List of environment variables to set in the container.
`resources`	ResourceRequirements	false	Resources required by this container. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
`securityContext`	SecurityContext	false	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
`image`	string	false	Image specifies the EnvoyProxy container image to be used, instead of the default image.
`volumeMounts`	VolumeMount array	false	VolumeMounts are volumes to mount into the container’s filesystem. Cannot be updated.

KubernetesDaemonSetSpec

KubernetesDaemonSetSpec defines the desired state of the Kubernetes daemonset resource.

Appears in:

EnvoyProxyKubernetesProvider

Field	Type	Required	Description
`patch`	KubernetesPatchSpec	false	Patch defines how to perform the patch operation to daemonset
`strategy`	DaemonSetUpdateStrategy	false	The daemonset strategy to use to replace existing pods with new ones.
`pod`	KubernetesPodSpec	false	Pod defines the desired specification of pod.
`container`	KubernetesContainerSpec	false	Container defines the desired specification of main container.
`name`	string	false	Name of the daemonSet. When unset, this defaults to an autogenerated name.

KubernetesDeployMode

KubernetesDeployMode holds configuration for how to deploy managed resources such as the Envoy Proxy data plane fleet.

Appears in:

EnvoyGatewayKubernetesProvider

KubernetesDeploymentSpec

KubernetesDeploymentSpec defines the desired state of the Kubernetes deployment resource.

Appears in:

Field	Type	Required	Description
`patch`	KubernetesPatchSpec	false	Patch defines how to perform the patch operation to deployment
`replicas`	integer	false	Replicas is the number of desired pods. Defaults to 1.
`strategy`	DeploymentStrategy	false	The deployment strategy to use to replace existing pods with new ones.
`pod`	KubernetesPodSpec	false	Pod defines the desired specification of pod.
`container`	KubernetesContainerSpec	false	Container defines the desired specification of main container.
`initContainers`	Container array	false	List of initialization containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
`name`	string	false	Name of the deployment. When unset, this defaults to an autogenerated name.

KubernetesHorizontalPodAutoscalerSpec

KubernetesHorizontalPodAutoscalerSpec defines Kubernetes Horizontal Pod Autoscaler settings of Envoy Proxy Deployment. When HPA is enabled, it is recommended that the value in KubernetesDeploymentSpec.replicas be removed, otherwise Envoy Gateway will revert back to this value every time reconciliation occurs. See k8s.io.autoscaling.v2.HorizontalPodAutoScalerSpec.

Appears in:

EnvoyProxyKubernetesProvider

Field	Type	Required	Description
`minReplicas`	integer	false	minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 replica.
`maxReplicas`	integer	true	maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
`metrics`	MetricSpec array	false	metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). If left empty, it defaults to being based on CPU utilization with average on 80% usage.
`behavior`	HorizontalPodAutoscalerBehavior	false	behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used. See k8s.io.autoscaling.v2.HorizontalPodAutoScalerBehavior.

KubernetesPatchSpec

KubernetesPatchSpec defines how to perform the patch operation. Note that value can be an in-line YAML document, as can be seen in e.g. (the example of patching the Envoy proxy Deployment)[https://gateway.envoyproxy.io/docs/tasks/operations/customize-envoyproxy/#patching-deployment-for-envoyproxy]. Note also that, currently, strings containing literal JSON are rejected.

Appears in:

Field	Type	Required	Description
`type`	MergeType	false	Type is the type of merge operation to perform By default, StrategicMerge is used as the patch type.
`value`	JSON	true	Object contains the raw configuration for merged object

KubernetesPodDisruptionBudgetSpec

KubernetesPodDisruptionBudgetSpec defines Kubernetes PodDisruptionBudget settings of Envoy Proxy Deployment.

Appears in:

EnvoyProxyKubernetesProvider

Field	Type	Required	Description
`minAvailable`	integer	false	MinAvailable specifies the minimum number of pods that must be available at all times during voluntary disruptions, such as node drains or updates. This setting ensures that your envoy proxy maintains a certain level of availability and resilience during maintenance operations.

KubernetesPodSpec

KubernetesPodSpec defines the desired state of the Kubernetes pod resource.

Appears in:

Field	Type	Required	Description
`annotations`	object (keys:string, values:string)	false	Annotations are the annotations that should be appended to the pods. By default, no pod annotations are appended.
`labels`	object (keys:string, values:string)	false	Labels are the additional labels that should be tagged to the pods. By default, no additional pod labels are tagged.
`securityContext`	PodSecurityContext	false	SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
`affinity`	Affinity	false	If specified, the pod’s scheduling constraints.
`tolerations`	Toleration array	false	If specified, the pod’s tolerations.
`volumes`	Volume array	false	Volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes
`imagePullSecrets`	LocalObjectReference array	false	ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
`nodeSelector`	object (keys:string, values:string)	false	NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
`topologySpreadConstraints`	TopologySpreadConstraint array	false	TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.

KubernetesServiceSpec

KubernetesServiceSpec defines the desired state of the Kubernetes service resource.

Appears in:

EnvoyProxyKubernetesProvider

Field	Type	Required	Description
`annotations`	object (keys:string, values:string)	false	Annotations that should be appended to the service. By default, no annotations are appended.
`labels`	object (keys:string, values:string)	false	Labels that should be appended to the service. By default, no labels are appended.
`type`	ServiceType	false	Type determines how the Service is exposed. Defaults to LoadBalancer. Valid options are ClusterIP, LoadBalancer and NodePort. “LoadBalancer” means a service will be exposed via an external load balancer (if the cloud provider supports it). “ClusterIP” means a service will only be accessible inside the cluster, via the cluster IP. “NodePort” means a service will be exposed on a static Port on all Nodes of the cluster.
`loadBalancerClass`	string	false	LoadBalancerClass, when specified, allows for choosing the LoadBalancer provider implementation if more than one are available or is otherwise expected to be specified
`allocateLoadBalancerNodePorts`	boolean	false	AllocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is “true”. It may be set to “false” if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type.
`loadBalancerSourceRanges`	string array	false	LoadBalancerSourceRanges defines a list of allowed IP addresses which will be configured as firewall rules on the platform providers load balancer. This is not guaranteed to be working as it happens outside of kubernetes and has to be supported and handled by the platform provider. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type.
`loadBalancerIP`	string	false	LoadBalancerIP defines the IP Address of the underlying load balancer service. This field may be ignored if the load balancer provider does not support this feature. This field has been deprecated in Kubernetes, but it is still used for setting the IP Address in some cloud providers such as GCP.
`externalTrafficPolicy`	ServiceExternalTrafficPolicy	false	ExternalTrafficPolicy determines the externalTrafficPolicy for the Envoy Service. Valid options are Local and Cluster. Default is “Local”. “Local” means traffic will only go to pods on the node receiving the traffic. “Cluster” means connections are loadbalanced to all pods in the cluster.
`patch`	KubernetesPatchSpec	false	Patch defines how to perform the patch operation to the service
`name`	string	false	Name of the service. When unset, this defaults to an autogenerated name.

KubernetesWatchMode

KubernetesWatchMode holds the configuration for which input resources to watch and reconcile.

Appears in:

EnvoyGatewayKubernetesProvider

Field	Type	Required	Description
`type`	KubernetesWatchModeType	true	Type indicates what watch mode to use. KubernetesWatchModeTypeNamespaces and KubernetesWatchModeTypeNamespaceSelector are currently supported By default, when this field is unset or empty, Envoy Gateway will watch for input namespaced resources from all namespaces.
`namespaces`	string array	true	Namespaces holds the list of namespaces that Envoy Gateway will watch for namespaced scoped resources such as Gateway, HTTPRoute and Service. Note that Envoy Gateway will continue to reconcile relevant cluster scoped resources such as GatewayClass that it is linked to. Precisely one of Namespaces and NamespaceSelector must be set.
`namespaceSelector`	LabelSelector	true	NamespaceSelector holds the label selector used to dynamically select namespaces. Envoy Gateway will watch for namespaces matching the specified label selector. Precisely one of Namespaces and NamespaceSelector must be set.

KubernetesWatchModeType

Underlying type: string

KubernetesWatchModeType defines the type of KubernetesWatchMode

Appears in:

KubernetesWatchMode

LeaderElection

LeaderElection defines the desired leader election settings.

Appears in:

EnvoyGatewayKubernetesProvider

Field	Type	Required	Description
`leaseDuration`	Duration	true	LeaseDuration defines the time non-leader contenders will wait before attempting to claim leadership. It’s based on the timestamp of the last acknowledged signal. The default setting is 15 seconds.
`renewDeadline`	Duration	true	RenewDeadline represents the time frame within which the current leader will attempt to renew its leadership status before relinquishing its position. The default setting is 10 seconds.
`retryPeriod`	Duration	true	RetryPeriod denotes the interval at which LeaderElector clients should perform action retries. The default setting is 2 seconds.
`disable`	boolean	true	Disable provides the option to turn off leader election, which is enabled by default.

LiteralCustomTag

LiteralCustomTag adds hard-coded value to each span.

Appears in:

CustomTag

Field	Type	Required	Description
`value`	string	true	Value defines the hard-coded value to add to each span.

LoadBalancer

LoadBalancer defines the load balancer policy to be applied.

Appears in:

Field	Type	Required	Description
`type`	LoadBalancerType	true	Type decides the type of Load Balancer policy. Valid LoadBalancerType values are “ConsistentHash”, “LeastRequest”, “Random”, “RoundRobin”.
`consistentHash`	ConsistentHash	false	ConsistentHash defines the configuration when the load balancer type is set to ConsistentHash
`slowStart`	SlowStart	false	SlowStart defines the configuration related to the slow start load balancer policy. If set, during slow start window, traffic sent to the newly added hosts will gradually increase. Currently this is only supported for RoundRobin and LeastRequest load balancers

LoadBalancerType

Underlying type: string

LoadBalancerType specifies the types of LoadBalancer.

Appears in:

LoadBalancer

Value	Description
`ConsistentHash`	ConsistentHashLoadBalancerType load balancer policy.
`LeastRequest`	LeastRequestLoadBalancerType load balancer policy.
`Random`	RandomLoadBalancerType load balancer policy.
`RoundRobin`	RoundRobinLoadBalancerType load balancer policy.

LocalRateLimit

LocalRateLimit defines local rate limit configuration.

Appears in:

RateLimitSpec

Field	Type	Required	Description
`rules`	RateLimitRule array	false	Rules are a list of RateLimit selectors and limits. If a request matches multiple rules, the strictest limit is applied. For example, if a request matches two rules, one with 10rps and one with 20rps, the final limit will be based on the rule with 10rps.

LogLevel

Underlying type: string

LogLevel defines a log level for Envoy Gateway and EnvoyProxy system logs.

Appears in:

Value	Description
`debug`	LogLevelDebug defines the “debug” logging level.
`info`	LogLevelInfo defines the “Info” logging level.
`warn`	LogLevelWarn defines the “Warn” logging level.
`error`	LogLevelError defines the “Error” logging level.

MergeType

Underlying type: string

MergeType defines the type of merge operation

Appears in:

KubernetesPatchSpec

Value	Description
`StrategicMerge`	StrategicMerge indicates a strategic merge patch type
`JSONMerge`	JSONMerge indicates a JSON merge patch type

MetricSinkType

Underlying type: string

Appears in:

Value	Description
`OpenTelemetry`

OIDC

OIDC defines the configuration for the OpenID Connect (OIDC) authentication.

Appears in:

SecurityPolicySpec

Field	Type	Required	Description
`provider`	OIDCProvider	true	The OIDC Provider configuration.
`clientID`	string	true	The client ID to be used in the OIDC Authentication Request.
`clientSecret`	SecretObjectReference	true	The Kubernetes secret which contains the OIDC client secret to be used in the Authentication Request. This is an Opaque secret. The client secret should be stored in the key “client-secret”.
`cookieNames`	OIDCCookieNames	false	The optional cookie name overrides to be used for Bearer and IdToken cookies in the Authentication Request. If not specified, uses a randomly generated suffix
`cookieDomain`	string	false	The optional domain to set the access and ID token cookies on. If not set, the cookies will default to the host of the request, not including the subdomains. If set, the cookies will be set on the specified domain and all subdomains. This means that requests to any subdomain will not require reauthentication after users log in to the parent domain.
`scopes`	string array	false	The OIDC scopes to be used in the Authentication Request. The “openid” scope is always added to the list of scopes if not already specified.
`resources`	string array	false	The OIDC resources to be used in the Authentication Request.
`redirectURL`	string	true	The redirect URL to be used in the OIDC Authentication Request. If not specified, uses the default redirect URI “%REQ(x-forwarded-proto)%://%REQ(:authority)%/oauth2/callback”
`logoutPath`	string	true	The path to log a user out, clearing their credential cookies. If not specified, uses a default logout path “/logout”
`forwardAccessToken`	boolean	false	ForwardAccessToken indicates whether the Envoy should forward the access token via the Authorization header Bearer scheme to the upstream. If not specified, defaults to false.
`defaultTokenTTL`	Duration	false	DefaultTokenTTL is the default lifetime of the id token and access token. Please note that Envoy will always use the expiry time from the response of the authorization server if it is provided. This field is only used when the expiry time is not provided by the authorization. If not specified, defaults to 0. In this case, the “expires_in” field in the authorization response must be set by the authorization server, or the OAuth flow will fail.
`refreshToken`	boolean	false	RefreshToken indicates whether the Envoy should automatically refresh the id token and access token when they expire. When set to true, the Envoy will use the refresh token to get a new id token and access token when they expire. If not specified, defaults to false.
`defaultRefreshTokenTTL`	Duration	false	DefaultRefreshTokenTTL is the default lifetime of the refresh token. This field is only used when the exp (expiration time) claim is omitted in the refresh token or the refresh token is not JWT. If not specified, defaults to 604800s (one week). Note: this field is only applicable when the “refreshToken” field is set to true.

OIDCCookieNames

OIDCCookieNames defines the names of cookies to use in the Envoy OIDC filter.

Appears in:

OIDC

Field	Type	Required	Description
`accessToken`	string	false	The name of the cookie used to store the AccessToken in the Authentication Request. If not specified, defaults to “AccessToken-(randomly generated uid)”
`idToken`	string	false	The name of the cookie used to store the IdToken in the Authentication Request. If not specified, defaults to “IdToken-(randomly generated uid)”

OIDCProvider

OIDCProvider defines the OIDC Provider configuration.

Appears in:

OIDC

Field	Type	Required	Description
`backendRef`	BackendObjectReference	false	BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.
`backendRefs`	BackendRef array	false	BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.
`backendSettings`	ClusterSettings	false	BackendSettings holds configuration for managing the connection to the backend.
`issuer`	string	true	The OIDC Provider’s issuer identifier. Issuer MUST be a URI RFC 3986 [RFC3986] with a scheme component that MUST be https, a host component, and optionally, port and path components and no query or fragment components.
`authorizationEndpoint`	string	false	The OIDC Provider’s authorization endpoint. If not provided, EG will try to discover it from the provider’s Well-Known Configuration Endpoint.
`tokenEndpoint`	string	false	The OIDC Provider’s token endpoint. If not provided, EG will try to discover it from the provider’s Well-Known Configuration Endpoint.

OpenTelemetryEnvoyProxyAccessLog

OpenTelemetryEnvoyProxyAccessLog defines the OpenTelemetry access log sink.

Appears in:

ProxyAccessLogSink

Field	Type	Required	Description
`backendRef`	BackendObjectReference	false	BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.
`backendRefs`	BackendRef array	false	BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.
`backendSettings`	ClusterSettings	false	BackendSettings holds configuration for managing the connection to the backend.
`host`	string	false	Host define the extension service hostname. Deprecated: Use BackendRefs instead.
`port`	integer	false	Port defines the port the extension service is exposed on. Deprecated: Use BackendRefs instead.
`resources`	object (keys:string, values:string)	false	Resources is a set of labels that describe the source of a log entry, including envoy node info. It’s recommended to follow semantic conventions.

Origin

Underlying type: string

Origin is defined by the scheme (protocol), hostname (domain), and port of the URL used to access it. The hostname can be “precise” which is just the domain name or “wildcard” which is a domain name prefixed with a single wildcard label such as “*.example.com”. In addition to that a single wildcard (with or without scheme) can be configured to match any origin.

For example, the following are valid origins:

https://foo.example.com
https://*.example.com
http://foo.example.com:8080
http://*.example.com:8080
https://*

Appears in:

CORS

PassiveHealthCheck

PassiveHealthCheck defines the configuration for passive health checks in the context of Envoy’s Outlier Detection, see https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/outlier

Appears in:

HealthCheck

Field	Type	Required	Description
`splitExternalLocalOriginErrors`	boolean	false	SplitExternalLocalOriginErrors enables splitting of errors between external and local origin.
`interval`	Duration	false	Interval defines the time between passive health checks.
`consecutiveLocalOriginFailures`	integer	false	ConsecutiveLocalOriginFailures sets the number of consecutive local origin failures triggering ejection. Parameter takes effect only when split_external_local_origin_errors is set to true.
`consecutiveGatewayErrors`	integer	false	ConsecutiveGatewayErrors sets the number of consecutive gateway errors triggering ejection.
`consecutive5XxErrors`	integer	false	Consecutive5xxErrors sets the number of consecutive 5xx errors triggering ejection.
`baseEjectionTime`	Duration	false	BaseEjectionTime defines the base duration for which a host will be ejected on consecutive failures.
`maxEjectionPercent`	integer	false	MaxEjectionPercent sets the maximum percentage of hosts in a cluster that can be ejected.

PathEscapedSlashAction

Underlying type: string

PathEscapedSlashAction determines the action for requests that contain %2F, %2f, %5C, or %5c sequences in the URI path.

Appears in:

PathSettings

Value	Description
`KeepUnchanged`	KeepUnchangedAction keeps escaped slashes as they arrive without changes
`RejectRequest`	RejectRequestAction rejects client requests containing escaped slashes with a 400 status. gRPC requests will be rejected with the INTERNAL (13) error code. The “httpN.downstream_rq_failed_path_normalization” counter is incremented for each rejected request.
`UnescapeAndRedirect`	UnescapeAndRedirect unescapes %2F and %5C sequences and redirects to the new path if these sequences were present. Redirect occurs after path normalization and merge slashes transformations if they were configured. gRPC requests will be rejected with the INTERNAL (13) error code. This option minimizes possibility of path confusion exploits by forcing request with unescaped slashes to traverse all parties: downstream client, intermediate proxies, Envoy and upstream server. The “httpN.downstream_rq_redirected_with_normalized_path” counter is incremented for each redirected request.
`UnescapeAndForward`	UnescapeAndForward unescapes %2F and %5C sequences and forwards the request. Note: this option should not be enabled if intermediaries perform path based access control as it may lead to path confusion vulnerabilities.

PathSettings

PathSettings provides settings that managing how the incoming path set by clients is handled.

Appears in:

ClientTrafficPolicySpec

Field	Type	Required	Description
`escapedSlashesAction`	PathEscapedSlashAction	false	EscapedSlashesAction determines how %2f, %2F, %5c, or %5C sequences in the path URI should be handled. The default is UnescapeAndRedirect.
`disableMergeSlashes`	boolean	false	DisableMergeSlashes allows disabling the default configuration of merging adjacent slashes in the path. Note that slash merging is not part of the HTTP spec and is provided for convenience.

PerRetryPolicy

Appears in:

Retry

Field	Type	Required	Description
`timeout`	Duration	false	Timeout is the timeout per retry attempt.
`backOff`	BackOffPolicy	false	Backoff is the backoff policy to be applied per retry attempt. gateway uses a fully jittered exponential back-off algorithm for retries. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#config-http-filters-router-x-envoy-max-retries

PolicyTargetReferences

Appears in:

Field	Type	Required	Description
`targetRef`	LocalPolicyTargetReferenceWithSectionName	true	TargetRef is the name of the resource this policy is being attached to. This policy and the TargetRef MUST be in the same namespace for this Policy to have effect Deprecated: use targetRefs/targetSelectors instead
`targetRefs`	LocalPolicyTargetReferenceWithSectionName array	true	TargetRefs are the names of the Gateway resources this policy is being attached to.
`targetSelectors`	TargetSelector array	true	TargetSelectors allow targeting resources for this policy based on labels

Principal

If there are multiple principal types, all principals must match for the rule to match.

Appears in:

AuthorizationRule

Field	Type	Required	Description
`clientCIDRs`	CIDR array	false	ClientCIDRs are the IP CIDR ranges of the client. Valid examples are “192.168.1.0/24” or “2001:db8::/64” If multiple CIDR ranges are specified, one of the CIDR ranges must match the client IP for the rule to match. The client IP is inferred from the X-Forwarded-For header, a custom header, or the proxy protocol. You can use the `ClientIPDetection` or the `EnableProxyProtocol` field in the `ClientTrafficPolicy` to configure how the client IP is detected.
`jwt`	JWTPrincipal	false	JWT authorize the request based on the JWT claims and scopes. Note: in order to use JWT claims for authorization, you must configure the JWT authentication in the same `SecurityPolicy`.

ProcessingModeOptions

ProcessingModeOptions defines if headers or body should be processed by the external service

Appears in:

ExtProcProcessingMode

Field	Type	Required	Description
`body`	ExtProcBodyProcessingMode	false	Defines body processing mode

ProviderType

Underlying type: string

ProviderType defines the types of providers supported by Envoy Gateway.

Appears in:

Value	Description
`Kubernetes`	ProviderTypeKubernetes defines the “Kubernetes” provider.
`Custom`	ProviderTypeCustom defines the “Custom” provider.

ProxyAccessLog

Appears in:

ProxyTelemetry

Field	Type	Required	Description
`disable`	boolean	true	Disable disables access logging for managed proxies if set to true.
`settings`	ProxyAccessLogSetting array	false	Settings defines accesslog settings for managed proxies. If unspecified, will send default format to stdout.

ProxyAccessLogFormat

ProxyAccessLogFormat defines the format of accesslog. By default accesslogs are written to standard output.

Appears in:

ProxyAccessLogSetting

Field	Type	Required	Description
`type`	ProxyAccessLogFormatType	true	Type defines the type of accesslog format.
`text`	string	false	Text defines the text accesslog format, following Envoy accesslog formatting, It’s required when the format type is “Text”. Envoy command operators may be used in the format. The format string documentation provides more information.
`json`	object (keys:string, values:string)	false	JSON is additional attributes that describe the specific event occurrence. Structured format for the envoy access logs. Envoy command operators can be used as values for fields within the Struct. It’s required when the format type is “JSON”.

ProxyAccessLogFormatType

Underlying type: string

Appears in:

ProxyAccessLogFormat

Value	Description
`Text`	ProxyAccessLogFormatTypeText defines the text accesslog format.
`JSON`	ProxyAccessLogFormatTypeJSON defines the JSON accesslog format.

ProxyAccessLogSetting

Appears in:

ProxyAccessLog

Field	Type	Required	Description
`format`	ProxyAccessLogFormat	false	Format defines the format of accesslog. This will be ignored if sink type is ALS.
`matches`	string array	true	Matches defines the match conditions for accesslog in CEL expression. An accesslog will be emitted only when one or more match conditions are evaluated to true. Invalid CEL expressions will be ignored.
`sinks`	ProxyAccessLogSink array	true	Sinks defines the sinks of accesslog.
`type`	ProxyAccessLogType	false	Type defines the component emitting the accesslog, such as Listener and Route. If type not defined, the setting would apply to: (1) All Routes. (2) Listeners if and only if Envoy does not find a matching route for a request. If type is defined, the accesslog settings would apply to the relevant component (as-is).

ProxyAccessLogSink

ProxyAccessLogSink defines the sink of accesslog.

Appears in:

ProxyAccessLogSetting

Field	Type	Required	Description
`type`	ProxyAccessLogSinkType	true	Type defines the type of accesslog sink.
`als`	ALSEnvoyProxyAccessLog	false	ALS defines the gRPC Access Log Service (ALS) sink.
`file`	FileEnvoyProxyAccessLog	false	File defines the file accesslog sink.
`openTelemetry`	OpenTelemetryEnvoyProxyAccessLog	false	OpenTelemetry defines the OpenTelemetry accesslog sink.

ProxyAccessLogSinkType

Underlying type: string

Appears in:

ProxyAccessLogSink

Value	Description
`ALS`	ProxyAccessLogSinkTypeALS defines the gRPC Access Log Service (ALS) sink. The service must implement the Envoy gRPC Access Log Service streaming API: https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/accesslog/v3/als.proto
`File`	ProxyAccessLogSinkTypeFile defines the file accesslog sink.
`OpenTelemetry`	ProxyAccessLogSinkTypeOpenTelemetry defines the OpenTelemetry accesslog sink. When the provider is Kubernetes, EnvoyGateway always sends `k8s.namespace.name` and `k8s.pod.name` as additional attributes.

ProxyAccessLogType

Underlying type: string

Appears in:

ProxyAccessLogSetting

Value Description

Listener ProxyAccessLogTypeListener defines the accesslog for Listeners.
https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/listener/v3/listener.proto#envoy-v3-api-field-config-listener-v3-listener-access-log

Route ProxyAccessLogTypeRoute defines the accesslog for HTTP, GRPC, UDP and TCP Routes.
https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/udp/udp_proxy/v3/udp_proxy.proto#envoy-v3-api-field-extensions-filters-udp-udp-proxy-v3-udpproxyconfig-access-log
https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/tcp_proxy/v3/tcp_proxy.proto#envoy-v3-api-field-extensions-filters-network-tcp-proxy-v3-tcpproxy-access-log
https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-access-log

ProxyBootstrap

ProxyBootstrap defines Envoy Bootstrap configuration.

Appears in:

EnvoyProxySpec

Field	Type	Required	Description
`type`	BootstrapType	false	Type is the type of the bootstrap configuration, it should be either Replace, Merge, or JSONPatch. If unspecified, it defaults to Replace.
`value`	string	false	Value is a YAML string of the bootstrap.
`jsonPatches`	JSONPatchOperation array	true	JSONPatches is an array of JSONPatches to be applied to the default bootstrap. Patches are applied in the order in which they are defined.

ProxyLogComponent

Underlying type: string

ProxyLogComponent defines a component that supports a configured logging level.

Appears in:

ProxyLogging

Value	Description
`default`	LogComponentDefault defines the default logging component. See more details: https://www.envoyproxy.io/docs/envoy/latest/operations/cli#cmdoption-l
`upstream`	LogComponentUpstream defines the “upstream” logging component.
`http`	LogComponentHTTP defines the “http” logging component.
`connection`	LogComponentConnection defines the “connection” logging component.
`admin`	LogComponentAdmin defines the “admin” logging component.
`client`	LogComponentClient defines the “client” logging component.
`filter`	LogComponentFilter defines the “filter” logging component.
`main`	LogComponentMain defines the “main” logging component.
`router`	LogComponentRouter defines the “router” logging component.
`runtime`	LogComponentRuntime defines the “runtime” logging component.

ProxyLogging

ProxyLogging defines logging parameters for managed proxies.

Appears in:

EnvoyProxySpec

Field	Type	Required	Description
`level`	object (keys:ProxyLogComponent, values:LogLevel)	true	Level is a map of logging level per component, where the component is the key and the log level is the value. If unspecified, defaults to “default: warn”.

ProxyMetricSink

ProxyMetricSink defines the sink of metrics. Default metrics sink is OpenTelemetry.

Appears in:

ProxyMetrics

Field	Type	Required	Description
`type`	MetricSinkType	true	Type defines the metric sink type. EG currently only supports OpenTelemetry.
`openTelemetry`	ProxyOpenTelemetrySink	false	OpenTelemetry defines the configuration for OpenTelemetry sink. It’s required if the sink type is OpenTelemetry.

ProxyMetrics

Appears in:

ProxyTelemetry

Field	Type	Required	Description
`prometheus`	ProxyPrometheusProvider	true	Prometheus defines the configuration for Admin endpoint `/stats/prometheus`.
`sinks`	ProxyMetricSink array	true	Sinks defines the metric sinks where metrics are sent to.
`matches`	StringMatch array	true	Matches defines configuration for selecting specific metrics instead of generating all metrics stats that are enabled by default. This helps reduce CPU and memory overhead in Envoy, but eliminating some stats may after critical functionality. Here are the stats that we strongly recommend not disabling: `cluster_manager.warming_clusters`, `cluster.<cluster_name>.membership_total`,`cluster.<cluster_name>.membership_healthy`, `cluster.<cluster_name>.membership_degraded`，reference https://github.com/envoyproxy/envoy/issues/9856, https://github.com/envoyproxy/envoy/issues/14610
`enableVirtualHostStats`	boolean	false	EnableVirtualHostStats enables envoy stat metrics for virtual hosts.
`enablePerEndpointStats`	boolean	false	EnablePerEndpointStats enables per endpoint envoy stats metrics. Please use with caution.
`enableRequestResponseSizesStats`	boolean	false	EnableRequestResponseSizesStats enables publishing of histograms tracking header and body sizes of requests and responses.

ProxyOpenTelemetrySink

ProxyOpenTelemetrySink defines the configuration for OpenTelemetry sink.

Appears in:

ProxyMetricSink

Field	Type	Required	Description
`backendRef`	BackendObjectReference	false	BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.
`backendRefs`	BackendRef array	false	BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.
`backendSettings`	ClusterSettings	false	BackendSettings holds configuration for managing the connection to the backend.
`host`	string	false	Host define the service hostname. Deprecated: Use BackendRefs instead.
`port`	integer	false	Port defines the port the service is exposed on. Deprecated: Use BackendRefs instead.

ProxyPrometheusProvider

Appears in:

ProxyMetrics

Field	Type	Required	Description
`disable`	boolean	true	Disable the Prometheus endpoint.
`compression`	Compression	false	Configure the compression on Prometheus endpoint. Compression is useful in situations when bandwidth is scarce and large payloads can be effectively compressed at the expense of higher CPU load.

ProxyProtocol

ProxyProtocol defines the configuration related to the proxy protocol when communicating with the backend.

Appears in:

Field	Type	Required	Description
`version`	ProxyProtocolVersion	true	Version of ProxyProtol Valid ProxyProtocolVersion values are “V1” “V2”

ProxyProtocolVersion

Underlying type: string

ProxyProtocolVersion defines the version of the Proxy Protocol to use.

Appears in:

ProxyProtocol

Value	Description
`V1`	ProxyProtocolVersionV1 is the PROXY protocol version 1 (human readable format).
`V2`	ProxyProtocolVersionV2 is the PROXY protocol version 2 (binary format).

ProxyTelemetry

Appears in:

EnvoyProxySpec

Field	Type	Required	Description
`accessLog`	ProxyAccessLog	false	AccessLogs defines accesslog parameters for managed proxies. If unspecified, will send default format to stdout.
`tracing`	ProxyTracing	false	Tracing defines tracing configuration for managed proxies. If unspecified, will not send tracing data.
`metrics`	ProxyMetrics	true	Metrics defines metrics configuration for managed proxies.

ProxyTracing

Appears in:

ProxyTelemetry

Field	Type	Required	Description
`samplingRate`	integer	false	SamplingRate controls the rate at which traffic will be selected for tracing if no prior sampling decision has been made. Defaults to 100, valid values [0-100]. 100 indicates 100% sampling.
`customTags`	object (keys:string, values:CustomTag)	true	CustomTags defines the custom tags to add to each span. If provider is kubernetes, pod name and namespace are added by default.
`provider`	TracingProvider	true	Provider defines the tracing provider.

RateLimit

RateLimit defines the configuration associated with the Rate Limit Service used for Global Rate Limiting.

Appears in:

Field	Type	Required	Description
`backend`	RateLimitDatabaseBackend	true	Backend holds the configuration associated with the database backend used by the rate limit service to store state associated with global ratelimiting.
`timeout`	Duration	false	Timeout specifies the timeout period for the proxy to access the ratelimit server If not set, timeout is 20ms.
`failClosed`	boolean	true	FailClosed is a switch used to control the flow of traffic when the response from the ratelimit server cannot be obtained. If FailClosed is false, let the traffic pass, otherwise, don’t let the traffic pass and return 500. If not set, FailClosed is False.
`telemetry`	RateLimitTelemetry	false	Telemetry defines telemetry configuration for RateLimit.

RateLimitDatabaseBackend

RateLimitDatabaseBackend defines the configuration associated with the database backend used by the rate limit service.

Appears in:

RateLimit

Field	Type	Required	Description
`type`	RateLimitDatabaseBackendType	true	Type is the type of database backend to use. Supported types are: * Redis: Connects to a Redis database.
`redis`	RateLimitRedisSettings	false	Redis defines the settings needed to connect to a Redis database.

RateLimitDatabaseBackendType

Underlying type: string

RateLimitDatabaseBackendType specifies the types of database backend to be used by the rate limit service.

Appears in:

RateLimitDatabaseBackend

Value	Description
`Redis`	RedisBackendType uses a redis database for the rate limit service.

RateLimitMetrics

Appears in:

RateLimitTelemetry

Field	Type	Required	Description
`prometheus`	RateLimitMetricsPrometheusProvider	true	Prometheus defines the configuration for prometheus endpoint.

RateLimitMetricsPrometheusProvider

Appears in:

RateLimitMetrics

Field	Type	Required	Description
`disable`	boolean	true	Disable the Prometheus endpoint.

RateLimitRedisSettings

RateLimitRedisSettings defines the configuration for connecting to redis database.

Appears in:

RateLimitDatabaseBackend

Field	Type	Required	Description
`url`	string	true	URL of the Redis Database.
`tls`	RedisTLSSettings	false	TLS defines TLS configuration for connecting to redis database.

RateLimitRule

RateLimitRule defines the semantics for matching attributes from the incoming requests, and setting limits for them.

Appears in:

Field	Type	Required	Description
`clientSelectors`	RateLimitSelectCondition array	false	ClientSelectors holds the list of select conditions to select specific clients using attributes from the traffic flow. All individual select conditions must hold True for this rule and its limit to be applied. If no client selectors are specified, the rule applies to all traffic of the targeted Route. If the policy targets a Gateway, the rule applies to each Route of the Gateway. Please note that each Route has its own rate limit counters. For example, if a Gateway has two Routes, and the policy has a rule with limit 10rps, each Route will have its own 10rps limit.
`limit`	RateLimitValue	true	Limit holds the rate limit values. This limit is applied for traffic flows when the selectors compute to True, causing the request to be counted towards the limit. The limit is enforced and the request is ratelimited, i.e. a response with 429 HTTP status code is sent back to the client when the selected requests have reached the limit.

RateLimitSelectCondition

RateLimitSelectCondition specifies the attributes within the traffic flow that can be used to select a subset of clients to be ratelimited. All the individual conditions must hold True for the overall condition to hold True.

Appears in:

RateLimitRule

Field	Type	Required	Description
`headers`	HeaderMatch array	false	Headers is a list of request headers to match. Multiple header values are ANDed together, meaning, a request MUST match all the specified headers. At least one of headers or sourceCIDR condition must be specified.
`sourceCIDR`	SourceMatch	false	SourceCIDR is the client IP Address range to match on. At least one of headers or sourceCIDR condition must be specified.

RateLimitSpec

RateLimitSpec defines the desired state of RateLimitSpec.

Appears in:

BackendTrafficPolicySpec

Field	Type	Required	Description
`type`	RateLimitType	true	Type decides the scope for the RateLimits. Valid RateLimitType values are “Global” or “Local”.
`global`	GlobalRateLimit	false	Global defines global rate limit configuration.
`local`	LocalRateLimit	false	Local defines local rate limit configuration.

RateLimitTelemetry

Appears in:

RateLimit

Field	Type	Required	Description
`metrics`	RateLimitMetrics	true	Metrics defines metrics configuration for RateLimit.
`tracing`	RateLimitTracing	true	Tracing defines traces configuration for RateLimit.

RateLimitTracing

Appears in:

RateLimitTelemetry

Field	Type	Required	Description
`samplingRate`	integer	false	SamplingRate controls the rate at which traffic will be selected for tracing if no prior sampling decision has been made. Defaults to 100, valid values [0-100]. 100 indicates 100% sampling.
`provider`	RateLimitTracingProvider	true	Provider defines the rateLimit tracing provider. Only OpenTelemetry is supported currently.

RateLimitTracingProvider

RateLimitTracingProvider defines the tracing provider configuration of RateLimit

Appears in:

RateLimitTracing

Field	Type	Required	Description
`type`	RateLimitTracingProviderType	true	Type defines the tracing provider type. Since to RateLimit Exporter currently using OpenTelemetry, only OpenTelemetry is supported
`url`	string	true	URL is the endpoint of the trace collector that supports the OTLP protocol

RateLimitTracingProviderType

Underlying type: string

Appears in:

RateLimitTracingProvider

RateLimitType

Underlying type: string

RateLimitType specifies the types of RateLimiting.

Appears in:

RateLimitSpec

Value	Description
`Global`	GlobalRateLimitType allows the rate limits to be applied across all Envoy proxy instances.
`Local`	LocalRateLimitType allows the rate limits to be applied on a per Envoy proxy instance basis.

RateLimitUnit

Underlying type: string

RateLimitUnit specifies the intervals for setting rate limits. Valid RateLimitUnit values are “Second”, “Minute”, “Hour”, and “Day”.

Appears in:

RateLimitValue

Value	Description
`Second`	RateLimitUnitSecond specifies the rate limit interval to be 1 second.
`Minute`	RateLimitUnitMinute specifies the rate limit interval to be 1 minute.
`Hour`	RateLimitUnitHour specifies the rate limit interval to be 1 hour.
`Day`	RateLimitUnitDay specifies the rate limit interval to be 1 day.

RateLimitValue

RateLimitValue defines the limits for rate limiting.

Appears in:

RateLimitRule

Field	Type	Required	Description
`requests`	integer	true
`unit`	RateLimitUnit	true

RedisTLSSettings

RedisTLSSettings defines the TLS configuration for connecting to redis database.

Appears in:

RateLimitRedisSettings

Field	Type	Required	Description
`certificateRef`	SecretObjectReference	false	CertificateRef defines the client certificate reference for TLS connections. Currently only a Kubernetes Secret of type TLS is supported.

RemoteJWKS

RemoteJWKS defines how to fetch and cache JSON Web Key Sets (JWKS) from a remote HTTP/HTTPS endpoint.

Appears in:

JWTProvider

Field	Type	Required	Description
`uri`	string	true	URI is the HTTPS URI to fetch the JWKS. Envoy’s system trust bundle is used to validate the server certificate.

ReplaceRegexMatch

Appears in:

HTTPPathModifier

Field	Type	Required	Description
`pattern`	string	true	Pattern matches a regular expression against the value of the HTTP Path.The regex string must adhere to the syntax documented in https://github.com/google/re2/wiki/Syntax.
`substitution`	string	true	Substitution is an expression that replaces the matched portion.The expression may include numbered capture groups that adhere to syntax documented in https://github.com/google/re2/wiki/Syntax.

RequestHeaderCustomTag

RequestHeaderCustomTag adds value from request header to each span.

Appears in:

CustomTag

Field	Type	Required	Description
`name`	string	true	Name defines the name of the request header which to extract the value from.
`defaultValue`	string	false	DefaultValue defines the default value to use if the request header is not set.

ResourceProviderType

Underlying type: string

ResourceProviderType defines the types of custom resource providers supported by Envoy Gateway.

Appears in:

EnvoyGatewayResourceProvider

Value	Description
`File`	ResourceProviderTypeFile defines the “File” provider.

ResponseOverride

ResponseOverride defines the configuration to override specific responses with a custom one.

Appears in:

BackendTrafficPolicySpec

Field	Type	Required	Description
`match`	CustomResponseMatch	true	Match configuration.
`response`	CustomResponse	true	Response configuration.

ResponseValueType

Underlying type: string

ResponseValueType defines the types of values for the response body supported by Envoy Gateway.

Appears in:

CustomResponseBody

Value	Description
`Inline`	ResponseValueTypeInline defines the “Inline” response body type.
`ValueRef`	ResponseValueTypeValueRef defines the “ValueRef” response body type.

Retry

Retry defines the retry strategy to be applied.

Appears in:

Field	Type	Required	Description
`numRetries`	integer	false	NumRetries is the number of retries to be attempted. Defaults to 2.
`retryOn`	RetryOn	false	RetryOn specifies the retry trigger condition. If not specified, the default is to retry on connect-failure,refused-stream,unavailable,cancelled,retriable-status-codes(503).
`perRetry`	PerRetryPolicy	false	PerRetry is the retry policy to be applied per retry attempt.

RetryOn

Appears in:

Retry

Field	Type	Required	Description
`triggers`	TriggerEnum array	false	Triggers specifies the retry trigger condition(Http/Grpc).
`httpStatusCodes`	HTTPStatus array	false	HttpStatusCodes specifies the http status codes to be retried. The retriable-status-codes trigger must also be configured for these status codes to trigger a retry.

RoutingType

Underlying type: string

RoutingType defines the type of routing of this Envoy proxy.

Appears in:

EnvoyProxySpec

Value	Description
`Service`	ServiceRoutingType is the RoutingType for Service Cluster IP routing.
`Endpoint`	EndpointRoutingType is the RoutingType for Endpoint routing.

SecurityPolicy

SecurityPolicy allows the user to configure various security settings for a Gateway.

Field	Type	Required	Description
`apiVersion`	string		`gateway.envoyproxy.io/v1alpha1`
`kind`	string		`SecurityPolicy`
`metadata`	ObjectMeta	true	Refer to Kubernetes API documentation for fields of `metadata`.
`spec`	SecurityPolicySpec	true	Spec defines the desired state of SecurityPolicy.
`status`	PolicyStatus	true	Status defines the current status of SecurityPolicy.

SecurityPolicySpec

SecurityPolicySpec defines the desired state of SecurityPolicy.

Appears in:

SecurityPolicy

Field	Type	Required	Description
`targetRef`	LocalPolicyTargetReferenceWithSectionName	true	TargetRef is the name of the resource this policy is being attached to. This policy and the TargetRef MUST be in the same namespace for this Policy to have effect Deprecated: use targetRefs/targetSelectors instead
`targetRefs`	LocalPolicyTargetReferenceWithSectionName array	true	TargetRefs are the names of the Gateway resources this policy is being attached to.
`targetSelectors`	TargetSelector array	true	TargetSelectors allow targeting resources for this policy based on labels
`cors`	CORS	false	CORS defines the configuration for Cross-Origin Resource Sharing (CORS).
`basicAuth`	BasicAuth	false	BasicAuth defines the configuration for the HTTP Basic Authentication.
`jwt`	JWT	false	JWT defines the configuration for JSON Web Token (JWT) authentication.
`oidc`	OIDC	false	OIDC defines the configuration for the OpenID Connect (OIDC) authentication.
`extAuth`	ExtAuth	false	ExtAuth defines the configuration for External Authorization.
`authorization`	Authorization	false	Authorization defines the authorization configuration.

ServiceExternalTrafficPolicy

Underlying type: string

ServiceExternalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service’s “externally-facing” addresses (NodePorts, ExternalIPs, and LoadBalancer IPs.

Appears in:

KubernetesServiceSpec

Value	Description
`Cluster`	ServiceExternalTrafficPolicyCluster routes traffic to all endpoints.
`Local`	ServiceExternalTrafficPolicyLocal preserves the source IP of the traffic by routing only to endpoints on the same node as the traffic was received on (dropping the traffic if there are no local endpoints).

ServiceType

Underlying type: string

ServiceType string describes ingress methods for a service

Appears in:

KubernetesServiceSpec

Value	Description
`ClusterIP`	ServiceTypeClusterIP means a service will only be accessible inside the cluster, via the cluster IP.
`LoadBalancer`	ServiceTypeLoadBalancer means a service will be exposed via an external load balancer (if the cloud provider supports it).
`NodePort`	ServiceTypeNodePort means a service will be exposed on each Kubernetes Node at a static Port, common across all Nodes.

Session

Session defines settings related to TLS session management.

Appears in:

ClientTLSSettings

Field	Type	Required	Description
`resumption`	SessionResumption	false	Resumption determines the proxy’s supported TLS session resumption option. By default, Envoy Gateway does not enable session resumption. Use sessionResumption to enable stateful and stateless session resumption. Users should consider security impacts of different resumption methods. Performance gains from resumption are diminished when Envoy proxy is deployed with more than one replica.

SessionResumption

SessionResumption defines supported tls session resumption methods and their associated configuration.

Appears in:

Session

Field	Type	Required	Description
`stateless`	StatelessTLSSessionResumption	false	Stateless defines setting for stateless (session-ticket based) session resumption
`stateful`	StatefulTLSSessionResumption	false	Stateful defines setting for stateful (session-id based) session resumption

ShutdownConfig

ShutdownConfig defines configuration for graceful envoy shutdown process.

Appears in:

EnvoyProxySpec

Field	Type	Required	Description
`drainTimeout`	Duration	false	DrainTimeout defines the graceful drain timeout. This should be less than the pod’s terminationGracePeriodSeconds. If unspecified, defaults to 60 seconds.
`minDrainDuration`	Duration	false	MinDrainDuration defines the minimum drain duration allowing time for endpoint deprogramming to complete. If unspecified, defaults to 10 seconds.

ShutdownManager

ShutdownManager defines the configuration for the shutdown manager.

Appears in:

EnvoyGatewayKubernetesProvider

Field	Type	Required	Description
`image`	string	true	Image specifies the ShutdownManager container image to be used, instead of the default image.

SlowStart

SlowStart defines the configuration related to the slow start load balancer policy.

Appears in:

LoadBalancer

Field	Type	Required	Description
`window`	Duration	true	Window defines the duration of the warm up period for newly added host. During slow start window, traffic sent to the newly added hosts will gradually increase. Currently only supports linear growth of traffic. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto#config-cluster-v3-cluster-slowstartconfig

SourceMatch

Appears in:

RateLimitSelectCondition

Field	Type	Required	Description
`type`	SourceMatchType	false
`value`	string	true	Value is the IP CIDR that represents the range of Source IP Addresses of the client. These could also be the intermediate addresses through which the request has flown through and is part of the `X-Forwarded-For` header. For example, `192.168.0.1/32`, `192.168.0.0/24`, `001:db8::/64`.

SourceMatchType

Underlying type: string

Appears in:

SourceMatch

Value	Description
`Exact`	SourceMatchExact All IP Addresses within the specified Source IP CIDR are treated as a single client selector and share the same rate limit bucket.
`Distinct`	SourceMatchDistinct Each IP Address within the specified Source IP CIDR is treated as a distinct client selector and uses a separate rate limit bucket/counter. Note: This is only supported for Global Rate Limits.

StatefulTLSSessionResumption

StatefulTLSSessionResumption defines the stateful (session-id based) type of TLS session resumption. Note: When Envoy Proxy is deployed with more than one replica, session caches are not synchronized between instances, possibly leading to resumption failures. Envoy does not re-validate client certificates upon session resumption. https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/route/v3/route_components.proto#config-route-v3-routematch-tlscontextmatchoptions

Appears in:

SessionResumption

StatelessTLSSessionResumption

StatelessTLSSessionResumption defines the stateless (session-ticket based) type of TLS session resumption. Note: When Envoy Proxy is deployed with more than one replica, session ticket encryption keys are not synchronized between instances, possibly leading to resumption failures. In-memory session ticket encryption keys are rotated every 48 hours. https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/transport_sockets/tls/v3/common.proto#extensions-transport-sockets-tls-v3-tlssessionticketkeys https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Session-tickets

Appears in:

SessionResumption

StatusCodeMatch

StatusCodeMatch defines the configuration for matching a status code.

Appears in:

CustomResponseMatch

Field	Type	Required	Description
`type`	StatusCodeValueType	true	Type is the type of value. Valid values are Value and Range, default is Value.
`value`	integer	false	Value contains the value of the status code.
`range`	StatusCodeRange	false	Range contains the range of status codes.

StatusCodeRange

StatusCodeRange defines the configuration for define a range of status codes.

Appears in:

StatusCodeMatch

Field	Type	Required	Description
`start`	integer	true	Start of the range, including the start value.
`end`	integer	true	End of the range, including the end value.

StatusCodeValueType

Underlying type: string

StatusCodeValueType defines the types of values for the status code match supported by Envoy Gateway.

Appears in:

StatusCodeMatch

Value	Description
`Value`	StatusCodeValueTypeValue defines the “Value” status code match type.
`Range`	StatusCodeValueTypeRange defines the “Range” status code match type.

StringMatch

StringMatch defines how to match any strings. This is a general purpose match condition that can be used by other EG APIs that need to match against a string.

Appears in:

ProxyMetrics

Field	Type	Required	Description
`type`	StringMatchType	false	Type specifies how to match against a string.
`value`	string	true	Value specifies the string value that the match must have.

StringMatchType

Underlying type: string

StringMatchType specifies the semantics of how a string value should be compared. Valid MatchType values are “Exact”, “Prefix”, “Suffix”, “RegularExpression”.

Appears in:

StringMatch

Value	Description
`Exact`	StringMatchExact :the input string must match exactly the match value.
`Prefix`	StringMatchPrefix :the input string must start with the match value.
`Suffix`	StringMatchSuffix :the input string must end with the match value.
`RegularExpression`	StringMatchRegularExpression :The input string must match the regular expression specified in the match value. The regex string must adhere to the syntax documented in https://github.com/google/re2/wiki/Syntax.

TCPActiveHealthChecker

TCPActiveHealthChecker defines the settings of tcp health check.

Appears in:

ActiveHealthCheck

Field	Type	Required	Description
`send`	ActiveHealthCheckPayload	false	Send defines the request payload.
`receive`	ActiveHealthCheckPayload	false	Receive defines the expected response payload.

TCPClientTimeout

TCPClientTimeout only provides timeout configuration on the listener whose protocol is TCP or TLS.

Appears in:

ClientTimeout

Field	Type	Required	Description
`idleTimeout`	Duration	false	IdleTimeout for a TCP connection. Idle time is defined as a period in which there are no bytes sent or received on either the upstream or downstream connection. Default: 1 hour.

TCPKeepalive

TCPKeepalive define the TCP Keepalive configuration.

Appears in:

Field	Type	Required	Description
`probes`	integer	false	The total number of unacknowledged probes to send before deciding the connection is dead. Defaults to 9.
`idleTime`	Duration	false	The duration a connection needs to be idle before keep-alive probes start being sent. The duration format is Defaults to `7200s`.
`interval`	Duration	false	The duration between keep-alive probes. Defaults to `75s`.

TCPTimeout

Appears in:

Timeout

Field	Type	Required	Description
`connectTimeout`	Duration	false	The timeout for network connection establishment, including TCP and TLS handshakes. Default: 10 seconds.

TLSSettings

Appears in:

Field	Type	Required	Description
`minVersion`	TLSVersion	false	Min specifies the minimal TLS protocol version to allow. The default is TLS 1.2 if this is not specified.
`maxVersion`	TLSVersion	false	Max specifies the maximal TLS protocol version to allow The default is TLS 1.3 if this is not specified.
`ciphers`	string array	false	Ciphers specifies the set of cipher suites supported when negotiating TLS 1.0 - 1.2. This setting has no effect for TLS 1.3. In non-FIPS Envoy Proxy builds the default cipher list is: - [ECDHE-ECDSA-AES128-GCM-SHA256\|ECDHE-ECDSA-CHACHA20-POLY1305] - [ECDHE-RSA-AES128-GCM-SHA256\|ECDHE-RSA-CHACHA20-POLY1305] - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 In builds using BoringSSL FIPS the default cipher list is: - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384
`ecdhCurves`	string array	false	ECDHCurves specifies the set of supported ECDH curves. In non-FIPS Envoy Proxy builds the default curves are: - X25519 - P-256 In builds using BoringSSL FIPS the default curve is: - P-256
`signatureAlgorithms`	string array	false	SignatureAlgorithms specifies which signature algorithms the listener should support.
`alpnProtocols`	ALPNProtocol array	false	ALPNProtocols supplies the list of ALPN protocols that should be exposed by the listener. By default h2 and http/1.1 are enabled. Supported values are: - http/1.0 - http/1.1 - h2

TLSVersion

Underlying type: string

TLSVersion specifies the TLS version

Appears in:

Value	Description
`Auto`	TLSAuto allows Envoy to choose the optimal TLS Version
`1.0`	TLS1.0 specifies TLS version 1.0
`1.1`	TLS1.1 specifies TLS version 1.1
`1.2`	TLSv1.2 specifies TLS version 1.2
`1.3`	TLSv1.3 specifies TLS version 1.3

TargetSelector

Appears in:

Field	Type	Required	Description
`group`	Group	true	Group is the group that this selector targets. Defaults to gateway.networking.k8s.io
`kind`	Kind	true	Kind is the resource kind that this selector targets.
`matchLabels`	object (keys:string, values:string)	true	MatchLabels are the set of label selectors for identifying the targeted resource

Timeout

Timeout defines configuration for timeouts related to connections.

Appears in:

Field	Type	Required	Description
`tcp`	TCPTimeout	false	Timeout settings for TCP.
`http`	HTTPTimeout	false	Timeout settings for HTTP.

TracingProvider

TracingProvider defines the tracing provider configuration.

Appears in:

ProxyTracing

Field	Type	Required	Description
`backendRef`	BackendObjectReference	false	BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.
`backendRefs`	BackendRef array	false	BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.
`backendSettings`	ClusterSettings	false	BackendSettings holds configuration for managing the connection to the backend.
`type`	TracingProviderType	true	Type defines the tracing provider type.
`host`	string	false	Host define the provider service hostname. Deprecated: Use BackendRefs instead.
`port`	integer	false	Port defines the port the provider service is exposed on. Deprecated: Use BackendRefs instead.
`zipkin`	ZipkinTracingProvider	false	Zipkin defines the Zipkin tracing provider configuration

TracingProviderType

Underlying type: string

Appears in:

TracingProvider

Value	Description
`OpenTelemetry`
`OpenTelemetry`
`Zipkin`
`Datadog`

TriggerEnum

Underlying type: string

TriggerEnum specifies the conditions that trigger retries.

Appears in:

RetryOn

Value	Description
`5xx`	The upstream server responds with any 5xx response code, or does not respond at all (disconnect/reset/read timeout). Includes connect-failure and refused-stream.
`gateway-error`	The response is a gateway error (502,503 or 504).
`reset`	The upstream server does not respond at all (disconnect/reset/read timeout.)
`connect-failure`	Connection failure to the upstream server (connect timeout, etc.). (Included in 5xx)
`retriable-4xx`	The upstream server responds with a retriable 4xx response code. Currently, the only response code in this category is 409.
`refused-stream`	The upstream server resets the stream with a REFUSED_STREAM error code.
`retriable-status-codes`	The upstream server responds with any response code matching one defined in the RetriableStatusCodes.
`cancelled`	The gRPC status code in the response headers is “cancelled”.
`deadline-exceeded`	The gRPC status code in the response headers is “deadline-exceeded”.
`internal`	The gRPC status code in the response headers is “internal”.
`resource-exhausted`	The gRPC status code in the response headers is “resource-exhausted”.
`unavailable`	The gRPC status code in the response headers is “unavailable”.

UnixSocket

UnixSocket describes TCP/UDP unix domain socket address, corresponding to Envoy’s Pipe https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/address.proto#config-core-v3-pipe

Appears in:

Field	Type	Required	Description
`path`	string	true	Path defines the unix domain socket path of the backend endpoint.

Wasm

Wasm defines a Wasm extension.

Note: at the moment, Envoy Gateway does not support configuring Wasm runtime. v8 is used as the VM runtime for the Wasm extensions.

Appears in:

EnvoyExtensionPolicySpec

Field	Type	Required	Description
`name`	string	false	Name is a unique name for this Wasm extension. It is used to identify the Wasm extension if multiple extensions are handled by the same vm_id and root_id. It’s also used for logging/debugging. If not specified, EG will generate a unique name for the Wasm extension.
`rootID`	string	true	RootID is a unique ID for a set of extensions in a VM which will share a RootContext and Contexts if applicable (e.g., an Wasm HttpFilter and an Wasm AccessLog). If left blank, all extensions with a blank root_id with the same vm_id will share Context(s). Note: RootID must match the root_id parameter used to register the Context in the Wasm code.
`code`	WasmCodeSource	true	Code is the Wasm code for the extension.
`config`	JSON	false	Config is the configuration for the Wasm extension. This configuration will be passed as a JSON string to the Wasm extension.
`failOpen`	boolean	false	FailOpen is a switch used to control the behavior when a fatal error occurs during the initialization or the execution of the Wasm extension. If FailOpen is set to true, the system bypasses the Wasm extension and allows the traffic to pass through. Otherwise, if it is set to false or not set (defaulting to false), the system blocks the traffic and returns an HTTP 5xx error.

WasmCodeSource

WasmCodeSource defines the source of the Wasm code.

Appears in:

Wasm

Field	Type	Required	Description
`type`	WasmCodeSourceType	true	Type is the type of the source of the Wasm code. Valid WasmCodeSourceType values are “HTTP” or “Image”.
`http`	HTTPWasmCodeSource	false	HTTP is the HTTP URL containing the Wasm code. Note that the HTTP server must be accessible from the Envoy proxy.
`image`	ImageWasmCodeSource	false	Image is the OCI image containing the Wasm code. Note that the image must be accessible from the Envoy Gateway.
`pullPolicy`	ImagePullPolicy	false	PullPolicy is the policy to use when pulling the Wasm module by either the HTTP or Image source. This field is only applicable when the SHA256 field is not set. If not specified, the default policy is IfNotPresent except for OCI images whose tag is latest. Note: EG does not update the Wasm module every time an Envoy proxy requests the Wasm module even if the pull policy is set to Always. It only updates the Wasm module when the EnvoyExtension resource version changes.

WasmCodeSourceType

Underlying type: string

WasmCodeSourceType specifies the types of sources for the Wasm code.

Appears in:

WasmCodeSource

Value	Description
`HTTP`	HTTPWasmCodeSourceType allows the user to specify the Wasm code in an HTTP URL.
`Image`	ImageWasmCodeSourceType allows the user to specify the Wasm code in an OCI image.

WithUnderscoresAction

Underlying type: string

WithUnderscoresAction configures the action to take when an HTTP header with underscores is encountered.

Appears in:

HeaderSettings

Value	Description
`Allow`	WithUnderscoresActionAllow allows headers with underscores to be passed through.
`RejectRequest`	WithUnderscoresActionRejectRequest rejects the client request. HTTP/1 requests are rejected with the 400 status. HTTP/2 requests end with the stream reset.
`DropHeader`	WithUnderscoresActionDropHeader drops the client header with name containing underscores. The header is dropped before the filter chain is invoked and as such filters will not see dropped headers.

XDSTranslatorHook

Underlying type: string

XDSTranslatorHook defines the types of hooks that an Envoy Gateway extension may support for the xds-translator

Appears in:

XDSTranslatorHooks

Value	Description
`VirtualHost`
`Route`
`HTTPListener`
`Translation`

XDSTranslatorHooks

XDSTranslatorHooks contains all the pre and post hooks for the xds-translator runner.

Appears in:

ExtensionHooks

Field	Type	Required	Description
`pre`	XDSTranslatorHook array	true
`post`	XDSTranslatorHook array	true

XFCCCertData

Underlying type: string

XFCCCertData specifies the fields in the client certificate to be forwarded in the XFCC header.

Appears in:

XForwardedClientCert

Value	Description
`Subject`	XFCCCertDataSubject is the Subject field of the current client certificate.
`Cert`	XFCCCertDataCert is the entire client certificate in URL encoded PEM format.
`Chain`	XFCCCertDataChain is the entire client certificate chain (including the leaf certificate) in URL encoded PEM format.
`DNS`	XFCCCertDataDNS is the DNS type Subject Alternative Name field of the current client certificate.
`URI`	XFCCCertDataURI is the URI type Subject Alternative Name field of the current client certificate.

XFCCForwardMode

Underlying type: string

XFCCForwardMode defines how XFCC header is handled by Envoy Proxy.

Appears in:

XForwardedClientCert

Value	Description
`Sanitize`	XFCCForwardModeSanitize removes the XFCC header from the request. This is the default mode.
`ForwardOnly`	XFCCForwardModeForwardOnly forwards the XFCC header in the request if the client connection is mTLS.
`AppendForward`	XFCCForwardModeAppendForward appends the client certificate information to the request’s XFCC header and forward it if the client connection is mTLS.
`SanitizeSet`	XFCCForwardModeSanitizeSet resets the XFCC header with the client certificate information and forward it if the client connection is mTLS. The existing certificate information in the XFCC header is removed.
`AlwaysForwardOnly`	XFCCForwardModeAlwaysForwardOnly always forwards the XFCC header in the request, regardless of whether the client connection is mTLS.

XForwardedClientCert

XForwardedClientCert configures how Envoy Proxy handle the x-forwarded-client-cert (XFCC) HTTP header.

Appears in:

HeaderSettings

Field	Type	Required	Description
`mode`	XFCCForwardMode	false	Mode defines how XFCC header is handled by Envoy Proxy. If not set, the default mode is `Sanitize`.
`certDetailsToAdd`	XFCCCertData array	false	CertDetailsToAdd specifies the fields in the client certificate to be forwarded in the XFCC header. Hash(the SHA 256 digest of the current client certificate) and By(the Subject Alternative Name) are always included if the client certificate is forwarded. This field is only applicable when the mode is set to `AppendForward` or `SanitizeSet` and the client connection is mTLS.

XForwardedForSettings

XForwardedForSettings provides configuration for using X-Forwarded-For headers for determining the client IP address. Refer to https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_conn_man/headers#x-forwarded-for for more details.

Appears in:

ClientIPDetectionSettings

Field	Type	Required	Description
`numTrustedHops`	integer	false	NumTrustedHops controls the number of additional ingress proxy hops from the right side of XFF HTTP headers to trust when determining the origin client’s IP address. Only one of NumTrustedHops and TrustedCIDRs must be set.

ZipkinTracingProvider

ZipkinTracingProvider defines the Zipkin tracing provider configuration.

Appears in:

TracingProvider

Field	Type	Required	Description
`enable128BitTraceId`	boolean	false	Enable128BitTraceID determines whether a 128bit trace id will be used when creating a new trace instance. If set to false, a 64bit trace id will be used.
`disableSharedSpanContext`	boolean	false	DisableSharedSpanContext determines whether the default Envoy behaviour of client and server spans sharing the same span context should be disabled.

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Last modified December 20, 2024: chore: fix typo (#4958) (2a10d47)