{ "description": "MCPRoute defines how to route MCP requests to the backend MCP servers.\n\nThis serves as a way to define a \"unified\" AI API for a Gateway which allows downstream\nclients to use a single schema API to interact with multiple MCP backends.", "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 details of the MCPRoute.", "properties": { "backendRefs": { "description": "BackendRefs is a list of backend references to the MCP servers.\nThese MCP servers will be aggregated and exposed as a single MCP endpoint to the clients.\nFrom the client's perspective, they only need to configure a single MCP server URL, e.g. \"https://api.example.com/mcp\",\nand the Envoy AI Gateway will route the requests to the appropriate MCP server based on the requests.\n\nAll names must be unique within this list to avoid potential tools, resources, etc. name collisions.\nAlso, cross-namespace references are not supported. In other words, the backend MCP servers must be in the\nsame namespace as the MCPRoute.", "items": { "description": "MCPRouteBackendRef wraps a EG's BackendObjectReference to reference an MCP server.", "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" }, "path": { "default": "/mcp", "description": "Path is the HTTP endpoint path of the baackend MCP server.\nIf not specified, the default is \"/mcp\".", "maxLength": 1024, "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" }, "securityPolicy": { "description": "SecurityPolicy is the security policy to apply to this MCP server.", "properties": { "apiKey": { "description": "APIKey is a mechanism to access a backend. The API key will be injected into the request headers.", "properties": { "header": { "description": "Header is the HTTP header to inject the API key into. If not specified,\ndefaults to \"Authorization\".\nWhen the header is \"Authorization\", the injected header value will be\nprefixed with \"Bearer \".", "minLength": 1, "type": "string" }, "inline": { "description": "Inline contains the API key as an inline string.", "type": "string" }, "secretRef": { "description": "secretRef is the Kubernetes secret which contains the API keys.\nThe key of the secret should be \"apiKey\".", "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 } }, "type": "object", "x-kubernetes-validations": [ { "message": "exactly one of secretRef or inline must be set", "rule": "(has(self.secretRef) && !has(self.inline)) || (!has(self.secretRef) && has(self.inline))" } ], "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "toolSelector": { "description": "ToolSelector filters the tools exposed by this MCP server.\nSupports exact matches and RE2-compatible regular expressions for both include and exclude patterns.\nIf not specified, all tools from the MCP server are exposed.", "properties": { "include": { "description": "Include is a list of tool names to include. Only the specified tools will be available.", "items": { "type": "string" }, "maxItems": 32, "type": "array" }, "includeRegex": { "description": "IncludeRegex is a list of RE2-compatible regular expressions that, when matched, include the tool.\nOnly tools matching these patterns will be available.", "items": { "type": "string" }, "maxItems": 32, "type": "array" } }, "type": "object", "x-kubernetes-validations": [ { "message": "exactly one of include or includeRegex must be specified", "rule": "(has(self.include) && !has(self.includeRegex)) || (!has(self.include) && has(self.includeRegex))" } ], "additionalProperties": false } }, "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": 256, "minItems": 1, "type": "array", "x-kubernetes-validations": [ { "message": "all backendRefs names must be unique", "rule": "self.all(i, self.exists_one(j, j.name == i.name))" } ] }, "headers": { "description": "Headers are HTTP headers that must match for this route to be selected.\nMultiple match values are ANDed together, meaning, a request must match all the specified headers to select the route.", "items": { "description": "HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request\nheaders.", "properties": { "name": { "description": "Name is the name of the HTTP Header to be matched. Name matching MUST be\ncase-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).\n\nIf multiple entries specify equivalent header names, only the first\nentry with an equivalent name MUST be considered for a match. Subsequent\nentries with an equivalent header name MUST be ignored. Due to the\ncase-insensitivity of header names, \"foo\" and \"Foo\" are considered\nequivalent.\n\nWhen a header is repeated in an HTTP request, it is\nimplementation-specific behavior as to how this is represented.\nGenerally, proxies should follow the guidance from the RFC:\nhttps://www.rfc-editor.org/rfc/rfc7230.html#section-3.2.2 regarding\nprocessing a repeated header, with special handling for \"Set-Cookie\".", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%&'*+\\-.^_\\x60|~]+$", "type": "string" }, "type": { "default": "Exact", "description": "Type specifies how to match against the value of the header.\n\nSupport: Core (Exact)\n\nSupport: Implementation-specific (RegularExpression)\n\nSince RegularExpression HeaderMatchType has implementation-specific\nconformance, implementations can support POSIX, PCRE or any other dialects\nof regular expressions. Please read the implementation's documentation to\ndetermine the supported dialect.", "enum": [ "Exact", "RegularExpression" ], "type": "string" }, "value": { "description": "Value is the value of HTTP Header to be matched.", "maxLength": 4096, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object", "additionalProperties": false }, "maxItems": 16, "type": "array", "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "parentRefs": { "description": "ParentRefs are the names of the Gateway resources this MCPRoute is being attached to.\nCross namespace references are not supported. In other words, the Gateway resources must be in the\nsame namespace as the MCPRoute. Currently, each reference's Kind must be Gateway.", "items": { "description": "ParentReference identifies an API object (usually a Gateway) that can be considered\na parent of this resource (usually a route). There are two kinds of parent resources\nwith \"Core\" support:\n\n* Gateway (Gateway conformance profile)\n* Service (Mesh conformance profile, ClusterIP Services only)\n\nThis API may be extended in the future to support additional kinds of parent\nresources.\n\nThe API object must be valid in the cluster; the Group and Kind must\nbe registered in the cluster for this reference to be valid.", "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 }, "maxItems": 16, "minItems": 1, "type": "array", "x-kubernetes-validations": [ { "message": "only Gateway is supported", "rule": "self.all(match, match.kind == 'Gateway')" } ] }, "path": { "default": "/mcp", "description": "Path is the HTTP endpoint path that serves MCP requests over the Streamable HTTP transport.\nIf not specified, the default is \"/mcp\".", "maxLength": 1024, "type": "string" }, "securityPolicy": { "description": "SecurityPolicy defines the security policy for this MCPRoute.", "properties": { "apiKeyAuth": { "description": "APIKeyAuth defines the configuration for the API Key Authentication.", "properties": { "credentialRefs": { "description": "CredentialRefs is the Kubernetes secret which contains the API keys.\nThis is an Opaque secret.\nEach API key is stored in the key representing the client id.\nIf the secrets have a key for a duplicated client, the first one will be used.", "items": { "description": "SecretObjectReference identifies an API object including its namespace,\ndefaulting to Secret.\n\nThe API object must be valid in the cluster; the Group and Kind must\nbe registered in the cluster for this reference to be valid.\n\nReferences to objects with invalid Group and Kind are not valid, and must\nbe rejected by the implementation, with appropriate Conditions set\non the containing object.", "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 }, "type": "array" }, "extractFrom": { "description": "ExtractFrom is where to fetch the key from the coming request.\nThe value from the first source that has a key will be used.", "items": { "description": "ExtractFrom is where to fetch the key from the coming request.\nOnly one of header, param or cookie is supposed to be specified.", "properties": { "cookies": { "description": "Cookies is the names of the cookie to fetch the key from.\nIf multiple cookies are specified, envoy will look for the api key in the order of the list.\nThis field is optional, but only one of headers, params or cookies is supposed to be specified.", "items": { "type": "string" }, "type": "array" }, "headers": { "description": "Headers is the names of the header to fetch the key from.\nIf multiple headers are specified, envoy will look for the api key in the order of the list.\nThis field is optional, but only one of headers, params or cookies is supposed to be specified.", "items": { "type": "string" }, "type": "array" }, "params": { "description": "Params is the names of the query parameter to fetch the key from.\nIf multiple params are specified, envoy will look for the api key in the order of the list.\nThis field is optional, but only one of headers, params or cookies is supposed to be specified.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "forwardClientIDHeader": { "description": "ForwardClientIDHeader is the name of the header to forward the client identity to the backend\nservice. The header will be added to the request with the client id as the value.", "type": "string" }, "sanitize": { "description": "Sanitize indicates whether to remove the API key from the request before forwarding it to the backend service.", "type": "boolean" } }, "required": [ "credentialRefs", "extractFrom" ], "type": "object", "additionalProperties": false }, "authorization": { "description": "Authorization defines the configuration for the MCP spec compatible authorization.", "properties": { "defaultAction": { "default": "Deny", "description": "DefaultAction is the action to take when no rules match. If unspecified, defaults to Deny.", "enum": [ "Allow", "Deny" ], "type": "string" }, "rules": { "description": "Rules defines a list of authorization rules.\nThese rules are evaluated in order, the first matching rule will be applied,\nand the rest will be skipped.\n\nIf no rules are defined, the default action will be applied to all requests.", "items": { "description": "MCPRouteAuthorizationRule defines an authorization rule for MCPRoute based on the MCP authorization spec.\nReference: https://modelcontextprotocol.io/specification/draft/basic/authorization#scope-challenge-handling", "properties": { "action": { "default": "Allow", "description": "Action is the authorization decision for matching requests. If unspecified, defaults to Allow.", "enum": [ "Allow", "Deny" ], "type": "string" }, "cel": { "description": "CEL specifies a Common Expression Language (CEL) expression evaluated for this rule.\nThe expression must return a boolean; evaluation errors or non-boolean results\nare treated as \"no match\".\n\nExample CEL expressions:\n\t* `request.method == \"POST\"`\n\t* `request.headers[\"x-custom-header\"] == \"AllowedValue\"`\n\t* `request.mcp.tool in [\"toolA\", \"toolB\"]`\n\nAvailable attributes in the CEL expression:\n\n\t* request.method: HTTP method such as GET or POST. Type: string.\n\t* request.headers: map of headers with lowercased keys, first value only. Type: map[string]string.\n\t* request.headers_all: map of headers with lowercased keys, all values. Type: map[string][]string.\n\t* request.path: request path such as /mcp. Type: string.\n\t* request.auth.jwt.claims: JWT claims when a bearer JWT is present. Type: map[string]any.\n\t* request.auth.jwt.scopes: JWT scopes when a bearer JWT is present. Type: []string.\n\t* request.mcp.method: MCP method such as tools/list or tools/call. Type: string.\n\t* request.mcp.backend: upstream backend name (for example, \"kiwi\" or \"github\"). Type: string.\n\t* request.mcp.tool: tool name without backend prefix (for example, \"list_issues\"). Type: string.\n\t* request.mcp.params: parameters of the MCP method, including keys like \"_meta\" and \"arguments\". Type: object.\n\nNote: The CEL expression support is experimental, and the attributes\navailable to the expression may change in future releases.", "maxLength": 4096, "type": "string" }, "source": { "description": "Source defines the authorization source for this rule.\nIf not specified, the rule will match all sources.", "properties": { "jwt": { "description": "JWT defines the JWT scopes required for this rule to match.", "properties": { "claims": { "description": "Claims defines the list of JWT claims required for the rule. Each claim must exist on the token\nand have at least one of the expected values. Use to enforce tenant or subject-based access.", "items": { "description": "JWTClaim specifies a claim in a JWT token.", "properties": { "name": { "description": "Name is the name of the claim.\nIf it is a nested claim, use a dot (.) separated string as the name to\nrepresent the full path to the claim.\nFor example, if the claim is in the \"department\" field in the \"organization\" field,\nthe name should be \"organization.department\".", "maxLength": 253, "minLength": 1, "type": "string" }, "valueType": { "default": "String", "description": "ValueType is the type of the claim value.\nOnly String and StringArray types are supported for now.", "enum": [ "String", "StringArray" ], "type": "string" }, "values": { "description": "Values are the values that the claim must match.\nIf the claim is a string type, the specified value must match exactly.\nIf the claim is a string array type, the specified value must match one of the values in the array.\nIf multiple values are specified, one of the values must match for the rule to match.", "items": { "type": "string" }, "maxItems": 128, "minItems": 1, "type": "array" } }, "required": [ "name", "values" ], "type": "object", "additionalProperties": false }, "maxItems": 16, "type": "array", "x-kubernetes-validations": [ { "message": "'scope' claim name is reserved for OAuth scopes", "rule": "!self.exists(c, c.name == 'scope')" } ] }, "scopes": { "description": "Scopes defines the list of JWT scopes required for the rule.\nIf multiple scopes are specified, all scopes must be present in the JWT for the rule to match.", "items": { "maxLength": 253, "minLength": 1, "type": "string" }, "maxItems": 16, "type": "array" } }, "type": "object", "x-kubernetes-validations": [ { "message": "either scopes or claims must be specified", "rule": "(has(self.scopes) && size(self.scopes) > 0) || (has(self.claims) && size(self.claims) > 0)" } ], "additionalProperties": false } }, "required": [ "jwt" ], "type": "object", "additionalProperties": false }, "target": { "description": "Target defines the authorization target for this rule.\nIf not specified, the rule will match all targets.", "properties": { "tools": { "description": "Tools defines the list of tools this rule applies to.", "items": { "description": "ToolCall represents a tool call in the MCP authorization target.", "properties": { "backend": { "description": "Backend is the name of the backend this tool belongs to.", "type": "string" }, "tool": { "description": "Tool is the name of the tool.", "type": "string" } }, "required": [ "backend", "tool" ], "type": "object", "additionalProperties": false }, "maxItems": 16, "minItems": 1, "type": "array" } }, "required": [ "tools" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "maxItems": 32, "type": "array" } }, "type": "object", "additionalProperties": false }, "extAuth": { "description": "ExtAuth defines the configuration for External Authorization.", "properties": { "bodyToExtAuth": { "description": "BodyToExtAuth defines the Body to Ext Auth configuration.", "properties": { "maxRequestBytes": { "description": "MaxRequestBytes is the maximum size of a message body that the filter will hold in memory.\nEnvoy will return HTTP 413 and will not initiate the authorization process when buffer\nreaches the number set in this field.\nNote that this setting will have precedence over failOpen mode.", "format": "int32", "minimum": 1, "type": "integer" } }, "required": [ "maxRequestBytes" ], "type": "object", "additionalProperties": false }, "contextExtensions": { "description": "ContextExtensions are analogous to http_request.headers, however these\ncontents will not be sent to the upstream server. This provides an\nextension mechanism for sending additional information to the auth server\nwithout modifying the proto definition. It maps to the internal opaque\ncontext in the filter chain.", "items": { "description": "ContextExtension is analogous to http_request.headers, however these\ncontents will not be sent to the upstream server. This provides an\nextension mechanism for sending additional information to the auth server\nwithout modifying the proto definition. It maps to the internal opaque\ncontext in the filter chain.", "properties": { "name": { "description": "Name of the context extension.", "type": "string" }, "type": { "default": "Value", "description": "Type is the type of method to use to read the ContextExtension value.\nValid values are Value and ValueRef, default is Value.", "enum": [ "Value", "ValueRef" ], "type": "string" }, "value": { "description": "Value of the context extension.", "type": "string" }, "valueRef": { "description": "ValueRef for the context extension's value.", "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" }, "key": { "description": "The key to select.", "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", "key", "kind", "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Only a reference to an object of kind ConfigMap or Secret belonging to default v1 API group is supported.", "rule": "self.kind in ['ConfigMap', 'Secret'] && self.group in ['', 'v1']" } ], "additionalProperties": false } }, "required": [ "name", "type" ], "type": "object", "x-kubernetes-validations": [ { "message": "Exactly one of value or valueRef must be set with correct type.", "rule": "(self.type == 'Value' && has(self.value) && !has(self.valueRef)) || (self.type == 'ValueRef' && !has(self.value) && has(self.valueRef))" } ], "additionalProperties": false }, "type": "array", "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "failOpen": { "default": false, "description": "FailOpen is a switch used to control the behavior when a response from the External Authorization service cannot be obtained.\nIf FailOpen is set to true, the system allows the traffic to pass through.\nOtherwise, if it is set to false or not set (defaulting to false),\nthe system blocks the traffic and returns a HTTP 5xx error, reflecting a fail-closed approach.\nThis setting determines whether to prioritize accessibility over strict security in case of authorization service failure.\n\nIf set to true, the External Authorization will also be bypassed if its configuration is invalid.", "type": "boolean" }, "grpc": { "description": "GRPC defines the gRPC External Authorization service.\nEither GRPCService or HTTPService must be specified,\nand only one of them can be provided.", "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 } }, "type": "object", "x-kubernetes-validations": [ { "message": "backendRef or backendRefs needs to be set", "rule": "has(self.backendRef) || self.backendRefs.size() > 0" }, { "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" } ], "additionalProperties": false }, "headersToExtAuth": { "description": "HeadersToExtAuth defines the client request headers that will be included\nin the request to the external authorization service.\nNote: If not specified, the default behavior for gRPC and HTTP external\nauthorization services is different due to backward compatibility reasons.\nAll headers will be included in the check request to a gRPC authorization server.\nOnly the following headers will be included in the check request to an HTTP\nauthorization server: Host, Method, Path, Content-Length, and Authorization.\nAnd these headers will always be included to the check request to an HTTP\nauthorization server by default, no matter whether they are specified\nin HeadersToExtAuth or not.", "items": { "type": "string" }, "type": "array" }, "http": { "description": "HTTP defines the HTTP External Authorization service.\nEither GRPCService or HTTPService must be specified,\nand only one of them can be provided.", "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 }, "headersToBackend": { "description": "HeadersToBackend are the authorization response headers that will be added\nto the original client request before sending it to the backend server.\nNote that coexisting headers will be overridden.\nIf not specified, no authorization response headers will be added to the\noriginal client request.", "items": { "type": "string" }, "type": "array" }, "path": { "description": "Path is the path of the HTTP External Authorization service.\nIf path is specified, the authorization request will be sent to that path,\nor else the authorization request will use the path of the original request.\n\nPlease note that the original request path will be appended to the path specified here.\nFor example, if the original request path is \"/hello\", and the path specified here is \"/auth\",\nthen the path of the authorization request will be \"/auth/hello\". If the path is not specified,\nthe path of the authorization request will be \"/hello\".", "type": "string" } }, "type": "object", "x-kubernetes-validations": [ { "message": "backendRef or backendRefs needs to be set", "rule": "has(self.backendRef) || self.backendRefs.size() > 0" }, { "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" } ], "additionalProperties": false }, "recomputeRoute": { "description": "RecomputeRoute clears the route cache and recalculates the routing decision.\nThis field must be enabled if the headers added or modified by the ExtAuth are used for\nroute matching decisions. If the recomputation selects a new route, features targeting\nthe new matched route will be applied.", "type": "boolean" }, "timeout": { "description": "Timeout defines the timeout for requests to the external authorization service.\nIf not specified, defaults to 10 seconds.", "pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$", "type": "string" } }, "type": "object", "x-kubernetes-validations": [ { "message": "one of grpc or http must be specified", "rule": "(has(self.grpc) || has(self.http))" }, { "message": "only one of grpc or http can be specified", "rule": "(has(self.grpc) && !has(self.http)) || (!has(self.grpc) && has(self.http))" } ], "additionalProperties": false }, "oauth": { "description": "OAuth defines the configuration for the MCP spec compatible OAuth authentication.", "properties": { "audiences": { "description": "Audiences is a list of JWT audiences allowed access.\nIt is recommended to set this field for token audience validation, as it is a security best practice to prevent token misuse.\nReference: https://modelcontextprotocol.io/specification/2025-06-18/basic/authorization#token-audience-binding-and-validation", "items": { "type": "string" }, "maxItems": 32, "type": "array" }, "issuer": { "description": "Issuer is the authorization server's issuer identity.", "format": "uri", "type": "string" }, "jwks": { "description": "JWKS defines how a JSON Web Key Sets (JWKS) can be obtained to verify the access tokens presented by the clients.\n\nIf not specified, the JWKS URI will be discovered from the OAuth 2.0 Authorization Server Metadata\nas per RFC 8414 by querying the `/.well-known/oauth-authorization-server` endpoint on the Issuer.", "properties": { "localJWKS": { "description": "LocalJWKS defines how to get the JSON Web Key Sets (JWKS) from a local source.", "properties": { "inline": { "description": "Inline contains the value as an inline string.", "type": "string" }, "type": { "default": "Inline", "description": "Type is the type of method to use to read the body value.\nValid values are Inline and ValueRef, default is Inline.", "enum": [ "Inline", "ValueRef" ], "type": "string" }, "valueRef": { "description": "ValueRef is a reference to a local ConfigMap that contains the JSON Web Key Sets (JWKS).\n\nThe value of key `jwks` 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", "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 }, "remoteJWKS": { "description": "RemoteJWKS defines how to fetch and cache JSON Web Key Sets (JWKS) from a remote\nHTTP/HTTPS endpoint.", "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 }, "cacheDuration": { "default": "300s", "description": "Duration is a string value representing a duration in time. The format is as specified\nin GEP-2257, a strict subset of the syntax parsed by Golang time.ParseDuration.", "pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$", "type": "string" }, "uri": { "description": "URI is the HTTPS URI to fetch the JWKS. Envoy's system trust bundle is used to validate the server certificate.\nIf a custom trust bundle is needed, it can be specified in a BackendTLSConfig resource and target the BackendRefs.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "uri" ], "type": "object", "x-kubernetes-validations": [ { "message": "BackendRefs must be used, backendRef is not supported.", "rule": "!has(self.backendRef)" }, { "message": "Retry timeout is not supported.", "rule": "has(self.backendSettings)? (has(self.backendSettings.retry)?(has(self.backendSettings.retry.perRetry)? !has(self.backendSettings.retry.perRetry.timeout):true):true):true" }, { "message": "HTTPStatusCodes is not supported.", "rule": "has(self.backendSettings)? (has(self.backendSettings.retry)?(has(self.backendSettings.retry.retryOn)? !has(self.backendSettings.retry.retryOn.httpStatusCodes):true):true):true" } ], "additionalProperties": false } }, "type": "object", "x-kubernetes-validations": [ { "message": "either remoteJWKS or localJWKS must be specified.", "rule": "has(self.remoteJWKS) || has(self.localJWKS)" }, { "message": "remoteJWKS and localJWKS cannot both be specified.", "rule": "!(has(self.remoteJWKS) && has(self.localJWKS))" } ], "additionalProperties": false }, "protectedResourceMetadata": { "description": "ProtectedResourceMetadata defines the OAuth 2.0 Resource Server Metadata as per RFC 8414.\nThis is used to expose the metadata endpoint for mcp clients to discover the authorization servers,\nsupported scopes, and JWKS URI.", "properties": { "resource": { "description": "Resource is the identifier of the protected resource.\nThis should match the MCPRoute's URL. For example, if the MCPRoute's URL is\n\"https://api.example.com/mcp\", the Resource should be \"https://api.example.com/mcp\".", "format": "uri", "type": "string" }, "resourceDocumentation": { "description": "ResourceDocumentation is a URL that provides human-readable documentation for the resource.", "format": "uri", "type": "string" }, "resourceName": { "description": "ResourceName is a human-readable name for the protected resource.", "maxLength": 256, "type": "string" }, "resourcePolicyUri": { "description": "ResourcePolicyURI is a URL that points to the resource server's policy document.", "format": "uri", "type": "string" }, "resourceSigningAlgValuesSupported": { "description": "ResourceSigningAlgValuesSupported is a list of JWS signing algorithms supported by the resource server.\nThese algorithms are used in the \"alg\" field of the JOSE header in signed tokens.", "items": { "type": "string" }, "maxItems": 16, "minItems": 1, "type": "array" }, "scopesSupported": { "description": "ScopesSupported defines the minimal set of scopes required for the basic functionality of the MCPRoute.\nIt should avoid broad or overly permissive scopes to prevent clients from requesting tokens with excessive privileges.\n\nIf an operation requires additional scopes that are not present in the access token, the client will receive a\n403 Forbidden response that includes the required scopes in the `scope` field of the `WWW-Authenticate` header.\nThis enables incremental privilege elevation through targeted `WWW-Authenticate: scope=\"...\"` challenges when\nprivileged operations are first attempted.", "items": { "type": "string" }, "maxItems": 32, "type": "array" } }, "required": [ "resource" ], "type": "object", "additionalProperties": false } }, "required": [ "issuer", "protectedResourceMetadata" ], "type": "object", "additionalProperties": false } }, "type": "object", "x-kubernetes-validations": [ { "message": "oauth must be configured when any authorization rule uses a jwt source", "rule": "!(has(self.authorization) && self.authorization.rules.exists(r, has(r.source) && has(r.source.jwt)) && !has(self.oauth))" } ], "additionalProperties": false } }, "required": [ "backendRefs", "parentRefs" ], "type": "object", "additionalProperties": false }, "status": { "description": "Status defines the status details of the MCPRoute.", "properties": { "conditions": { "description": "Conditions is the list of conditions by the reconciliation result.\nCurrently, at most one condition is set.\n\nKnown .status.conditions.type are: \"Accepted\", \"NotAccepted\".", "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 }, "type": "array" } }, "type": "object", "additionalProperties": false } }, "type": "object" }