SecurityPolicy allows the user to configure various security settings for a Gateway.
Last changed in Envoy Gateway v1.9.0
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Spec defines the desired state of SecurityPolicy.
APIKeyAuth defines the configuration for the API Key Authentication.
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 is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
Kind is kind of the referent. For example "Secret".
Name is the name of the referent.
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
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 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 must be specified.
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 must be specified.
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 must be specified.
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 indicates whether to remove the API key from the request before forwarding it to the backend service.
Authorization defines the authorization configuration.
DefaultAction defines the default action to be taken if no rules match. If not specified, the default action is Deny.
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 defines the action to be taken if the rule matches.
CEL specifies a Common Expression Language expression to evaluate for the request. If specified, the expression must evaluate to true for the rule to match. The expression can use Envoy attributes exposed to the CEL runtime. Request attributes, such as request.path, request.url_path, request.host, request.scheme, request.method, request.headers, and request.query, are generally available during authorization. Connection attributes, such as source.address, source.port, destination.address, destination.port, connection.mtls, and connection.requested_server_name, may also be used. Dynamic metadata and filter state produced by earlier filters may also be available through attributes such as metadata and filter_state. Response attributes are only available after the request completes and should not be used for authorization decisions. For more details, see: https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/advanced/attributes The rule matches only when the expression evaluates to a boolean true. Non-boolean results, false, null, and CEL evaluation errors are treated as no match. Examples: `request.headers['x-tenant'] == 'team-a'` `request.method == 'POST' && request.path.startsWith('/admin')`
Name is a user-friendly name for the rule. If not specified, Envoy Gateway will generate a unique name for the rule.
Operation specifies the operation of a request, such as HTTP methods. If not specified, all operations are matched on.
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.
Path is the HTTP path of the request. Support Exact, PathPrefix and RegularExpression match types.
Invert specifies whether the value match result will be inverted.
Type specifies how to match against the value of the path.
Value specifies the HTTP path.
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 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.
ClientIPGeoLocations authorizes the request based on geolocation metadata derived from the client IP. This field is supported for HTTPRoute and GRPCRoute authorization. It is not supported for TCPRoute targets. If multiple entries are specified, one of the ClientIPGeoLocation entries must match for the rule to match. The client IP is inferred from the X-Forwarded-For header, a custom header, or the direct downstream connection source address (the TCP peer of the connection terminated by Envoy). You can use the `ClientIPDetection` field in the `ClientTrafficPolicy` to configure the client IP detection.
Anonymous matches anonymous network detection signals.
IsAnonymous matches whether the client IP is considered anonymous.
IsHosting matches whether the client IP belongs to a hosting provider.
IsProxy matches whether the client IP belongs to a public proxy.
IsTor matches whether the client IP belongs to a Tor exit node.
IsVPN matches whether the client IP is detected as VPN.
ASN is the autonomous system number associated with the client IP.
City is the city associated with the client IP.
Country is the country ISO code associated with the client IP.
ISP is the internet service provider associated with the client IP.
Region is the region ISO code associated with the client IP.
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.
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.
Values are the values that the header must match. If multiple values are specified, the rule will match if any of the values match.
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 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.
Name is the name of the claim. If it is a nested claim, use a dot (.) separated string as the name to represent the full path to the claim. For example, if the claim is in the "department" field in the "organization" field, the name should be "organization.department".
ValueType is the type of the claim value. Only String and StringArray types are supported for now.
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.
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`.
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.
BasicAuth defines the configuration for the HTTP Basic Authentication.
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.
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.
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
Kind is kind of the referent. For example "Secret".
Name is the name of the referent.
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
CORS defines the configuration for Cross-Origin Resource Sharing (CORS).
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 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 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 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 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 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..
CSRF defines the configuration for Cross-Site Request Forgery (CSRF) protection. When enabled, the CSRF filter checks that the Origin header matches the destination or one of the additional allowed origins on mutating requests (POST, PUT, DELETE, PATCH).
AdditionalOrigins specifies additional origins that are allowed to make mutating requests, beyond the destination origin. A request whose Origin header matches one of them is allowed. The value "*" allows any origin, which effectively disables origin validation. Note: Envoy's CSRF filter compares the host and port of the origin only, so the scheme is ignored: "https://www.example.com" and "http://www.example.com" are equivalent here, and both allow the request regardless of the scheme the client used.
ShadowFraction represents the fraction of requests for which the CSRF policy is evaluated in shadow (dry-run) mode. For these requests, the filter records whether the request would have been allowed or rejected in the `csrf.request_valid` and `csrf.request_invalid` stats, but always lets the request through. The remaining requests are enforced, i.e. a mutating request with a missing or non-matching Origin header is rejected with a 403. Defaults to 0% (all requests are enforced) if not specified. Set it to 100% to dry run the filter, watch the stats to find origins that would be rejected, then lower it to roll enforcement out gradually.
ExtAuth defines the configuration for External Authorization.
BodyToExtAuth defines the Body to Ext Auth configuration.
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.
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 of the context extension.
Type is the type of method to use to read the ContextExtension value. Valid values are Value and ValueRef, default is Value.
Value of the context extension.
ValueRef for the context extension's value.
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
The key to select.
Kind is kind of the referent. For example "HTTPRoute" or "Service".
Name is the name of the referent.
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 defines the gRPC External Authorization service. Either GRPCService or HTTPService must be specified, and only one of them can be provided.
BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
Kind is the Kubernetes resource kind of the referent. For example "Service". Defaults to "Service" when not specified. ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services. Support: Core (Services with a type other than ExternalName) Support: Implementation-specific (Services with type ExternalName)
Name is the name of the referent.
Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core
Port 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.
BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.
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 is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
Kind is the Kubernetes resource kind of the referent. For example "Service". Defaults to "Service" when not specified. ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services. Support: Core (Services with a type other than ExternalName) Support: Implementation-specific (Services with type ExternalName)
Name is the name of the referent.
Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core
Port 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.
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.
BackendSettings holds configuration for managing the connection to the backend.
Circuit Breaker settings for the upstream connections and requests. If not set, circuit breakers will be enabled with the default thresholds
The maximum number of connections that Envoy will establish to the referenced backend defined within a xRoute rule.
The maximum number of parallel requests that Envoy will make to the referenced backend defined within a xRoute rule.
The maximum number of parallel retries that Envoy will make to the referenced backend defined within a xRoute rule.
The maximum number of pending requests that Envoy will queue to the referenced backend defined within a xRoute rule.
The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule. Default: unlimited.
PerEndpoint defines Circuit Breakers that will apply per-endpoint for an upstream cluster
MaxConnections configures the maximum number of connections that Envoy will establish per-endpoint to the referenced backend defined within a xRoute rule.
RetryBudget provides settings for retry budget, which limits the number of retries in a given percentage. RetryBudget take precedence over maxParallelRetries.
MinRetryConcurrency specifies the minimum retry concurrency allowed for the retry budget. For example, a budget of 20% with a minimum retry concurrency of 3 will allow 5 active retries while there are 25 active requests. If there are 2 active requests, there are still 3 active retries allowed because of the minimum retry concurrency. Defaults to 3.
Percent specifies the limit on concurrent retries as a percentage [0, 100] of the sum of active requests and active pending requests.
Connection includes backend connection settings.
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 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 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).
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).
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 includes dns resolution settings.
DNSRefreshRate specifies the rate at which DNS records should be refreshed. Defaults to 30 seconds.
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.
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 allows gateway to perform active health checking on backends.
Active health check configuration
GRPC defines the configuration of the GRPC health checker. It's optional, and can only be used if the specified type is GRPC.
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.
HealthCheckLog defines health check event logging configuration for this cluster. When set, HC probe outcomes are logged to the configured sinks. Takes precedence over the gateway-level EnvoyProxy.spec.telemetry.healthCheckLog.
Matches defines which health check probe outcomes produce a log entry. When omitted or empty, all events are logged. Each value must be unique. Multiple values are ORed. If any failure type is specified then a success type must also be specified, and vice versa.
Sinks defines where health check events are written. When omitted, events are written to /dev/stdout.
File defines the file sink configuration. Required when type is File.
Path specifies the file path for health check event output. Use /dev/stdout to write to standard output.
Type defines the type of sink.
HealthyThreshold defines the number of healthy health checks required before a backend host is marked healthy.
HTTP defines the configuration of http health checker. It's required while the health checker type is HTTP.
ExpectedResponse defines a list of HTTP expected responses to match.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
ExpectedStatuses defines a list of HTTP response statuses considered healthy. Defaults to 200 only
Hostname defines the HTTP Host header used for active HTTP health checks. Host selection uses this order: this field, the associated Backend endpoint hostname if available, then the effective Route hostname.
Method defines the HTTP method used for health checking. Defaults to GET
Path defines the HTTP path that will be requested during health checking.
RequestBody defines the HTTP request body payload sent during health checking.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
RetriableStatuses defines a list of HTTP response statuses considered retriable. Responses matching these statuses count towards the unhealthy threshold but do not result in the host being considered immediately unhealthy. The expected statuses take precedence for any range overlaps with this field.
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.
Interval defines the time between active health checks.
Overrides defines the configuration of the overriding health check settings for all endpoints in the backend cluster. This allows customization of port and other settings that may differ from the main service configuration.
Port overrides the health check port. If not set, the endpoint's serving port is used for health checks. This is useful when health checks are served on a different port than the main service port (e.g., port 443 for service, port 9090 for health checks).
TCP defines the configuration of tcp health checker. It's required while the health checker type is TCP.
Receive defines the expected response payload.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
Send defines the request payload.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
Timeout defines the time to wait for a health check response.
Type defines the type of health checker.
UnhealthyThreshold defines the number of unhealthy health checks required before a backend host is marked unhealthy. Without RetriableStatuses configured, any health check failure results in the host being immediately considered unhealthy. When RetriableStatuses is set, health checks returning those statuses are retried up to this threshold before the host is marked unhealthy.
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`.
Passive passive check configuration
AlwaysEjectOneEndpoint defines whether at least one host should be ejected, regardless of MaxEjectionPercent.
BaseEjectionTime defines the base duration for which a host will be ejected on consecutive failures.
Consecutive5xxErrors sets the number of consecutive 5xx errors triggering ejection.
ConsecutiveGatewayErrors sets the number of consecutive gateway errors triggering ejection.
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.
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.
Interval defines the time between passive health checks.
MaxEjectionPercent sets the maximum percentage of hosts in a cluster that can be ejected.
SplitExternalLocalOriginErrors enables splitting of errors between external and local origin.
HTTP2 provides HTTP/2 configuration for backend connections.
ConnectionKeepalive configures HTTP/2 connection keepalive using PING frames.
IdleInterval specifies how long a connection must be idle before a PING is sent.
Interval specifies how often to send HTTP/2 PING frames to keep the connection alive.
IntervalJitter specifies a random jitter percentage added to each interval. Defaults to 15% if not specified.
Timeout specifies how long to wait for a PING response before considering the connection dead.
InitialConnectionWindowSize sets the initial window size for HTTP/2 connections. If not set, the default value is 1 MiB.
InitialStreamWindowSize sets the initial window size for HTTP/2 streams. If not set, the default value is 64 KiB(64*1024).
MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection. If not set, the default value is 100.
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 policy to apply when routing traffic from the gateway to the backend endpoints. Defaults to `LeastRequest`.
BackendUtilization defines the configuration when the load balancer type is set to BackendUtilization.
A given endpoint must report load metrics continuously for at least this long before the endpoint weight will be used. Default is 10s.
ErrorUtilizationPenaltyPercent adjusts endpoint weights based on the error rate (eps/qps). This is expressed as a percentage-based integer where 100 represents 1.0, 150 represents 1.5, etc. For example: - 100 => 1.0x - 120 => 1.2x - 200 => 2.0x Must be non-negative.
KeepResponseHeaders keeps the ORCA load report headers/trailers before sending the response to the client. Defaults to false.
Metric names used to compute utilization if application_utilization is not set. For map fields in ORCA proto, use the form "<map_field>.<key>", e.g., "named_metrics.foo".
OutOfBand enables out-of-band ORCA load reporting. When set, Envoy opens a server-streaming gRPC connection to each endpoint's xds.service.orca.v3.OpenRcaService/StreamCoreMetrics and pulls load reports periodically, instead of relying on in-band ORCA metrics carried in response headers/trailers. The backend must implement OpenRcaService for this to take effect.
Authority overrides the :authority header on the OutOfBand gRPC stream. If unset, Envoy uses the endpoint hostname, then the dialed address, then the cluster name.
Port overrides the port used for the OutOfBand reporting connection, e.g. to reach a separate reporting sidecar. Defaults to the endpoint's port.
ReportingPeriod is how often Envoy requests load reports from the server. Must be greater than 0. Defaults to 10s.
If a given endpoint has not reported load metrics in this long, stop using the reported weight. Defaults to 3m.
How often endpoint weights are recalculated. Values less than 100ms are capped at 100ms. Default 1s.
ConsistentHash defines the configuration when the load balancer type is set to ConsistentHash
Cookie configures the cookie hash policy when the consistent hash type is set to Cookie.
Additional Attributes to set for the generated cookie.
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 of the generated cookie if the cookie is not present. This value sets the Max-Age attribute value.
Header configures the header hash policy when the consistent hash type is set to Header. Deprecated: use Headers instead
Name of the header to hash.
Headers configures the header hash policy for each header, when the consistent hash type is set to Headers.
Name of the header to hash.
QueryParams configures the query parameter hash policy when the consistent hash type is set to QueryParams.
Name of the query param to hash.
The table size for consistent hashing, must be prime number limited to 5000011.
ConsistentHashType defines the type of input to hash on. Valid Type values are "SourceIP", "Header", "Headers", "Cookie". "QueryParams".
DynamicModule defines the configuration when the load balancer type is set to DynamicModule. The referenced module must be registered in the EnvoyProxy resource's dynamicModules allowlist.
Config is optional configuration for the module's load balancer implementation. This is serialized and passed to the module's initialization function.
LBPolicyName identifies a specific load balancer implementation within the dynamic module. A single shared library can contain multiple LB policy implementations. This value is passed to the module's initialization function to select the appropriate implementation.
Name references a dynamic module registered in the EnvoyProxy resource's dynamicModules list. The referenced module must exist in the registry; otherwise, the policy will be rejected.
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 defines the sources to extract endpoint override information from.
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 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. Supported for RoundRobin, LeastRequest, and BackendUtilization load balancers.
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
Type decides the type of Load Balancer policy. Valid LoadBalancerType values are "ConsistentHash", "LeastRequest", "Random", "RoundRobin", "BackendUtilization", "DynamicModule".
ZoneAware defines the configuration related to the distribution of requests between locality zones.
PreferLocalZone configures zone-aware routing to prefer sending traffic to the local locality zone.
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 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.
MinEndpointsThreshold is the minimum number of total upstream endpoints across all zones required to enable zone-aware routing.
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%.
WeightedZones configures weight-based traffic distribution across locality zones. Traffic is distributed proportionally based on the sum of all zone weights.
Weight defines the weight for this locality. Higher values receive more traffic. The actual traffic distribution is proportional to this value relative to other localities.
Zone specifies the topology zone this weight applies to. The value should match the topology.kubernetes.io/zone label of the nodes where endpoints are running. Zones not listed in the configuration receive a default weight of 1.
ProxyProtocol enables the Proxy Protocol when communicating with the backend.
Version of ProxyProtocol Valid ProxyProtocolVersion values are "V1" "V2"
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 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.
NumRetries is the number of retries to be attempted. Defaults to 2.
PerRetry is the retry policy to be applied per retry attempt.
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 is the base interval between retries.
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
Timeout is the timeout per retry attempt.
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 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 specifies the retry trigger condition(Http/Grpc).
TcpKeepalive settings associated with the upstream client connection. Disabled by default.
The duration a connection needs to be idle before keep-alive probes start being sent. The duration format is Defaults to `7200s`.
The duration between keep-alive probes. Defaults to `75s`.
The total number of unacknowledged probes to send before deciding the connection is dead. Defaults to 9.
Timeout settings for the backend connections.
Timeout settings for HTTP.
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.
The maximum duration of an HTTP connection. Default: unlimited.
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.
RequestTimeout is the time until which entire response is received from the upstream.
The stream idle timeout defines the amount of time a stream can exist without any upstream or downstream activity. If not specified, StreamIdleTimeout is inherited from the listener-level setting, which can be configured via ClientTrafficPolicy.
Timeout settings for TCP.
The timeout for network connection establishment, including TCP and TLS handshakes. Default: 10 seconds.
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 defines the HTTP External Authorization service. Either GRPCService or HTTPService must be specified, and only one of them can be provided.
BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
Kind is the Kubernetes resource kind of the referent. For example "Service". Defaults to "Service" when not specified. ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services. Support: Core (Services with a type other than ExternalName) Support: Implementation-specific (Services with type ExternalName)
Name is the name of the referent.
Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core
Port 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.
BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.
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 is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
Kind is the Kubernetes resource kind of the referent. For example "Service". Defaults to "Service" when not specified. ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services. Support: Core (Services with a type other than ExternalName) Support: Implementation-specific (Services with type ExternalName)
Name is the name of the referent.
Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core
Port 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.
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.
BackendSettings holds configuration for managing the connection to the backend.
Circuit Breaker settings for the upstream connections and requests. If not set, circuit breakers will be enabled with the default thresholds
The maximum number of connections that Envoy will establish to the referenced backend defined within a xRoute rule.
The maximum number of parallel requests that Envoy will make to the referenced backend defined within a xRoute rule.
The maximum number of parallel retries that Envoy will make to the referenced backend defined within a xRoute rule.
The maximum number of pending requests that Envoy will queue to the referenced backend defined within a xRoute rule.
The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule. Default: unlimited.
PerEndpoint defines Circuit Breakers that will apply per-endpoint for an upstream cluster
MaxConnections configures the maximum number of connections that Envoy will establish per-endpoint to the referenced backend defined within a xRoute rule.
RetryBudget provides settings for retry budget, which limits the number of retries in a given percentage. RetryBudget take precedence over maxParallelRetries.
MinRetryConcurrency specifies the minimum retry concurrency allowed for the retry budget. For example, a budget of 20% with a minimum retry concurrency of 3 will allow 5 active retries while there are 25 active requests. If there are 2 active requests, there are still 3 active retries allowed because of the minimum retry concurrency. Defaults to 3.
Percent specifies the limit on concurrent retries as a percentage [0, 100] of the sum of active requests and active pending requests.
Connection includes backend connection settings.
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 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 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).
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).
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 includes dns resolution settings.
DNSRefreshRate specifies the rate at which DNS records should be refreshed. Defaults to 30 seconds.
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.
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 allows gateway to perform active health checking on backends.
Active health check configuration
GRPC defines the configuration of the GRPC health checker. It's optional, and can only be used if the specified type is GRPC.
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.
HealthCheckLog defines health check event logging configuration for this cluster. When set, HC probe outcomes are logged to the configured sinks. Takes precedence over the gateway-level EnvoyProxy.spec.telemetry.healthCheckLog.
Matches defines which health check probe outcomes produce a log entry. When omitted or empty, all events are logged. Each value must be unique. Multiple values are ORed. If any failure type is specified then a success type must also be specified, and vice versa.
Sinks defines where health check events are written. When omitted, events are written to /dev/stdout.
File defines the file sink configuration. Required when type is File.
Path specifies the file path for health check event output. Use /dev/stdout to write to standard output.
Type defines the type of sink.
HealthyThreshold defines the number of healthy health checks required before a backend host is marked healthy.
HTTP defines the configuration of http health checker. It's required while the health checker type is HTTP.
ExpectedResponse defines a list of HTTP expected responses to match.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
ExpectedStatuses defines a list of HTTP response statuses considered healthy. Defaults to 200 only
Hostname defines the HTTP Host header used for active HTTP health checks. Host selection uses this order: this field, the associated Backend endpoint hostname if available, then the effective Route hostname.
Method defines the HTTP method used for health checking. Defaults to GET
Path defines the HTTP path that will be requested during health checking.
RequestBody defines the HTTP request body payload sent during health checking.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
RetriableStatuses defines a list of HTTP response statuses considered retriable. Responses matching these statuses count towards the unhealthy threshold but do not result in the host being considered immediately unhealthy. The expected statuses take precedence for any range overlaps with this field.
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.
Interval defines the time between active health checks.
Overrides defines the configuration of the overriding health check settings for all endpoints in the backend cluster. This allows customization of port and other settings that may differ from the main service configuration.
Port overrides the health check port. If not set, the endpoint's serving port is used for health checks. This is useful when health checks are served on a different port than the main service port (e.g., port 443 for service, port 9090 for health checks).
TCP defines the configuration of tcp health checker. It's required while the health checker type is TCP.
Receive defines the expected response payload.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
Send defines the request payload.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
Timeout defines the time to wait for a health check response.
Type defines the type of health checker.
UnhealthyThreshold defines the number of unhealthy health checks required before a backend host is marked unhealthy. Without RetriableStatuses configured, any health check failure results in the host being immediately considered unhealthy. When RetriableStatuses is set, health checks returning those statuses are retried up to this threshold before the host is marked unhealthy.
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`.
Passive passive check configuration
AlwaysEjectOneEndpoint defines whether at least one host should be ejected, regardless of MaxEjectionPercent.
BaseEjectionTime defines the base duration for which a host will be ejected on consecutive failures.
Consecutive5xxErrors sets the number of consecutive 5xx errors triggering ejection.
ConsecutiveGatewayErrors sets the number of consecutive gateway errors triggering ejection.
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.
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.
Interval defines the time between passive health checks.
MaxEjectionPercent sets the maximum percentage of hosts in a cluster that can be ejected.
SplitExternalLocalOriginErrors enables splitting of errors between external and local origin.
HTTP2 provides HTTP/2 configuration for backend connections.
ConnectionKeepalive configures HTTP/2 connection keepalive using PING frames.
IdleInterval specifies how long a connection must be idle before a PING is sent.
Interval specifies how often to send HTTP/2 PING frames to keep the connection alive.
IntervalJitter specifies a random jitter percentage added to each interval. Defaults to 15% if not specified.
Timeout specifies how long to wait for a PING response before considering the connection dead.
InitialConnectionWindowSize sets the initial window size for HTTP/2 connections. If not set, the default value is 1 MiB.
InitialStreamWindowSize sets the initial window size for HTTP/2 streams. If not set, the default value is 64 KiB(64*1024).
MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection. If not set, the default value is 100.
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 policy to apply when routing traffic from the gateway to the backend endpoints. Defaults to `LeastRequest`.
BackendUtilization defines the configuration when the load balancer type is set to BackendUtilization.
A given endpoint must report load metrics continuously for at least this long before the endpoint weight will be used. Default is 10s.
ErrorUtilizationPenaltyPercent adjusts endpoint weights based on the error rate (eps/qps). This is expressed as a percentage-based integer where 100 represents 1.0, 150 represents 1.5, etc. For example: - 100 => 1.0x - 120 => 1.2x - 200 => 2.0x Must be non-negative.
KeepResponseHeaders keeps the ORCA load report headers/trailers before sending the response to the client. Defaults to false.
Metric names used to compute utilization if application_utilization is not set. For map fields in ORCA proto, use the form "<map_field>.<key>", e.g., "named_metrics.foo".
OutOfBand enables out-of-band ORCA load reporting. When set, Envoy opens a server-streaming gRPC connection to each endpoint's xds.service.orca.v3.OpenRcaService/StreamCoreMetrics and pulls load reports periodically, instead of relying on in-band ORCA metrics carried in response headers/trailers. The backend must implement OpenRcaService for this to take effect.
Authority overrides the :authority header on the OutOfBand gRPC stream. If unset, Envoy uses the endpoint hostname, then the dialed address, then the cluster name.
Port overrides the port used for the OutOfBand reporting connection, e.g. to reach a separate reporting sidecar. Defaults to the endpoint's port.
ReportingPeriod is how often Envoy requests load reports from the server. Must be greater than 0. Defaults to 10s.
If a given endpoint has not reported load metrics in this long, stop using the reported weight. Defaults to 3m.
How often endpoint weights are recalculated. Values less than 100ms are capped at 100ms. Default 1s.
ConsistentHash defines the configuration when the load balancer type is set to ConsistentHash
Cookie configures the cookie hash policy when the consistent hash type is set to Cookie.
Additional Attributes to set for the generated cookie.
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 of the generated cookie if the cookie is not present. This value sets the Max-Age attribute value.
Header configures the header hash policy when the consistent hash type is set to Header. Deprecated: use Headers instead
Name of the header to hash.
Headers configures the header hash policy for each header, when the consistent hash type is set to Headers.
Name of the header to hash.
QueryParams configures the query parameter hash policy when the consistent hash type is set to QueryParams.
Name of the query param to hash.
The table size for consistent hashing, must be prime number limited to 5000011.
ConsistentHashType defines the type of input to hash on. Valid Type values are "SourceIP", "Header", "Headers", "Cookie". "QueryParams".
DynamicModule defines the configuration when the load balancer type is set to DynamicModule. The referenced module must be registered in the EnvoyProxy resource's dynamicModules allowlist.
Config is optional configuration for the module's load balancer implementation. This is serialized and passed to the module's initialization function.
LBPolicyName identifies a specific load balancer implementation within the dynamic module. A single shared library can contain multiple LB policy implementations. This value is passed to the module's initialization function to select the appropriate implementation.
Name references a dynamic module registered in the EnvoyProxy resource's dynamicModules list. The referenced module must exist in the registry; otherwise, the policy will be rejected.
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 defines the sources to extract endpoint override information from.
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 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. Supported for RoundRobin, LeastRequest, and BackendUtilization load balancers.
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
Type decides the type of Load Balancer policy. Valid LoadBalancerType values are "ConsistentHash", "LeastRequest", "Random", "RoundRobin", "BackendUtilization", "DynamicModule".
ZoneAware defines the configuration related to the distribution of requests between locality zones.
PreferLocalZone configures zone-aware routing to prefer sending traffic to the local locality zone.
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 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.
MinEndpointsThreshold is the minimum number of total upstream endpoints across all zones required to enable zone-aware routing.
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%.
WeightedZones configures weight-based traffic distribution across locality zones. Traffic is distributed proportionally based on the sum of all zone weights.
Weight defines the weight for this locality. Higher values receive more traffic. The actual traffic distribution is proportional to this value relative to other localities.
Zone specifies the topology zone this weight applies to. The value should match the topology.kubernetes.io/zone label of the nodes where endpoints are running. Zones not listed in the configuration receive a default weight of 1.
ProxyProtocol enables the Proxy Protocol when communicating with the backend.
Version of ProxyProtocol Valid ProxyProtocolVersion values are "V1" "V2"
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 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.
NumRetries is the number of retries to be attempted. Defaults to 2.
PerRetry is the retry policy to be applied per retry attempt.
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 is the base interval between retries.
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
Timeout is the timeout per retry attempt.
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 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 specifies the retry trigger condition(Http/Grpc).
TcpKeepalive settings associated with the upstream client connection. Disabled by default.
The duration a connection needs to be idle before keep-alive probes start being sent. The duration format is Defaults to `7200s`.
The duration between keep-alive probes. Defaults to `75s`.
The total number of unacknowledged probes to send before deciding the connection is dead. Defaults to 9.
Timeout settings for the backend connections.
Timeout settings for HTTP.
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.
The maximum duration of an HTTP connection. Default: unlimited.
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.
RequestTimeout is the time until which entire response is received from the upstream.
The stream idle timeout defines the amount of time a stream can exist without any upstream or downstream activity. If not specified, StreamIdleTimeout is inherited from the listener-level setting, which can be configured via ClientTrafficPolicy.
Timeout settings for TCP.
The timeout for network connection establishment, including TCP and TLS handshakes. Default: 10 seconds.
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 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". Only one of Path or PathOverride can be set.
PathOverride replaces the original request path in the authorization request. If set, the path will be overridden to this value during authorization. For example, if the original request path is "/hello", and PathOverride is set to "/auth", then the path of the authorization request will be "/auth". Only one of Path or PathOverride can be set.
IncludeRouteMetadata sends Envoy Gateway's built-in route metadata to the external authorization service as context. This includes Envoy Gateway's built-in metadata for the selected route in the "envoy-gateway" metadata namespace. The metadata is exposed under the "resources" field as a list of route resource objects. For example: envoy-gateway: resources: - kind: HTTPRoute name: backend namespace: default annotations: foo: bar The resource object may include fields such as kind, namespace, name, sectionName, and supported route annotations.
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.
Sets the HTTP status that is returned when the authorization service returns an error or cannot be reached. Defaults to 403 Forbidden. Only 4xx and 5xx status codes are supported.
Timeout defines the timeout for requests to the external authorization service. If not specified, defaults to 10 seconds.
JWT defines the configuration for JSON Web Token (JWT) authentication.
FailOpen lets a request pass JWT authentication even when its JWT is missing or invalid, rather than being rejected. This helps when a header that clients use to carry a JWT may also legitimately hold a non-JWT value that the backend relies on. A valid JWT is still verified and its claims forwarded as usual; only the rejection of requests with a missing or invalid JWT is relaxed. Because this does not enforce authentication on its own, pair it with an Authorization policy when access needs to be restricted. This is broader than Optional (which tolerates a missing JWT but still rejects an invalid one) and takes precedence over it.
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. See FailOpen if this is necessary for your use case.
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.
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.
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 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 defines the name of the HTTP request header that the JWT Claim will be saved into.
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 represents a list of cookie names to extract the JWT token from.
Headers represents a list of HTTP request headers to extract the JWT token from.
Name is the HTTP header name to retrieve the token
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 represents a list of query parameters to extract the JWT token from.
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.
LocalJWKS defines how to get the JSON Web Key Sets (JWKS) from a local source.
Inline contains the value as an inline string.
Type is the type of method to use to read the body value. Valid values are Inline and ValueRef, default is Inline.
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 is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
Kind is kind of the referent. For example "HTTPRoute" or "Service".
Name is the name of the referent.
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.
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 defines how to fetch and cache JSON Web Key Sets (JWKS) from a remote HTTP/HTTPS endpoint.
BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
Kind is the Kubernetes resource kind of the referent. For example "Service". Defaults to "Service" when not specified. ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services. Support: Core (Services with a type other than ExternalName) Support: Implementation-specific (Services with type ExternalName)
Name is the name of the referent.
Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core
Port 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.
BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.
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 is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
Kind is the Kubernetes resource kind of the referent. For example "Service". Defaults to "Service" when not specified. ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services. Support: Core (Services with a type other than ExternalName) Support: Implementation-specific (Services with type ExternalName)
Name is the name of the referent.
Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core
Port 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.
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.
BackendSettings holds configuration for managing the connection to the backend.
Circuit Breaker settings for the upstream connections and requests. If not set, circuit breakers will be enabled with the default thresholds
The maximum number of connections that Envoy will establish to the referenced backend defined within a xRoute rule.
The maximum number of parallel requests that Envoy will make to the referenced backend defined within a xRoute rule.
The maximum number of parallel retries that Envoy will make to the referenced backend defined within a xRoute rule.
The maximum number of pending requests that Envoy will queue to the referenced backend defined within a xRoute rule.
The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule. Default: unlimited.
PerEndpoint defines Circuit Breakers that will apply per-endpoint for an upstream cluster
MaxConnections configures the maximum number of connections that Envoy will establish per-endpoint to the referenced backend defined within a xRoute rule.
RetryBudget provides settings for retry budget, which limits the number of retries in a given percentage. RetryBudget take precedence over maxParallelRetries.
MinRetryConcurrency specifies the minimum retry concurrency allowed for the retry budget. For example, a budget of 20% with a minimum retry concurrency of 3 will allow 5 active retries while there are 25 active requests. If there are 2 active requests, there are still 3 active retries allowed because of the minimum retry concurrency. Defaults to 3.
Percent specifies the limit on concurrent retries as a percentage [0, 100] of the sum of active requests and active pending requests.
Connection includes backend connection settings.
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 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 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).
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).
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 includes dns resolution settings.
DNSRefreshRate specifies the rate at which DNS records should be refreshed. Defaults to 30 seconds.
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.
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 allows gateway to perform active health checking on backends.
Active health check configuration
GRPC defines the configuration of the GRPC health checker. It's optional, and can only be used if the specified type is GRPC.
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.
HealthCheckLog defines health check event logging configuration for this cluster. When set, HC probe outcomes are logged to the configured sinks. Takes precedence over the gateway-level EnvoyProxy.spec.telemetry.healthCheckLog.
Matches defines which health check probe outcomes produce a log entry. When omitted or empty, all events are logged. Each value must be unique. Multiple values are ORed. If any failure type is specified then a success type must also be specified, and vice versa.
Sinks defines where health check events are written. When omitted, events are written to /dev/stdout.
File defines the file sink configuration. Required when type is File.
Path specifies the file path for health check event output. Use /dev/stdout to write to standard output.
Type defines the type of sink.
HealthyThreshold defines the number of healthy health checks required before a backend host is marked healthy.
HTTP defines the configuration of http health checker. It's required while the health checker type is HTTP.
ExpectedResponse defines a list of HTTP expected responses to match.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
ExpectedStatuses defines a list of HTTP response statuses considered healthy. Defaults to 200 only
Hostname defines the HTTP Host header used for active HTTP health checks. Host selection uses this order: this field, the associated Backend endpoint hostname if available, then the effective Route hostname.
Method defines the HTTP method used for health checking. Defaults to GET
Path defines the HTTP path that will be requested during health checking.
RequestBody defines the HTTP request body payload sent during health checking.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
RetriableStatuses defines a list of HTTP response statuses considered retriable. Responses matching these statuses count towards the unhealthy threshold but do not result in the host being considered immediately unhealthy. The expected statuses take precedence for any range overlaps with this field.
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.
Interval defines the time between active health checks.
Overrides defines the configuration of the overriding health check settings for all endpoints in the backend cluster. This allows customization of port and other settings that may differ from the main service configuration.
Port overrides the health check port. If not set, the endpoint's serving port is used for health checks. This is useful when health checks are served on a different port than the main service port (e.g., port 443 for service, port 9090 for health checks).
TCP defines the configuration of tcp health checker. It's required while the health checker type is TCP.
Receive defines the expected response payload.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
Send defines the request payload.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
Timeout defines the time to wait for a health check response.
Type defines the type of health checker.
UnhealthyThreshold defines the number of unhealthy health checks required before a backend host is marked unhealthy. Without RetriableStatuses configured, any health check failure results in the host being immediately considered unhealthy. When RetriableStatuses is set, health checks returning those statuses are retried up to this threshold before the host is marked unhealthy.
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`.
Passive passive check configuration
AlwaysEjectOneEndpoint defines whether at least one host should be ejected, regardless of MaxEjectionPercent.
BaseEjectionTime defines the base duration for which a host will be ejected on consecutive failures.
Consecutive5xxErrors sets the number of consecutive 5xx errors triggering ejection.
ConsecutiveGatewayErrors sets the number of consecutive gateway errors triggering ejection.
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.
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.
Interval defines the time between passive health checks.
MaxEjectionPercent sets the maximum percentage of hosts in a cluster that can be ejected.
SplitExternalLocalOriginErrors enables splitting of errors between external and local origin.
HTTP2 provides HTTP/2 configuration for backend connections.
ConnectionKeepalive configures HTTP/2 connection keepalive using PING frames.
IdleInterval specifies how long a connection must be idle before a PING is sent.
Interval specifies how often to send HTTP/2 PING frames to keep the connection alive.
IntervalJitter specifies a random jitter percentage added to each interval. Defaults to 15% if not specified.
Timeout specifies how long to wait for a PING response before considering the connection dead.
InitialConnectionWindowSize sets the initial window size for HTTP/2 connections. If not set, the default value is 1 MiB.
InitialStreamWindowSize sets the initial window size for HTTP/2 streams. If not set, the default value is 64 KiB(64*1024).
MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection. If not set, the default value is 100.
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 policy to apply when routing traffic from the gateway to the backend endpoints. Defaults to `LeastRequest`.
BackendUtilization defines the configuration when the load balancer type is set to BackendUtilization.
A given endpoint must report load metrics continuously for at least this long before the endpoint weight will be used. Default is 10s.
ErrorUtilizationPenaltyPercent adjusts endpoint weights based on the error rate (eps/qps). This is expressed as a percentage-based integer where 100 represents 1.0, 150 represents 1.5, etc. For example: - 100 => 1.0x - 120 => 1.2x - 200 => 2.0x Must be non-negative.
KeepResponseHeaders keeps the ORCA load report headers/trailers before sending the response to the client. Defaults to false.
Metric names used to compute utilization if application_utilization is not set. For map fields in ORCA proto, use the form "<map_field>.<key>", e.g., "named_metrics.foo".
OutOfBand enables out-of-band ORCA load reporting. When set, Envoy opens a server-streaming gRPC connection to each endpoint's xds.service.orca.v3.OpenRcaService/StreamCoreMetrics and pulls load reports periodically, instead of relying on in-band ORCA metrics carried in response headers/trailers. The backend must implement OpenRcaService for this to take effect.
Authority overrides the :authority header on the OutOfBand gRPC stream. If unset, Envoy uses the endpoint hostname, then the dialed address, then the cluster name.
Port overrides the port used for the OutOfBand reporting connection, e.g. to reach a separate reporting sidecar. Defaults to the endpoint's port.
ReportingPeriod is how often Envoy requests load reports from the server. Must be greater than 0. Defaults to 10s.
If a given endpoint has not reported load metrics in this long, stop using the reported weight. Defaults to 3m.
How often endpoint weights are recalculated. Values less than 100ms are capped at 100ms. Default 1s.
ConsistentHash defines the configuration when the load balancer type is set to ConsistentHash
Cookie configures the cookie hash policy when the consistent hash type is set to Cookie.
Additional Attributes to set for the generated cookie.
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 of the generated cookie if the cookie is not present. This value sets the Max-Age attribute value.
Header configures the header hash policy when the consistent hash type is set to Header. Deprecated: use Headers instead
Name of the header to hash.
Headers configures the header hash policy for each header, when the consistent hash type is set to Headers.
Name of the header to hash.
QueryParams configures the query parameter hash policy when the consistent hash type is set to QueryParams.
Name of the query param to hash.
The table size for consistent hashing, must be prime number limited to 5000011.
ConsistentHashType defines the type of input to hash on. Valid Type values are "SourceIP", "Header", "Headers", "Cookie". "QueryParams".
DynamicModule defines the configuration when the load balancer type is set to DynamicModule. The referenced module must be registered in the EnvoyProxy resource's dynamicModules allowlist.
Config is optional configuration for the module's load balancer implementation. This is serialized and passed to the module's initialization function.
LBPolicyName identifies a specific load balancer implementation within the dynamic module. A single shared library can contain multiple LB policy implementations. This value is passed to the module's initialization function to select the appropriate implementation.
Name references a dynamic module registered in the EnvoyProxy resource's dynamicModules list. The referenced module must exist in the registry; otherwise, the policy will be rejected.
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 defines the sources to extract endpoint override information from.
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 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. Supported for RoundRobin, LeastRequest, and BackendUtilization load balancers.
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
Type decides the type of Load Balancer policy. Valid LoadBalancerType values are "ConsistentHash", "LeastRequest", "Random", "RoundRobin", "BackendUtilization", "DynamicModule".
ZoneAware defines the configuration related to the distribution of requests between locality zones.
PreferLocalZone configures zone-aware routing to prefer sending traffic to the local locality zone.
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 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.
MinEndpointsThreshold is the minimum number of total upstream endpoints across all zones required to enable zone-aware routing.
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%.
WeightedZones configures weight-based traffic distribution across locality zones. Traffic is distributed proportionally based on the sum of all zone weights.
Weight defines the weight for this locality. Higher values receive more traffic. The actual traffic distribution is proportional to this value relative to other localities.
Zone specifies the topology zone this weight applies to. The value should match the topology.kubernetes.io/zone label of the nodes where endpoints are running. Zones not listed in the configuration receive a default weight of 1.
ProxyProtocol enables the Proxy Protocol when communicating with the backend.
Version of ProxyProtocol Valid ProxyProtocolVersion values are "V1" "V2"
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 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.
NumRetries is the number of retries to be attempted. Defaults to 2.
PerRetry is the retry policy to be applied per retry attempt.
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 is the base interval between retries.
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
Timeout is the timeout per retry attempt.
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 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 specifies the retry trigger condition(Http/Grpc).
TcpKeepalive settings associated with the upstream client connection. Disabled by default.
The duration a connection needs to be idle before keep-alive probes start being sent. The duration format is Defaults to `7200s`.
The duration between keep-alive probes. Defaults to `75s`.
The total number of unacknowledged probes to send before deciding the connection is dead. Defaults to 9.
Timeout settings for the backend connections.
Timeout settings for HTTP.
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.
The maximum duration of an HTTP connection. Default: unlimited.
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.
RequestTimeout is the time until which entire response is received from the upstream.
The stream idle timeout defines the amount of time a stream can exist without any upstream or downstream activity. If not specified, StreamIdleTimeout is inherited from the listener-level setting, which can be configured via ClientTrafficPolicy.
Timeout settings for TCP.
The timeout for network connection establishment, including TCP and TLS handshakes. Default: 10 seconds.
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.
FailedRefetchDuration is the duration Envoy waits before re-fetching the JWKS after a failed fetch. This does not control retries within a single fetch attempt (see BackendSettings.Retry), only the interval between fetch attempts after a failure. If not specified, Envoy's default of 1 second is used.
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.
MergeType determines how this configuration is merged with existing SecurityPolicy configurations targeting a parent resource. When set, this configuration will be merged into the closest parent SecurityPolicy in the route's attachment hierarchy (for example, one targeting a Gateway, Gateway listener, ListenerSet, or ListenerSet listener). Currently, this field can only be set when targeting xRoute resources. If unset, no merging occurs, and only the most specific configuration takes effect.
OIDC defines the configuration for the OpenID Connect (OIDC) authentication.
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.
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 is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
Kind is kind of the referent. For example "Secret".
Name is the name of the referent.
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
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 is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
Kind is kind of the referent. For example "Secret".
Name is the name of the referent.
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
CookieConfigs allows setting the SameSite attribute for OIDC cookies. By default, its unset.
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.
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
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)"
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 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.
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.
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.
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.
Defines the headers to match against the request to deny redirect to the OIDC Provider.
Specifies the name of the header in the request.
Type specifies how to match against a string.
Value specifies the string value that the match must have.
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 indicates whether the Envoy should forward the access token via the Authorization header Bearer scheme to the upstream. If not specified, defaults to false.
ForwardIDToken configures forwarding of the OIDC ID token to the upstream. If the configured header is "Authorization", EG forwards the ID token using the "Bearer " prefix. For any other header, EG forwards the raw token value. If not specified, the ID token will not be forwarded. Note: when passThroughAuthHeader is enabled, this header must not be the same as a header a JWT provider extracts from (the "Authorization" header by default). The forwarded ID token header is owned by Envoy, and Envoy rejects an OAuth2 configuration whose pass-through matcher keys on it.
Header is the upstream request header that will carry the ID token. It must be a valid HTTP header name. Pseudo-headers (names starting with ":") and the "Host" header are not allowed.
The path to log a user out, clearing their credential cookies. If not specified, uses a default logout path "/logout"
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.
The OIDC Provider configuration.
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 references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead.
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
Kind is the Kubernetes resource kind of the referent. For example "Service". Defaults to "Service" when not specified. ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services. Support: Core (Services with a type other than ExternalName) Support: Implementation-specific (Services with type ExternalName)
Name is the name of the referent.
Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core
Port 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.
BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent.
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 is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
Kind is the Kubernetes resource kind of the referent. For example "Service". Defaults to "Service" when not specified. ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services. Support: Core (Services with a type other than ExternalName) Support: Implementation-specific (Services with type ExternalName)
Name is the name of the referent.
Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core
Port 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.
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.
BackendSettings holds configuration for managing the connection to the backend.
Circuit Breaker settings for the upstream connections and requests. If not set, circuit breakers will be enabled with the default thresholds
The maximum number of connections that Envoy will establish to the referenced backend defined within a xRoute rule.
The maximum number of parallel requests that Envoy will make to the referenced backend defined within a xRoute rule.
The maximum number of parallel retries that Envoy will make to the referenced backend defined within a xRoute rule.
The maximum number of pending requests that Envoy will queue to the referenced backend defined within a xRoute rule.
The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule. Default: unlimited.
PerEndpoint defines Circuit Breakers that will apply per-endpoint for an upstream cluster
MaxConnections configures the maximum number of connections that Envoy will establish per-endpoint to the referenced backend defined within a xRoute rule.
RetryBudget provides settings for retry budget, which limits the number of retries in a given percentage. RetryBudget take precedence over maxParallelRetries.
MinRetryConcurrency specifies the minimum retry concurrency allowed for the retry budget. For example, a budget of 20% with a minimum retry concurrency of 3 will allow 5 active retries while there are 25 active requests. If there are 2 active requests, there are still 3 active retries allowed because of the minimum retry concurrency. Defaults to 3.
Percent specifies the limit on concurrent retries as a percentage [0, 100] of the sum of active requests and active pending requests.
Connection includes backend connection settings.
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 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 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).
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).
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 includes dns resolution settings.
DNSRefreshRate specifies the rate at which DNS records should be refreshed. Defaults to 30 seconds.
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.
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 allows gateway to perform active health checking on backends.
Active health check configuration
GRPC defines the configuration of the GRPC health checker. It's optional, and can only be used if the specified type is GRPC.
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.
HealthCheckLog defines health check event logging configuration for this cluster. When set, HC probe outcomes are logged to the configured sinks. Takes precedence over the gateway-level EnvoyProxy.spec.telemetry.healthCheckLog.
Matches defines which health check probe outcomes produce a log entry. When omitted or empty, all events are logged. Each value must be unique. Multiple values are ORed. If any failure type is specified then a success type must also be specified, and vice versa.
Sinks defines where health check events are written. When omitted, events are written to /dev/stdout.
File defines the file sink configuration. Required when type is File.
Path specifies the file path for health check event output. Use /dev/stdout to write to standard output.
Type defines the type of sink.
HealthyThreshold defines the number of healthy health checks required before a backend host is marked healthy.
HTTP defines the configuration of http health checker. It's required while the health checker type is HTTP.
ExpectedResponse defines a list of HTTP expected responses to match.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
ExpectedStatuses defines a list of HTTP response statuses considered healthy. Defaults to 200 only
Hostname defines the HTTP Host header used for active HTTP health checks. Host selection uses this order: this field, the associated Backend endpoint hostname if available, then the effective Route hostname.
Method defines the HTTP method used for health checking. Defaults to GET
Path defines the HTTP path that will be requested during health checking.
RequestBody defines the HTTP request body payload sent during health checking.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
RetriableStatuses defines a list of HTTP response statuses considered retriable. Responses matching these statuses count towards the unhealthy threshold but do not result in the host being considered immediately unhealthy. The expected statuses take precedence for any range overlaps with this field.
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.
Interval defines the time between active health checks.
Overrides defines the configuration of the overriding health check settings for all endpoints in the backend cluster. This allows customization of port and other settings that may differ from the main service configuration.
Port overrides the health check port. If not set, the endpoint's serving port is used for health checks. This is useful when health checks are served on a different port than the main service port (e.g., port 443 for service, port 9090 for health checks).
TCP defines the configuration of tcp health checker. It's required while the health checker type is TCP.
Receive defines the expected response payload.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
Send defines the request payload.
Binary payload base64 encoded.
Text payload in plain text.
Type defines the type of the payload.
Timeout defines the time to wait for a health check response.
Type defines the type of health checker.
UnhealthyThreshold defines the number of unhealthy health checks required before a backend host is marked unhealthy. Without RetriableStatuses configured, any health check failure results in the host being immediately considered unhealthy. When RetriableStatuses is set, health checks returning those statuses are retried up to this threshold before the host is marked unhealthy.
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`.
Passive passive check configuration
AlwaysEjectOneEndpoint defines whether at least one host should be ejected, regardless of MaxEjectionPercent.
BaseEjectionTime defines the base duration for which a host will be ejected on consecutive failures.
Consecutive5xxErrors sets the number of consecutive 5xx errors triggering ejection.
ConsecutiveGatewayErrors sets the number of consecutive gateway errors triggering ejection.
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.
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.
Interval defines the time between passive health checks.
MaxEjectionPercent sets the maximum percentage of hosts in a cluster that can be ejected.
SplitExternalLocalOriginErrors enables splitting of errors between external and local origin.
HTTP2 provides HTTP/2 configuration for backend connections.
ConnectionKeepalive configures HTTP/2 connection keepalive using PING frames.
IdleInterval specifies how long a connection must be idle before a PING is sent.
Interval specifies how often to send HTTP/2 PING frames to keep the connection alive.
IntervalJitter specifies a random jitter percentage added to each interval. Defaults to 15% if not specified.
Timeout specifies how long to wait for a PING response before considering the connection dead.
InitialConnectionWindowSize sets the initial window size for HTTP/2 connections. If not set, the default value is 1 MiB.
InitialStreamWindowSize sets the initial window size for HTTP/2 streams. If not set, the default value is 64 KiB(64*1024).
MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection. If not set, the default value is 100.
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 policy to apply when routing traffic from the gateway to the backend endpoints. Defaults to `LeastRequest`.
BackendUtilization defines the configuration when the load balancer type is set to BackendUtilization.
A given endpoint must report load metrics continuously for at least this long before the endpoint weight will be used. Default is 10s.
ErrorUtilizationPenaltyPercent adjusts endpoint weights based on the error rate (eps/qps). This is expressed as a percentage-based integer where 100 represents 1.0, 150 represents 1.5, etc. For example: - 100 => 1.0x - 120 => 1.2x - 200 => 2.0x Must be non-negative.
KeepResponseHeaders keeps the ORCA load report headers/trailers before sending the response to the client. Defaults to false.
Metric names used to compute utilization if application_utilization is not set. For map fields in ORCA proto, use the form "<map_field>.<key>", e.g., "named_metrics.foo".
OutOfBand enables out-of-band ORCA load reporting. When set, Envoy opens a server-streaming gRPC connection to each endpoint's xds.service.orca.v3.OpenRcaService/StreamCoreMetrics and pulls load reports periodically, instead of relying on in-band ORCA metrics carried in response headers/trailers. The backend must implement OpenRcaService for this to take effect.
Authority overrides the :authority header on the OutOfBand gRPC stream. If unset, Envoy uses the endpoint hostname, then the dialed address, then the cluster name.
Port overrides the port used for the OutOfBand reporting connection, e.g. to reach a separate reporting sidecar. Defaults to the endpoint's port.
ReportingPeriod is how often Envoy requests load reports from the server. Must be greater than 0. Defaults to 10s.
If a given endpoint has not reported load metrics in this long, stop using the reported weight. Defaults to 3m.
How often endpoint weights are recalculated. Values less than 100ms are capped at 100ms. Default 1s.
ConsistentHash defines the configuration when the load balancer type is set to ConsistentHash
Cookie configures the cookie hash policy when the consistent hash type is set to Cookie.
Additional Attributes to set for the generated cookie.
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 of the generated cookie if the cookie is not present. This value sets the Max-Age attribute value.
Header configures the header hash policy when the consistent hash type is set to Header. Deprecated: use Headers instead
Name of the header to hash.
Headers configures the header hash policy for each header, when the consistent hash type is set to Headers.
Name of the header to hash.
QueryParams configures the query parameter hash policy when the consistent hash type is set to QueryParams.
Name of the query param to hash.
The table size for consistent hashing, must be prime number limited to 5000011.
ConsistentHashType defines the type of input to hash on. Valid Type values are "SourceIP", "Header", "Headers", "Cookie". "QueryParams".
DynamicModule defines the configuration when the load balancer type is set to DynamicModule. The referenced module must be registered in the EnvoyProxy resource's dynamicModules allowlist.
Config is optional configuration for the module's load balancer implementation. This is serialized and passed to the module's initialization function.
LBPolicyName identifies a specific load balancer implementation within the dynamic module. A single shared library can contain multiple LB policy implementations. This value is passed to the module's initialization function to select the appropriate implementation.
Name references a dynamic module registered in the EnvoyProxy resource's dynamicModules list. The referenced module must exist in the registry; otherwise, the policy will be rejected.
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 defines the sources to extract endpoint override information from.
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 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. Supported for RoundRobin, LeastRequest, and BackendUtilization load balancers.
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
Type decides the type of Load Balancer policy. Valid LoadBalancerType values are "ConsistentHash", "LeastRequest", "Random", "RoundRobin", "BackendUtilization", "DynamicModule".
ZoneAware defines the configuration related to the distribution of requests between locality zones.
PreferLocalZone configures zone-aware routing to prefer sending traffic to the local locality zone.
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 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.
MinEndpointsThreshold is the minimum number of total upstream endpoints across all zones required to enable zone-aware routing.
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%.
WeightedZones configures weight-based traffic distribution across locality zones. Traffic is distributed proportionally based on the sum of all zone weights.
Weight defines the weight for this locality. Higher values receive more traffic. The actual traffic distribution is proportional to this value relative to other localities.
Zone specifies the topology zone this weight applies to. The value should match the topology.kubernetes.io/zone label of the nodes where endpoints are running. Zones not listed in the configuration receive a default weight of 1.
ProxyProtocol enables the Proxy Protocol when communicating with the backend.
Version of ProxyProtocol Valid ProxyProtocolVersion values are "V1" "V2"
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 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.
NumRetries is the number of retries to be attempted. Defaults to 2.
PerRetry is the retry policy to be applied per retry attempt.
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 is the base interval between retries.
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
Timeout is the timeout per retry attempt.
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 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 specifies the retry trigger condition(Http/Grpc).
TcpKeepalive settings associated with the upstream client connection. Disabled by default.
The duration a connection needs to be idle before keep-alive probes start being sent. The duration format is Defaults to `7200s`.
The duration between keep-alive probes. Defaults to `75s`.
The total number of unacknowledged probes to send before deciding the connection is dead. Defaults to 9.
Timeout settings for the backend connections.
Timeout settings for HTTP.
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.
The maximum duration of an HTTP connection. Default: unlimited.
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.
RequestTimeout is the time until which entire response is received from the upstream.
The stream idle timeout defines the amount of time a stream can exist without any upstream or downstream activity. If not specified, StreamIdleTimeout is inherited from the listener-level setting, which can be configured via ClientTrafficPolicy.
Timeout settings for TCP.
The timeout for network connection establishment, including TCP and TLS handshakes. Default: 10 seconds.
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.
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.
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).
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 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.
The OIDC resources to be used in the [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).
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 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 is the group of the target resource.
Kind is kind of the target resource.
Name is the name of the target resource.
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.
TargetRefs are the names of the Gateway resources this policy is being attached to.
Group is the group of the target resource.
Kind is kind of the target resource.
Name is the name of the target resource.
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.
TargetSelectors allow targeting resources for this policy based on labels
Group is the group that this selector targets. Defaults to gateway.networking.k8s.io
Kind is the resource kind that this selector targets.
MatchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
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 are the set of label selectors for identifying the targeted resource.
Namespaces determines which namespaces are considered for target selection. If unspecified, only targets in the same namespace as this policy are considered. When specified, the effective set of namespaces is always constrained to the namespaces watched by Envoy Gateway. Selecting targets across namespaces requires a ReferenceGrant in the target namespace that allows this policy kind to reference the selected target kind. Cross-namespace targets without a matching ReferenceGrant are ignored.
From indicates how namespaces are selected for this target selector. All means all namespaces watched by Envoy Gateway. Selector means namespaces watched by Envoy Gateway that match Selector.
Selector selects namespaces when From is set to Selector.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
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 is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
Status defines the current status of SecurityPolicy.
Ancestors is a list of ancestor resources (usually Gateways) that are associated with the policy, and the status of the policy with respect to each ancestor. When this policy attaches to a parent, the controller that manages the parent and the ancestors MUST add an entry to this list when the controller first sees the policy and SHOULD update the entry as appropriate when the relevant ancestor is modified. Note that choosing the relevant ancestor is left to the Policy designers; an important part of Policy design is designing the right object level at which to namespace this status. Note also that implementations MUST ONLY populate ancestor status for the Ancestor resources they are responsible for. Implementations MUST use the ControllerName field to uniquely identify the entries in this list that they are responsible for. Note that to achieve this, the list of PolicyAncestorStatus structs MUST be treated as a map with a composite key, made up of the AncestorRef and ControllerName fields combined. A maximum of 16 ancestors will be represented in this list. An empty list means the Policy is not relevant for any ancestors. If this slice is full, implementations MUST NOT add further entries. Instead they MUST consider the policy unimplementable and signal that on any related resources such as the ancestor that would be referenced here. For example, if this list was full on BackendTLSPolicy, no additional Gateways would be able to reference the Service targeted by the BackendTLSPolicy.
AncestorRef corresponds with a ParentRef in the spec that this PolicyAncestorStatus struct describes the status of.
Group is the group of the referent. When unspecified, "gateway.networking.k8s.io" is inferred. To set the core API group (such as for a "Service" kind referent), Group must be explicitly set to "" (empty string). Support: Core
Kind is kind of the referent. There are two kinds of parent resources with "Core" support: * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, ClusterIP Services only) Support for other resources is Implementation-Specific.
Name is the name of the referent. Support: Core
Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. <gateway:experimental:description> ParentRefs from a Route to a Service in the same namespace are "producer" routes, which apply default routing rules to inbound connections from any namespace to the Service. ParentRefs from a Route to a Service in a different namespace are "consumer" routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route. </gateway:experimental:description> Support: Core
Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set `Port` unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. <gateway:experimental:description> When the parent resource is a Service, this targets a specific port in the Service spec. When both Port (experimental) and SectionName are specified, the name and port of the selected port must match both specified values. </gateway:experimental:description> Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Extended
SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: * Gateway: Listener name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. * Service: Port name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Core
Conditions describes the status of the Policy with respect to the given Ancestor. <gateway:util:excludeFromCRD> Notes for implementors: Conditions are a listType `map`, which means that they function like a map with a key of the `type` field _in the k8s apiserver_. This means that implementations must obey some rules when updating this section. * Implementations MUST perform a read-modify-write cycle on this field before modifying it. That is, when modifying this field, implementations must be confident they have fetched the most recent version of this field, and ensure that changes they make are on that recent version. * Implementations MUST NOT remove or reorder Conditions that they are not directly responsible for. For example, if an implementation sees a Condition with type `special.io/SomeField`, it MUST NOT remove, change or update that Condition. * Implementations MUST always _merge_ changes into Conditions of the same Type, rather than creating more than one Condition of the same Type. * Implementations MUST always update the `observedGeneration` field of the Condition to the `metadata.generation` of the Gateway at the time of update creation. * If the `observedGeneration` of a Condition is _greater than_ the value the implementation knows about, then it MUST NOT perform the update on that Condition, but must wait for a future reconciliation and status update. (The assumption is that the implementation's copy of the object is stale and an update will be re-triggered if relevant.) </gateway:util:excludeFromCRD>
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status of the condition, one of True, False, Unknown.
type of condition in CamelCase or in foo.example.com/CamelCase.
ControllerName is a domain/path string that indicates the name of the controller that wrote this status. This corresponds with the controllerName field on GatewayClass. Example: "example.net/gateway-controller". The format of this field is DOMAIN "/" PATH, where DOMAIN and PATH are valid Kubernetes names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). Controllers MUST populate this field when writing status. Controllers should ensure that entries to status populated with their ControllerName are cleaned up when they are no longer necessary.
Source: gateway.envoyproxy.io_securitypolicies.yaml
Changes to SecurityPolicy (gateway.envoyproxy.io/v1alpha1) in each Envoy Gateway version, compared to the version before it.
17 properties have been added
2 properties are no longer required
5 properties have changed the description
Released · View SecurityPolicy in v1.9.0
3 properties have changed the description
Released · View SecurityPolicy in v1.8.2
SecurityPolicy was already present in this version of Envoy Gateway, the oldest one on kubespec.dev
Released · View SecurityPolicy in v1.8.0
No examples of SecurityPolicy yet. Contribute one on GitHub.
kubespec.dev