{
"description": "EnvoyExtensionPolicy allows the user to configure various envoy extensibility options for the Gateway.",
"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": "Spec defines the desired state of EnvoyExtensionPolicy.",
"properties": {
"extProc": {
"description": "ExtProc is an ordered list of external processing filters\nthat should be added to the envoy filter chain",
"items": {
"description": "ExtProc defines the configuration for External Processing filter.",
"properties": {
"backendRef": {
"description": "BackendRef references a Kubernetes object that represents the\nbackend server to which the authorization request will be sent.\n\nDeprecated: Use BackendRefs instead.",
"properties": {
"group": {
"default": "",
"description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.",
"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": "Service",
"description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)",
"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.",
"maxLength": 253,
"minLength": 1,
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core",
"maxLength": 63,
"minLength": 1,
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$",
"type": "string"
},
"port": {
"description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.",
"format": "int32",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"required": [
"name"
],
"type": "object",
"x-kubernetes-validations": [
{
"message": "Must have port for Service reference",
"rule": "(size(self.group) == 0 && self.kind == 'Service') ? has(self.port) : true"
}
],
"additionalProperties": false
},
"backendRefs": {
"description": "BackendRefs references a Kubernetes object that represents the\nbackend server to which the authorization request will be sent.",
"items": {
"description": "BackendRef defines how an ObjectReference that is specific to BackendRef.",
"properties": {
"fallback": {
"description": "Fallback indicates whether the backend is designated as a fallback.\nMultiple fallback backends can be configured.\nIt is highly recommended to configure active or passive health checks to ensure that failover can be detected\nwhen the active backends become unhealthy and to automatically readjust once the primary backends are healthy again.\nThe overprovisioning factor is set to 1.4, meaning the fallback backends will only start receiving traffic when\nthe health of the active backends falls below 72%.",
"type": "boolean"
},
"group": {
"default": "",
"description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.",
"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": "Service",
"description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)",
"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.",
"maxLength": 253,
"minLength": 1,
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core",
"maxLength": 63,
"minLength": 1,
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$",
"type": "string"
},
"port": {
"description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.",
"format": "int32",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"weight": {
"default": 1,
"description": "Weight specifies the proportion of requests forwarded to the referenced\nbackend. This is computed as weight/(sum of all weights in this\nBackendRefs list). For non-zero values, there may be some epsilon from\nthe exact proportion defined here depending on the precision an\nimplementation supports. Weight is not a percentage and the sum of\nweights does not need to equal 100.\n\nIf only one backend is specified and it has a weight greater than 0, 100%\nof the traffic is forwarded to that backend. If weight is set to 0, no\ntraffic should be forwarded for this entry. If unspecified, weight\ndefaults to 1.\n\nSupport for this field varies based on the context where used.",
"format": "int32",
"maximum": 1000000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"name"
],
"type": "object",
"x-kubernetes-validations": [
{
"message": "Must have port for Service reference",
"rule": "(size(self.group) == 0 && self.kind == 'Service') ? has(self.port) : true"
}
],
"additionalProperties": false
},
"maxItems": 16,
"type": "array"
},
"backendSettings": {
"description": "BackendSettings holds configuration for managing the connection\nto the backend.",
"properties": {
"circuitBreaker": {
"description": "Circuit Breaker settings for the upstream connections and requests.\nIf not set, circuit breakers will be enabled with the default thresholds",
"properties": {
"maxConnections": {
"default": 1024,
"description": "The maximum number of connections that Envoy will establish to the referenced backend defined within a xRoute rule.",
"format": "int64",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"maxParallelRequests": {
"default": 1024,
"description": "The maximum number of parallel requests that Envoy will make to the referenced backend defined within a xRoute rule.",
"format": "int64",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"maxParallelRetries": {
"default": 1024,
"description": "The maximum number of parallel retries that Envoy will make to the referenced backend defined within a xRoute rule.",
"format": "int64",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"maxPendingRequests": {
"default": 1024,
"description": "The maximum number of pending requests that Envoy will queue to the referenced backend defined within a xRoute rule.",
"format": "int64",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"maxRequestsPerConnection": {
"description": "The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule.\nDefault: unlimited.",
"format": "int64",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"perEndpoint": {
"description": "PerEndpoint defines Circuit Breakers that will apply per-endpoint for an upstream cluster",
"properties": {
"maxConnections": {
"default": 1024,
"description": "MaxConnections configures the maximum number of connections that Envoy will establish per-endpoint to the referenced backend defined within a xRoute rule.",
"format": "int64",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
},
"connection": {
"description": "Connection includes backend connection settings.",
"properties": {
"bufferLimit": {
"allOf": [
{
"pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$"
},
{
"pattern": "^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$"
}
],
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"description": "BufferLimit Soft limit on size of the cluster\u2019s connections read and write buffers.\nBufferLimit applies to connection streaming (maybe non-streaming) channel between processes, it's in user space.\nIf unspecified, an implementation defined default is applied (32768 bytes).\nFor example, 20Mi, 1Gi, 256Ki etc.\nNote: that when the suffix is not provided, the value is interpreted as bytes.",
"x-kubernetes-int-or-string": true
},
"preconnect": {
"description": "Preconnect configures proactive upstream connections to reduce latency by establishing\nconnections before they\u2019re needed and avoiding connection establishment overhead.\n\nIf unset, Envoy will fetch connections as needed to serve in-flight requests.",
"properties": {
"perEndpointPercent": {
"description": "PerEndpointPercent configures how many additional connections to maintain per\nupstream endpoint, useful for high-QPS or latency sensitive services. Expressed as a\npercentage of the connections required by active streams\n(e.g. 100 = preconnect disabled, 105 = 1.05x connections per-endpoint, 200 = 2.00\u00d7).\n\nAllowed value range is between 100-300. When both PerEndpointPercent and\nPredictivePercent are set, Envoy ensures both are satisfied (max of the two).",
"format": "int32",
"maximum": 300,
"minimum": 100,
"type": "integer"
},
"predictivePercent": {
"description": "PredictivePercent configures how many additional connections to maintain\nacross the cluster by anticipating which upstream endpoint the load balancer\nwill select next, useful for low-QPS services. Relies on deterministic\nloadbalancing and is only supported with Random or RoundRobin.\nExpressed as a percentage of the connections required by active streams\n(e.g. 100 = 1.0 (no preconnect), 105 = 1.05\u00d7 connections across the cluster, 200 = 2.00\u00d7).\n\nMinimum allowed value is 100. When both PerEndpointPercent and PredictivePercent are\nset Envoy ensures both are satisfied per host (max of the two).",
"format": "int32",
"minimum": 100,
"type": "integer"
}
},
"type": "object",
"additionalProperties": false
},
"socketBufferLimit": {
"allOf": [
{
"pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$"
},
{
"pattern": "^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$"
}
],
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"description": "SocketBufferLimit provides configuration for the maximum buffer size in bytes for each socket\nto backend.\nSocketBufferLimit applies to socket streaming channel between TCP/IP stacks, it's in kernel space.\nFor example, 20Mi, 1Gi, 256Ki etc.\nNote that when the suffix is not provided, the value is interpreted as bytes.",
"x-kubernetes-int-or-string": true
}
},
"type": "object",
"additionalProperties": false
},
"dns": {
"description": "DNS includes dns resolution settings.",
"properties": {
"dnsRefreshRate": {
"description": "DNSRefreshRate specifies the rate at which DNS records should be refreshed.\nDefaults to 30 seconds.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
},
"lookupFamily": {
"description": "LookupFamily determines how Envoy would resolve DNS for Routes where the backend is specified as a fully qualified domain name (FQDN).\nIf set, this configuration overrides other defaults.",
"enum": [
"IPv4",
"IPv6",
"IPv4Preferred",
"IPv6Preferred",
"IPv4AndIPv6"
],
"type": "string"
},
"respectDnsTtl": {
"description": "RespectDNSTTL indicates whether the DNS Time-To-Live (TTL) should be respected.\nIf the value is set to true, the DNS refresh rate will be set to the resource record\u2019s TTL.\nDefaults to true.",
"type": "boolean"
}
},
"type": "object",
"additionalProperties": false
},
"healthCheck": {
"description": "HealthCheck allows gateway to perform active health checking on backends.",
"properties": {
"active": {
"description": "Active health check configuration",
"properties": {
"grpc": {
"description": "GRPC defines the configuration of the GRPC health checker.\nIt's optional, and can only be used if the specified type is GRPC.",
"properties": {
"service": {
"description": "Service to send in the health check request.\nIf this is not specified, then the health check request applies to the entire\nserver and not to a specific service.",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
},
"healthyThreshold": {
"default": 1,
"description": "HealthyThreshold defines the number of healthy health checks required before a backend host is marked healthy.",
"format": "int32",
"minimum": 1,
"type": "integer"
},
"http": {
"description": "HTTP defines the configuration of http health checker.\nIt's required while the health checker type is HTTP.",
"properties": {
"expectedResponse": {
"description": "ExpectedResponse defines a list of HTTP expected responses to match.",
"properties": {
"binary": {
"description": "Binary payload base64 encoded.",
"format": "byte",
"type": "string"
},
"text": {
"description": "Text payload in plain text.",
"type": "string"
},
"type": {
"allOf": [
{
"enum": [
"Text",
"Binary"
]
},
{
"enum": [
"Text",
"Binary"
]
}
],
"description": "Type defines the type of the payload.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-validations": [
{
"message": "If payload type is Text, text field needs to be set.",
"rule": "self.type == 'Text' ? has(self.text) : !has(self.text)"
},
{
"message": "If payload type is Binary, binary field needs to be set.",
"rule": "self.type == 'Binary' ? has(self.binary) : !has(self.binary)"
}
],
"additionalProperties": false
},
"expectedStatuses": {
"description": "ExpectedStatuses defines a list of HTTP response statuses considered healthy.\nDefaults to 200 only",
"items": {
"description": "HTTPStatus defines the http status code.",
"maximum": 599,
"minimum": 100,
"type": "integer"
},
"type": "array"
},
"hostname": {
"description": "Hostname defines the HTTP host that will be requested during health checking.\nDefault: HTTPRoute or GRPCRoute hostname.",
"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"
},
"method": {
"description": "Method defines the HTTP method used for health checking.\nDefaults to GET",
"type": "string"
},
"path": {
"description": "Path defines the HTTP path that will be requested during health checking.",
"maxLength": 1024,
"minLength": 1,
"type": "string"
}
},
"required": [
"path"
],
"type": "object",
"additionalProperties": false
},
"initialJitter": {
"description": "InitialJitter defines the maximum time Envoy will wait before the first health check.\nEnvoy will randomly select a value between 0 and the initial jitter value.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
},
"interval": {
"default": "3s",
"description": "Interval defines the time between active health checks.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
},
"tcp": {
"description": "TCP defines the configuration of tcp health checker.\nIt's required while the health checker type is TCP.",
"properties": {
"receive": {
"description": "Receive defines the expected response payload.",
"properties": {
"binary": {
"description": "Binary payload base64 encoded.",
"format": "byte",
"type": "string"
},
"text": {
"description": "Text payload in plain text.",
"type": "string"
},
"type": {
"allOf": [
{
"enum": [
"Text",
"Binary"
]
},
{
"enum": [
"Text",
"Binary"
]
}
],
"description": "Type defines the type of the payload.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-validations": [
{
"message": "If payload type is Text, text field needs to be set.",
"rule": "self.type == 'Text' ? has(self.text) : !has(self.text)"
},
{
"message": "If payload type is Binary, binary field needs to be set.",
"rule": "self.type == 'Binary' ? has(self.binary) : !has(self.binary)"
}
],
"additionalProperties": false
},
"send": {
"description": "Send defines the request payload.",
"properties": {
"binary": {
"description": "Binary payload base64 encoded.",
"format": "byte",
"type": "string"
},
"text": {
"description": "Text payload in plain text.",
"type": "string"
},
"type": {
"allOf": [
{
"enum": [
"Text",
"Binary"
]
},
{
"enum": [
"Text",
"Binary"
]
}
],
"description": "Type defines the type of the payload.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-validations": [
{
"message": "If payload type is Text, text field needs to be set.",
"rule": "self.type == 'Text' ? has(self.text) : !has(self.text)"
},
{
"message": "If payload type is Binary, binary field needs to be set.",
"rule": "self.type == 'Binary' ? has(self.binary) : !has(self.binary)"
}
],
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
},
"timeout": {
"default": "1s",
"description": "Timeout defines the time to wait for a health check response.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
},
"type": {
"allOf": [
{
"enum": [
"HTTP",
"TCP",
"GRPC"
]
},
{
"enum": [
"HTTP",
"TCP",
"GRPC"
]
}
],
"description": "Type defines the type of health checker.",
"type": "string"
},
"unhealthyThreshold": {
"default": 3,
"description": "UnhealthyThreshold defines the number of unhealthy health checks required before a backend host is marked unhealthy.",
"format": "int32",
"minimum": 1,
"type": "integer"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-validations": [
{
"message": "If Health Checker type is HTTP, http field needs to be set.",
"rule": "self.type == 'HTTP' ? has(self.http) : !has(self.http)"
},
{
"message": "If Health Checker type is TCP, tcp field needs to be set.",
"rule": "self.type == 'TCP' ? has(self.tcp) : !has(self.tcp)"
},
{
"message": "The grpc field can only be set if the Health Checker type is GRPC.",
"rule": "has(self.grpc) ? self.type == 'GRPC' : true"
}
],
"additionalProperties": false
},
"panicThreshold": {
"description": "When number of unhealthy endpoints for a backend reaches this threshold\nEnvoy will disregard health status and balance across all endpoints.\nIt's designed to prevent a situation in which host failures cascade throughout the cluster\nas load increases. If not set, the default value is 50%. To disable panic mode, set value to `0`.",
"format": "int32",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"passive": {
"description": "Passive passive check configuration",
"properties": {
"baseEjectionTime": {
"default": "30s",
"description": "BaseEjectionTime defines the base duration for which a host will be ejected on consecutive failures.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
},
"consecutive5XxErrors": {
"default": 5,
"description": "Consecutive5xxErrors sets the number of consecutive 5xx errors triggering ejection.",
"format": "int32",
"type": "integer"
},
"consecutiveGatewayErrors": {
"description": "ConsecutiveGatewayErrors sets the number of consecutive gateway errors triggering ejection.",
"format": "int32",
"type": "integer"
},
"consecutiveLocalOriginFailures": {
"default": 5,
"description": "ConsecutiveLocalOriginFailures sets the number of consecutive local origin failures triggering ejection.\nParameter takes effect only when split_external_local_origin_errors is set to true.",
"format": "int32",
"type": "integer"
},
"failurePercentageThreshold": {
"description": "FailurePercentageThreshold sets the failure percentage threshold for outlier detection.\nIf the failure percentage of a given host is greater than or equal to this value, it will be ejected.\nDefaults to 85.",
"format": "int32",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"interval": {
"default": "3s",
"description": "Interval defines the time between passive health checks.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
},
"maxEjectionPercent": {
"default": 10,
"description": "MaxEjectionPercent sets the maximum percentage of hosts in a cluster that can be ejected.",
"format": "int32",
"type": "integer"
},
"splitExternalLocalOriginErrors": {
"default": false,
"description": "SplitExternalLocalOriginErrors enables splitting of errors between external and local origin.",
"type": "boolean"
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
},
"http2": {
"description": "HTTP2 provides HTTP/2 configuration for backend connections.",
"properties": {
"initialConnectionWindowSize": {
"allOf": [
{
"pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$"
},
{
"pattern": "^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$"
}
],
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"description": "InitialConnectionWindowSize sets the initial window size for HTTP/2 connections.\nIf not set, the default value is 1 MiB.",
"x-kubernetes-int-or-string": true
},
"initialStreamWindowSize": {
"allOf": [
{
"pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$"
},
{
"pattern": "^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$"
}
],
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"description": "InitialStreamWindowSize sets the initial window size for HTTP/2 streams.\nIf not set, the default value is 64 KiB(64*1024).",
"x-kubernetes-int-or-string": true
},
"maxConcurrentStreams": {
"description": "MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection.\nIf not set, the default value is 100.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"type": "integer"
},
"onInvalidMessage": {
"description": "OnInvalidMessage determines if Envoy will terminate the connection or just the offending stream in the event of HTTP messaging error\nIt's recommended for L2 Envoy deployments to set this value to TerminateStream.\nhttps://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/level_two\nDefault: TerminateConnection",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
},
"loadBalancer": {
"description": "LoadBalancer policy to apply when routing traffic from the gateway to\nthe backend endpoints. Defaults to `LeastRequest`.",
"properties": {
"consistentHash": {
"description": "ConsistentHash defines the configuration when the load balancer type is\nset to ConsistentHash",
"properties": {
"cookie": {
"description": "Cookie configures the cookie hash policy when the consistent hash type is set to Cookie.",
"properties": {
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Additional Attributes to set for the generated cookie.",
"type": "object"
},
"name": {
"description": "Name of the cookie to hash.\nIf this cookie does not exist in the request, Envoy will generate a cookie and set\nthe TTL on the response back to the client based on Layer 4\nattributes of the backend endpoint, to ensure that these future requests\ngo to the same backend endpoint. Make sure to set the TTL field for this case.",
"type": "string"
},
"ttl": {
"description": "TTL of the generated cookie if the cookie is not present. This value sets the\nMax-Age attribute value.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"header": {
"description": "Header configures the header hash policy when the consistent hash type is set to Header.\n\nDeprecated: use Headers instead",
"properties": {
"name": {
"description": "Name of the header to hash.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"headers": {
"description": "Headers configures the header hash policy for each header, when the consistent hash type is set to Headers.",
"items": {
"description": "Header defines the header hashing configuration for consistent hash based\nload balancing.",
"properties": {
"name": {
"description": "Name of the header to hash.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"type": "array"
},
"queryParams": {
"description": "QueryParams configures the query parameter hash policy when the consistent hash type is set to QueryParams.",
"items": {
"description": "QueryParam defines the query parameter name hashing configuration for consistent hash based\nload balancing.",
"properties": {
"name": {
"description": "Name of the query param to hash.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"type": "array"
},
"tableSize": {
"default": 65537,
"description": "The table size for consistent hashing, must be prime number limited to 5000011.",
"format": "int64",
"maximum": 5000011,
"minimum": 2,
"type": "integer"
},
"type": {
"description": "ConsistentHashType defines the type of input to hash on. Valid Type values are\n\"SourceIP\",\n\"Header\",\n\"Headers\",\n\"Cookie\".\n\"QueryParams\".",
"enum": [
"SourceIP",
"Header",
"Headers",
"Cookie",
"QueryParams"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-validations": [
{
"message": "If consistent hash type is header, the header field must be set.",
"rule": "self.type == 'Header' ? has(self.header) : !has(self.header)"
},
{
"message": "If consistent hash type is headers, the headers field must be set.",
"rule": "self.type == 'Headers' ? has(self.headers) : !has(self.headers)"
},
{
"message": "If consistent hash type is cookie, the cookie field must be set.",
"rule": "self.type == 'Cookie' ? has(self.cookie) : !has(self.cookie)"
},
{
"message": "If consistent hash type is queryParams, the queryParams field must be set.",
"rule": "self.type == 'QueryParams' ? has(self.queryParams) : !has(self.queryParams)"
}
],
"additionalProperties": false
},
"endpointOverride": {
"description": "EndpointOverride defines the configuration for endpoint override.\nWhen specified, the load balancer will attempt to route requests to endpoints\nbased on the override information extracted from request headers or metadata.\n If the override endpoints are not available, the configured load balancer policy will be used as fallback.",
"properties": {
"extractFrom": {
"description": "ExtractFrom defines the sources to extract endpoint override information from.",
"items": {
"description": "EndpointOverrideExtractFrom defines a source to extract endpoint override information from.",
"properties": {
"header": {
"description": "Header defines the header to get the override endpoint addresses.\nThe header value must specify at least one endpoint in `IP:Port` format or multiple endpoints in `IP:Port,IP:Port,...` format.\nFor example `10.0.0.5:8080` or `[2600:4040:5204::1574:24ae]:80`.\nThe IPv6 address is enclosed in square brackets.",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
},
"maxItems": 10,
"minItems": 1,
"type": "array"
}
},
"required": [
"extractFrom"
],
"type": "object",
"additionalProperties": false
},
"slowStart": {
"description": "SlowStart defines the configuration related to the slow start load balancer policy.\nIf set, during slow start window, traffic sent to the newly added hosts will gradually increase.\nCurrently this is only supported for RoundRobin and LeastRequest load balancers",
"properties": {
"window": {
"description": "Window defines the duration of the warm up period for newly added host.\nDuring slow start window, traffic sent to the newly added hosts will gradually increase.\nCurrently only supports linear growth of traffic. For additional details,\nsee https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto#config-cluster-v3-cluster-slowstartconfig",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
}
},
"required": [
"window"
],
"type": "object",
"additionalProperties": false
},
"type": {
"description": "Type decides the type of Load Balancer policy.\nValid LoadBalancerType values are\n\"ConsistentHash\",\n\"LeastRequest\",\n\"Random\",\n\"RoundRobin\".",
"enum": [
"ConsistentHash",
"LeastRequest",
"Random",
"RoundRobin"
],
"type": "string"
},
"zoneAware": {
"description": "ZoneAware defines the configuration related to the distribution of requests between locality zones.",
"properties": {
"preferLocal": {
"description": "PreferLocalZone configures zone-aware routing to prefer sending traffic to the local locality zone.",
"properties": {
"force": {
"description": "ForceLocalZone defines override configuration for forcing all traffic to stay within the local zone instead of the default behavior\nwhich maintains equal distribution among upstream endpoints while sending as much traffic as possible locally.",
"properties": {
"minEndpointsInZoneThreshold": {
"description": "MinEndpointsInZoneThreshold is the minimum number of upstream endpoints in the local zone required to honor the forceLocalZone\noverride. This is useful for protecting zones with fewer endpoints.",
"format": "int32",
"type": "integer"
}
},
"type": "object",
"additionalProperties": false
},
"minEndpointsThreshold": {
"description": "MinEndpointsThreshold is the minimum number of total upstream endpoints across all zones required to enable zone-aware routing.",
"format": "int64",
"type": "integer"
},
"percentageEnabled": {
"description": "Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured. If not specified, Envoy defaults to 100%.",
"format": "int32",
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-validations": [
{
"message": "If LoadBalancer type is consistentHash, consistentHash field needs to be set.",
"rule": "self.type == 'ConsistentHash' ? has(self.consistentHash) : !has(self.consistentHash)"
},
{
"message": "Currently SlowStart is only supported for RoundRobin and LeastRequest load balancers.",
"rule": "self.type in ['Random', 'ConsistentHash'] ? !has(self.slowStart) : true "
},
{
"message": "Currently ZoneAware is only supported for LeastRequest, Random, and RoundRobin load balancers.",
"rule": "self.type == 'ConsistentHash' ? !has(self.zoneAware) : true "
}
],
"additionalProperties": false
},
"proxyProtocol": {
"description": "ProxyProtocol enables the Proxy Protocol when communicating with the backend.",
"properties": {
"version": {
"description": "Version of ProxyProtol\nValid ProxyProtocolVersion values are\n\"V1\"\n\"V2\"",
"enum": [
"V1",
"V2"
],
"type": "string"
}
},
"required": [
"version"
],
"type": "object",
"additionalProperties": false
},
"retry": {
"description": "Retry provides more advanced usage, allowing users to customize the number of retries, retry fallback strategy, and retry triggering conditions.\nIf not set, retry will be disabled.",
"properties": {
"numAttemptsPerPriority": {
"description": "NumAttemptsPerPriority defines the number of requests (initial attempt + retries)\nthat should be sent to the same priority before switching to a different one.\nIf not specified or set to 0, all requests are sent to the highest priority that is healthy.",
"format": "int32",
"type": "integer"
},
"numRetries": {
"default": 2,
"description": "NumRetries is the number of retries to be attempted. Defaults to 2.",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"perRetry": {
"description": "PerRetry is the retry policy to be applied per retry attempt.",
"properties": {
"backOff": {
"description": "Backoff is the backoff policy to be applied per retry attempt. gateway uses a fully jittered exponential\nback-off algorithm for retries. For additional details,\nsee https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#config-http-filters-router-x-envoy-max-retries",
"properties": {
"baseInterval": {
"description": "BaseInterval is the base interval between retries.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
},
"maxInterval": {
"description": "MaxInterval is the maximum interval between retries. This parameter is optional, but must be greater than or equal to the base_interval if set.\nThe default is 10 times the base_interval",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
},
"timeout": {
"description": "Timeout is the timeout per retry attempt.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
},
"retryOn": {
"description": "RetryOn specifies the retry trigger condition.\n\nIf not specified, the default is to retry on connect-failure,refused-stream,unavailable,cancelled,retriable-status-codes(503).",
"properties": {
"httpStatusCodes": {
"description": "HttpStatusCodes specifies the http status codes to be retried.\nThe retriable-status-codes trigger must also be configured for these status codes to trigger a retry.",
"items": {
"description": "HTTPStatus defines the http status code.",
"maximum": 599,
"minimum": 100,
"type": "integer"
},
"type": "array"
},
"triggers": {
"description": "Triggers specifies the retry trigger condition(Http/Grpc).",
"items": {
"description": "TriggerEnum specifies the conditions that trigger retries.",
"enum": [
"5xx",
"gateway-error",
"reset",
"reset-before-request",
"connect-failure",
"retriable-4xx",
"refused-stream",
"retriable-status-codes",
"cancelled",
"deadline-exceeded",
"internal",
"resource-exhausted",
"unavailable"
],
"type": "string"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
},
"tcpKeepalive": {
"description": "TcpKeepalive settings associated with the upstream client connection.\nDisabled by default.",
"properties": {
"idleTime": {
"description": "The duration a connection needs to be idle before keep-alive\nprobes start being sent.\nThe duration format is\nDefaults to `7200s`.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
},
"interval": {
"description": "The duration between keep-alive probes.\nDefaults to `75s`.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
},
"probes": {
"description": "The total number of unacknowledged probes to send before deciding\nthe connection is dead.\nDefaults to 9.",
"format": "int32",
"type": "integer"
}
},
"type": "object",
"additionalProperties": false
},
"timeout": {
"description": "Timeout settings for the backend connections.",
"properties": {
"http": {
"description": "Timeout settings for HTTP.",
"properties": {
"connectionIdleTimeout": {
"description": "The idle timeout for an HTTP connection. Idle time is defined as a period in which there are no active requests in the connection.\nDefault: 1 hour.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
},
"maxConnectionDuration": {
"description": "The maximum duration of an HTTP connection.\nDefault: unlimited.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
},
"maxStreamDuration": {
"description": "MaxStreamDuration is the maximum duration for a stream to complete. This timeout measures the time\nfrom when the request is sent until the response stream is fully consumed and does not apply to\nnon-streaming requests.\nWhen set to \"0s\", no max duration is applied and streams can run indefinitely.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
},
"requestTimeout": {
"description": "RequestTimeout is the time until which entire response is received from the upstream.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
},
"tcp": {
"description": "Timeout settings for TCP.",
"properties": {
"connectTimeout": {
"description": "The timeout for network connection establishment, including TCP and TLS handshakes.\nDefault: 10 seconds.",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"x-kubernetes-validations": [
{
"message": "predictivePercent in preconnect policy only works with RoundRobin or Random load balancers",
"rule": "!((has(self.connection) && has(self.connection.preconnect) && has(self.connection.preconnect.predictivePercent)) && !(has(self.loadBalancer) && has(self.loadBalancer.type) && self.loadBalancer.type in ['Random', 'RoundRobin']))"
}
],
"additionalProperties": false
},
"failOpen": {
"default": false,
"description": "FailOpen is a switch used to control the behavior when failing to call the external processor.\n\nIf FailOpen is set to true, the system bypasses the ExtProc extension and\nallows the traffic to pass through. If it is set to false or\nnot set (defaulting to false), the system blocks the traffic and returns\nan HTTP 5xx error.\n\nIf set to true, the ExtProc extension will also be bypassed if the configuration is invalid.",
"type": "boolean"
},
"messageTimeout": {
"description": "MessageTimeout is the timeout for a response to be returned from the external processor\nDefault: 200ms",
"pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$",
"type": "string"
},
"metadata": {
"description": "Metadata defines options related to the sending and receiving of dynamic metadata.\nThese options define which metadata namespaces would be sent to the processor and which dynamic metadata\nnamespaces the processor would be permitted to emit metadata to.\nUsers can specify custom namespaces or well-known envoy metadata namespace (such as envoy.filters.http.ext_authz)\ndocumented here: https://www.envoyproxy.io/docs/envoy/latest/configuration/advanced/well_known_dynamic_metadata#well-known-dynamic-metadata\nDefault: no metadata context is sent or received from the external processor",
"properties": {
"accessibleNamespaces": {
"description": "AccessibleNamespaces are metadata namespaces that are sent to the external processor as context",
"items": {
"type": "string"
},
"type": "array"
},
"writableNamespaces": {
"description": "WritableNamespaces are metadata namespaces that the external processor can write to",
"items": {
"type": "string"
},
"maxItems": 8,
"type": "array",
"x-kubernetes-validations": [
{
"message": "writableNamespaces cannot contain well-known Envoy HTTP filter namespaces",
"rule": "self.all(f, !f.startsWith('envoy.filters.http'))"
}
]
}
},
"type": "object",
"additionalProperties": false
},
"processingMode": {
"description": "ProcessingMode defines how request and response body is processed\nDefault: header and body are not sent to the external processor",
"properties": {
"allowModeOverride": {
"description": "AllowModeOverride allows the external processor to override the processing mode set via the\n`mode_override` field in the gRPC response message. This defaults to false.",
"type": "boolean"
},
"request": {
"description": "Defines processing mode for requests. If present, request headers are sent. Request body is processed according\nto the specified mode.",
"properties": {
"attributes": {
"description": "Defines which attributes are sent to the external processor. Envoy Gateway currently\nsupports only the following attribute prefixes: connection, source, destination,\nrequest, response, upstream and xds.route.\nhttps://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/advanced/attributes",
"items": {
"pattern": "^(connection\\.|source\\.|destination\\.|request\\.|response\\.|upstream\\.|xds\\.route_)[a-z_1-9]*$",
"type": "string"
},
"type": "array"
},
"body": {
"description": "Defines body processing mode",
"enum": [
"Streamed",
"Buffered",
"BufferedPartial",
"FullDuplexStreamed"
],
"type": "string"
}
},
"type": "object",
"additionalProperties": false
},
"response": {
"description": "Defines processing mode for responses. If present, response headers are sent. Response body is processed according\nto the specified mode.",
"properties": {
"attributes": {
"description": "Defines which attributes are sent to the external processor. Envoy Gateway currently\nsupports only the following attribute prefixes: connection, source, destination,\nrequest, response, upstream and xds.route.\nhttps://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/advanced/attributes",
"items": {
"pattern": "^(connection\\.|source\\.|destination\\.|request\\.|response\\.|upstream\\.|xds\\.route_)[a-z_1-9]*$",
"type": "string"
},
"type": "array"
},
"body": {
"description": "Defines body processing mode",
"enum": [
"Streamed",
"Buffered",
"BufferedPartial",
"FullDuplexStreamed"
],
"type": "string"
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"x-kubernetes-validations": [
{
"message": "BackendRefs must be used, backendRef is not supported.",
"rule": "!has(self.backendRef)"
},
{
"message": "BackendRefs only supports Service, ServiceImport, and Backend kind.",
"rule": "has(self.backendRefs) ? self.backendRefs.all(f, f.kind == 'Service' || f.kind == 'ServiceImport' || f.kind == 'Backend') : true"
},
{
"message": "BackendRefs only supports Core, multicluster.x-k8s.io, and gateway.envoyproxy.io groups.",
"rule": "has(self.backendRefs) ? (self.backendRefs.all(f, f.group == \"\" || f.group == 'multicluster.x-k8s.io' || f.group == 'gateway.envoyproxy.io')) : true"
},
{
"message": "If FullDuplexStreamed body processing mode is used, FailOpen must be false.",
"rule": "!(has(self.failOpen) && self.failOpen == true && has(self.processingMode) && ((has(self.processingMode.request) && has(self.processingMode.request.body) && self.processingMode.request.body == 'FullDuplexStreamed') || (has(self.processingMode.response) && has(self.processingMode.response.body) && self.processingMode.response.body == 'FullDuplexStreamed')))"
}
],
"additionalProperties": false
},
"maxItems": 16,
"type": "array"
},
"lua": {
"description": "Lua is an ordered list of Lua filters\nthat should be added to the envoy filter chain",
"items": {
"description": "Lua defines a Lua extension\nOnly one of Inline or ValueRef must be set",
"properties": {
"inline": {
"description": "Inline contains the source code as an inline string.",
"type": "string"
},
"type": {
"default": "Inline",
"description": "Type is the type of method to use to read the Lua value.\nValid values are Inline and ValueRef, default is Inline.",
"enum": [
"Inline",
"ValueRef"
],
"type": "string"
},
"valueRef": {
"description": "ValueRef has the source code specified as a local object reference.\nOnly a reference to ConfigMap is supported.\nThe value of key `lua` in the ConfigMap will be used.\nIf the key is not found, the first value in the ConfigMap will be used.",
"properties": {
"group": {
"description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.",
"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": "Kind is kind of the referent. For example \"HTTPRoute\" or \"Service\".",
"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.",
"maxLength": 253,
"minLength": 1,
"type": "string"
}
},
"required": [
"group",
"kind",
"name"
],
"type": "object",
"x-kubernetes-validations": [
{
"message": "Only a reference to an object of kind ConfigMap belonging to default v1 API group is supported.",
"rule": "self.kind == 'ConfigMap' && (self.group == 'v1' || self.group == '')"
}
],
"additionalProperties": false
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-validations": [
{
"message": "Exactly one of inline or valueRef must be set with correct type.",
"rule": "(self.type == 'Inline' && has(self.inline) && !has(self.valueRef)) || (self.type == 'ValueRef' && !has(self.inline) && has(self.valueRef))"
}
],
"additionalProperties": false
},
"maxItems": 16,
"type": "array"
},
"targetRef": {
"description": "TargetRef is the name of the resource this policy is being attached to.\nThis policy and the TargetRef MUST be in the same namespace for this\nPolicy to have effect\n\nDeprecated: use targetRefs/targetSelectors instead",
"properties": {
"group": {
"description": "Group is the group of the target resource.",
"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": "Kind is kind of the target resource.",
"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 target resource.",
"maxLength": 253,
"minLength": 1,
"type": "string"
},
"sectionName": {
"description": "SectionName is the name of a section within the target resource. When\nunspecified, this targetRef targets the entire resource. In the following\nresources, SectionName is interpreted as the following:\n\n* Gateway: Listener name\n* HTTPRoute: HTTPRouteRule name\n* Service: Port name\n\nIf a SectionName is specified, but does not exist on the targeted object,\nthe Policy must fail to attach, and the policy implementation should record\na `ResolvedRefs` or similar Condition in the Policy's status.",
"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": [
"group",
"kind",
"name"
],
"type": "object",
"additionalProperties": false
},
"targetRefs": {
"description": "TargetRefs are the names of the Gateway resources this policy\nis being attached to.",
"items": {
"description": "LocalPolicyTargetReferenceWithSectionName identifies an API object to apply a\ndirect policy to. This should be used as part of Policy resources that can\ntarget single resources. For more information on how this policy attachment\nmode works, and a sample Policy resource, refer to the policy attachment\ndocumentation for Gateway API.\n\nNote: This should only be used for direct policy attachment when references\nto SectionName are actually needed. In all other cases,\nLocalPolicyTargetReference should be used.",
"properties": {
"group": {
"description": "Group is the group of the target resource.",
"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": "Kind is kind of the target resource.",
"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 target resource.",
"maxLength": 253,
"minLength": 1,
"type": "string"
},
"sectionName": {
"description": "SectionName is the name of a section within the target resource. When\nunspecified, this targetRef targets the entire resource. In the following\nresources, SectionName is interpreted as the following:\n\n* Gateway: Listener name\n* HTTPRoute: HTTPRouteRule name\n* Service: Port name\n\nIf a SectionName is specified, but does not exist on the targeted object,\nthe Policy must fail to attach, and the policy implementation should record\na `ResolvedRefs` or similar Condition in the Policy's status.",
"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": [
"group",
"kind",
"name"
],
"type": "object",
"additionalProperties": false
},
"type": "array"
},
"targetSelectors": {
"description": "TargetSelectors allow targeting resources for this policy based on labels",
"items": {
"properties": {
"group": {
"default": "gateway.networking.k8s.io",
"description": "Group is the group that this selector targets. Defaults to 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": "Kind is the resource kind that this selector targets.",
"maxLength": 63,
"minLength": 1,
"pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$",
"type": "string"
},
"matchExpressions": {
"description": "MatchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.",
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string"
},
"operator": {
"description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object",
"additionalProperties": false
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "MatchLabels are the set of label selectors for identifying the targeted resource",
"type": "object"
}
},
"required": [
"kind"
],
"type": "object",
"x-kubernetes-validations": [
{
"message": "group must be gateway.networking.k8s.io",
"rule": "has(self.group) ? self.group == 'gateway.networking.k8s.io' : true "
}
],
"additionalProperties": false
},
"type": "array"
},
"wasm": {
"description": "Wasm is a list of Wasm extensions to be loaded by the Gateway.\nOrder matters, as the extensions will be loaded in the order they are\ndefined in this list.",
"items": {
"description": "Wasm defines a Wasm extension.\n\nNote: at the moment, Envoy Gateway does not support configuring Wasm runtime.\nv8 is used as the VM runtime for the Wasm extensions.",
"properties": {
"code": {
"description": "Code is the Wasm code for the extension.",
"properties": {
"http": {
"description": "HTTP is the HTTP URL containing the Wasm code.\n\nNote that the HTTP server must be accessible from the Envoy proxy.",
"properties": {
"sha256": {
"description": "SHA256 checksum that will be used to verify the Wasm code.\n\nIf not specified, Envoy Gateway will not verify the downloaded Wasm code.\nkubebuilder:validation:Pattern=`^[a-f0-9]{64}$`",
"type": "string"
},
"tls": {
"description": "TLS configuration when connecting to the Wasm code source.",
"properties": {
"caCertificateRef": {
"description": "CACertificateRef contains a references to\nKubernetes objects that contain TLS certificates of\nthe Certificate Authorities that can be used\nas a trust anchor to validate the certificates presented by the Wasm code source.\n\nKubernetes ConfigMap and Kubernetes Secret are supported.\nNote: The ConfigMap or Secret must be in the same namespace as the EnvoyExtensionPolicy.",
"properties": {
"group": {
"default": "",
"description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.",
"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": "Secret",
"description": "Kind is kind of the referent. For example \"Secret\".",
"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.",
"maxLength": 253,
"minLength": 1,
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the referenced object. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core",
"maxLength": 63,
"minLength": 1,
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
}
},
"required": [
"caCertificateRef"
],
"type": "object",
"additionalProperties": false
},
"url": {
"description": "URL is the URL containing the Wasm code.",
"pattern": "^((https?:)(\\/\\/\\/?)([\\w]*(?::[\\w]*)?@)?([\\d\\w\\.-]+)(?::(\\d+))?)?([\\/\\\\\\w\\.()-]*)?(?:([?][^#]*)?(#.*)?)*",
"type": "string"
}
},
"required": [
"url"
],
"type": "object",
"additionalProperties": false
},
"image": {
"description": "Image is the OCI image containing the Wasm code.\n\nNote that the image must be accessible from the Envoy Gateway.",
"properties": {
"pullSecretRef": {
"description": "PullSecretRef is a reference to the secret containing the credentials to pull the image.\nOnly support Kubernetes Secret resource from the same namespace.",
"properties": {
"group": {
"default": "",
"description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.",
"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": "Secret",
"description": "Kind is kind of the referent. For example \"Secret\".",
"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.",
"maxLength": 253,
"minLength": 1,
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the referenced object. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core",
"maxLength": 63,
"minLength": 1,
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"x-kubernetes-validations": [
{
"message": "only support Secret kind.",
"rule": "self.kind == 'Secret'"
}
],
"additionalProperties": false
},
"sha256": {
"description": "SHA256 checksum that will be used to verify the OCI image.\n\nIt must match the digest of the OCI image.\n\nIf not specified, Envoy Gateway will not verify the downloaded OCI image.\nkubebuilder:validation:Pattern=`^[a-f0-9]{64}$`",
"type": "string"
},
"tls": {
"description": "TLS configuration when connecting to the Wasm code source.",
"properties": {
"caCertificateRef": {
"description": "CACertificateRef contains a references to\nKubernetes objects that contain TLS certificates of\nthe Certificate Authorities that can be used\nas a trust anchor to validate the certificates presented by the Wasm code source.\n\nKubernetes ConfigMap and Kubernetes Secret are supported.\nNote: The ConfigMap or Secret must be in the same namespace as the EnvoyExtensionPolicy.",
"properties": {
"group": {
"default": "",
"description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.",
"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": "Secret",
"description": "Kind is kind of the referent. For example \"Secret\".",
"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.",
"maxLength": 253,
"minLength": 1,
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the referenced object. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core",
"maxLength": 63,
"minLength": 1,
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
}
},
"required": [
"caCertificateRef"
],
"type": "object",
"additionalProperties": false
},
"url": {
"description": "URL is the URL of the OCI image.\nURL can be in the format of `registry/image:tag` or `registry/image@sha256:digest`.",
"type": "string"
}
},
"required": [
"url"
],
"type": "object",
"additionalProperties": false
},
"pullPolicy": {
"description": "PullPolicy is the policy to use when pulling the Wasm module by either the HTTP or Image source.\nThis field is only applicable when the SHA256 field is not set.\n\nIf not specified, the default policy is IfNotPresent except for OCI images whose tag is latest.\n\nNote: EG does not update the Wasm module every time an Envoy proxy requests\nthe Wasm module even if the pull policy is set to Always.\nIt only updates the Wasm module when the EnvoyExtension resource version changes.",
"enum": [
"IfNotPresent",
"Always"
],
"type": "string"
},
"type": {
"allOf": [
{
"enum": [
"HTTP",
"Image"
]
},
{
"enum": [
"HTTP",
"Image",
"ConfigMap"
]
}
],
"description": "Type is the type of the source of the Wasm code.\nValid WasmCodeSourceType values are \"HTTP\" or \"Image\".",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-validations": [
{
"message": "If type is HTTP, http field needs to be set.",
"rule": "self.type == 'HTTP' ? has(self.http) : !has(self.http)"
},
{
"message": "If type is Image, image field needs to be set.",
"rule": "self.type == 'Image' ? has(self.image) : !has(self.image)"
}
],
"additionalProperties": false
},
"config": {
"description": "Config is the configuration for the Wasm extension.\nThis configuration will be passed as a JSON string to the Wasm extension.",
"x-kubernetes-preserve-unknown-fields": true
},
"env": {
"description": "Env configures the environment for the Wasm extension",
"properties": {
"hostKeys": {
"description": "HostKeys is a list of keys for environment variables from the host envoy process\nthat should be passed into the Wasm VM. This is useful for passing secrets to to Wasm extensions.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"failOpen": {
"default": false,
"description": "FailOpen is a switch used to control the behavior when a fatal error occurs\nduring the initialization or the execution of the Wasm extension.\n\nIf FailOpen is set to true, the system bypasses the Wasm extension and\nallows the traffic to pass through. If it is set to false or\nnot set (defaulting to false), the system blocks the traffic and returns\nan HTTP 5xx error.\n\nIf set to true, the Wasm extension will also be bypassed if the configuration is invalid.",
"type": "boolean"
},
"name": {
"description": "Name is a unique name for this Wasm extension. It is used to identify the\nWasm extension if multiple extensions are handled by the same vm_id and root_id.\nIt's also used for logging/debugging.\nIf not specified, EG will generate a unique name for the Wasm extension.",
"type": "string"
},
"rootID": {
"description": "RootID is a unique ID for a set of extensions in a VM which will share a\nRootContext and Contexts if applicable (e.g., an Wasm HttpFilter and an Wasm AccessLog).\nIf left blank, all extensions with a blank root_id with the same vm_id will share Context(s).\n\nNote: RootID must match the root_id parameter used to register the Context in the Wasm code.",
"type": "string"
}
},
"required": [
"code"
],
"type": "object",
"additionalProperties": false
},
"maxItems": 16,
"type": "array"
}
},
"type": "object",
"x-kubernetes-validations": [
{
"message": "either targetRef or targetRefs must be used",
"rule": "(has(self.targetRef) && !has(self.targetRefs)) || (!has(self.targetRef) && has(self.targetRefs)) || (has(self.targetSelectors) && self.targetSelectors.size() > 0) "
},
{
"message": "this policy can only have a targetRef.group of gateway.networking.k8s.io",
"rule": "has(self.targetRef) ? self.targetRef.group == 'gateway.networking.k8s.io' : true"
},
{
"message": "this policy can only have a targetRef.kind of Gateway/HTTPRoute/GRPCRoute/TCPRoute/UDPRoute/TLSRoute",
"rule": "has(self.targetRef) ? self.targetRef.kind in ['Gateway', 'HTTPRoute', 'GRPCRoute', 'UDPRoute', 'TCPRoute', 'TLSRoute'] : true"
},
{
"message": "this policy can only have a targetRefs[*].group of gateway.networking.k8s.io",
"rule": "has(self.targetRefs) ? self.targetRefs.all(ref, ref.group == 'gateway.networking.k8s.io') : true "
},
{
"message": "this policy can only have a targetRefs[*].kind of Gateway/HTTPRoute/GRPCRoute/TCPRoute/UDPRoute/TLSRoute",
"rule": "has(self.targetRefs) ? self.targetRefs.all(ref, ref.kind in ['Gateway', 'HTTPRoute', 'GRPCRoute', 'UDPRoute', 'TCPRoute', 'TLSRoute']) : true "
}
],
"additionalProperties": false
},
"status": {
"description": "Status defines the current status of EnvoyExtensionPolicy.",
"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"
}