SecurityPolicy v1alpha1 — gateway.envoyproxy.io

apiKeyAuth object

APIKeyAuth defines the configuration for the API Key Authentication.

credentialRefs []object required

CredentialRefs is the Kubernetes secret which contains the API keys. This is an Opaque secret. Each API key is stored in the key representing the client id. If the secrets have a key for a duplicated client, the first one will be used.

group string

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kind is kind of the referent. For example "Secret".

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace is the namespace of the referenced object. 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

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

extractFrom []object required

ExtractFrom is where to fetch the key from the coming request. The value from the first source that has a key will be used.

cookies []string

Cookies is the names of the cookie to fetch the key from. If multiple cookies are specified, envoy will look for the api key in the order of the list. This field is optional, but only one of headers, params or cookies is supposed to be specified.

headers []string

Headers is the names of the header to fetch the key from. If multiple headers are specified, envoy will look for the api key in the order of the list. This field is optional, but only one of headers, params or cookies is supposed to be specified.

params []string

Params is the names of the query parameter to fetch the key from. If multiple params are specified, envoy will look for the api key in the order of the list. This field is optional, but only one of headers, params or cookies is supposed to be specified.

forwardClientIDHeader string

ForwardClientIDHeader is the name of the header to forward the client identity to the backend service. The header will be added to the request with the client id as the value.

sanitize boolean

Sanitize indicates whether to remove the API key from the request before forwarding it to the backend service.

authorization object

Authorization defines the authorization configuration.

defaultAction string

DefaultAction defines the default action to be taken if no rules match. If not specified, the default action is Deny.

enum: Allow, Deny

rules []object

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.

action string required

Action defines the action to be taken if the rule matches.

enum: Allow, Deny

name string

Name is a user-friendly name for the rule. If not specified, Envoy Gateway will generate a unique name for the rule.

minLength: 1

maxLength: 253

operation object

Operation specifies the operation of a request, such as HTTP methods. If not specified, all operations are matched on.

methods []string required

Methods are the HTTP methods of the request. If multiple methods are specified, all specified methods are allowed or denied, based on the action of the rule.

minItems: 1

maxItems: 16

principal object required

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.

clientCIDRs []string

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 `ProxyProtocol` field in the `ClientTrafficPolicy` to configure how the client IP is detected. For TCPRoute targets (raw TCP connections), HTTP headers such as X-Forwarded-For are not available. The client IP is obtained from the TCP connection's peer address. If intermediaries (load balancers, NAT) terminate or proxy TCP, the original client IP will only be available if the intermediary preserves the source address (for example by enabling the PROXY protocol or avoiding SNAT). Ensure your L4 proxy is configured to preserve the source IP to enable correct client-IP matching for TCPRoute targets.

minItems: 1

headers []object

Headers authorize the request based on user identity extracted from custom headers. If multiple headers are specified, all headers must match for the rule to match.

minItems: 1

maxItems: 256

name string required

Name of the HTTP header. The header name is case-insensitive unless PreserveHeaderCase is set to true. For example, "Foo" and "foo" are considered the same header.

minLength: 1

maxLength: 256

values []string required

Values are the values that the header must match. If multiple values are specified, the rule will match if any of the values match.

minItems: 1

maxItems: 256

jwt object

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`.

claims []object

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.

minItems: 1

maxItems: 16

name string required

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".

minLength: 1

maxLength: 253

valueType string

ValueType is the type of the claim value. Only String and StringArray types are supported for now.

enum: String, StringArray

values []string required

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.

minItems: 1

maxItems: 128

provider string required

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`.

minLength: 1

maxLength: 253

scopes []string

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 (or scp) claim, 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.

minItems: 1

maxItems: 16

sourceCIDRs []string

SourceCIDRs are the IP CIDR ranges of the source (L4 peer IP). 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 source IP for the rule to match. The source IP is the IP address of the peer that connected to Envoy. This IP is obtained from the TCP connection's peer address and is not affected by X-Forwarded-For or other IP detection headers. If intermediaries (load balancers, NAT) terminate or proxy TCP, the original client IP will only be available if the intermediary preserves the source address (for example by enabling the PROXY protocol or avoiding SNAT).

minItems: 1

basicAuth object

BasicAuth defines the configuration for the HTTP Basic Authentication.

forwardUsernameHeader string

This field specifies the header name to forward a successfully authenticated user to the backend. The header will be added to the request with the username as the value. If it is not specified, the username will not be forwarded.

users object required

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.

group string

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kind is kind of the referent. For example "Secret".

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace is the namespace of the referenced object. 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

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

cors object

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

allowCredentials boolean

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.

allowHeaders []string

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.

allowMethods []string

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.

allowOrigins []string

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.

exposeHeaders []string

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 string

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..

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

extAuth object

ExtAuth defines the configuration for External Authorization.

bodyToExtAuth object

BodyToExtAuth defines the Body to Ext Auth configuration.

maxRequestBytes integer required

MaxRequestBytes is the maximum size of a message body that the filter will hold in memory. Envoy will return HTTP 413 and will not initiate the authorization process when buffer reaches the number set in this field. Note that this setting will have precedence over failOpen mode.

format: int32

minimum: 1

contextExtensions []object

ContextExtensions are analogous to http_request.headers, however these contents will not be sent to the upstream server. This provides an extension mechanism for sending additional information to the auth server without modifying the proto definition. It maps to the internal opaque context in the filter chain.

name string required

Name of the context extension.

type string required

Type is the type of method to use to read the ContextExtension value. Valid values are Value and ValueRef, default is Value.

enum: Value, ValueRef

value string

Value of the context extension.

valueRef object

ValueRef for the context extension's value.

group string required

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

key string required

The key to select.

kind string required

Kind is kind of the referent. For example "HTTPRoute" or "Service".

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

failOpen boolean

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. If set to true, the External Authorization will also be bypassed if its configuration is invalid.

grpc object

GRPC defines the gRPC External Authorization service. Either GRPCService or HTTPService must be specified, and only one of them can be provided.

backendRef object

BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.

group string

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

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)

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

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

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

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.

format: int32

minimum: 1

maximum: 65535

backendRefs []object

BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.

maxItems: 16

fallback boolean

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%.

group string

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

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)

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

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

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

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.

format: int32

minimum: 1

maximum: 65535

weight integer

Weight specifies the proportion of requests forwarded to the referenced backend. This is computed as weight/(sum of all weights in this BackendRefs list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. Weight is not a percentage and the sum of weights does not need to equal 100. If only one backend is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weight is set to 0, no traffic should be forwarded for this entry. If unspecified, weight defaults to 1. Support for this field varies based on the context where used.

format: int32

minimum: 0

maximum: 1e+06

backendSettings object

BackendSettings holds configuration for managing the connection to the backend.

circuitBreaker object

Circuit Breaker settings for the upstream connections and requests. If not set, circuit breakers will be enabled with the default thresholds

maxConnections integer

The maximum number of connections that Envoy will establish to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxParallelRequests integer

The maximum number of parallel requests that Envoy will make to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxParallelRetries integer

The maximum number of parallel retries that Envoy will make to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxPendingRequests integer

The maximum number of pending requests that Envoy will queue to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxRequestsPerConnection integer

The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule. Default: unlimited.

format: int64

minimum: 0

maximum: 4.294967295e+09

perEndpoint object

PerEndpoint defines Circuit Breakers that will apply per-endpoint for an upstream cluster

maxConnections integer

MaxConnections configures the maximum number of connections that Envoy will establish per-endpoint to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

connection object

Connection includes backend connection settings.

bufferLimit string | integer

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.

preconnect object

Preconnect configures proactive upstream connections to reduce latency by establishing connections before they’re needed and avoiding connection establishment overhead. If unset, Envoy will fetch connections as needed to serve in-flight requests.

perEndpointPercent integer

PerEndpointPercent configures how many additional connections to maintain per upstream endpoint, useful for high-QPS or latency sensitive services. Expressed as a percentage of the connections required by active streams (e.g. 100 = preconnect disabled, 105 = 1.05x connections per-endpoint, 200 = 2.00×). Allowed value range is between 100-300. When both PerEndpointPercent and PredictivePercent are set, Envoy ensures both are satisfied (max of the two).

format: int32

minimum: 100

maximum: 300

predictivePercent integer

PredictivePercent configures how many additional connections to maintain across the cluster by anticipating which upstream endpoint the load balancer will select next, useful for low-QPS services. Relies on deterministic loadbalancing and is only supported with Random or RoundRobin. Expressed as a percentage of the connections required by active streams (e.g. 100 = 1.0 (no preconnect), 105 = 1.05× connections across the cluster, 200 = 2.00×). Minimum allowed value is 100. When both PerEndpointPercent and PredictivePercent are set Envoy ensures both are satisfied per host (max of the two).

format: int32

minimum: 100

socketBufferLimit string | integer

SocketBufferLimit provides configuration for the maximum buffer size in bytes for each socket to backend. SocketBufferLimit applies to socket streaming channel between TCP/IP stacks, it's in kernel space. For example, 20Mi, 1Gi, 256Ki etc. Note that when the suffix is not provided, the value is interpreted as bytes.

dns object

DNS includes dns resolution settings.

dnsRefreshRate string

DNSRefreshRate specifies the rate at which DNS records should be refreshed. Defaults to 30 seconds.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

lookupFamily string

LookupFamily determines how Envoy would resolve DNS for Routes where the backend is specified as a fully qualified domain name (FQDN). If set, this configuration overrides other defaults.

enum: IPv4, IPv6, IPv4Preferred, IPv6Preferred, IPv4AndIPv6

respectDnsTtl boolean

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.

healthCheck object

HealthCheck allows gateway to perform active health checking on backends.

active object

Active health check configuration

grpc object

GRPC defines the configuration of the GRPC health checker. It's optional, and can only be used if the specified type is GRPC.

service string

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.

healthyThreshold integer

HealthyThreshold defines the number of healthy health checks required before a backend host is marked healthy.

format: int32

minimum: 1

http object

HTTP defines the configuration of http health checker. It's required while the health checker type is HTTP.

expectedResponse object

ExpectedResponse defines a list of HTTP expected responses to match.

binary string

Binary payload base64 encoded.

format: byte

text string

Text payload in plain text.

type string required

Type defines the type of the payload.

expectedStatuses []integer

ExpectedStatuses defines a list of HTTP response statuses considered healthy. Defaults to 200 only

hostname string

Hostname defines the HTTP host that will be requested during health checking. Default: HTTPRoute or GRPCRoute hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

method string

Method defines the HTTP method used for health checking. Defaults to GET

path string required

Path defines the HTTP path that will be requested during health checking.

minLength: 1

maxLength: 1024

initialJitter string

InitialJitter defines the maximum time Envoy will wait before the first health check. Envoy will randomly select a value between 0 and the initial jitter value.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

interval string

Interval defines the time between active health checks.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

tcp object

TCP defines the configuration of tcp health checker. It's required while the health checker type is TCP.

receive object

Receive defines the expected response payload.

binary string

Binary payload base64 encoded.

format: byte

text string

Text payload in plain text.

type string required

Type defines the type of the payload.

send object

Send defines the request payload.

binary string

Binary payload base64 encoded.

format: byte

text string

Text payload in plain text.

type string required

Type defines the type of the payload.

timeout string

Timeout defines the time to wait for a health check response.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

type string required

Type defines the type of health checker.

unhealthyThreshold integer

UnhealthyThreshold defines the number of unhealthy health checks required before a backend host is marked unhealthy.

format: int32

minimum: 1

panicThreshold integer

When number of unhealthy endpoints for a backend reaches this threshold Envoy will disregard health status and balance across all endpoints. It's designed to prevent a situation in which host failures cascade throughout the cluster as load increases. If not set, the default value is 50%. To disable panic mode, set value to `0`.

format: int32

minimum: 0

maximum: 100

passive object

Passive passive check configuration

baseEjectionTime string

BaseEjectionTime defines the base duration for which a host will be ejected on consecutive failures.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

consecutive5XxErrors integer

Consecutive5xxErrors sets the number of consecutive 5xx errors triggering ejection.

format: int32

consecutiveGatewayErrors integer

ConsecutiveGatewayErrors sets the number of consecutive gateway errors triggering ejection.

format: int32

consecutiveLocalOriginFailures integer

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.

format: int32

failurePercentageThreshold integer

FailurePercentageThreshold sets the failure percentage threshold for outlier detection. If the failure percentage of a given host is greater than or equal to this value, it will be ejected. Defaults to 85.

format: int32

minimum: 0

maximum: 100

interval string

Interval defines the time between passive health checks.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxEjectionPercent integer

MaxEjectionPercent sets the maximum percentage of hosts in a cluster that can be ejected.

format: int32

splitExternalLocalOriginErrors boolean

SplitExternalLocalOriginErrors enables splitting of errors between external and local origin.

http2 object

HTTP2 provides HTTP/2 configuration for backend connections.

initialConnectionWindowSize string | integer

InitialConnectionWindowSize sets the initial window size for HTTP/2 connections. If not set, the default value is 1 MiB.

initialStreamWindowSize string | integer

InitialStreamWindowSize sets the initial window size for HTTP/2 streams. If not set, the default value is 64 KiB(64*1024).

maxConcurrentStreams integer

MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection. If not set, the default value is 100.

format: int32

minimum: 1

maximum: 2.147483647e+09

onInvalidMessage string

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

loadBalancer object

LoadBalancer policy to apply when routing traffic from the gateway to the backend endpoints. Defaults to `LeastRequest`.

consistentHash object

ConsistentHash defines the configuration when the load balancer type is set to ConsistentHash

cookie object

Cookie configures the cookie hash policy when the consistent hash type is set to Cookie.

attributes object

Additional Attributes to set for the generated cookie.

name string required

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 string

TTL of the generated cookie if the cookie is not present. This value sets the Max-Age attribute value.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

header object

Header configures the header hash policy when the consistent hash type is set to Header. Deprecated: use Headers instead

name string required

Name of the header to hash.

headers []object

Headers configures the header hash policy for each header, when the consistent hash type is set to Headers.

name string required

Name of the header to hash.

queryParams []object

QueryParams configures the query parameter hash policy when the consistent hash type is set to QueryParams.

name string required

Name of the query param to hash.

tableSize integer

The table size for consistent hashing, must be prime number limited to 5000011.

format: int64

minimum: 2

maximum: 5.000011e+06

type string required

ConsistentHashType defines the type of input to hash on. Valid Type values are "SourceIP", "Header", "Headers", "Cookie". "QueryParams".

enum: SourceIP, Header, Headers, Cookie, QueryParams

endpointOverride object

EndpointOverride defines the configuration for endpoint override. When specified, the load balancer will attempt to route requests to endpoints based on the override information extracted from request headers or metadata. If the override endpoints are not available, the configured load balancer policy will be used as fallback.

extractFrom []object required

ExtractFrom defines the sources to extract endpoint override information from.

minItems: 1

maxItems: 10

header string

Header defines the header to get the override endpoint addresses. The header value must specify at least one endpoint in `IP:Port` format or multiple endpoints in `IP:Port,IP:Port,...` format. For example `10.0.0.5:8080` or `[2600:4040:5204::1574:24ae]:80`. The IPv6 address is enclosed in square brackets.

slowStart object

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

window string required

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

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

type string required

Type decides the type of Load Balancer policy. Valid LoadBalancerType values are "ConsistentHash", "LeastRequest", "Random", "RoundRobin".

enum: ConsistentHash, LeastRequest, Random, RoundRobin

zoneAware object

ZoneAware defines the configuration related to the distribution of requests between locality zones.

preferLocal object

PreferLocalZone configures zone-aware routing to prefer sending traffic to the local locality zone.

force object

ForceLocalZone defines override configuration for forcing all traffic to stay within the local zone instead of the default behavior which maintains equal distribution among upstream endpoints while sending as much traffic as possible locally.

minEndpointsInZoneThreshold integer

MinEndpointsInZoneThreshold is the minimum number of upstream endpoints in the local zone required to honor the forceLocalZone override. This is useful for protecting zones with fewer endpoints.

format: int32

minEndpointsThreshold integer

MinEndpointsThreshold is the minimum number of total upstream endpoints across all zones required to enable zone-aware routing.

format: int64

percentageEnabled integer

Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured. If not specified, Envoy defaults to 100%.

format: int32

minimum: 0

maximum: 100

proxyProtocol object

ProxyProtocol enables the Proxy Protocol when communicating with the backend.

version string required

Version of ProxyProtol Valid ProxyProtocolVersion values are "V1" "V2"

enum: V1, V2

retry object

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.

numAttemptsPerPriority integer

NumAttemptsPerPriority defines the number of requests (initial attempt + retries) that should be sent to the same priority before switching to a different one. If not specified or set to 0, all requests are sent to the highest priority that is healthy.

format: int32

numRetries integer

NumRetries is the number of retries to be attempted. Defaults to 2.

format: int32

minimum: 0

perRetry object

PerRetry is the retry policy to be applied per retry attempt.

backOff object

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

baseInterval string

BaseInterval is the base interval between retries.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxInterval string

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

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

timeout string

Timeout is the timeout per retry attempt.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

retryOn object

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).

httpStatusCodes []integer

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.

triggers []string

Triggers specifies the retry trigger condition(Http/Grpc).

tcpKeepalive object

TcpKeepalive settings associated with the upstream client connection. Disabled by default.

idleTime string

The duration a connection needs to be idle before keep-alive probes start being sent. The duration format is Defaults to `7200s`.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

interval string

The duration between keep-alive probes. Defaults to `75s`.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

probes integer

The total number of unacknowledged probes to send before deciding the connection is dead. Defaults to 9.

format: int32

timeout object

Timeout settings for the backend connections.

http object

Timeout settings for HTTP.

connectionIdleTimeout string

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.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxConnectionDuration string

The maximum duration of an HTTP connection. Default: unlimited.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxStreamDuration string

MaxStreamDuration is the maximum duration for a stream to complete. This timeout measures the time from when the request is sent until the response stream is fully consumed and does not apply to non-streaming requests. When set to "0s", no max duration is applied and streams can run indefinitely.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

requestTimeout string

RequestTimeout is the time until which entire response is received from the upstream.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

tcp object

Timeout settings for TCP.

connectTimeout string

The timeout for network connection establishment, including TCP and TLS handshakes. Default: 10 seconds.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

headersToExtAuth []string

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.

http object

HTTP defines the HTTP External Authorization service. Either GRPCService or HTTPService must be specified, and only one of them can be provided.

backendRef object

BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.

group string

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

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)

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

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

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

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.

format: int32

minimum: 1

maximum: 65535

backendRefs []object

BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.

maxItems: 16

fallback boolean

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%.

group string

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

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)

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

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

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

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.

format: int32

minimum: 1

maximum: 65535

weight integer

Weight specifies the proportion of requests forwarded to the referenced backend. This is computed as weight/(sum of all weights in this BackendRefs list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. Weight is not a percentage and the sum of weights does not need to equal 100. If only one backend is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weight is set to 0, no traffic should be forwarded for this entry. If unspecified, weight defaults to 1. Support for this field varies based on the context where used.

format: int32

minimum: 0

maximum: 1e+06

backendSettings object

BackendSettings holds configuration for managing the connection to the backend.

circuitBreaker object

Circuit Breaker settings for the upstream connections and requests. If not set, circuit breakers will be enabled with the default thresholds

maxConnections integer

The maximum number of connections that Envoy will establish to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxParallelRequests integer

The maximum number of parallel requests that Envoy will make to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxParallelRetries integer

The maximum number of parallel retries that Envoy will make to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxPendingRequests integer

The maximum number of pending requests that Envoy will queue to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxRequestsPerConnection integer

The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule. Default: unlimited.

format: int64

minimum: 0

maximum: 4.294967295e+09

perEndpoint object

PerEndpoint defines Circuit Breakers that will apply per-endpoint for an upstream cluster

maxConnections integer

MaxConnections configures the maximum number of connections that Envoy will establish per-endpoint to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

connection object

Connection includes backend connection settings.

bufferLimit string | integer

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.

preconnect object

Preconnect configures proactive upstream connections to reduce latency by establishing connections before they’re needed and avoiding connection establishment overhead. If unset, Envoy will fetch connections as needed to serve in-flight requests.

perEndpointPercent integer

PerEndpointPercent configures how many additional connections to maintain per upstream endpoint, useful for high-QPS or latency sensitive services. Expressed as a percentage of the connections required by active streams (e.g. 100 = preconnect disabled, 105 = 1.05x connections per-endpoint, 200 = 2.00×). Allowed value range is between 100-300. When both PerEndpointPercent and PredictivePercent are set, Envoy ensures both are satisfied (max of the two).

format: int32

minimum: 100

maximum: 300

predictivePercent integer

PredictivePercent configures how many additional connections to maintain across the cluster by anticipating which upstream endpoint the load balancer will select next, useful for low-QPS services. Relies on deterministic loadbalancing and is only supported with Random or RoundRobin. Expressed as a percentage of the connections required by active streams (e.g. 100 = 1.0 (no preconnect), 105 = 1.05× connections across the cluster, 200 = 2.00×). Minimum allowed value is 100. When both PerEndpointPercent and PredictivePercent are set Envoy ensures both are satisfied per host (max of the two).

format: int32

minimum: 100

socketBufferLimit string | integer

SocketBufferLimit provides configuration for the maximum buffer size in bytes for each socket to backend. SocketBufferLimit applies to socket streaming channel between TCP/IP stacks, it's in kernel space. For example, 20Mi, 1Gi, 256Ki etc. Note that when the suffix is not provided, the value is interpreted as bytes.

dns object

DNS includes dns resolution settings.

dnsRefreshRate string

DNSRefreshRate specifies the rate at which DNS records should be refreshed. Defaults to 30 seconds.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

lookupFamily string

LookupFamily determines how Envoy would resolve DNS for Routes where the backend is specified as a fully qualified domain name (FQDN). If set, this configuration overrides other defaults.

enum: IPv4, IPv6, IPv4Preferred, IPv6Preferred, IPv4AndIPv6

respectDnsTtl boolean

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.

healthCheck object

HealthCheck allows gateway to perform active health checking on backends.

active object

Active health check configuration

grpc object

GRPC defines the configuration of the GRPC health checker. It's optional, and can only be used if the specified type is GRPC.

service string

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.

healthyThreshold integer

HealthyThreshold defines the number of healthy health checks required before a backend host is marked healthy.

format: int32

minimum: 1

http object

HTTP defines the configuration of http health checker. It's required while the health checker type is HTTP.

expectedResponse object

ExpectedResponse defines a list of HTTP expected responses to match.

binary string

Binary payload base64 encoded.

format: byte

text string

Text payload in plain text.

type string required

Type defines the type of the payload.

expectedStatuses []integer

ExpectedStatuses defines a list of HTTP response statuses considered healthy. Defaults to 200 only

hostname string

Hostname defines the HTTP host that will be requested during health checking. Default: HTTPRoute or GRPCRoute hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

method string

Method defines the HTTP method used for health checking. Defaults to GET

path string required

Path defines the HTTP path that will be requested during health checking.

minLength: 1

maxLength: 1024

initialJitter string

InitialJitter defines the maximum time Envoy will wait before the first health check. Envoy will randomly select a value between 0 and the initial jitter value.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

interval string

Interval defines the time between active health checks.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

tcp object

TCP defines the configuration of tcp health checker. It's required while the health checker type is TCP.

receive object

Receive defines the expected response payload.

binary string

Binary payload base64 encoded.

format: byte

text string

Text payload in plain text.

type string required

Type defines the type of the payload.

send object

Send defines the request payload.

binary string

Binary payload base64 encoded.

format: byte

text string

Text payload in plain text.

type string required

Type defines the type of the payload.

timeout string

Timeout defines the time to wait for a health check response.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

type string required

Type defines the type of health checker.

unhealthyThreshold integer

UnhealthyThreshold defines the number of unhealthy health checks required before a backend host is marked unhealthy.

format: int32

minimum: 1

panicThreshold integer

When number of unhealthy endpoints for a backend reaches this threshold Envoy will disregard health status and balance across all endpoints. It's designed to prevent a situation in which host failures cascade throughout the cluster as load increases. If not set, the default value is 50%. To disable panic mode, set value to `0`.

format: int32

minimum: 0

maximum: 100

passive object

Passive passive check configuration

baseEjectionTime string

BaseEjectionTime defines the base duration for which a host will be ejected on consecutive failures.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

consecutive5XxErrors integer

Consecutive5xxErrors sets the number of consecutive 5xx errors triggering ejection.

format: int32

consecutiveGatewayErrors integer

ConsecutiveGatewayErrors sets the number of consecutive gateway errors triggering ejection.

format: int32

consecutiveLocalOriginFailures integer

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.

format: int32

failurePercentageThreshold integer

FailurePercentageThreshold sets the failure percentage threshold for outlier detection. If the failure percentage of a given host is greater than or equal to this value, it will be ejected. Defaults to 85.

format: int32

minimum: 0

maximum: 100

interval string

Interval defines the time between passive health checks.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxEjectionPercent integer

MaxEjectionPercent sets the maximum percentage of hosts in a cluster that can be ejected.

format: int32

splitExternalLocalOriginErrors boolean

SplitExternalLocalOriginErrors enables splitting of errors between external and local origin.

http2 object

HTTP2 provides HTTP/2 configuration for backend connections.

initialConnectionWindowSize string | integer

InitialConnectionWindowSize sets the initial window size for HTTP/2 connections. If not set, the default value is 1 MiB.

initialStreamWindowSize string | integer

InitialStreamWindowSize sets the initial window size for HTTP/2 streams. If not set, the default value is 64 KiB(64*1024).

maxConcurrentStreams integer

MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection. If not set, the default value is 100.

format: int32

minimum: 1

maximum: 2.147483647e+09

onInvalidMessage string

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

loadBalancer object

LoadBalancer policy to apply when routing traffic from the gateway to the backend endpoints. Defaults to `LeastRequest`.

consistentHash object

ConsistentHash defines the configuration when the load balancer type is set to ConsistentHash

cookie object

Cookie configures the cookie hash policy when the consistent hash type is set to Cookie.

attributes object

Additional Attributes to set for the generated cookie.

name string required

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 string

TTL of the generated cookie if the cookie is not present. This value sets the Max-Age attribute value.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

header object

Header configures the header hash policy when the consistent hash type is set to Header. Deprecated: use Headers instead

name string required

Name of the header to hash.

headers []object

Headers configures the header hash policy for each header, when the consistent hash type is set to Headers.

name string required

Name of the header to hash.

queryParams []object

QueryParams configures the query parameter hash policy when the consistent hash type is set to QueryParams.

name string required

Name of the query param to hash.

tableSize integer

The table size for consistent hashing, must be prime number limited to 5000011.

format: int64

minimum: 2

maximum: 5.000011e+06

type string required

ConsistentHashType defines the type of input to hash on. Valid Type values are "SourceIP", "Header", "Headers", "Cookie". "QueryParams".

enum: SourceIP, Header, Headers, Cookie, QueryParams

endpointOverride object

EndpointOverride defines the configuration for endpoint override. When specified, the load balancer will attempt to route requests to endpoints based on the override information extracted from request headers or metadata. If the override endpoints are not available, the configured load balancer policy will be used as fallback.

extractFrom []object required

ExtractFrom defines the sources to extract endpoint override information from.

minItems: 1

maxItems: 10

header string

Header defines the header to get the override endpoint addresses. The header value must specify at least one endpoint in `IP:Port` format or multiple endpoints in `IP:Port,IP:Port,...` format. For example `10.0.0.5:8080` or `[2600:4040:5204::1574:24ae]:80`. The IPv6 address is enclosed in square brackets.

slowStart object

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

window string required

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

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

type string required

Type decides the type of Load Balancer policy. Valid LoadBalancerType values are "ConsistentHash", "LeastRequest", "Random", "RoundRobin".

enum: ConsistentHash, LeastRequest, Random, RoundRobin

zoneAware object

ZoneAware defines the configuration related to the distribution of requests between locality zones.

preferLocal object

PreferLocalZone configures zone-aware routing to prefer sending traffic to the local locality zone.

force object

ForceLocalZone defines override configuration for forcing all traffic to stay within the local zone instead of the default behavior which maintains equal distribution among upstream endpoints while sending as much traffic as possible locally.

minEndpointsInZoneThreshold integer

MinEndpointsInZoneThreshold is the minimum number of upstream endpoints in the local zone required to honor the forceLocalZone override. This is useful for protecting zones with fewer endpoints.

format: int32

minEndpointsThreshold integer

MinEndpointsThreshold is the minimum number of total upstream endpoints across all zones required to enable zone-aware routing.

format: int64

percentageEnabled integer

Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured. If not specified, Envoy defaults to 100%.

format: int32

minimum: 0

maximum: 100

proxyProtocol object

ProxyProtocol enables the Proxy Protocol when communicating with the backend.

version string required

Version of ProxyProtol Valid ProxyProtocolVersion values are "V1" "V2"

enum: V1, V2

retry object

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.

numAttemptsPerPriority integer

NumAttemptsPerPriority defines the number of requests (initial attempt + retries) that should be sent to the same priority before switching to a different one. If not specified or set to 0, all requests are sent to the highest priority that is healthy.

format: int32

numRetries integer

NumRetries is the number of retries to be attempted. Defaults to 2.

format: int32

minimum: 0

perRetry object

PerRetry is the retry policy to be applied per retry attempt.

backOff object

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

baseInterval string

BaseInterval is the base interval between retries.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxInterval string

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

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

timeout string

Timeout is the timeout per retry attempt.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

retryOn object

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).

httpStatusCodes []integer

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.

triggers []string

Triggers specifies the retry trigger condition(Http/Grpc).

tcpKeepalive object

TcpKeepalive settings associated with the upstream client connection. Disabled by default.

idleTime string

The duration a connection needs to be idle before keep-alive probes start being sent. The duration format is Defaults to `7200s`.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

interval string

The duration between keep-alive probes. Defaults to `75s`.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

probes integer

The total number of unacknowledged probes to send before deciding the connection is dead. Defaults to 9.

format: int32

timeout object

Timeout settings for the backend connections.

http object

Timeout settings for HTTP.

connectionIdleTimeout string

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.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxConnectionDuration string

The maximum duration of an HTTP connection. Default: unlimited.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxStreamDuration string

MaxStreamDuration is the maximum duration for a stream to complete. This timeout measures the time from when the request is sent until the response stream is fully consumed and does not apply to non-streaming requests. When set to "0s", no max duration is applied and streams can run indefinitely.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

requestTimeout string

RequestTimeout is the time until which entire response is received from the upstream.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

tcp object

Timeout settings for TCP.

connectTimeout string

The timeout for network connection establishment, including TCP and TLS handshakes. Default: 10 seconds.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

headersToBackend []string

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.

path string

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 use the path of the original request. Please note that the original request path will be appended to the path specified here. For example, if the original request path is "/hello", and the path specified here is "/auth", then the path of the authorization request will be "/auth/hello". If the path is not specified, the path of the authorization request will be "/hello".

recomputeRoute boolean

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.

timeout string

Timeout defines the timeout for requests to the external authorization service. If not specified, defaults to 10 seconds.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

jwt object

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

optional boolean

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 []object required

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.

minItems: 1

maxItems: 4

audiences []string

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.

maxItems: 8

claimToHeaders []object

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

claim string required

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.

header string required

Header defines the name of the HTTP request header that the JWT Claim will be saved into.

extractFrom object

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.

cookies []string

Cookies represents a list of cookie names to extract the JWT token from.

headers []object

Headers represents a list of HTTP request headers to extract the JWT token from.

name string required

Name is the HTTP header name to retrieve the token

valuePrefix string

ValuePrefix is the prefix that should be stripped before extracting the token. The format would be used by Envoy like "{ValuePrefix}<TOKEN>". For example, "Authorization: Bearer <TOKEN>", then the ValuePrefix="Bearer " with a space at the end.

params []string

Params represents a list of query parameters to extract the JWT token from.

issuer string

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.

maxLength: 253

localJWKS object

LocalJWKS defines how to get the JSON Web Key Sets (JWKS) from a local source.

inline string

Inline contains the value as an inline string.

type string required

Type is the type of method to use to read the body value. Valid values are Inline and ValueRef, default is Inline.

enum: Inline, ValueRef

valueRef object

ValueRef is a reference to a local ConfigMap that contains the JSON Web Key Sets (JWKS). The value of key `jwks` in the ConfigMap will be used. If the key is not found, the first value in the ConfigMap will be used.

group string required

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string required

Kind is kind of the referent. For example "HTTPRoute" or "Service".

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

name string required

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.

minLength: 1

maxLength: 253

recomputeRoute boolean

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.

remoteJWKS object

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

backendRef object

BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.

group string

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

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)

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

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

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

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.

format: int32

minimum: 1

maximum: 65535

backendRefs []object

BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.

maxItems: 16

fallback boolean

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%.

group string

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

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)

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

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

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

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.

format: int32

minimum: 1

maximum: 65535

weight integer

Weight specifies the proportion of requests forwarded to the referenced backend. This is computed as weight/(sum of all weights in this BackendRefs list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. Weight is not a percentage and the sum of weights does not need to equal 100. If only one backend is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weight is set to 0, no traffic should be forwarded for this entry. If unspecified, weight defaults to 1. Support for this field varies based on the context where used.

format: int32

minimum: 0

maximum: 1e+06

backendSettings object

BackendSettings holds configuration for managing the connection to the backend.

circuitBreaker object

Circuit Breaker settings for the upstream connections and requests. If not set, circuit breakers will be enabled with the default thresholds

maxConnections integer

The maximum number of connections that Envoy will establish to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxParallelRequests integer

The maximum number of parallel requests that Envoy will make to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxParallelRetries integer

The maximum number of parallel retries that Envoy will make to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxPendingRequests integer

The maximum number of pending requests that Envoy will queue to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxRequestsPerConnection integer

The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule. Default: unlimited.

format: int64

minimum: 0

maximum: 4.294967295e+09

perEndpoint object

PerEndpoint defines Circuit Breakers that will apply per-endpoint for an upstream cluster

maxConnections integer

MaxConnections configures the maximum number of connections that Envoy will establish per-endpoint to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

connection object

Connection includes backend connection settings.

bufferLimit string | integer

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.

preconnect object

Preconnect configures proactive upstream connections to reduce latency by establishing connections before they’re needed and avoiding connection establishment overhead. If unset, Envoy will fetch connections as needed to serve in-flight requests.

perEndpointPercent integer

PerEndpointPercent configures how many additional connections to maintain per upstream endpoint, useful for high-QPS or latency sensitive services. Expressed as a percentage of the connections required by active streams (e.g. 100 = preconnect disabled, 105 = 1.05x connections per-endpoint, 200 = 2.00×). Allowed value range is between 100-300. When both PerEndpointPercent and PredictivePercent are set, Envoy ensures both are satisfied (max of the two).

format: int32

minimum: 100

maximum: 300

predictivePercent integer

PredictivePercent configures how many additional connections to maintain across the cluster by anticipating which upstream endpoint the load balancer will select next, useful for low-QPS services. Relies on deterministic loadbalancing and is only supported with Random or RoundRobin. Expressed as a percentage of the connections required by active streams (e.g. 100 = 1.0 (no preconnect), 105 = 1.05× connections across the cluster, 200 = 2.00×). Minimum allowed value is 100. When both PerEndpointPercent and PredictivePercent are set Envoy ensures both are satisfied per host (max of the two).

format: int32

minimum: 100

socketBufferLimit string | integer

SocketBufferLimit provides configuration for the maximum buffer size in bytes for each socket to backend. SocketBufferLimit applies to socket streaming channel between TCP/IP stacks, it's in kernel space. For example, 20Mi, 1Gi, 256Ki etc. Note that when the suffix is not provided, the value is interpreted as bytes.

dns object

DNS includes dns resolution settings.

dnsRefreshRate string

DNSRefreshRate specifies the rate at which DNS records should be refreshed. Defaults to 30 seconds.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

lookupFamily string

LookupFamily determines how Envoy would resolve DNS for Routes where the backend is specified as a fully qualified domain name (FQDN). If set, this configuration overrides other defaults.

enum: IPv4, IPv6, IPv4Preferred, IPv6Preferred, IPv4AndIPv6

respectDnsTtl boolean

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.

healthCheck object

HealthCheck allows gateway to perform active health checking on backends.

active object

Active health check configuration

grpc object

GRPC defines the configuration of the GRPC health checker. It's optional, and can only be used if the specified type is GRPC.

service string

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.

healthyThreshold integer

HealthyThreshold defines the number of healthy health checks required before a backend host is marked healthy.

format: int32

minimum: 1

http object

HTTP defines the configuration of http health checker. It's required while the health checker type is HTTP.

expectedResponse object

ExpectedResponse defines a list of HTTP expected responses to match.

binary string

Binary payload base64 encoded.

format: byte

text string

Text payload in plain text.

type string required

Type defines the type of the payload.

expectedStatuses []integer

ExpectedStatuses defines a list of HTTP response statuses considered healthy. Defaults to 200 only

hostname string

Hostname defines the HTTP host that will be requested during health checking. Default: HTTPRoute or GRPCRoute hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

method string

Method defines the HTTP method used for health checking. Defaults to GET

path string required

Path defines the HTTP path that will be requested during health checking.

minLength: 1

maxLength: 1024

initialJitter string

InitialJitter defines the maximum time Envoy will wait before the first health check. Envoy will randomly select a value between 0 and the initial jitter value.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

interval string

Interval defines the time between active health checks.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

tcp object

TCP defines the configuration of tcp health checker. It's required while the health checker type is TCP.

receive object

Receive defines the expected response payload.

binary string

Binary payload base64 encoded.

format: byte

text string

Text payload in plain text.

type string required

Type defines the type of the payload.

send object

Send defines the request payload.

binary string

Binary payload base64 encoded.

format: byte

text string

Text payload in plain text.

type string required

Type defines the type of the payload.

timeout string

Timeout defines the time to wait for a health check response.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

type string required

Type defines the type of health checker.

unhealthyThreshold integer

UnhealthyThreshold defines the number of unhealthy health checks required before a backend host is marked unhealthy.

format: int32

minimum: 1

panicThreshold integer

When number of unhealthy endpoints for a backend reaches this threshold Envoy will disregard health status and balance across all endpoints. It's designed to prevent a situation in which host failures cascade throughout the cluster as load increases. If not set, the default value is 50%. To disable panic mode, set value to `0`.

format: int32

minimum: 0

maximum: 100

passive object

Passive passive check configuration

baseEjectionTime string

BaseEjectionTime defines the base duration for which a host will be ejected on consecutive failures.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

consecutive5XxErrors integer

Consecutive5xxErrors sets the number of consecutive 5xx errors triggering ejection.

format: int32

consecutiveGatewayErrors integer

ConsecutiveGatewayErrors sets the number of consecutive gateway errors triggering ejection.

format: int32

consecutiveLocalOriginFailures integer

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.

format: int32

failurePercentageThreshold integer

FailurePercentageThreshold sets the failure percentage threshold for outlier detection. If the failure percentage of a given host is greater than or equal to this value, it will be ejected. Defaults to 85.

format: int32

minimum: 0

maximum: 100

interval string

Interval defines the time between passive health checks.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxEjectionPercent integer

MaxEjectionPercent sets the maximum percentage of hosts in a cluster that can be ejected.

format: int32

splitExternalLocalOriginErrors boolean

SplitExternalLocalOriginErrors enables splitting of errors between external and local origin.

http2 object

HTTP2 provides HTTP/2 configuration for backend connections.

initialConnectionWindowSize string | integer

InitialConnectionWindowSize sets the initial window size for HTTP/2 connections. If not set, the default value is 1 MiB.

initialStreamWindowSize string | integer

InitialStreamWindowSize sets the initial window size for HTTP/2 streams. If not set, the default value is 64 KiB(64*1024).

maxConcurrentStreams integer

MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection. If not set, the default value is 100.

format: int32

minimum: 1

maximum: 2.147483647e+09

onInvalidMessage string

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

loadBalancer object

LoadBalancer policy to apply when routing traffic from the gateway to the backend endpoints. Defaults to `LeastRequest`.

consistentHash object

ConsistentHash defines the configuration when the load balancer type is set to ConsistentHash

cookie object

Cookie configures the cookie hash policy when the consistent hash type is set to Cookie.

attributes object

Additional Attributes to set for the generated cookie.

name string required

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 string

TTL of the generated cookie if the cookie is not present. This value sets the Max-Age attribute value.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

header object

Header configures the header hash policy when the consistent hash type is set to Header. Deprecated: use Headers instead

name string required

Name of the header to hash.

headers []object

Headers configures the header hash policy for each header, when the consistent hash type is set to Headers.

name string required

Name of the header to hash.

queryParams []object

QueryParams configures the query parameter hash policy when the consistent hash type is set to QueryParams.

name string required

Name of the query param to hash.

tableSize integer

The table size for consistent hashing, must be prime number limited to 5000011.

format: int64

minimum: 2

maximum: 5.000011e+06

type string required

ConsistentHashType defines the type of input to hash on. Valid Type values are "SourceIP", "Header", "Headers", "Cookie". "QueryParams".

enum: SourceIP, Header, Headers, Cookie, QueryParams

endpointOverride object

EndpointOverride defines the configuration for endpoint override. When specified, the load balancer will attempt to route requests to endpoints based on the override information extracted from request headers or metadata. If the override endpoints are not available, the configured load balancer policy will be used as fallback.

extractFrom []object required

ExtractFrom defines the sources to extract endpoint override information from.

minItems: 1

maxItems: 10

header string

Header defines the header to get the override endpoint addresses. The header value must specify at least one endpoint in `IP:Port` format or multiple endpoints in `IP:Port,IP:Port,...` format. For example `10.0.0.5:8080` or `[2600:4040:5204::1574:24ae]:80`. The IPv6 address is enclosed in square brackets.

slowStart object

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

window string required

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

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

type string required

Type decides the type of Load Balancer policy. Valid LoadBalancerType values are "ConsistentHash", "LeastRequest", "Random", "RoundRobin".

enum: ConsistentHash, LeastRequest, Random, RoundRobin

zoneAware object

ZoneAware defines the configuration related to the distribution of requests between locality zones.

preferLocal object

PreferLocalZone configures zone-aware routing to prefer sending traffic to the local locality zone.

force object

ForceLocalZone defines override configuration for forcing all traffic to stay within the local zone instead of the default behavior which maintains equal distribution among upstream endpoints while sending as much traffic as possible locally.

minEndpointsInZoneThreshold integer

MinEndpointsInZoneThreshold is the minimum number of upstream endpoints in the local zone required to honor the forceLocalZone override. This is useful for protecting zones with fewer endpoints.

format: int32

minEndpointsThreshold integer

MinEndpointsThreshold is the minimum number of total upstream endpoints across all zones required to enable zone-aware routing.

format: int64

percentageEnabled integer

Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured. If not specified, Envoy defaults to 100%.

format: int32

minimum: 0

maximum: 100

proxyProtocol object

ProxyProtocol enables the Proxy Protocol when communicating with the backend.

version string required

Version of ProxyProtol Valid ProxyProtocolVersion values are "V1" "V2"

enum: V1, V2

retry object

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.

numAttemptsPerPriority integer

NumAttemptsPerPriority defines the number of requests (initial attempt + retries) that should be sent to the same priority before switching to a different one. If not specified or set to 0, all requests are sent to the highest priority that is healthy.

format: int32

numRetries integer

NumRetries is the number of retries to be attempted. Defaults to 2.

format: int32

minimum: 0

perRetry object

PerRetry is the retry policy to be applied per retry attempt.

backOff object

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

baseInterval string

BaseInterval is the base interval between retries.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxInterval string

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

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

timeout string

Timeout is the timeout per retry attempt.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

retryOn object

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).

httpStatusCodes []integer

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.

triggers []string

Triggers specifies the retry trigger condition(Http/Grpc).

tcpKeepalive object

TcpKeepalive settings associated with the upstream client connection. Disabled by default.

idleTime string

The duration a connection needs to be idle before keep-alive probes start being sent. The duration format is Defaults to `7200s`.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

interval string

The duration between keep-alive probes. Defaults to `75s`.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

probes integer

The total number of unacknowledged probes to send before deciding the connection is dead. Defaults to 9.

format: int32

timeout object

Timeout settings for the backend connections.

http object

Timeout settings for HTTP.

connectionIdleTimeout string

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.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxConnectionDuration string

The maximum duration of an HTTP connection. Default: unlimited.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxStreamDuration string

MaxStreamDuration is the maximum duration for a stream to complete. This timeout measures the time from when the request is sent until the response stream is fully consumed and does not apply to non-streaming requests. When set to "0s", no max duration is applied and streams can run indefinitely.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

requestTimeout string

RequestTimeout is the time until which entire response is received from the upstream.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

tcp object

Timeout settings for TCP.

connectTimeout string

The timeout for network connection establishment, including TCP and TLS handshakes. Default: 10 seconds.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

cacheDuration string

Duration is a string value representing a duration in time. The format is as specified in GEP-2257, a strict subset of the syntax parsed by Golang time.ParseDuration.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

uri string required

URI is the HTTPS URI to fetch the JWKS. Envoy's system trust bundle is used to validate the server certificate. If a custom trust bundle is needed, it can be specified in a BackendTLSConfig resource and target the BackendRefs.

minLength: 1

maxLength: 253

oidc object

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

clientID string

The client ID to be used in the OIDC [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest). Only one of clientID or clientIDRef must be set.

minLength: 1

clientIDRef object

The Kubernetes secret which contains the client ID to be used in the [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest). Exactly one of clientID or clientIDRef must be set. This is an Opaque secret. The client ID should be stored in the key "client-id". Only one of clientID or clientIDRef must be set.

group string

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kind is kind of the referent. For example "Secret".

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace is the namespace of the referenced object. 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

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

clientSecret object required

The Kubernetes secret which contains the OIDC client secret to be used in the [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest). This is an Opaque secret. The client secret should be stored in the key "client-secret".

group string

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kind is kind of the referent. For example "Secret".

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace is the namespace of the referenced object. 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

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

cookieConfig object

CookieConfigs allows setting the SameSite attribute for OIDC cookies. By default, its unset.

sameSite string

enum: Lax, Strict, None

cookieDomain string

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.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9]))*$

cookieNames object

The optional cookie name overrides to be used for Bearer and IdToken cookies in the [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest). If not specified, uses a randomly generated suffix

accessToken string

The name of the cookie used to store the AccessToken in the [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest). If not specified, defaults to "AccessToken-(randomly generated uid)"

idToken string

The name of the cookie used to store the IdToken in the [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest). If not specified, defaults to "IdToken-(randomly generated uid)"

csrfTokenTTL string

CSRFTokenTTL defines how long the CSRF token generated during the OAuth2 authorization flow remains valid. This duration determines the lifetime of the CSRF cookie, which is validated against the CSRF token in the "state" parameter when the provider redirects back to the callback endpoint. If omitted, Envoy Gateway defaults the token expiration to 10 minutes.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

defaultRefreshTokenTTL string

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.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

defaultTokenTTL string

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.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

denyRedirect object

Any request that matches any of the provided matchers (with either tokens that are expired or missing tokens) will not be redirected to the OIDC Provider. This behavior can be useful for AJAX or machine requests.

headers []object required

Defines the headers to match against the request to deny redirect to the OIDC Provider.

minItems: 1

maxItems: 16

name string required

Specifies the name of the header in the request.

minLength: 1

type string

Type specifies how to match against a string.

enum: Exact, Prefix, Suffix, RegularExpression

value string required

Value specifies the string value that the match must have.

minLength: 1

maxLength: 1024

disableTokenEncryption boolean

Disable token encryption. When set to true, both the access token and the ID token will be stored in plain text. This option should only be used in secure environments where token encryption is not required. Default is false (tokens are encrypted).

forwardAccessToken boolean

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.

logoutPath string

The path to log a user out, clearing their credential cookies. If not specified, uses a default logout path "/logout"

passThroughAuthHeader boolean

Skips OIDC authentication when the request contains a header that will be extracted by the JWT filter. Unless explicitly stated otherwise in the extractFrom field, this will be the "Authorization: Bearer ..." header. The passThroughAuthHeader option is typically used for non-browser clients that may not be able to handle OIDC redirects and wish to directly supply a token instead. If not specified, defaults to false.

provider object required

The OIDC Provider configuration.

authorizationEndpoint string

The OIDC Provider's [authorization endpoint](https://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint). If not provided, EG will try to discover it from the provider's [Well-Known Configuration Endpoint](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse).

backendRef object

BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.

group string

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

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)

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

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

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

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.

format: int32

minimum: 1

maximum: 65535

backendRefs []object

BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.

maxItems: 16

fallback boolean

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%.

group string

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

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)

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

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

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

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.

format: int32

minimum: 1

maximum: 65535

weight integer

Weight specifies the proportion of requests forwarded to the referenced backend. This is computed as weight/(sum of all weights in this BackendRefs list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. Weight is not a percentage and the sum of weights does not need to equal 100. If only one backend is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weight is set to 0, no traffic should be forwarded for this entry. If unspecified, weight defaults to 1. Support for this field varies based on the context where used.

format: int32

minimum: 0

maximum: 1e+06

backendSettings object

BackendSettings holds configuration for managing the connection to the backend.

circuitBreaker object

Circuit Breaker settings for the upstream connections and requests. If not set, circuit breakers will be enabled with the default thresholds

maxConnections integer

The maximum number of connections that Envoy will establish to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxParallelRequests integer

The maximum number of parallel requests that Envoy will make to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxParallelRetries integer

The maximum number of parallel retries that Envoy will make to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxPendingRequests integer

The maximum number of pending requests that Envoy will queue to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

maxRequestsPerConnection integer

The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule. Default: unlimited.

format: int64

minimum: 0

maximum: 4.294967295e+09

perEndpoint object

PerEndpoint defines Circuit Breakers that will apply per-endpoint for an upstream cluster

maxConnections integer

MaxConnections configures the maximum number of connections that Envoy will establish per-endpoint to the referenced backend defined within a xRoute rule.

format: int64

minimum: 0

maximum: 4.294967295e+09

connection object

Connection includes backend connection settings.

bufferLimit string | integer

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.

preconnect object

Preconnect configures proactive upstream connections to reduce latency by establishing connections before they’re needed and avoiding connection establishment overhead. If unset, Envoy will fetch connections as needed to serve in-flight requests.

perEndpointPercent integer

PerEndpointPercent configures how many additional connections to maintain per upstream endpoint, useful for high-QPS or latency sensitive services. Expressed as a percentage of the connections required by active streams (e.g. 100 = preconnect disabled, 105 = 1.05x connections per-endpoint, 200 = 2.00×). Allowed value range is between 100-300. When both PerEndpointPercent and PredictivePercent are set, Envoy ensures both are satisfied (max of the two).

format: int32

minimum: 100

maximum: 300

predictivePercent integer

PredictivePercent configures how many additional connections to maintain across the cluster by anticipating which upstream endpoint the load balancer will select next, useful for low-QPS services. Relies on deterministic loadbalancing and is only supported with Random or RoundRobin. Expressed as a percentage of the connections required by active streams (e.g. 100 = 1.0 (no preconnect), 105 = 1.05× connections across the cluster, 200 = 2.00×). Minimum allowed value is 100. When both PerEndpointPercent and PredictivePercent are set Envoy ensures both are satisfied per host (max of the two).

format: int32

minimum: 100

socketBufferLimit string | integer

SocketBufferLimit provides configuration for the maximum buffer size in bytes for each socket to backend. SocketBufferLimit applies to socket streaming channel between TCP/IP stacks, it's in kernel space. For example, 20Mi, 1Gi, 256Ki etc. Note that when the suffix is not provided, the value is interpreted as bytes.

dns object

DNS includes dns resolution settings.

dnsRefreshRate string

DNSRefreshRate specifies the rate at which DNS records should be refreshed. Defaults to 30 seconds.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

lookupFamily string

LookupFamily determines how Envoy would resolve DNS for Routes where the backend is specified as a fully qualified domain name (FQDN). If set, this configuration overrides other defaults.

enum: IPv4, IPv6, IPv4Preferred, IPv6Preferred, IPv4AndIPv6

respectDnsTtl boolean

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.

healthCheck object

HealthCheck allows gateway to perform active health checking on backends.

active object

Active health check configuration

grpc object

GRPC defines the configuration of the GRPC health checker. It's optional, and can only be used if the specified type is GRPC.

service string

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.

healthyThreshold integer

HealthyThreshold defines the number of healthy health checks required before a backend host is marked healthy.

format: int32

minimum: 1

http object

HTTP defines the configuration of http health checker. It's required while the health checker type is HTTP.

expectedResponse object

ExpectedResponse defines a list of HTTP expected responses to match.

binary string

Binary payload base64 encoded.

format: byte

text string

Text payload in plain text.

type string required

Type defines the type of the payload.

expectedStatuses []integer

ExpectedStatuses defines a list of HTTP response statuses considered healthy. Defaults to 200 only

hostname string

Hostname defines the HTTP host that will be requested during health checking. Default: HTTPRoute or GRPCRoute hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

method string

Method defines the HTTP method used for health checking. Defaults to GET

path string required

Path defines the HTTP path that will be requested during health checking.

minLength: 1

maxLength: 1024

initialJitter string

InitialJitter defines the maximum time Envoy will wait before the first health check. Envoy will randomly select a value between 0 and the initial jitter value.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

interval string

Interval defines the time between active health checks.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

tcp object

TCP defines the configuration of tcp health checker. It's required while the health checker type is TCP.

receive object

Receive defines the expected response payload.

binary string

Binary payload base64 encoded.

format: byte

text string

Text payload in plain text.

type string required

Type defines the type of the payload.

send object

Send defines the request payload.

binary string

Binary payload base64 encoded.

format: byte

text string

Text payload in plain text.

type string required

Type defines the type of the payload.

timeout string

Timeout defines the time to wait for a health check response.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

type string required

Type defines the type of health checker.

unhealthyThreshold integer

UnhealthyThreshold defines the number of unhealthy health checks required before a backend host is marked unhealthy.

format: int32

minimum: 1

panicThreshold integer

When number of unhealthy endpoints for a backend reaches this threshold Envoy will disregard health status and balance across all endpoints. It's designed to prevent a situation in which host failures cascade throughout the cluster as load increases. If not set, the default value is 50%. To disable panic mode, set value to `0`.

format: int32

minimum: 0

maximum: 100

passive object

Passive passive check configuration

baseEjectionTime string

BaseEjectionTime defines the base duration for which a host will be ejected on consecutive failures.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

consecutive5XxErrors integer

Consecutive5xxErrors sets the number of consecutive 5xx errors triggering ejection.

format: int32

consecutiveGatewayErrors integer

ConsecutiveGatewayErrors sets the number of consecutive gateway errors triggering ejection.

format: int32

consecutiveLocalOriginFailures integer

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.

format: int32

failurePercentageThreshold integer

FailurePercentageThreshold sets the failure percentage threshold for outlier detection. If the failure percentage of a given host is greater than or equal to this value, it will be ejected. Defaults to 85.

format: int32

minimum: 0

maximum: 100

interval string

Interval defines the time between passive health checks.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxEjectionPercent integer

MaxEjectionPercent sets the maximum percentage of hosts in a cluster that can be ejected.

format: int32

splitExternalLocalOriginErrors boolean

SplitExternalLocalOriginErrors enables splitting of errors between external and local origin.

http2 object

HTTP2 provides HTTP/2 configuration for backend connections.

initialConnectionWindowSize string | integer

InitialConnectionWindowSize sets the initial window size for HTTP/2 connections. If not set, the default value is 1 MiB.

initialStreamWindowSize string | integer

InitialStreamWindowSize sets the initial window size for HTTP/2 streams. If not set, the default value is 64 KiB(64*1024).

maxConcurrentStreams integer

MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection. If not set, the default value is 100.

format: int32

minimum: 1

maximum: 2.147483647e+09

onInvalidMessage string

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

loadBalancer object

LoadBalancer policy to apply when routing traffic from the gateway to the backend endpoints. Defaults to `LeastRequest`.

consistentHash object

ConsistentHash defines the configuration when the load balancer type is set to ConsistentHash

cookie object

Cookie configures the cookie hash policy when the consistent hash type is set to Cookie.

attributes object

Additional Attributes to set for the generated cookie.

name string required

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 string

TTL of the generated cookie if the cookie is not present. This value sets the Max-Age attribute value.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

header object

Header configures the header hash policy when the consistent hash type is set to Header. Deprecated: use Headers instead

name string required

Name of the header to hash.

headers []object

Headers configures the header hash policy for each header, when the consistent hash type is set to Headers.

name string required

Name of the header to hash.

queryParams []object

QueryParams configures the query parameter hash policy when the consistent hash type is set to QueryParams.

name string required

Name of the query param to hash.

tableSize integer

The table size for consistent hashing, must be prime number limited to 5000011.

format: int64

minimum: 2

maximum: 5.000011e+06

type string required

ConsistentHashType defines the type of input to hash on. Valid Type values are "SourceIP", "Header", "Headers", "Cookie". "QueryParams".

enum: SourceIP, Header, Headers, Cookie, QueryParams

endpointOverride object

EndpointOverride defines the configuration for endpoint override. When specified, the load balancer will attempt to route requests to endpoints based on the override information extracted from request headers or metadata. If the override endpoints are not available, the configured load balancer policy will be used as fallback.

extractFrom []object required

ExtractFrom defines the sources to extract endpoint override information from.

minItems: 1

maxItems: 10

header string

Header defines the header to get the override endpoint addresses. The header value must specify at least one endpoint in `IP:Port` format or multiple endpoints in `IP:Port,IP:Port,...` format. For example `10.0.0.5:8080` or `[2600:4040:5204::1574:24ae]:80`. The IPv6 address is enclosed in square brackets.

slowStart object

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

window string required

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

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

type string required

Type decides the type of Load Balancer policy. Valid LoadBalancerType values are "ConsistentHash", "LeastRequest", "Random", "RoundRobin".

enum: ConsistentHash, LeastRequest, Random, RoundRobin

zoneAware object

ZoneAware defines the configuration related to the distribution of requests between locality zones.

preferLocal object

PreferLocalZone configures zone-aware routing to prefer sending traffic to the local locality zone.

force object

ForceLocalZone defines override configuration for forcing all traffic to stay within the local zone instead of the default behavior which maintains equal distribution among upstream endpoints while sending as much traffic as possible locally.

minEndpointsInZoneThreshold integer

MinEndpointsInZoneThreshold is the minimum number of upstream endpoints in the local zone required to honor the forceLocalZone override. This is useful for protecting zones with fewer endpoints.

format: int32

minEndpointsThreshold integer

MinEndpointsThreshold is the minimum number of total upstream endpoints across all zones required to enable zone-aware routing.

format: int64

percentageEnabled integer

Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured. If not specified, Envoy defaults to 100%.

format: int32

minimum: 0

maximum: 100

proxyProtocol object

ProxyProtocol enables the Proxy Protocol when communicating with the backend.

version string required

Version of ProxyProtol Valid ProxyProtocolVersion values are "V1" "V2"

enum: V1, V2

retry object

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.

numAttemptsPerPriority integer

NumAttemptsPerPriority defines the number of requests (initial attempt + retries) that should be sent to the same priority before switching to a different one. If not specified or set to 0, all requests are sent to the highest priority that is healthy.

format: int32

numRetries integer

NumRetries is the number of retries to be attempted. Defaults to 2.

format: int32

minimum: 0

perRetry object

PerRetry is the retry policy to be applied per retry attempt.

backOff object

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

baseInterval string

BaseInterval is the base interval between retries.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxInterval string

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

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

timeout string

Timeout is the timeout per retry attempt.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

retryOn object

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).

httpStatusCodes []integer

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.

triggers []string

Triggers specifies the retry trigger condition(Http/Grpc).

tcpKeepalive object

TcpKeepalive settings associated with the upstream client connection. Disabled by default.

idleTime string

The duration a connection needs to be idle before keep-alive probes start being sent. The duration format is Defaults to `7200s`.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

interval string

The duration between keep-alive probes. Defaults to `75s`.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

probes integer

The total number of unacknowledged probes to send before deciding the connection is dead. Defaults to 9.

format: int32

timeout object

Timeout settings for the backend connections.

http object

Timeout settings for HTTP.

connectionIdleTimeout string

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.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxConnectionDuration string

The maximum duration of an HTTP connection. Default: unlimited.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxStreamDuration string

MaxStreamDuration is the maximum duration for a stream to complete. This timeout measures the time from when the request is sent until the response stream is fully consumed and does not apply to non-streaming requests. When set to "0s", no max duration is applied and streams can run indefinitely.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

requestTimeout string

RequestTimeout is the time until which entire response is received from the upstream.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

tcp object

Timeout settings for TCP.

connectTimeout string

The timeout for network connection establishment, including TCP and TLS handshakes. Default: 10 seconds.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

endSessionEndpoint string

The OIDC Provider's [end session endpoint](https://openid.net/specs/openid-connect-core-1_0.html#RPLogout). If the end session endpoint is provided, EG will use it to log out the user from the OIDC Provider when the user accesses the logout path. EG will also try to discover the end session endpoint from the provider's [Well-Known Configuration Endpoint](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse) when authorizationEndpoint or tokenEndpoint is not provided.

issuer string required

The OIDC Provider's [issuer identifier](https://openid.net/specs/openid-connect-discovery-1_0.html#IssuerDiscovery). 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.

minLength: 1

tokenEndpoint string

The OIDC Provider's [token endpoint](https://openid.net/specs/openid-connect-core-1_0.html#TokenEndpoint). If not provided, EG will try to discover it from the provider's [Well-Known Configuration Endpoint](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse).

redirectURL string

The redirect URL to be used in the OIDC [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest). If not specified, uses the default redirect URI "%REQ(x-forwarded-proto)%://%REQ(:authority)%/oauth2/callback"

refreshToken boolean

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 true.

resources []string

The OIDC resources to be used in the [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).

scopes []string

The OIDC scopes to be used in the [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest). The "openid" scope is always added to the list of scopes if not already specified.

targetRef object

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

group string required

Group is the group of the target resource.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string required

Kind is kind of the target resource.

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the target resource.

minLength: 1

maxLength: 253

sectionName string

SectionName is the name of a section within the target resource. When unspecified, this targetRef targets the entire resource. In the following resources, SectionName is interpreted as the following: * Gateway: Listener name * HTTPRoute: HTTPRouteRule name * Service: Port name If a SectionName is specified, but does not exist on the targeted object, the Policy must fail to attach, and the policy implementation should record a `ResolvedRefs` or similar Condition in the Policy's status.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

targetRefs []object

TargetRefs are the names of the Gateway resources this policy is being attached to.

group string required

Group is the group of the target resource.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string required

Kind is kind of the target resource.

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the target resource.

minLength: 1

maxLength: 253

sectionName string

SectionName is the name of a section within the target resource. When unspecified, this targetRef targets the entire resource. In the following resources, SectionName is interpreted as the following: * Gateway: Listener name * HTTPRoute: HTTPRouteRule name * Service: Port name If a SectionName is specified, but does not exist on the targeted object, the Policy must fail to attach, and the policy implementation should record a `ResolvedRefs` or similar Condition in the Policy's status.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

targetSelectors []object

TargetSelectors allow targeting resources for this policy based on labels

group string

Group is the group that this selector targets. Defaults to gateway.networking.k8s.io

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string required

Kind is the resource kind that this selector targets.

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

matchExpressions []object

MatchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

matchLabels object

MatchLabels are the set of label selectors for identifying the targeted resource