EnvoyExtensionPolicy allows the user to configure various envoy extensibility options for the Gateway.
Unchanged since Envoy Gateway v1.8.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 EnvoyExtensionPolicy.
DynamicModule is an ordered list of dynamic module HTTP filters that should be added to the envoy filter chain. Each module must be registered in the EnvoyProxy resource's dynamicModules allowlist. Order matters, as the filters will be loaded in the order they are defined in this list.
Config is the configuration for the dynamic module filter. This is serialized as JSON and passed to the module's initialization function.
FilterName identifies a specific filter implementation within the dynamic module. A single shared library can contain multiple filter implementations. This value is passed to the module's HTTP filter config init function to select the appropriate implementation. If not specified, defaults to an empty string.
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.
TerminalFilter indicates that this dynamic module handles requests without requiring an upstream backend. The module is responsible for generating and sending the response to downstream directly. Defaults to false.
ExtProc is an ordered list of external processing filters that should be added to the envoy filter chain
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.
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.
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".
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.
FailOpen is a switch used to control the behavior when failing to call the external processor. If FailOpen is set to true, the system bypasses the ExtProc extension and allows the traffic to pass through. If it is set to false or not set (defaulting to false), the system blocks the traffic and returns an HTTP 5xx error. If set to true, the ExtProc extension will also be bypassed if the configuration is invalid.
MessageTimeout is the timeout for a response to be returned from the external processor Default: 200ms
Metadata defines options related to the sending and receiving of dynamic metadata. These options define which metadata namespaces would be sent to the processor and which dynamic metadata namespaces the processor would be permitted to emit metadata to. Users can specify custom namespaces or well-known envoy metadata namespace (such as envoy.filters.http.ext_authz) documented here: https://www.envoyproxy.io/docs/envoy/latest/configuration/advanced/well_known_dynamic_metadata#well-known-dynamic-metadata Default: no metadata context is sent or received from the external processor
AccessibleNamespaces are metadata namespaces that are sent to the external processor as context
WritableNamespaces are metadata namespaces that the external processor can write to
ProcessingMode defines how request and response body is processed Default: header and body are not sent to the external processor
AllowModeOverride allows the external processor to override the processing mode set via the `mode_override` field in the gRPC response message. This defaults to false.
Defines processing mode for requests. If present, request headers are sent. Request body is processed according to the specified mode.
Defines which attributes are sent to the external processor. Envoy Gateway currently supports only the following attribute prefixes: connection, source, destination, request, response, upstream and xds.route. https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/advanced/attributes
Defines body processing mode
Defines processing mode for responses. If present, response headers are sent. Response body is processed according to the specified mode.
Defines which attributes are sent to the external processor. Envoy Gateway currently supports only the following attribute prefixes: connection, source, destination, request, response, upstream and xds.route. https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/advanced/attributes
Defines body processing mode
Lua is an ordered list of Lua filters that should be added to the envoy filter chain
Inline contains the source code as an inline string.
Type is the type of method to use to read the Lua value. Valid values are Inline and ValueRef, default is Inline.
ValueRef has the source code specified as a local object reference. Only a reference to ConfigMap is supported. The value of key `lua` 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.
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.
Wasm is a list of Wasm extensions to be loaded by the Gateway. Order matters, as the extensions will be loaded in the order they are defined in this list.
Code is the Wasm code for the extension.
HTTP is the HTTP URL containing the Wasm code. Note that the HTTP server must be accessible from the Envoy proxy.
SHA256 checksum that will be used to verify the Wasm code. If not specified, Envoy Gateway will not verify the downloaded Wasm code. kubebuilder:validation:Pattern=`^[a-f0-9]{64}$`
TLS configuration when connecting to the Wasm code source.
CACertificateRef contains a reference to Kubernetes objects that contain TLS certificates of the Certificate Authorities that can be used as a trust anchor to validate the certificates presented by the Wasm code source. Kubernetes ConfigMap, Kubernetes Secret, and Kubernetes ClusterTrustBundle are supported.
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
URL is the URL containing the Wasm code.
Image is the OCI image containing the Wasm code. Note that the image must be accessible from the Envoy Gateway.
PullSecretRef is a reference to the secret containing the credentials to pull the image.
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
SHA256 checksum that will be used to verify the OCI image. It must match the digest of the OCI image. If not specified, Envoy Gateway will not verify the downloaded OCI image. kubebuilder:validation:Pattern=`^[a-f0-9]{64}$`
TLS configuration when connecting to the Wasm code source.
CACertificateRef contains a reference to Kubernetes objects that contain TLS certificates of the Certificate Authorities that can be used as a trust anchor to validate the certificates presented by the Wasm code source. Kubernetes ConfigMap, Kubernetes Secret, and Kubernetes ClusterTrustBundle are supported.
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
URL is the URL of the OCI image. URL can be in the format of `registry/image:tag` or `registry/image@sha256:digest`.
PullPolicy is the policy to use when pulling the Wasm module by either the HTTP or Image source. This field is only applicable when the SHA256 field is not set. If not specified, the default policy is IfNotPresent except for OCI images whose tag is latest. Note: EG does not update the Wasm module every time an Envoy proxy requests the Wasm module even if the pull policy is set to Always. It only updates the Wasm module when the EnvoyExtension resource version changes.
Type is the type of the source of the Wasm code. Valid WasmCodeSourceType values are "HTTP" or "Image".
Config is the configuration for the Wasm extension. This configuration will be passed as a JSON string to the Wasm extension.
Env configures the environment for the Wasm extension
HostKeys is a list of keys for environment variables from the host envoy process that should be passed into the Wasm VM. This is useful for passing secrets to to Wasm extensions.
FailOpen is a switch used to control the behavior when a fatal error occurs during the initialization or the execution of the Wasm extension. If FailOpen is set to true, the system bypasses the Wasm extension and allows the traffic to pass through. If it is set to false or not set (defaulting to false), the system blocks the traffic and returns an HTTP 5xx error. If set to true, the Wasm extension will also be bypassed if the configuration is invalid.
Name is a unique name for this Wasm extension. It is used to identify the Wasm extension if multiple extensions are handled by the same vm_id and root_id. It's also used for logging/debugging. If not specified, EG will generate a unique name for the Wasm extension.
RootID is a unique ID for a set of extensions in a VM which will share a RootContext and Contexts if applicable (e.g., an Wasm HttpFilter and an Wasm AccessLog). If left blank, all extensions with a blank root_id with the same vm_id will share Context(s). Note: RootID must match the root_id parameter used to register the Context in the Wasm code.
Status defines the current status of EnvoyExtensionPolicy.
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_envoyextensionpolicies.yaml
Changes to EnvoyExtensionPolicy (gateway.envoyproxy.io/v1alpha1) in each Envoy Gateway version, compared to the version before it.
EnvoyExtensionPolicy was already present in this version of Envoy Gateway, the oldest one on kubespec.dev
Released · View EnvoyExtensionPolicy in v1.8.0
No examples of EnvoyExtensionPolicy yet. Contribute one on GitHub.
kubespec.dev