{
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"type": "object"
},
"spec": {
"description": "BackendConfigPolicySpec defines the desired state of BackendConfigPolicy.",
"properties": {
"circuitBreakers": {
"description": "CircuitBreakers contains the options necessary to configure circuit breaking.\nSee [Envoy documentation](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/circuit_breaking) for more details.",
"properties": {
"maxConnections": {
"description": "MaxConnections is the maximum number of connections that will be made to\nthe upstream cluster. If not specified, defaults to 1024.",
"format": "int32",
"minimum": 1,
"type": "integer"
},
"maxPendingRequests": {
"description": "MaxPendingRequests is the maximum number of pending requests that are\nallowed to the upstream cluster. If not specified, defaults to 1024.",
"format": "int32",
"minimum": 1,
"type": "integer"
},
"maxRequests": {
"description": "MaxRequests is the maximum number of parallel requests that are allowed\nto the upstream cluster. If not specified, defaults to 1024.",
"format": "int32",
"minimum": 1,
"type": "integer"
},
"maxRetries": {
"description": "MaxRetries is the maximum number of parallel retries that are allowed\nto the upstream cluster. If not specified, defaults to 3.",
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
"type": "object",
"x-kubernetes-validations": [
{
"message": "at least one of the fields in [maxConnections maxPendingRequests maxRequests maxRetries] must be set",
"rule": "[has(self.maxConnections),has(self.maxPendingRequests),has(self.maxRequests),has(self.maxRetries)].filter(x,x==true).size() >= 1"
}
],
"additionalProperties": false
},
"commonHttpProtocolOptions": {
"description": "Additional options when handling HTTP requests upstream, applicable to\nboth HTTP1 and HTTP2 requests.",
"properties": {
"idleTimeout": {
"description": "The idle timeout for connections. The idle timeout is defined as the\nperiod in which there are no active requests. When the\nidle timeout is reached the connection will be closed. If the connection is an HTTP/2\ndownstream connection a drain sequence will occur prior to closing the connection.\nNote that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.\nIf not specified, this defaults to 1 hour. To disable idle timeouts explicitly set this to 0.\n\tDisabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP\n\tFIN packets, etc.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "invalid duration value",
"rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')"
}
]
},
"maxHeadersCount": {
"description": "Specifies the maximum number of headers that the connection will accept.\nIf not specified, the default of 100 is used. Requests that exceed this limit will receive\na 431 response for HTTP/1.x and cause a stream reset for HTTP/2.",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"maxRequestsPerConnection": {
"description": "Maximum requests for a single upstream connection.\nIf set to 0 or unspecified, defaults to unlimited.",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"maxStreamDuration": {
"description": "Total duration to keep alive an HTTP request/response stream. If the time limit is reached the stream will be\nreset independent of any other timeouts. If not specified, this value is not set.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "invalid duration value",
"rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')"
}
]
}
},
"type": "object",
"additionalProperties": false
},
"connectTimeout": {
"description": "The timeout for new network connections to hosts in the cluster.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "invalid duration value",
"rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')"
}
]
},
"healthCheck": {
"description": "HealthCheck contains the options necessary to configure the health check.",
"properties": {
"grpc": {
"description": "Grpc contains the options to configure the gRPC health check.",
"properties": {
"authority": {
"description": "Authority is the authority header used to make the gRPC health check request.\nIf unset, the name of the cluster this health check is associated\nwith will be used.",
"type": "string"
},
"serviceName": {
"description": "ServiceName is the optional name of the service to check.",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
},
"healthyThreshold": {
"description": "HealthyThreshold is the number of healthy health checks required before a host is marked\nhealthy. Note that during startup, only a single successful health check is\nrequired to mark a host healthy.",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"http": {
"description": "Http contains the options to configure the HTTP health check.",
"properties": {
"host": {
"description": "Host is the value of the host header in the HTTP health check request. If\nunset, the name of the cluster this health check is associated\nwith will be used.",
"type": "string"
},
"method": {
"description": "Method is the HTTP method to use.\nIf unset, GET is used.",
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"DELETE",
"OPTIONS",
"TRACE",
"PATCH"
],
"type": "string"
},
"path": {
"description": "Path is the HTTP path requested.",
"type": "string"
}
},
"required": [
"path"
],
"type": "object",
"additionalProperties": false
},
"interval": {
"description": "Interval is the time between health checks.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "invalid duration value",
"rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')"
}
]
},
"timeout": {
"description": "Timeout is time to wait for a health check response. If the timeout is reached the\nhealth check attempt will be considered a failure.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "invalid duration value",
"rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')"
}
]
},
"unhealthyThreshold": {
"description": "UnhealthyThreshold is the number of consecutive failed health checks that will be considered\nunhealthy.\nNote that for HTTP health checks, if a host responds with a code not in ExpectedStatuses or RetriableStatuses,\nthis threshold is ignored and the host is considered immediately unhealthy.",
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
"required": [
"healthyThreshold",
"interval",
"timeout",
"unhealthyThreshold"
],
"type": "object",
"x-kubernetes-validations": [
{
"message": "exactly one of http or grpc must be set",
"rule": "has(self.http) != has(self.grpc)"
}
],
"additionalProperties": false
},
"http1ProtocolOptions": {
"description": "Additional options when handling HTTP1 requests upstream.",
"properties": {
"enableTrailers": {
"description": "Enables trailers for HTTP/1. By default the HTTP/1 codec drops proxied trailers.\nNote: Trailers must also be enabled at the gateway level in order for this option to take effect",
"type": "boolean"
},
"overrideStreamErrorOnInvalidHttpMessage": {
"description": "Allows invalid HTTP messaging. When this option is false, then Envoy will terminate\nHTTP/1.1 connections upon receiving an invalid HTTP message. However,\nwhen this option is true, then Envoy will leave the HTTP/1.1 connection\nopen where possible.",
"type": "boolean"
},
"preserveHttp1HeaderCase": {
"description": "PreserveHttp1HeaderCase determines whether to preserve the case of HTTP1 response headers.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_conn_man/header_casing",
"type": "boolean"
}
},
"type": "object",
"additionalProperties": false
},
"http2ProtocolOptions": {
"description": "Http2ProtocolOptions contains the options necessary to configure HTTP/2 backends.\nNote: Http2ProtocolOptions can only be applied to HTTP/2 backends.\nSee [Envoy documentation](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/transport_sockets/tls/v3/tls.proto#envoy-v3-api-msg-extensions-transport-sockets-tls-v3-sslconfig) for more details.",
"properties": {
"initialConnectionWindowSize": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"description": "InitialConnectionWindowSize is similar to InitialStreamWindowSize, but for the connection level.\nSame range and default value as InitialStreamWindowSize.\nValues can be specified with units like \"64Ki\".",
"pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$",
"x-kubernetes-int-or-string": true,
"x-kubernetes-validations": [
{
"message": "InitialConnectionWindowSize must be between 65535 and 2147483647 bytes (inclusive)",
"rule": "(type(self) == int && int(self) >= 65535 && int(self) <= 2147483647) || (type(self) == string && quantity(self).isGreaterThan(quantity('65534')) && quantity(self).isLessThan(quantity('2147483648')))"
}
]
},
"initialStreamWindowSize": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"description": "InitialStreamWindowSize is the initial window size for the stream.\nValid values range from 65535 (2^16 - 1, HTTP/2 default) to 2147483647 (2^31 - 1, HTTP/2 maximum).\nDefaults to 268435456 (256 * 1024 * 1024).\nValues can be specified with units like \"64Ki\".",
"pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$",
"x-kubernetes-int-or-string": true,
"x-kubernetes-validations": [
{
"message": "InitialStreamWindowSize must be between 65535 and 2147483647 bytes (inclusive)",
"rule": "(type(self) == int && int(self) >= 65535 && int(self) <= 2147483647) || (type(self) == string && quantity(self).isGreaterThan(quantity('65534')) && quantity(self).isLessThan(quantity('2147483648')))"
}
]
},
"maxConcurrentStreams": {
"description": "The maximum number of concurrent streams that the connection can have.",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"overrideStreamErrorOnInvalidHttpMessage": {
"description": "Allows invalid HTTP messaging and headers. When disabled (default), then\nthe whole HTTP/2 connection is terminated upon receiving invalid HEADERS frame.\nWhen enabled, only the offending stream is terminated.",
"type": "boolean"
}
},
"type": "object",
"additionalProperties": false
},
"loadBalancer": {
"description": "LoadBalancer contains the options necessary to configure the load balancer.",
"properties": {
"closeConnectionsOnHostSetChange": {
"description": "If set to true, the load balancer will drain connections when the host set changes.\n\nRing Hash or Maglev can be used to ensure that clients with the same key\nare routed to the same upstream host.\nDistruptions can cause new connections with the same key as existing connections\nto be routed to different hosts.\nEnabling this feature will cause the load balancer to drain existing connections\nwhen the host set changes, ensuring that new connections with the same key are\nconsistently routed to the same host.\nConnections are not immediately closed, but are allowed to drain\nbefore being closed.",
"type": "boolean"
},
"healthyPanicThreshold": {
"description": "HealthyPanicThreshold configures envoy's panic threshold percentage between 0-100. Once the number of non-healthy hosts\nreaches this percentage, envoy disregards health information.\nSee [Envoy documentation](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/load_balancing/panic_threshold.html).",
"format": "int32",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"leastRequest": {
"description": "LeastRequest configures the least request load balancer type.",
"properties": {
"choiceCount": {
"default": 2,
"description": "How many choices to take into account.\nDefaults to 2.",
"format": "int32",
"type": "integer"
},
"slowStart": {
"description": "SlowStart configures the slow start configuration for the load balancer.",
"properties": {
"aggression": {
"description": "This parameter controls the speed of traffic increase over the slow start window. Defaults to 1.0,\nso that endpoint would get linearly increasing amount of traffic.\nWhen increasing the value for this parameter, the speed of traffic ramp-up increases non-linearly.\nThe value of aggression parameter should be greater than 0.0.\nBy tuning the parameter, is possible to achieve polynomial or exponential shape of ramp-up curve.\n\nDuring slow start window, effective weight of an endpoint would be scaled with time factor and aggression:\n`new_weight = weight * max(min_weight_percent, time_factor ^ (1 / aggression))`,\nwhere `time_factor=(time_since_start_seconds / slow_start_time_seconds)`.\n\nAs time progresses, more and more traffic would be sent to endpoint, which is in slow start window.\nOnce host exits slow start, time_factor and aggression no longer affect its weight.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "Aggression, if specified, must be a string representing a number greater than 0.0",
"rule": "(self.matches('^-?(?:[0-9]+(?:\\\\.[0-9]*)?|\\\\.[0-9]+)$') && double(self) > 0.0)"
}
]
},
"minWeightPercent": {
"description": "Minimum weight percentage of an endpoint during slow start.",
"format": "int32",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"window": {
"description": "Represents the size of slow start window.\nIf set, the newly created host remains in slow start mode starting from its creation time\nfor the duration of slow start window.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "invalid duration value",
"rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')"
}
]
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
},
"localityType": {
"description": "LocalityType specifies the locality config type to use.\nSee https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/load_balancing_policies/common/v3/common.proto#envoy-v3-api-msg-extensions-load-balancing-policies-common-v3-localitylbconfig",
"enum": [
"WeightedLb"
],
"type": "string"
},
"maglev": {
"description": "Maglev configures the maglev load balancer type.",
"properties": {
"hashPolicies": {
"description": "HashPolicies specifies the hash policies for hashing load balancers (RingHash, Maglev).",
"items": {
"properties": {
"cookie": {
"description": "Cookie specifies a given cookie as a component of the hash key.",
"properties": {
"httpOnly": {
"description": "HttpOnly specifies whether the cookie is HTTP only, i.e. not accessible to JavaScript.",
"type": "boolean"
},
"name": {
"description": "Name of the cookie.",
"minLength": 1,
"type": "string"
},
"path": {
"description": "Path is the name of the path for the cookie.",
"type": "string"
},
"sameSite": {
"description": "SameSite controls cross-site sending of cookies.\nSupported values are Strict, Lax, and None.",
"enum": [
"Strict",
"Lax",
"None"
],
"type": "string"
},
"secure": {
"description": "Secure specifies whether the cookie is secure.\nIf true, the cookie will only be sent over HTTPS.",
"type": "boolean"
},
"ttl": {
"description": "TTL specifies the time to live of the cookie.\nIf specified, a cookie with the TTL will be generated if the cookie is not present.\nIf the TTL is present and zero, the generated cookie will be a session cookie.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "invalid duration value",
"rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')"
}
]
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"header": {
"description": "Header specifies a header's value as a component of the hash key.",
"properties": {
"name": {
"description": "Name is the name of the header to use as a component of the hash key.",
"minLength": 1,
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"sourceIP": {
"description": "SourceIP specifies whether to use the request's source IP address as a component of the hash key.",
"type": "object"
},
"terminal": {
"description": "Terminal, if set, and a hash key is available after evaluating this policy, will cause Envoy to skip the subsequent policies and\nuse the key as it is.\nThis is useful for defining \"fallback\" policies and limiting the time Envoy spends generating hash keys.",
"type": "boolean"
}
},
"type": "object",
"x-kubernetes-validations": [
{
"message": "exactly one of the fields in [header cookie sourceIP] must be set",
"rule": "[has(self.header),has(self.cookie),has(self.sourceIP)].filter(x,x==true).size() == 1"
}
],
"additionalProperties": false
},
"maxItems": 16,
"minItems": 1,
"type": "array"
},
"useHostnameForHashing": {
"description": "UseHostnameForHashing specifies whether to use the hostname instead of the resolved IP address for hashing.\nDefaults to false.",
"type": "boolean"
}
},
"type": "object",
"additionalProperties": false
},
"random": {
"description": "Random configures the random load balancer type.",
"type": "object"
},
"ringHash": {
"description": "RingHash configures the ring hash load balancer type.",
"properties": {
"hashPolicies": {
"description": "HashPolicies specifies the hash policies for hashing load balancers (RingHash, Maglev).",
"items": {
"properties": {
"cookie": {
"description": "Cookie specifies a given cookie as a component of the hash key.",
"properties": {
"httpOnly": {
"description": "HttpOnly specifies whether the cookie is HTTP only, i.e. not accessible to JavaScript.",
"type": "boolean"
},
"name": {
"description": "Name of the cookie.",
"minLength": 1,
"type": "string"
},
"path": {
"description": "Path is the name of the path for the cookie.",
"type": "string"
},
"sameSite": {
"description": "SameSite controls cross-site sending of cookies.\nSupported values are Strict, Lax, and None.",
"enum": [
"Strict",
"Lax",
"None"
],
"type": "string"
},
"secure": {
"description": "Secure specifies whether the cookie is secure.\nIf true, the cookie will only be sent over HTTPS.",
"type": "boolean"
},
"ttl": {
"description": "TTL specifies the time to live of the cookie.\nIf specified, a cookie with the TTL will be generated if the cookie is not present.\nIf the TTL is present and zero, the generated cookie will be a session cookie.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "invalid duration value",
"rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')"
}
]
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"header": {
"description": "Header specifies a header's value as a component of the hash key.",
"properties": {
"name": {
"description": "Name is the name of the header to use as a component of the hash key.",
"minLength": 1,
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"sourceIP": {
"description": "SourceIP specifies whether to use the request's source IP address as a component of the hash key.",
"type": "object"
},
"terminal": {
"description": "Terminal, if set, and a hash key is available after evaluating this policy, will cause Envoy to skip the subsequent policies and\nuse the key as it is.\nThis is useful for defining \"fallback\" policies and limiting the time Envoy spends generating hash keys.",
"type": "boolean"
}
},
"type": "object",
"x-kubernetes-validations": [
{
"message": "exactly one of the fields in [header cookie sourceIP] must be set",
"rule": "[has(self.header),has(self.cookie),has(self.sourceIP)].filter(x,x==true).size() == 1"
}
],
"additionalProperties": false
},
"maxItems": 16,
"minItems": 1,
"type": "array"
},
"maximumRingSize": {
"description": "MaximumRingSize is the maximum size of the ring.",
"format": "int64",
"minimum": 0,
"type": "integer"
},
"minimumRingSize": {
"description": "MinimumRingSize is the minimum size of the ring.",
"format": "int64",
"minimum": 0,
"type": "integer"
},
"useHostnameForHashing": {
"description": "UseHostnameForHashing specifies whether to use the hostname instead of the resolved IP address for hashing.\nDefaults to false.",
"type": "boolean"
}
},
"type": "object",
"additionalProperties": false
},
"roundRobin": {
"description": "RoundRobin configures the round robin load balancer type.",
"properties": {
"slowStart": {
"description": "SlowStart configures the slow start configuration for the load balancer.",
"properties": {
"aggression": {
"description": "This parameter controls the speed of traffic increase over the slow start window. Defaults to 1.0,\nso that endpoint would get linearly increasing amount of traffic.\nWhen increasing the value for this parameter, the speed of traffic ramp-up increases non-linearly.\nThe value of aggression parameter should be greater than 0.0.\nBy tuning the parameter, is possible to achieve polynomial or exponential shape of ramp-up curve.\n\nDuring slow start window, effective weight of an endpoint would be scaled with time factor and aggression:\n`new_weight = weight * max(min_weight_percent, time_factor ^ (1 / aggression))`,\nwhere `time_factor=(time_since_start_seconds / slow_start_time_seconds)`.\n\nAs time progresses, more and more traffic would be sent to endpoint, which is in slow start window.\nOnce host exits slow start, time_factor and aggression no longer affect its weight.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "Aggression, if specified, must be a string representing a number greater than 0.0",
"rule": "(self.matches('^-?(?:[0-9]+(?:\\\\.[0-9]*)?|\\\\.[0-9]+)$') && double(self) > 0.0)"
}
]
},
"minWeightPercent": {
"description": "Minimum weight percentage of an endpoint during slow start.",
"format": "int32",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"window": {
"description": "Represents the size of slow start window.\nIf set, the newly created host remains in slow start mode starting from its creation time\nfor the duration of slow start window.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "invalid duration value",
"rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')"
}
]
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
},
"updateMergeWindow": {
"description": "This allows batch updates of endpoints health/weight/metadata that happen during a time window.\nthis help lower cpu usage when endpoint change rate is high. defaults to 1 second.\nSet to 0 to disable and have changes applied immediately.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "invalid duration value",
"rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')"
}
]
}
},
"type": "object",
"x-kubernetes-validations": [
{
"message": "exactly one of the fields in [leastRequest roundRobin ringHash maglev random] must be set",
"rule": "[has(self.leastRequest),has(self.roundRobin),has(self.ringHash),has(self.maglev),has(self.random)].filter(x,x==true).size() == 1"
}
],
"additionalProperties": false
},
"outlierDetection": {
"description": "OutlierDetection contains the options necessary to configure passive health checking.",
"properties": {
"baseEjectionTime": {
"default": "30s",
"description": "The base time that a host is ejected for. The real time is equal to the\nbase time multiplied by the number of times the host has been ejected.\nDefaults to 30s.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "invalid duration value",
"rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')"
},
{
"message": "baseEjectionTime must be at least 1ms",
"rule": "duration(self) >= duration('1ms')"
}
]
},
"consecutive5xx": {
"default": 5,
"description": "The number of consecutive server-side error responses (for HTTP traffic,\n5xx responses; for TCP traffic, connection failures; etc.) before an\nejection occurs. Defaults to 5. If this is zero, consecutive 5xx passive\nhealth checks will be disabled. In the future, other types of passive\nhealth checking might be added, but none will be enabled by default.",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"interval": {
"default": "10s",
"description": "The time interval between ejection analysis sweeps. This can result in\nboth new ejections as well as hosts being returned to service. Defaults\nto 10s.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "invalid duration value",
"rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')"
},
{
"message": "interval must be at least 1ms",
"rule": "duration(self) >= duration('1ms')"
}
]
},
"maxEjectionPercent": {
"default": 10,
"description": "The maximum % of an upstream cluster that can be ejected due to outlier\ndetection. Defaults to 10%.",
"format": "int32",
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"type": "object",
"additionalProperties": false
},
"perConnectionBufferLimitBytes": {
"description": "Soft limit on the size of the cluster's connections read and write buffers.\nIf unspecified, an implementation-defined default is applied (1MiB).",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"targetRefs": {
"description": "TargetRefs specifies the target references to attach the policy to.",
"items": {
"description": "Select the object to attach the policy by Group, Kind, and Name.\nThe object must be in the same namespace as the policy.\nYou can target only one object at a time.",
"properties": {
"group": {
"description": "The API group of the target resource.\nFor Kubernetes Gateway API resources, the group is `gateway.networking.k8s.io`.",
"maxLength": 253,
"pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$",
"type": "string"
},
"kind": {
"description": "The API kind of the target resource,\nsuch as Gateway or HTTPRoute.",
"maxLength": 63,
"minLength": 1,
"pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$",
"type": "string"
},
"name": {
"description": "The name of the target resource.",
"maxLength": 253,
"minLength": 1,
"type": "string"
}
},
"required": [
"group",
"kind",
"name"
],
"type": "object",
"additionalProperties": false
},
"maxItems": 16,
"minItems": 1,
"type": "array",
"x-kubernetes-validations": [
{
"message": "TargetRefs must reference either a Kubernetes Service, a Backend, or an Istio Hostname",
"rule": "self.all(r, (r.group == '' && r.kind == 'Service') || (r.group == 'gateway.kgateway.dev' && r.kind == 'Backend') || (r.group == 'networking.istio.io' && r.kind == 'Hostname'))"
}
]
},
"targetSelectors": {
"description": "TargetSelectors specifies the target selectors to select resources to attach the policy to.",
"items": {
"description": "LocalPolicyTargetSelector selects the object to attach the policy by Group, Kind, and MatchLabels.\nThe object must be in the same namespace as the policy and match the\nspecified labels.\nDo not use targetSelectors when reconciliation times are critical, especially if you\nhave a large number of policies that target the same resource.\nInstead, use targetRefs to attach the policy.",
"properties": {
"group": {
"description": "The API group of the target resource.\nFor Kubernetes Gateway API resources, the group is `gateway.networking.k8s.io`.",
"maxLength": 253,
"pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$",
"type": "string"
},
"kind": {
"description": "The API kind of the target resource,\nsuch as Gateway or HTTPRoute.",
"maxLength": 63,
"minLength": 1,
"pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$",
"type": "string"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Label selector to select the target resource.",
"type": "object"
}
},
"required": [
"group",
"kind",
"matchLabels"
],
"type": "object",
"additionalProperties": false
},
"type": "array",
"x-kubernetes-validations": [
{
"message": "TargetSelectors must reference either a Kubernetes Service, a Backend, or an Istio Hostname",
"rule": "self.all(r, (r.group == '' && r.kind == 'Service') || (r.group == 'gateway.kgateway.dev' && r.kind == 'Backend') || (r.group == 'networking.istio.io' && r.kind == 'Hostname'))"
}
]
},
"tcpKeepalive": {
"description": "Configure OS-level TCP keepalive checks.",
"properties": {
"keepAliveInterval": {
"description": "The number of seconds between keep-alive probes.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "invalid duration value",
"rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')"
},
{
"message": "keepAliveInterval must be at least 1 second",
"rule": "duration(self) >= duration('1s')"
}
]
},
"keepAliveProbes": {
"description": "Maximum number of keep-alive probes to send before dropping the connection.",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"keepAliveTime": {
"description": "The number of seconds a connection needs to be idle before keep-alive probes start being sent.",
"type": "string",
"x-kubernetes-validations": [
{
"message": "invalid duration value",
"rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')"
},
{
"message": "keepAliveTime must be at least 1 second",
"rule": "duration(self) >= duration('1s')"
}
]
}
},
"type": "object",
"additionalProperties": false
},
"tls": {
"description": "TLS contains the options necessary to configure a backend to use TLS origination.\nSee [Envoy documentation](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/transport_sockets/tls/v3/tls.proto#envoy-v3-api-msg-extensions-transport-sockets-tls-v3-sslconfig) for more details.",
"properties": {
"allowRenegotiation": {
"description": "Allow Tls renegotiation, the default value is false.\nTLS renegotiation is considered insecure and shouldn't be used unless absolutely necessary.",
"type": "boolean"
},
"alpnProtocols": {
"description": "Set Application Level Protocol Negotiation\nIf empty, defaults to [\"h2\", \"http/1.1\"].",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "File paths to certificates local to the proxy.",
"properties": {
"rootCA": {
"minLength": 1,
"type": "string"
},
"tlsCertificate": {
"minLength": 1,
"type": "string"
},
"tlsKey": {
"minLength": 1,
"type": "string"
}
},
"type": "object",
"x-kubernetes-validations": [
{
"message": "At least one of tlsCertificate, tlsKey, or rootCA must be set in TLSFiles",
"rule": "has(self.tlsCertificate) || has(self.tlsKey) || has(self.rootCA)"
}
],
"additionalProperties": false
},
"insecureSkipVerify": {
"description": "InsecureSkipVerify originates TLS but skips verification of the backend's certificate.\nWARNING: This is an insecure option that should only be used if the risks are understood.",
"type": "boolean"
},
"parameters": {
"description": "General TLS parameters. See the [envoy docs](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/transport_sockets/tls/v3/common.proto#extensions-transport-sockets-tls-v3-tlsparameters)\nfor more information on the meaning of these values.",
"properties": {
"cipherSuites": {
"items": {
"type": "string"
},
"type": "array"
},
"ecdhCurves": {
"items": {
"type": "string"
},
"type": "array"
},
"maxVersion": {
"description": "Maximum TLS version.",
"enum": [
"AUTO",
"1.0",
"1.1",
"1.2",
"1.3"
],
"type": "string"
},
"minVersion": {
"description": "Minimum TLS version.",
"enum": [
"AUTO",
"1.0",
"1.1",
"1.2",
"1.3"
],
"type": "string"
}
},
"type": "object",
"additionalProperties": false
},
"secretRef": {
"description": "Reference to the TLS secret containing the certificate, key, and optionally the root CA.",
"properties": {
"name": {
"default": "",
"description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic",
"additionalProperties": false
},
"simpleTLS": {
"description": "If the TLS config has the tls cert and key provided, kgateway uses it to perform mTLS by default.\nSet simpleTLS to true to disable mTLS in favor of server-only TLS (one-way TLS), even if kgateway has the client cert.\nIf unset, defaults to false.",
"type": "boolean"
},
"sni": {
"description": "The SNI domains that should be considered for TLS connection",
"minLength": 1,
"type": "string"
},
"verifySubjectAltNames": {
"description": "Verify that the Subject Alternative Name in the peer certificate is one of the specified values.\nnote that a root_ca must be provided if this option is used.",
"items": {
"type": "string"
},
"type": "array"
},
"wellKnownCACertificates": {
"description": "WellKnownCACertificates specifies whether to use a well-known set of CA\ncertificates for validating the backend's certificate chain. Currently,\nonly the system certificate pool is supported via SDS.",
"enum": [
"System"
],
"type": "string"
}
},
"type": "object",
"x-kubernetes-validations": [
{
"message": "exactly one of the fields in [secretRef files insecureSkipVerify wellKnownCACertificates] must be set",
"rule": "[has(self.secretRef),has(self.files),has(self.insecureSkipVerify),has(self.wellKnownCACertificates)].filter(x,x==true).size() == 1"
}
],
"additionalProperties": false
}
},
"type": "object",
"x-kubernetes-validations": [
{
"message": "at most one of the fields in [http1ProtocolOptions http2ProtocolOptions] may be set",
"rule": "[has(self.http1ProtocolOptions),has(self.http2ProtocolOptions)].filter(x,x==true).size() <= 1"
}
],
"additionalProperties": false
},
"status": {
"description": "PolicyStatus defines the common attributes that all Policies should include within\ntheir status.",
"properties": {
"ancestors": {
"description": "Ancestors is a list of ancestor resources (usually Gateways) that are\nassociated with the policy, and the status of the policy with respect to\neach ancestor. When this policy attaches to a parent, the controller that\nmanages the parent and the ancestors MUST add an entry to this list when\nthe controller first sees the policy and SHOULD update the entry as\nappropriate when the relevant ancestor is modified.\n\nNote that choosing the relevant ancestor is left to the Policy designers;\nan important part of Policy design is designing the right object level at\nwhich to namespace this status.\n\nNote also that implementations MUST ONLY populate ancestor status for\nthe Ancestor resources they are responsible for. Implementations MUST\nuse the ControllerName field to uniquely identify the entries in this list\nthat they are responsible for.\n\nNote that to achieve this, the list of PolicyAncestorStatus structs\nMUST be treated as a map with a composite key, made up of the AncestorRef\nand ControllerName fields combined.\n\nA maximum of 16 ancestors will be represented in this list. An empty list\nmeans the Policy is not relevant for any ancestors.\n\nIf this slice is full, implementations MUST NOT add further entries.\nInstead they MUST consider the policy unimplementable and signal that\non any related resources such as the ancestor that would be referenced\nhere. For example, if this list was full on BackendTLSPolicy, no\nadditional Gateways would be able to reference the Service targeted by\nthe BackendTLSPolicy.",
"items": {
"description": "PolicyAncestorStatus describes the status of a route with respect to an\nassociated Ancestor.\n\nAncestors refer to objects that are either the Target of a policy or above it\nin terms of object hierarchy. For example, if a policy targets a Service, the\nPolicy's Ancestors are, in order, the Service, the HTTPRoute, the Gateway, and\nthe GatewayClass. Almost always, in this hierarchy, the Gateway will be the most\nuseful object to place Policy status on, so we recommend that implementations\nSHOULD use Gateway as the PolicyAncestorStatus object unless the designers\nhave a _very_ good reason otherwise.\n\nIn the context of policy attachment, the Ancestor is used to distinguish which\nresource results in a distinct application of this policy. For example, if a policy\ntargets a Service, it may have a distinct result per attached Gateway.\n\nPolicies targeting the same resource may have different effects depending on the\nancestors of those resources. For example, different Gateways targeting the same\nService may have different capabilities, especially if they have different underlying\nimplementations.\n\nFor example, in BackendTLSPolicy, the Policy attaches to a Service that is\nused as a backend in a HTTPRoute that is itself attached to a Gateway.\nIn this case, the relevant object for status is the Gateway, and that is the\nancestor object referred to in this status.\n\nNote that a parent is also an ancestor, so for objects where the parent is the\nrelevant object for status, this struct SHOULD still be used.\n\nThis struct is intended to be used in a slice that's effectively a map,\nwith a composite key made up of the AncestorRef and the ControllerName.",
"properties": {
"ancestorRef": {
"description": "AncestorRef corresponds with a ParentRef in the spec that this\nPolicyAncestorStatus struct describes the status of.",
"properties": {
"group": {
"default": "gateway.networking.k8s.io",
"description": "Group is the group of the referent.\nWhen unspecified, \"gateway.networking.k8s.io\" is inferred.\nTo set the core API group (such as for a \"Service\" kind referent),\nGroup must be explicitly set to \"\" (empty string).\n\nSupport: Core",
"maxLength": 253,
"pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$",
"type": "string"
},
"kind": {
"default": "Gateway",
"description": "Kind is kind of the referent.\n\nThere are two kinds of parent resources with \"Core\" support:\n\n* Gateway (Gateway conformance profile)\n* Service (Mesh conformance profile, ClusterIP Services only)\n\nSupport for other resources is Implementation-Specific.",
"maxLength": 63,
"minLength": 1,
"pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$",
"type": "string"
},
"name": {
"description": "Name is the name of the referent.\n\nSupport: Core",
"maxLength": 253,
"minLength": 1,
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the referent. When unspecified, this refers\nto the local namespace of the Route.\n\nNote that there are specific rules for ParentRefs which cross namespace\nboundaries. Cross-namespace references are only valid if they are explicitly\nallowed by something in the namespace they are referring to. For example:\nGateway has the AllowedRoutes field, and ReferenceGrant provides a\ngeneric way to enable any other kind of cross-namespace reference.\n\n\nParentRefs from a Route to a Service in the same namespace are \"producer\"\nroutes, which apply default routing rules to inbound connections from\nany namespace to the Service.\n\nParentRefs from a Route to a Service in a different namespace are\n\"consumer\" routes, and these routing rules are only applied to outbound\nconnections originating from the same namespace as the Route, for which\nthe intended destination of the connections are a Service targeted as a\nParentRef of the Route.\n\n\nSupport: Core",
"maxLength": 63,
"minLength": 1,
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$",
"type": "string"
},
"port": {
"description": "Port is the network port this Route targets. It can be interpreted\ndifferently based on the type of parent resource.\n\nWhen the parent resource is a Gateway, this targets all listeners\nlistening on the specified port that also support this kind of Route(and\nselect this Route). It's not recommended to set `Port` unless the\nnetworking behaviors specified in a Route must apply to a specific port\nas opposed to a listener(s) whose port(s) may be changed. When both Port\nand SectionName are specified, the name and port of the selected listener\nmust match both specified values.\n\n\nWhen the parent resource is a Service, this targets a specific port in the\nService spec. When both Port (experimental) and SectionName are specified,\nthe name and port of the selected port must match both specified values.\n\n\nImplementations MAY choose to support other parent resources.\nImplementations supporting other types of parent resources MUST clearly\ndocument how/if Port is interpreted.\n\nFor the purpose of status, an attachment is considered successful as\nlong as the parent resource accepts it partially. For example, Gateway\nlisteners can restrict which Routes can attach to them by Route kind,\nnamespace, or hostname. If 1 of 2 Gateway listeners accept attachment\nfrom the referencing Route, the Route MUST be considered successfully\nattached. If no Gateway listeners accept attachment from this Route,\nthe Route MUST be considered detached from the Gateway.\n\nSupport: Extended",
"format": "int32",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"sectionName": {
"description": "SectionName is the name of a section within the target resource. In the\nfollowing resources, SectionName is interpreted as the following:\n\n* Gateway: Listener name. When both Port (experimental) and SectionName\nare specified, the name and port of the selected listener must match\nboth specified values.\n* Service: Port name. When both Port (experimental) and SectionName\nare specified, the name and port of the selected listener must match\nboth specified values.\n\nImplementations MAY choose to support attaching Routes to other resources.\nIf that is the case, they MUST clearly document how SectionName is\ninterpreted.\n\nWhen unspecified (empty string), this will reference the entire resource.\nFor the purpose of status, an attachment is considered successful if at\nleast one section in the parent resource accepts it. For example, Gateway\nlisteners can restrict which Routes can attach to them by Route kind,\nnamespace, or hostname. If 1 of 2 Gateway listeners accept attachment from\nthe referencing Route, the Route MUST be considered successfully\nattached. If no Gateway listeners accept attachment from this Route, the\nRoute MUST be considered detached from the Gateway.\n\nSupport: Core",
"maxLength": 253,
"minLength": 1,
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"conditions": {
"description": "Conditions describes the status of the Policy with respect to the given Ancestor.\n\n\n\nNotes for implementors:\n\nConditions are a listType `map`, which means that they function like a\nmap with a key of the `type` field _in the k8s apiserver_.\n\nThis means that implementations must obey some rules when updating this\nsection.\n\n* Implementations MUST perform a read-modify-write cycle on this field\n before modifying it. That is, when modifying this field, implementations\n must be confident they have fetched the most recent version of this field,\n and ensure that changes they make are on that recent version.\n* Implementations MUST NOT remove or reorder Conditions that they are not\n directly responsible for. For example, if an implementation sees a Condition\n with type `special.io/SomeField`, it MUST NOT remove, change or update that\n Condition.\n* Implementations MUST always _merge_ changes into Conditions of the same Type,\n rather than creating more than one Condition of the same Type.\n* Implementations MUST always update the `observedGeneration` field of the\n Condition to the `metadata.generation` of the Gateway at the time of update creation.\n* If the `observedGeneration` of a Condition is _greater than_ the value the\n implementation knows about, then it MUST NOT perform the update on that Condition,\n but must wait for a future reconciliation and status update. (The assumption is that\n the implementation's copy of the object is stale and an update will be re-triggered\n if relevant.)\n\n",
"items": {
"description": "Condition contains details for one aspect of the current state of this API Resource.",
"properties": {
"lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time",
"type": "string"
},
"message": {
"description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768,
"type": "string"
},
"observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64",
"minimum": 0,
"type": "integer"
},
"reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
"type": "string"
},
"status": {
"description": "status of the condition, one of True, False, Unknown.",
"enum": [
"True",
"False",
"Unknown"
],
"type": "string"
},
"type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase.",
"maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string"
}
},
"required": [
"lastTransitionTime",
"message",
"reason",
"status",
"type"
],
"type": "object",
"additionalProperties": false
},
"maxItems": 8,
"minItems": 1,
"type": "array",
"x-kubernetes-list-map-keys": [
"type"
],
"x-kubernetes-list-type": "map"
},
"controllerName": {
"description": "ControllerName is a domain/path string that indicates the name of the\ncontroller that wrote this status. This corresponds with the\ncontrollerName field on GatewayClass.\n\nExample: \"example.net/gateway-controller\".\n\nThe format of this field is DOMAIN \"/\" PATH, where DOMAIN and PATH are\nvalid Kubernetes names\n(https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).\n\nControllers MUST populate this field when writing status. Controllers should ensure that\nentries to status populated with their ControllerName are cleaned up when they are no\nlonger necessary.",
"maxLength": 253,
"minLength": 1,
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\\/[A-Za-z0-9\\/\\-._~%!$&'()*+,;=:]+$",
"type": "string"
}
},
"required": [
"ancestorRef",
"conditions",
"controllerName"
],
"type": "object",
"additionalProperties": false
},
"maxItems": 16,
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"ancestors"
],
"type": "object",
"additionalProperties": false
}
},
"required": [
"spec"
],
"type": "object"
}