{ "description": "ListenerPolicy is used for configuring Envoy listener-level settings that apply to all protocol types (HTTP, HTTPS, TCP, TLS).\nThese policies can only target `Gateway` objects.", "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": "ListenerPolicySpec defines the desired state of a listener policy.", "properties": { "default": { "description": "Default specifies default listener configuration for all Listeners, unless a per-port\nconfiguration is defined.", "properties": { "httpSettings": { "description": "HTTPListenerPolicy is intended to be used for configuring the Envoy `HttpConnectionManager` and any other config or policy\nthat should map 1-to-1 with a given HTTP listener, such as the Envoy health check HTTP filter.", "properties": { "acceptHttp10": { "description": "AcceptHTTP10 determines whether to accept incoming HTTP/1.0 and HTTP 0.9 requests.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#config-core-v3-http1protocoloptions", "type": "boolean" }, "accessLog": { "description": "AccessLoggingConfig contains various settings for Envoy's access logging service.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto", "items": { "description": "AccessLog represents the top-level access log configuration.", "properties": { "fileSink": { "description": "Output access logs to local file", "properties": { "jsonFormat": { "description": "the format object by which to envoy will emit the logs in a structured way.\nhttps://www.envoyproxy.io/docs/envoy/v1.33.0/configuration/observability/access_log/usage#format-dictionaries", "type": "object", "x-kubernetes-preserve-unknown-fields": true }, "path": { "description": "the file path to which the file access logging service will sink", "type": "string" }, "stringFormat": { "description": "the format string by which envoy will format the log lines\nhttps://www.envoyproxy.io/docs/envoy/v1.33.0/configuration/observability/access_log/usage#format-strings", "type": "string" } }, "required": [ "path" ], "type": "object", "x-kubernetes-validations": [ { "message": "exactly one of the fields in [stringFormat jsonFormat] must be set", "rule": "[has(self.stringFormat),has(self.jsonFormat)].filter(x,x==true).size() == 1" } ], "additionalProperties": false }, "filter": { "allOf": [ { "maxProperties": 1, "minProperties": 1 }, { "maxProperties": 1, "minProperties": 1 } ], "description": "Filter access logs configuration", "properties": { "andFilter": { "description": "Performs a logical \"and\" operation on the result of each individual filter.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-andfilter", "items": { "description": "FilterType represents the type of filter to apply (only one of these should be set).\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#envoy-v3-api-msg-config-accesslog-v3-accesslogfilter", "maxProperties": 1, "minProperties": 1, "properties": { "celFilter": { "description": "CELFilter filters requests based on Common Expression Language (CEL).", "properties": { "match": { "description": "The CEL expressions to evaluate. AccessLogs are only emitted when the CEL expressions evaluates to true.\nsee: https://www.envoyproxy.io/docs/envoy/v1.33.0/xds/type/v3/cel.proto.html#common-expression-language-cel-proto", "type": "string" } }, "required": [ "match" ], "type": "object", "additionalProperties": false }, "durationFilter": { "description": "DurationFilter filters based on request duration.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-durationfilter", "properties": { "op": { "description": "Op represents comparison operators.", "enum": [ "EQ", "GE", "LE" ], "type": "string" }, "value": { "description": "Value to compare against.", "format": "int32", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "op", "value" ], "type": "object", "additionalProperties": false }, "grpcStatusFilter": { "description": "GrpcStatusFilter filters gRPC requests based on their response status.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#enum-config-accesslog-v3-grpcstatusfilter-status", "properties": { "exclude": { "type": "boolean" }, "statuses": { "items": { "description": "GrpcStatus represents possible gRPC statuses.", "enum": [ "OK", "CANCELED", "UNKNOWN", "INVALID_ARGUMENT", "DEADLINE_EXCEEDED", "NOT_FOUND", "ALREADY_EXISTS", "PERMISSION_DENIED", "RESOURCE_EXHAUSTED", "FAILED_PRECONDITION", "ABORTED", "OUT_OF_RANGE", "UNIMPLEMENTED", "INTERNAL", "UNAVAILABLE", "DATA_LOSS", "UNAUTHENTICATED" ], "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object", "additionalProperties": false }, "headerFilter": { "description": "HeaderFilter filters requests based on headers.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-headerfilter", "properties": { "header": { "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 } }, "required": [ "header" ], "type": "object", "additionalProperties": false }, "notHealthCheckFilter": { "description": "Filters for requests that are not health check requests.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-nothealthcheckfilter", "type": "boolean" }, "responseFlagFilter": { "description": "ResponseFlagFilter filters based on response flags.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-responseflagfilter", "properties": { "flags": { "items": { "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "flags" ], "type": "object", "additionalProperties": false }, "statusCodeFilter": { "description": "StatusCodeFilter filters based on HTTP status code.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#envoy-v3-api-msg-config-accesslog-v3-statuscodefilter", "properties": { "op": { "description": "Op represents comparison operators.", "enum": [ "EQ", "GE", "LE" ], "type": "string" }, "value": { "description": "Value to compare against.", "format": "int32", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "op", "value" ], "type": "object", "additionalProperties": false }, "traceableFilter": { "description": "Filters for requests that are traceable.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-traceablefilter", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "minItems": 2, "type": "array" }, "celFilter": { "description": "CELFilter filters requests based on Common Expression Language (CEL).", "properties": { "match": { "description": "The CEL expressions to evaluate. AccessLogs are only emitted when the CEL expressions evaluates to true.\nsee: https://www.envoyproxy.io/docs/envoy/v1.33.0/xds/type/v3/cel.proto.html#common-expression-language-cel-proto", "type": "string" } }, "required": [ "match" ], "type": "object", "additionalProperties": false }, "durationFilter": { "description": "DurationFilter filters based on request duration.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-durationfilter", "properties": { "op": { "description": "Op represents comparison operators.", "enum": [ "EQ", "GE", "LE" ], "type": "string" }, "value": { "description": "Value to compare against.", "format": "int32", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "op", "value" ], "type": "object", "additionalProperties": false }, "grpcStatusFilter": { "description": "GrpcStatusFilter filters gRPC requests based on their response status.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#enum-config-accesslog-v3-grpcstatusfilter-status", "properties": { "exclude": { "type": "boolean" }, "statuses": { "items": { "description": "GrpcStatus represents possible gRPC statuses.", "enum": [ "OK", "CANCELED", "UNKNOWN", "INVALID_ARGUMENT", "DEADLINE_EXCEEDED", "NOT_FOUND", "ALREADY_EXISTS", "PERMISSION_DENIED", "RESOURCE_EXHAUSTED", "FAILED_PRECONDITION", "ABORTED", "OUT_OF_RANGE", "UNIMPLEMENTED", "INTERNAL", "UNAVAILABLE", "DATA_LOSS", "UNAUTHENTICATED" ], "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object", "additionalProperties": false }, "headerFilter": { "description": "HeaderFilter filters requests based on headers.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-headerfilter", "properties": { "header": { "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 } }, "required": [ "header" ], "type": "object", "additionalProperties": false }, "notHealthCheckFilter": { "description": "Filters for requests that are not health check requests.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-nothealthcheckfilter", "type": "boolean" }, "orFilter": { "description": "Performs a logical \"or\" operation on the result of each individual filter.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-orfilter", "items": { "description": "FilterType represents the type of filter to apply (only one of these should be set).\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#envoy-v3-api-msg-config-accesslog-v3-accesslogfilter", "maxProperties": 1, "minProperties": 1, "properties": { "celFilter": { "description": "CELFilter filters requests based on Common Expression Language (CEL).", "properties": { "match": { "description": "The CEL expressions to evaluate. AccessLogs are only emitted when the CEL expressions evaluates to true.\nsee: https://www.envoyproxy.io/docs/envoy/v1.33.0/xds/type/v3/cel.proto.html#common-expression-language-cel-proto", "type": "string" } }, "required": [ "match" ], "type": "object", "additionalProperties": false }, "durationFilter": { "description": "DurationFilter filters based on request duration.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-durationfilter", "properties": { "op": { "description": "Op represents comparison operators.", "enum": [ "EQ", "GE", "LE" ], "type": "string" }, "value": { "description": "Value to compare against.", "format": "int32", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "op", "value" ], "type": "object", "additionalProperties": false }, "grpcStatusFilter": { "description": "GrpcStatusFilter filters gRPC requests based on their response status.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#enum-config-accesslog-v3-grpcstatusfilter-status", "properties": { "exclude": { "type": "boolean" }, "statuses": { "items": { "description": "GrpcStatus represents possible gRPC statuses.", "enum": [ "OK", "CANCELED", "UNKNOWN", "INVALID_ARGUMENT", "DEADLINE_EXCEEDED", "NOT_FOUND", "ALREADY_EXISTS", "PERMISSION_DENIED", "RESOURCE_EXHAUSTED", "FAILED_PRECONDITION", "ABORTED", "OUT_OF_RANGE", "UNIMPLEMENTED", "INTERNAL", "UNAVAILABLE", "DATA_LOSS", "UNAUTHENTICATED" ], "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object", "additionalProperties": false }, "headerFilter": { "description": "HeaderFilter filters requests based on headers.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-headerfilter", "properties": { "header": { "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 } }, "required": [ "header" ], "type": "object", "additionalProperties": false }, "notHealthCheckFilter": { "description": "Filters for requests that are not health check requests.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-nothealthcheckfilter", "type": "boolean" }, "responseFlagFilter": { "description": "ResponseFlagFilter filters based on response flags.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-responseflagfilter", "properties": { "flags": { "items": { "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "flags" ], "type": "object", "additionalProperties": false }, "statusCodeFilter": { "description": "StatusCodeFilter filters based on HTTP status code.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#envoy-v3-api-msg-config-accesslog-v3-statuscodefilter", "properties": { "op": { "description": "Op represents comparison operators.", "enum": [ "EQ", "GE", "LE" ], "type": "string" }, "value": { "description": "Value to compare against.", "format": "int32", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "op", "value" ], "type": "object", "additionalProperties": false }, "traceableFilter": { "description": "Filters for requests that are traceable.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-traceablefilter", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "minItems": 2, "type": "array" }, "responseFlagFilter": { "description": "ResponseFlagFilter filters based on response flags.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-responseflagfilter", "properties": { "flags": { "items": { "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "flags" ], "type": "object", "additionalProperties": false }, "statusCodeFilter": { "description": "StatusCodeFilter filters based on HTTP status code.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#envoy-v3-api-msg-config-accesslog-v3-statuscodefilter", "properties": { "op": { "description": "Op represents comparison operators.", "enum": [ "EQ", "GE", "LE" ], "type": "string" }, "value": { "description": "Value to compare against.", "format": "int32", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "op", "value" ], "type": "object", "additionalProperties": false }, "traceableFilter": { "description": "Filters for requests that are traceable.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-traceablefilter", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "grpcService": { "description": "Send access logs to gRPC service", "properties": { "additionalRequestHeadersToLog": { "description": "Additional request headers to log in the access log", "items": { "type": "string" }, "type": "array" }, "additionalResponseHeadersToLog": { "description": "Additional response headers to log in the access log", "items": { "type": "string" }, "type": "array" }, "additionalResponseTrailersToLog": { "description": "Additional response trailers to log in the access log", "items": { "type": "string" }, "type": "array" }, "authority": { "description": "The :authority header in the grpc request. If this field is not set, the authority header value will be cluster_name.\nNote that this authority does not override the SNI. The SNI is provided by the transport socket of the cluster.", "type": "string" }, "backendRef": { "description": "The backend gRPC service. Can be any type of supported backend (Kubernetes Service, kgateway Backend, etc..)", "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" }, "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 }, "initialMetadata": { "description": "Additional metadata to include in streams initiated to the GrpcService.\nThis can be used for scenarios in which additional ad hoc authorization headers (e.g. x-foo-bar: baz-key) are to be injected", "items": { "description": "Header name/value pair.\nRef: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/base.proto#envoy-v3-api-msg-config-core-v3-headervalue", "properties": { "key": { "description": "Header name.", "type": "string" }, "value": { "description": "Header value.", "type": "string" } }, "required": [ "key" ], "type": "object", "additionalProperties": false }, "type": "array" }, "logName": { "description": "name of log stream", "type": "string" }, "maxReceiveMessageLength": { "description": "Maximum gRPC message size that is allowed to be received. If a message over this limit is received, the gRPC stream is terminated with the RESOURCE_EXHAUSTED error.\nDefaults to 0, which means unlimited.", "format": "int32", "minimum": 1, "type": "integer" }, "retryPolicy": { "description": "Indicates the retry policy for re-establishing the gRPC stream.\nIf max interval is not provided, it will be set to ten times the provided base interval", "properties": { "numRetries": { "description": "Specifies the allowed number of retries. Defaults to 1.", "format": "int32", "minimum": 1, "type": "integer" }, "retryBackOff": { "description": "Specifies parameters that control retry backoff strategy.\nthe default base interval is 1000 milliseconds and the default maximum interval is 10 times the base interval.", "properties": { "baseInterval": { "description": "The base interval to be used for the next back off computation. It should be greater than zero and less than or equal to max_interval.", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] }, "maxInterval": { "description": "Specifies the maximum interval between retries. This parameter is optional, but must be greater than or equal to the base_interval if set. The default is 10 times the base_interval.", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] } }, "required": [ "baseInterval" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "skipEnvoyHeaders": { "description": "This provides gRPC client level control over envoy generated headers. If false, the header will be sent but it can be overridden by per stream option. If true, the header will be removed and can not be overridden by per stream option. Default to false.", "type": "boolean" }, "timeout": { "description": "The timeout for the gRPC request. This is the timeout for a specific request", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] } }, "required": [ "backendRef", "logName" ], "type": "object", "additionalProperties": false }, "openTelemetry": { "description": "Send access logs to an OTel collector", "properties": { "attributes": { "description": "Additional attributes that describe the specific event occurrence.", "properties": { "values": { "description": "A collection of key/value pairs of key-value pairs.", "items": { "description": "KeyValue is a key-value pair that is used to store Span attributes, Link attributes, etc.", "properties": { "key": { "description": "Attribute keys must be unique", "type": "string" }, "value": { "description": "Value may contain a primitive value such as a string or integer or it may contain an arbitrary nested object containing arrays, key-value lists and primitives.", "maxProperties": 1, "minProperties": 1, "properties": { "arrayValue": { "items": { "type": "object", "x-kubernetes-preserve-unknown-fields": true }, "type": "array" }, "kvListValue": { "type": "object", "x-kubernetes-preserve-unknown-fields": true }, "stringValue": { "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "key", "value" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "body": { "description": "OpenTelemetry LogResource fields, following Envoy access logging formatting.", "type": "string" }, "disableBuiltinLabels": { "description": "If specified, Envoy will not generate built-in resource labels like log_name, zone_name, cluster_name, node_name.", "type": "boolean" }, "grpcService": { "description": "Send access logs to gRPC service", "properties": { "authority": { "description": "The :authority header in the grpc request. If this field is not set, the authority header value will be cluster_name.\nNote that this authority does not override the SNI. The SNI is provided by the transport socket of the cluster.", "type": "string" }, "backendRef": { "description": "The backend gRPC service. Can be any type of supported backend (Kubernetes Service, kgateway Backend, etc..)", "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" }, "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 }, "initialMetadata": { "description": "Additional metadata to include in streams initiated to the GrpcService.\nThis can be used for scenarios in which additional ad hoc authorization headers (e.g. x-foo-bar: baz-key) are to be injected", "items": { "description": "Header name/value pair.\nRef: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/base.proto#envoy-v3-api-msg-config-core-v3-headervalue", "properties": { "key": { "description": "Header name.", "type": "string" }, "value": { "description": "Header value.", "type": "string" } }, "required": [ "key" ], "type": "object", "additionalProperties": false }, "type": "array" }, "logName": { "description": "name of log stream", "type": "string" }, "maxReceiveMessageLength": { "description": "Maximum gRPC message size that is allowed to be received. If a message over this limit is received, the gRPC stream is terminated with the RESOURCE_EXHAUSTED error.\nDefaults to 0, which means unlimited.", "format": "int32", "minimum": 1, "type": "integer" }, "retryPolicy": { "description": "Indicates the retry policy for re-establishing the gRPC stream.\nIf max interval is not provided, it will be set to ten times the provided base interval", "properties": { "numRetries": { "description": "Specifies the allowed number of retries. Defaults to 1.", "format": "int32", "minimum": 1, "type": "integer" }, "retryBackOff": { "description": "Specifies parameters that control retry backoff strategy.\nthe default base interval is 1000 milliseconds and the default maximum interval is 10 times the base interval.", "properties": { "baseInterval": { "description": "The base interval to be used for the next back off computation. It should be greater than zero and less than or equal to max_interval.", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] }, "maxInterval": { "description": "Specifies the maximum interval between retries. This parameter is optional, but must be greater than or equal to the base_interval if set. The default is 10 times the base_interval.", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] } }, "required": [ "baseInterval" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "skipEnvoyHeaders": { "description": "This provides gRPC client level control over envoy generated headers. If false, the header will be sent but it can be overridden by per stream option. If true, the header will be removed and can not be overridden by per stream option. Default to false.", "type": "boolean" }, "timeout": { "description": "The timeout for the gRPC request. This is the timeout for a specific request", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] } }, "required": [ "backendRef", "logName" ], "type": "object", "additionalProperties": false }, "resourceAttributes": { "description": "Additional resource attributes that describe the resource.\nIf the `service.name` resource attribute is not specified, it adds it with the default value\nof the envoy cluster name, ie: `.`", "properties": { "values": { "description": "A collection of key/value pairs of key-value pairs.", "items": { "description": "KeyValue is a key-value pair that is used to store Span attributes, Link attributes, etc.", "properties": { "key": { "description": "Attribute keys must be unique", "type": "string" }, "value": { "description": "Value may contain a primitive value such as a string or integer or it may contain an arbitrary nested object containing arrays, key-value lists and primitives.", "maxProperties": 1, "minProperties": 1, "properties": { "arrayValue": { "items": { "type": "object", "x-kubernetes-preserve-unknown-fields": true }, "type": "array" }, "kvListValue": { "type": "object", "x-kubernetes-preserve-unknown-fields": true }, "stringValue": { "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "key", "value" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false } }, "required": [ "grpcService" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "maxItems": 16, "type": "array" }, "defaultHostForHttp10": { "description": "DefaultHostForHttp10 specifies a default host for HTTP/1.0 requests. This is highly suggested if acceptHttp10 is true and a no-op if acceptHttp10 is false.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#config-core-v3-http1protocoloptions", "minLength": 1, "type": "string" }, "earlyRequestHeaderModifier": { "description": "EarlyRequestHeaderModifier defines header modifications to be applied early in the request processing,\nbefore route selection.\nFor example, if you use ExternalAuthz to add a header, you may want to remove it here, to make\nsure it did not come from the client.", "properties": { "add": { "description": "Add adds the given header(s) (name, value) to the request\nbefore the action. It appends to any existing values associated\nwith the header name.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n add:\n - name: \"my-header\"\n value: \"bar,baz\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: foo,bar,baz", "items": { "description": "HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.", "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, the first entry with\nan equivalent name MUST be considered for a match. Subsequent entries\nwith an equivalent header name MUST be ignored. Due to the\ncase-insensitivity of header names, \"foo\" and \"Foo\" are considered\nequivalent.", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%&'*+\\-.^_\\x60|~]+$", "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" }, "remove": { "description": "Remove the given header(s) from the HTTP request before the action. The\nvalue of Remove is a list of HTTP header names. Note that the header\nnames are case-insensitive (see\nhttps://datatracker.ietf.org/doc/html/rfc2616#section-4.2).\n\nInput:\n GET /foo HTTP/1.1\n my-header1: foo\n my-header2: bar\n my-header3: baz\n\nConfig:\n remove: [\"my-header1\", \"my-header3\"]\n\nOutput:\n GET /foo HTTP/1.1\n my-header2: bar", "items": { "type": "string" }, "maxItems": 16, "type": "array", "x-kubernetes-list-type": "set" }, "set": { "description": "Set overwrites the request with the given header (name, value)\nbefore the action.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n set:\n - name: \"my-header\"\n value: \"bar\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: bar", "items": { "description": "HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.", "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, the first entry with\nan equivalent name MUST be considered for a match. Subsequent entries\nwith an equivalent header name MUST be ignored. Due to the\ncase-insensitivity of header names, \"foo\" and \"Foo\" are considered\nequivalent.", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%&'*+\\-.^_\\x60|~]+$", "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" } }, "type": "object", "additionalProperties": false }, "generateRequestId": { "description": "GenerateRequestId: Whether the connection manager will generate the x-request-id header if it does not exist.\nThis defaults to true. Generating a random UUID4 is expensive so in high throughput scenarios where this feature is not desired it can be disabled.\nSee here for more information https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-generate-request-id", "type": "boolean" }, "healthCheck": { "description": "HealthCheck configures [Envoy health checks](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/http/health_check/v3/health_check.proto)", "properties": { "path": { "description": "Path defines the exact path that will be matched for health check requests.", "maxLength": 2048, "pattern": "^/[-a-zA-Z0-9@:%.+~#?&/=_]+$", "type": "string" } }, "required": [ "path" ], "type": "object", "additionalProperties": false }, "idleTimeout": { "description": "IdleTimeout is the idle timeout for connnections.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-msg-config-core-v3-httpprotocoloptions", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] }, "maxRequestHeadersKb": { "description": "MaxRequestHeadersKb sets the maximum size of request headers that Envoy will accept.\nIf unset, the Envoy default is 60 KiB.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-max-request-headers-kb", "format": "int32", "maximum": 8192, "minimum": 1, "type": "integer" }, "preserveExternalRequestId": { "description": "PreserveExternalRequestId determines whether the connection manager will keep the x-request-id header if passed for\na request that is edge (Edge request is the request from external clients to front Envoy) and not reset it, which is the current Envoy behaviour. This defaults to false.\nSee here for more information https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-preserve-external-request-id", "type": "boolean" }, "preserveHttp1HeaderCase": { "description": "PreserveHttp1HeaderCase determines whether to preserve the case of HTTP1 request headers.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_conn_man/header_casing", "type": "boolean" }, "serverHeaderTransformation": { "description": "ServerHeaderTransformation determines how the server header is transformed.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-server-header-transformation", "enum": [ "Overwrite", "AppendIfAbsent", "PassThrough" ], "type": "string" }, "streamIdleTimeout": { "description": "StreamIdleTimeout is the idle timeout for HTTP streams.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-stream-idle-timeout", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] }, "tracing": { "description": "Tracing contains various settings for Envoy's OpenTelemetry tracer.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/trace/v3/opentelemetry.proto.html", "properties": { "attributes": { "description": "A list of attributes with a unique name to create attributes for the active span.", "items": { "description": "Describes attributes for the active span.\nRef: https://www.envoyproxy.io/docs/envoy/latest/api-v3/type/tracing/v3/custom_tag.proto#envoy-v3-api-msg-type-tracing-v3-customtag", "maxProperties": 2, "minProperties": 1, "properties": { "environment": { "description": "An environment attribute value.", "properties": { "defaultValue": { "description": "When the environment variable is not found, the attribute value will be populated with this default value if specified,\notherwise no attribute will be populated.", "type": "string" }, "name": { "description": "Environment variable name to obtain the value to populate the attribute value.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "literal": { "description": "A literal attribute value.", "properties": { "value": { "description": "Static literal value to populate the attribute value.", "type": "string" } }, "required": [ "value" ], "type": "object", "additionalProperties": false }, "metadata": { "description": "An attribute to obtain the value from the metadata.", "properties": { "defaultValue": { "description": "When no valid metadata is found, the attribute value would be populated with this default value if specified, otherwise no attribute would be populated.", "type": "string" }, "kind": { "description": "Specify what kind of metadata to obtain attribute value from", "enum": [ "Request", "Route", "Cluster", "Host" ], "type": "string" }, "metadataKey": { "description": "Metadata key to define the path to retrieve the attribute value.", "properties": { "key": { "description": "The key name of the Metadata from which to retrieve the Struct", "type": "string" }, "path": { "description": "The path used to retrieve a specific Value from the Struct. This can be either a prefix or a full path,\ndepending on the use case", "items": { "description": "Specifies a segment in a path for retrieving values from Metadata.", "properties": { "key": { "description": "The key used to retrieve the value in the struct", "type": "string" } }, "required": [ "key" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "required": [ "key", "path" ], "type": "object", "additionalProperties": false } }, "required": [ "kind", "metadataKey" ], "type": "object", "additionalProperties": false }, "name": { "description": "The name of the attribute", "type": "string" }, "requestHeader": { "description": "A request header attribute value.", "properties": { "defaultValue": { "description": "When the header does not exist, the attribute value will be populated with this default value if specified,\notherwise no attribute will be populated.", "type": "string" }, "name": { "description": "Header name to obtain the value to populate the attribute value.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "type": "array" }, "clientSampling": { "description": "Target percentage of requests managed by this HTTP connection manager that will be force traced if the x-client-trace-id header is set. Defaults to 100%", "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "maxPathTagLength": { "description": "Maximum length of the request path to extract and include in the HttpUrl tag. Used to truncate lengthy request paths to meet the needs of a tracing backend. Default: 256", "format": "int32", "minimum": 1, "type": "integer" }, "overallSampling": { "description": "Target percentage of requests managed by this HTTP connection manager that will be traced after all other sampling checks have been applied (client-directed, force tracing, random sampling). Defaults to 100%", "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "provider": { "description": "Provider defines the upstream to which envoy sends traces", "maxProperties": 1, "minProperties": 1, "properties": { "openTelemetry": { "description": "Tracing contains various settings for Envoy's OTel tracer.", "properties": { "grpcService": { "description": "Send traces to the gRPC service", "properties": { "authority": { "description": "The :authority header in the grpc request. If this field is not set, the authority header value will be cluster_name.\nNote that this authority does not override the SNI. The SNI is provided by the transport socket of the cluster.", "type": "string" }, "backendRef": { "description": "The backend gRPC service. Can be any type of supported backend (Kubernetes Service, kgateway Backend, etc..)", "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" }, "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 }, "initialMetadata": { "description": "Additional metadata to include in streams initiated to the GrpcService.\nThis can be used for scenarios in which additional ad hoc authorization headers (e.g. x-foo-bar: baz-key) are to be injected", "items": { "description": "Header name/value pair.\nRef: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/base.proto#envoy-v3-api-msg-config-core-v3-headervalue", "properties": { "key": { "description": "Header name.", "type": "string" }, "value": { "description": "Header value.", "type": "string" } }, "required": [ "key" ], "type": "object", "additionalProperties": false }, "type": "array" }, "maxReceiveMessageLength": { "description": "Maximum gRPC message size that is allowed to be received. If a message over this limit is received, the gRPC stream is terminated with the RESOURCE_EXHAUSTED error.\nDefaults to 0, which means unlimited.", "format": "int32", "minimum": 1, "type": "integer" }, "retryPolicy": { "description": "Indicates the retry policy for re-establishing the gRPC stream.\nIf max interval is not provided, it will be set to ten times the provided base interval", "properties": { "numRetries": { "description": "Specifies the allowed number of retries. Defaults to 1.", "format": "int32", "minimum": 1, "type": "integer" }, "retryBackOff": { "description": "Specifies parameters that control retry backoff strategy.\nthe default base interval is 1000 milliseconds and the default maximum interval is 10 times the base interval.", "properties": { "baseInterval": { "description": "The base interval to be used for the next back off computation. It should be greater than zero and less than or equal to max_interval.", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] }, "maxInterval": { "description": "Specifies the maximum interval between retries. This parameter is optional, but must be greater than or equal to the base_interval if set. The default is 10 times the base_interval.", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] } }, "required": [ "baseInterval" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "skipEnvoyHeaders": { "description": "This provides gRPC client level control over envoy generated headers. If false, the header will be sent but it can be overridden by per stream option. If true, the header will be removed and can not be overridden by per stream option. Default to false.", "type": "boolean" }, "timeout": { "description": "The timeout for the gRPC request. This is the timeout for a specific request", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] } }, "required": [ "backendRef" ], "type": "object", "additionalProperties": false }, "resourceDetectors": { "description": "An ordered list of resource detectors. Currently supported values are `EnvironmentResourceDetector`", "items": { "description": "ResourceDetector defines the list of supported ResourceDetectors", "maxProperties": 1, "minProperties": 1, "properties": { "environmentResourceDetector": { "description": "EnvironmentResourceDetectorConfig specified the EnvironmentResourceDetector", "type": "object" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "sampler": { "description": "Specifies the sampler to be used by the OpenTelemetry tracer. This field can be left empty. In this case, the default Envoy sampling decision is used.\nCurrently supported values are `AlwaysOn`", "maxProperties": 1, "minProperties": 1, "properties": { "alwaysOnConfig": { "description": "AlwaysOnConfig specified the AlwaysOn samplerc", "type": "object" } }, "type": "object", "additionalProperties": false }, "serviceName": { "description": "The name for the service. This will be populated in the ResourceSpan Resource attributes\nDefaults to the envoy cluster name. Ie: `.`", "type": "string" } }, "required": [ "grpcService" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "randomSampling": { "description": "Target percentage of requests managed by this HTTP connection manager that will be randomly selected for trace generation, if not requested by the client or not forced. Defaults to 100%", "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "spawnUpstreamSpan": { "description": "Create separate tracing span for each upstream request if true. Defaults to false\nLink to envoy docs for more info", "type": "boolean" }, "verbose": { "description": "Whether to annotate spans with additional data. If true, spans will include logs for stream events. Defaults to false", "type": "boolean" } }, "required": [ "provider" ], "type": "object", "additionalProperties": false }, "upgradeConfig": { "description": "UpgradeConfig contains configuration for HTTP upgrades like WebSocket.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/v1.34.1/intro/arch_overview/http/upgrades.html", "properties": { "enabledUpgrades": { "description": "List of upgrade types to enable (e.g. \"websocket\", \"CONNECT\", etc.)", "items": { "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object", "additionalProperties": false }, "useRemoteAddress": { "description": "UseRemoteAddress determines whether to use the remote address for the original client.\nNote: If this field is omitted, it will fallback to the default value of 'true', which we set for all Envoy HCMs.\nThus, setting this explicitly to true is unnecessary (but will not cause any harm).\nWhen true, Envoy will use the remote address of the connection as the client address.\nWhen false, Envoy will use the X-Forwarded-For header to determine the client address.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-use-remote-address", "type": "boolean" }, "xffNumTrustedHops": { "description": "XffNumTrustedHops is the number of additional ingress proxy hops from the right side of the X-Forwarded-For HTTP header to trust when determining the origin client's IP address.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-xff-num-trusted-hops", "format": "int32", "minimum": 0, "type": "integer" } }, "type": "object", "additionalProperties": false }, "perConnectionBufferLimitBytes": { "description": "PerConnectionBufferLimitBytes sets the per-connection buffer limit for all listeners on the gateway.\nThis controls the maximum size of read and write buffers for new connections.\nWhen using Envoy as an edge proxy, configuring the listener buffer limit is important to guard against\npotential attacks or misconfigured downstreams that could hog the proxy's resources.\nIf unspecified, an implementation-defined default is applied (1MiB).\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/listener/v3/listener.proto#envoy-v3-api-field-config-listener-v3-listener-per-connection-buffer-limit-bytes", "format": "int32", "minimum": 0, "type": "integer" }, "proxyProtocol": { "description": "ProxyProtocol configures the PROXY protocol listener filter.\nWhen set, Envoy will expect connections to include the PROXY protocol header.\nThis is commonly used when kgateway is behind a load balancer that preserves client IP information.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/listener/proxy_protocol/v3/proxy_protocol.proto", "type": "object" } }, "type": "object", "additionalProperties": false }, "perPort": { "description": "Per port configuration allows overriding the listener config per port. Once set, this\nconfiguration completely replaces the default configuration for all listeners handling traffic\nthat match this port. Unspecified fields in per-port configuration will not inherit values from default.", "items": { "properties": { "listener": { "description": "Listener stores the configuration that will be applied to all Listeners handling\nmatching the given port.", "properties": { "httpSettings": { "description": "HTTPListenerPolicy is intended to be used for configuring the Envoy `HttpConnectionManager` and any other config or policy\nthat should map 1-to-1 with a given HTTP listener, such as the Envoy health check HTTP filter.", "properties": { "acceptHttp10": { "description": "AcceptHTTP10 determines whether to accept incoming HTTP/1.0 and HTTP 0.9 requests.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#config-core-v3-http1protocoloptions", "type": "boolean" }, "accessLog": { "description": "AccessLoggingConfig contains various settings for Envoy's access logging service.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto", "items": { "description": "AccessLog represents the top-level access log configuration.", "properties": { "fileSink": { "description": "Output access logs to local file", "properties": { "jsonFormat": { "description": "the format object by which to envoy will emit the logs in a structured way.\nhttps://www.envoyproxy.io/docs/envoy/v1.33.0/configuration/observability/access_log/usage#format-dictionaries", "type": "object", "x-kubernetes-preserve-unknown-fields": true }, "path": { "description": "the file path to which the file access logging service will sink", "type": "string" }, "stringFormat": { "description": "the format string by which envoy will format the log lines\nhttps://www.envoyproxy.io/docs/envoy/v1.33.0/configuration/observability/access_log/usage#format-strings", "type": "string" } }, "required": [ "path" ], "type": "object", "x-kubernetes-validations": [ { "message": "exactly one of the fields in [stringFormat jsonFormat] must be set", "rule": "[has(self.stringFormat),has(self.jsonFormat)].filter(x,x==true).size() == 1" } ], "additionalProperties": false }, "filter": { "allOf": [ { "maxProperties": 1, "minProperties": 1 }, { "maxProperties": 1, "minProperties": 1 } ], "description": "Filter access logs configuration", "properties": { "andFilter": { "description": "Performs a logical \"and\" operation on the result of each individual filter.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-andfilter", "items": { "description": "FilterType represents the type of filter to apply (only one of these should be set).\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#envoy-v3-api-msg-config-accesslog-v3-accesslogfilter", "maxProperties": 1, "minProperties": 1, "properties": { "celFilter": { "description": "CELFilter filters requests based on Common Expression Language (CEL).", "properties": { "match": { "description": "The CEL expressions to evaluate. AccessLogs are only emitted when the CEL expressions evaluates to true.\nsee: https://www.envoyproxy.io/docs/envoy/v1.33.0/xds/type/v3/cel.proto.html#common-expression-language-cel-proto", "type": "string" } }, "required": [ "match" ], "type": "object", "additionalProperties": false }, "durationFilter": { "description": "DurationFilter filters based on request duration.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-durationfilter", "properties": { "op": { "description": "Op represents comparison operators.", "enum": [ "EQ", "GE", "LE" ], "type": "string" }, "value": { "description": "Value to compare against.", "format": "int32", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "op", "value" ], "type": "object", "additionalProperties": false }, "grpcStatusFilter": { "description": "GrpcStatusFilter filters gRPC requests based on their response status.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#enum-config-accesslog-v3-grpcstatusfilter-status", "properties": { "exclude": { "type": "boolean" }, "statuses": { "items": { "description": "GrpcStatus represents possible gRPC statuses.", "enum": [ "OK", "CANCELED", "UNKNOWN", "INVALID_ARGUMENT", "DEADLINE_EXCEEDED", "NOT_FOUND", "ALREADY_EXISTS", "PERMISSION_DENIED", "RESOURCE_EXHAUSTED", "FAILED_PRECONDITION", "ABORTED", "OUT_OF_RANGE", "UNIMPLEMENTED", "INTERNAL", "UNAVAILABLE", "DATA_LOSS", "UNAUTHENTICATED" ], "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object", "additionalProperties": false }, "headerFilter": { "description": "HeaderFilter filters requests based on headers.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-headerfilter", "properties": { "header": { "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 } }, "required": [ "header" ], "type": "object", "additionalProperties": false }, "notHealthCheckFilter": { "description": "Filters for requests that are not health check requests.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-nothealthcheckfilter", "type": "boolean" }, "responseFlagFilter": { "description": "ResponseFlagFilter filters based on response flags.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-responseflagfilter", "properties": { "flags": { "items": { "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "flags" ], "type": "object", "additionalProperties": false }, "statusCodeFilter": { "description": "StatusCodeFilter filters based on HTTP status code.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#envoy-v3-api-msg-config-accesslog-v3-statuscodefilter", "properties": { "op": { "description": "Op represents comparison operators.", "enum": [ "EQ", "GE", "LE" ], "type": "string" }, "value": { "description": "Value to compare against.", "format": "int32", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "op", "value" ], "type": "object", "additionalProperties": false }, "traceableFilter": { "description": "Filters for requests that are traceable.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-traceablefilter", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "minItems": 2, "type": "array" }, "celFilter": { "description": "CELFilter filters requests based on Common Expression Language (CEL).", "properties": { "match": { "description": "The CEL expressions to evaluate. AccessLogs are only emitted when the CEL expressions evaluates to true.\nsee: https://www.envoyproxy.io/docs/envoy/v1.33.0/xds/type/v3/cel.proto.html#common-expression-language-cel-proto", "type": "string" } }, "required": [ "match" ], "type": "object", "additionalProperties": false }, "durationFilter": { "description": "DurationFilter filters based on request duration.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-durationfilter", "properties": { "op": { "description": "Op represents comparison operators.", "enum": [ "EQ", "GE", "LE" ], "type": "string" }, "value": { "description": "Value to compare against.", "format": "int32", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "op", "value" ], "type": "object", "additionalProperties": false }, "grpcStatusFilter": { "description": "GrpcStatusFilter filters gRPC requests based on their response status.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#enum-config-accesslog-v3-grpcstatusfilter-status", "properties": { "exclude": { "type": "boolean" }, "statuses": { "items": { "description": "GrpcStatus represents possible gRPC statuses.", "enum": [ "OK", "CANCELED", "UNKNOWN", "INVALID_ARGUMENT", "DEADLINE_EXCEEDED", "NOT_FOUND", "ALREADY_EXISTS", "PERMISSION_DENIED", "RESOURCE_EXHAUSTED", "FAILED_PRECONDITION", "ABORTED", "OUT_OF_RANGE", "UNIMPLEMENTED", "INTERNAL", "UNAVAILABLE", "DATA_LOSS", "UNAUTHENTICATED" ], "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object", "additionalProperties": false }, "headerFilter": { "description": "HeaderFilter filters requests based on headers.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-headerfilter", "properties": { "header": { "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 } }, "required": [ "header" ], "type": "object", "additionalProperties": false }, "notHealthCheckFilter": { "description": "Filters for requests that are not health check requests.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-nothealthcheckfilter", "type": "boolean" }, "orFilter": { "description": "Performs a logical \"or\" operation on the result of each individual filter.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-orfilter", "items": { "description": "FilterType represents the type of filter to apply (only one of these should be set).\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#envoy-v3-api-msg-config-accesslog-v3-accesslogfilter", "maxProperties": 1, "minProperties": 1, "properties": { "celFilter": { "description": "CELFilter filters requests based on Common Expression Language (CEL).", "properties": { "match": { "description": "The CEL expressions to evaluate. AccessLogs are only emitted when the CEL expressions evaluates to true.\nsee: https://www.envoyproxy.io/docs/envoy/v1.33.0/xds/type/v3/cel.proto.html#common-expression-language-cel-proto", "type": "string" } }, "required": [ "match" ], "type": "object", "additionalProperties": false }, "durationFilter": { "description": "DurationFilter filters based on request duration.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-durationfilter", "properties": { "op": { "description": "Op represents comparison operators.", "enum": [ "EQ", "GE", "LE" ], "type": "string" }, "value": { "description": "Value to compare against.", "format": "int32", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "op", "value" ], "type": "object", "additionalProperties": false }, "grpcStatusFilter": { "description": "GrpcStatusFilter filters gRPC requests based on their response status.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#enum-config-accesslog-v3-grpcstatusfilter-status", "properties": { "exclude": { "type": "boolean" }, "statuses": { "items": { "description": "GrpcStatus represents possible gRPC statuses.", "enum": [ "OK", "CANCELED", "UNKNOWN", "INVALID_ARGUMENT", "DEADLINE_EXCEEDED", "NOT_FOUND", "ALREADY_EXISTS", "PERMISSION_DENIED", "RESOURCE_EXHAUSTED", "FAILED_PRECONDITION", "ABORTED", "OUT_OF_RANGE", "UNIMPLEMENTED", "INTERNAL", "UNAVAILABLE", "DATA_LOSS", "UNAUTHENTICATED" ], "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object", "additionalProperties": false }, "headerFilter": { "description": "HeaderFilter filters requests based on headers.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-headerfilter", "properties": { "header": { "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 } }, "required": [ "header" ], "type": "object", "additionalProperties": false }, "notHealthCheckFilter": { "description": "Filters for requests that are not health check requests.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-nothealthcheckfilter", "type": "boolean" }, "responseFlagFilter": { "description": "ResponseFlagFilter filters based on response flags.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-responseflagfilter", "properties": { "flags": { "items": { "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "flags" ], "type": "object", "additionalProperties": false }, "statusCodeFilter": { "description": "StatusCodeFilter filters based on HTTP status code.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#envoy-v3-api-msg-config-accesslog-v3-statuscodefilter", "properties": { "op": { "description": "Op represents comparison operators.", "enum": [ "EQ", "GE", "LE" ], "type": "string" }, "value": { "description": "Value to compare against.", "format": "int32", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "op", "value" ], "type": "object", "additionalProperties": false }, "traceableFilter": { "description": "Filters for requests that are traceable.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-traceablefilter", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "minItems": 2, "type": "array" }, "responseFlagFilter": { "description": "ResponseFlagFilter filters based on response flags.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-responseflagfilter", "properties": { "flags": { "items": { "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "flags" ], "type": "object", "additionalProperties": false }, "statusCodeFilter": { "description": "StatusCodeFilter filters based on HTTP status code.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#envoy-v3-api-msg-config-accesslog-v3-statuscodefilter", "properties": { "op": { "description": "Op represents comparison operators.", "enum": [ "EQ", "GE", "LE" ], "type": "string" }, "value": { "description": "Value to compare against.", "format": "int32", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "op", "value" ], "type": "object", "additionalProperties": false }, "traceableFilter": { "description": "Filters for requests that are traceable.\nBased on: https://www.envoyproxy.io/docs/envoy/v1.33.0/api-v3/config/accesslog/v3/accesslog.proto#config-accesslog-v3-traceablefilter", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "grpcService": { "description": "Send access logs to gRPC service", "properties": { "additionalRequestHeadersToLog": { "description": "Additional request headers to log in the access log", "items": { "type": "string" }, "type": "array" }, "additionalResponseHeadersToLog": { "description": "Additional response headers to log in the access log", "items": { "type": "string" }, "type": "array" }, "additionalResponseTrailersToLog": { "description": "Additional response trailers to log in the access log", "items": { "type": "string" }, "type": "array" }, "authority": { "description": "The :authority header in the grpc request. If this field is not set, the authority header value will be cluster_name.\nNote that this authority does not override the SNI. The SNI is provided by the transport socket of the cluster.", "type": "string" }, "backendRef": { "description": "The backend gRPC service. Can be any type of supported backend (Kubernetes Service, kgateway Backend, etc..)", "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" }, "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 }, "initialMetadata": { "description": "Additional metadata to include in streams initiated to the GrpcService.\nThis can be used for scenarios in which additional ad hoc authorization headers (e.g. x-foo-bar: baz-key) are to be injected", "items": { "description": "Header name/value pair.\nRef: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/base.proto#envoy-v3-api-msg-config-core-v3-headervalue", "properties": { "key": { "description": "Header name.", "type": "string" }, "value": { "description": "Header value.", "type": "string" } }, "required": [ "key" ], "type": "object", "additionalProperties": false }, "type": "array" }, "logName": { "description": "name of log stream", "type": "string" }, "maxReceiveMessageLength": { "description": "Maximum gRPC message size that is allowed to be received. If a message over this limit is received, the gRPC stream is terminated with the RESOURCE_EXHAUSTED error.\nDefaults to 0, which means unlimited.", "format": "int32", "minimum": 1, "type": "integer" }, "retryPolicy": { "description": "Indicates the retry policy for re-establishing the gRPC stream.\nIf max interval is not provided, it will be set to ten times the provided base interval", "properties": { "numRetries": { "description": "Specifies the allowed number of retries. Defaults to 1.", "format": "int32", "minimum": 1, "type": "integer" }, "retryBackOff": { "description": "Specifies parameters that control retry backoff strategy.\nthe default base interval is 1000 milliseconds and the default maximum interval is 10 times the base interval.", "properties": { "baseInterval": { "description": "The base interval to be used for the next back off computation. It should be greater than zero and less than or equal to max_interval.", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] }, "maxInterval": { "description": "Specifies the maximum interval between retries. This parameter is optional, but must be greater than or equal to the base_interval if set. The default is 10 times the base_interval.", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] } }, "required": [ "baseInterval" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "skipEnvoyHeaders": { "description": "This provides gRPC client level control over envoy generated headers. If false, the header will be sent but it can be overridden by per stream option. If true, the header will be removed and can not be overridden by per stream option. Default to false.", "type": "boolean" }, "timeout": { "description": "The timeout for the gRPC request. This is the timeout for a specific request", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] } }, "required": [ "backendRef", "logName" ], "type": "object", "additionalProperties": false }, "openTelemetry": { "description": "Send access logs to an OTel collector", "properties": { "attributes": { "description": "Additional attributes that describe the specific event occurrence.", "properties": { "values": { "description": "A collection of key/value pairs of key-value pairs.", "items": { "description": "KeyValue is a key-value pair that is used to store Span attributes, Link attributes, etc.", "properties": { "key": { "description": "Attribute keys must be unique", "type": "string" }, "value": { "description": "Value may contain a primitive value such as a string or integer or it may contain an arbitrary nested object containing arrays, key-value lists and primitives.", "maxProperties": 1, "minProperties": 1, "properties": { "arrayValue": { "items": { "type": "object", "x-kubernetes-preserve-unknown-fields": true }, "type": "array" }, "kvListValue": { "type": "object", "x-kubernetes-preserve-unknown-fields": true }, "stringValue": { "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "key", "value" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "body": { "description": "OpenTelemetry LogResource fields, following Envoy access logging formatting.", "type": "string" }, "disableBuiltinLabels": { "description": "If specified, Envoy will not generate built-in resource labels like log_name, zone_name, cluster_name, node_name.", "type": "boolean" }, "grpcService": { "description": "Send access logs to gRPC service", "properties": { "authority": { "description": "The :authority header in the grpc request. If this field is not set, the authority header value will be cluster_name.\nNote that this authority does not override the SNI. The SNI is provided by the transport socket of the cluster.", "type": "string" }, "backendRef": { "description": "The backend gRPC service. Can be any type of supported backend (Kubernetes Service, kgateway Backend, etc..)", "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" }, "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 }, "initialMetadata": { "description": "Additional metadata to include in streams initiated to the GrpcService.\nThis can be used for scenarios in which additional ad hoc authorization headers (e.g. x-foo-bar: baz-key) are to be injected", "items": { "description": "Header name/value pair.\nRef: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/base.proto#envoy-v3-api-msg-config-core-v3-headervalue", "properties": { "key": { "description": "Header name.", "type": "string" }, "value": { "description": "Header value.", "type": "string" } }, "required": [ "key" ], "type": "object", "additionalProperties": false }, "type": "array" }, "logName": { "description": "name of log stream", "type": "string" }, "maxReceiveMessageLength": { "description": "Maximum gRPC message size that is allowed to be received. If a message over this limit is received, the gRPC stream is terminated with the RESOURCE_EXHAUSTED error.\nDefaults to 0, which means unlimited.", "format": "int32", "minimum": 1, "type": "integer" }, "retryPolicy": { "description": "Indicates the retry policy for re-establishing the gRPC stream.\nIf max interval is not provided, it will be set to ten times the provided base interval", "properties": { "numRetries": { "description": "Specifies the allowed number of retries. Defaults to 1.", "format": "int32", "minimum": 1, "type": "integer" }, "retryBackOff": { "description": "Specifies parameters that control retry backoff strategy.\nthe default base interval is 1000 milliseconds and the default maximum interval is 10 times the base interval.", "properties": { "baseInterval": { "description": "The base interval to be used for the next back off computation. It should be greater than zero and less than or equal to max_interval.", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] }, "maxInterval": { "description": "Specifies the maximum interval between retries. This parameter is optional, but must be greater than or equal to the base_interval if set. The default is 10 times the base_interval.", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] } }, "required": [ "baseInterval" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "skipEnvoyHeaders": { "description": "This provides gRPC client level control over envoy generated headers. If false, the header will be sent but it can be overridden by per stream option. If true, the header will be removed and can not be overridden by per stream option. Default to false.", "type": "boolean" }, "timeout": { "description": "The timeout for the gRPC request. This is the timeout for a specific request", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] } }, "required": [ "backendRef", "logName" ], "type": "object", "additionalProperties": false }, "resourceAttributes": { "description": "Additional resource attributes that describe the resource.\nIf the `service.name` resource attribute is not specified, it adds it with the default value\nof the envoy cluster name, ie: `.`", "properties": { "values": { "description": "A collection of key/value pairs of key-value pairs.", "items": { "description": "KeyValue is a key-value pair that is used to store Span attributes, Link attributes, etc.", "properties": { "key": { "description": "Attribute keys must be unique", "type": "string" }, "value": { "description": "Value may contain a primitive value such as a string or integer or it may contain an arbitrary nested object containing arrays, key-value lists and primitives.", "maxProperties": 1, "minProperties": 1, "properties": { "arrayValue": { "items": { "type": "object", "x-kubernetes-preserve-unknown-fields": true }, "type": "array" }, "kvListValue": { "type": "object", "x-kubernetes-preserve-unknown-fields": true }, "stringValue": { "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "key", "value" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false } }, "required": [ "grpcService" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "maxItems": 16, "type": "array" }, "defaultHostForHttp10": { "description": "DefaultHostForHttp10 specifies a default host for HTTP/1.0 requests. This is highly suggested if acceptHttp10 is true and a no-op if acceptHttp10 is false.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#config-core-v3-http1protocoloptions", "minLength": 1, "type": "string" }, "earlyRequestHeaderModifier": { "description": "EarlyRequestHeaderModifier defines header modifications to be applied early in the request processing,\nbefore route selection.\nFor example, if you use ExternalAuthz to add a header, you may want to remove it here, to make\nsure it did not come from the client.", "properties": { "add": { "description": "Add adds the given header(s) (name, value) to the request\nbefore the action. It appends to any existing values associated\nwith the header name.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n add:\n - name: \"my-header\"\n value: \"bar,baz\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: foo,bar,baz", "items": { "description": "HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.", "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, the first entry with\nan equivalent name MUST be considered for a match. Subsequent entries\nwith an equivalent header name MUST be ignored. Due to the\ncase-insensitivity of header names, \"foo\" and \"Foo\" are considered\nequivalent.", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%&'*+\\-.^_\\x60|~]+$", "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" }, "remove": { "description": "Remove the given header(s) from the HTTP request before the action. The\nvalue of Remove is a list of HTTP header names. Note that the header\nnames are case-insensitive (see\nhttps://datatracker.ietf.org/doc/html/rfc2616#section-4.2).\n\nInput:\n GET /foo HTTP/1.1\n my-header1: foo\n my-header2: bar\n my-header3: baz\n\nConfig:\n remove: [\"my-header1\", \"my-header3\"]\n\nOutput:\n GET /foo HTTP/1.1\n my-header2: bar", "items": { "type": "string" }, "maxItems": 16, "type": "array", "x-kubernetes-list-type": "set" }, "set": { "description": "Set overwrites the request with the given header (name, value)\nbefore the action.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n set:\n - name: \"my-header\"\n value: \"bar\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: bar", "items": { "description": "HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.", "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, the first entry with\nan equivalent name MUST be considered for a match. Subsequent entries\nwith an equivalent header name MUST be ignored. Due to the\ncase-insensitivity of header names, \"foo\" and \"Foo\" are considered\nequivalent.", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%&'*+\\-.^_\\x60|~]+$", "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" } }, "type": "object", "additionalProperties": false }, "generateRequestId": { "description": "GenerateRequestId: Whether the connection manager will generate the x-request-id header if it does not exist.\nThis defaults to true. Generating a random UUID4 is expensive so in high throughput scenarios where this feature is not desired it can be disabled.\nSee here for more information https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-generate-request-id", "type": "boolean" }, "healthCheck": { "description": "HealthCheck configures [Envoy health checks](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/http/health_check/v3/health_check.proto)", "properties": { "path": { "description": "Path defines the exact path that will be matched for health check requests.", "maxLength": 2048, "pattern": "^/[-a-zA-Z0-9@:%.+~#?&/=_]+$", "type": "string" } }, "required": [ "path" ], "type": "object", "additionalProperties": false }, "idleTimeout": { "description": "IdleTimeout is the idle timeout for connnections.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-msg-config-core-v3-httpprotocoloptions", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] }, "maxRequestHeadersKb": { "description": "MaxRequestHeadersKb sets the maximum size of request headers that Envoy will accept.\nIf unset, the Envoy default is 60 KiB.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-max-request-headers-kb", "format": "int32", "maximum": 8192, "minimum": 1, "type": "integer" }, "preserveExternalRequestId": { "description": "PreserveExternalRequestId determines whether the connection manager will keep the x-request-id header if passed for\na request that is edge (Edge request is the request from external clients to front Envoy) and not reset it, which is the current Envoy behaviour. This defaults to false.\nSee here for more information https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-preserve-external-request-id", "type": "boolean" }, "preserveHttp1HeaderCase": { "description": "PreserveHttp1HeaderCase determines whether to preserve the case of HTTP1 request headers.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_conn_man/header_casing", "type": "boolean" }, "serverHeaderTransformation": { "description": "ServerHeaderTransformation determines how the server header is transformed.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-server-header-transformation", "enum": [ "Overwrite", "AppendIfAbsent", "PassThrough" ], "type": "string" }, "streamIdleTimeout": { "description": "StreamIdleTimeout is the idle timeout for HTTP streams.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-stream-idle-timeout", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] }, "tracing": { "description": "Tracing contains various settings for Envoy's OpenTelemetry tracer.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/trace/v3/opentelemetry.proto.html", "properties": { "attributes": { "description": "A list of attributes with a unique name to create attributes for the active span.", "items": { "description": "Describes attributes for the active span.\nRef: https://www.envoyproxy.io/docs/envoy/latest/api-v3/type/tracing/v3/custom_tag.proto#envoy-v3-api-msg-type-tracing-v3-customtag", "maxProperties": 2, "minProperties": 1, "properties": { "environment": { "description": "An environment attribute value.", "properties": { "defaultValue": { "description": "When the environment variable is not found, the attribute value will be populated with this default value if specified,\notherwise no attribute will be populated.", "type": "string" }, "name": { "description": "Environment variable name to obtain the value to populate the attribute value.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "literal": { "description": "A literal attribute value.", "properties": { "value": { "description": "Static literal value to populate the attribute value.", "type": "string" } }, "required": [ "value" ], "type": "object", "additionalProperties": false }, "metadata": { "description": "An attribute to obtain the value from the metadata.", "properties": { "defaultValue": { "description": "When no valid metadata is found, the attribute value would be populated with this default value if specified, otherwise no attribute would be populated.", "type": "string" }, "kind": { "description": "Specify what kind of metadata to obtain attribute value from", "enum": [ "Request", "Route", "Cluster", "Host" ], "type": "string" }, "metadataKey": { "description": "Metadata key to define the path to retrieve the attribute value.", "properties": { "key": { "description": "The key name of the Metadata from which to retrieve the Struct", "type": "string" }, "path": { "description": "The path used to retrieve a specific Value from the Struct. This can be either a prefix or a full path,\ndepending on the use case", "items": { "description": "Specifies a segment in a path for retrieving values from Metadata.", "properties": { "key": { "description": "The key used to retrieve the value in the struct", "type": "string" } }, "required": [ "key" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "required": [ "key", "path" ], "type": "object", "additionalProperties": false } }, "required": [ "kind", "metadataKey" ], "type": "object", "additionalProperties": false }, "name": { "description": "The name of the attribute", "type": "string" }, "requestHeader": { "description": "A request header attribute value.", "properties": { "defaultValue": { "description": "When the header does not exist, the attribute value will be populated with this default value if specified,\notherwise no attribute will be populated.", "type": "string" }, "name": { "description": "Header name to obtain the value to populate the attribute value.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "type": "array" }, "clientSampling": { "description": "Target percentage of requests managed by this HTTP connection manager that will be force traced if the x-client-trace-id header is set. Defaults to 100%", "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "maxPathTagLength": { "description": "Maximum length of the request path to extract and include in the HttpUrl tag. Used to truncate lengthy request paths to meet the needs of a tracing backend. Default: 256", "format": "int32", "minimum": 1, "type": "integer" }, "overallSampling": { "description": "Target percentage of requests managed by this HTTP connection manager that will be traced after all other sampling checks have been applied (client-directed, force tracing, random sampling). Defaults to 100%", "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "provider": { "description": "Provider defines the upstream to which envoy sends traces", "maxProperties": 1, "minProperties": 1, "properties": { "openTelemetry": { "description": "Tracing contains various settings for Envoy's OTel tracer.", "properties": { "grpcService": { "description": "Send traces to the gRPC service", "properties": { "authority": { "description": "The :authority header in the grpc request. If this field is not set, the authority header value will be cluster_name.\nNote that this authority does not override the SNI. The SNI is provided by the transport socket of the cluster.", "type": "string" }, "backendRef": { "description": "The backend gRPC service. Can be any type of supported backend (Kubernetes Service, kgateway Backend, etc..)", "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" }, "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 }, "initialMetadata": { "description": "Additional metadata to include in streams initiated to the GrpcService.\nThis can be used for scenarios in which additional ad hoc authorization headers (e.g. x-foo-bar: baz-key) are to be injected", "items": { "description": "Header name/value pair.\nRef: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/base.proto#envoy-v3-api-msg-config-core-v3-headervalue", "properties": { "key": { "description": "Header name.", "type": "string" }, "value": { "description": "Header value.", "type": "string" } }, "required": [ "key" ], "type": "object", "additionalProperties": false }, "type": "array" }, "maxReceiveMessageLength": { "description": "Maximum gRPC message size that is allowed to be received. If a message over this limit is received, the gRPC stream is terminated with the RESOURCE_EXHAUSTED error.\nDefaults to 0, which means unlimited.", "format": "int32", "minimum": 1, "type": "integer" }, "retryPolicy": { "description": "Indicates the retry policy for re-establishing the gRPC stream.\nIf max interval is not provided, it will be set to ten times the provided base interval", "properties": { "numRetries": { "description": "Specifies the allowed number of retries. Defaults to 1.", "format": "int32", "minimum": 1, "type": "integer" }, "retryBackOff": { "description": "Specifies parameters that control retry backoff strategy.\nthe default base interval is 1000 milliseconds and the default maximum interval is 10 times the base interval.", "properties": { "baseInterval": { "description": "The base interval to be used for the next back off computation. It should be greater than zero and less than or equal to max_interval.", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] }, "maxInterval": { "description": "Specifies the maximum interval between retries. This parameter is optional, but must be greater than or equal to the base_interval if set. The default is 10 times the base_interval.", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] } }, "required": [ "baseInterval" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "skipEnvoyHeaders": { "description": "This provides gRPC client level control over envoy generated headers. If false, the header will be sent but it can be overridden by per stream option. If true, the header will be removed and can not be overridden by per stream option. Default to false.", "type": "boolean" }, "timeout": { "description": "The timeout for the gRPC request. This is the timeout for a specific request", "type": "string", "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" } ] } }, "required": [ "backendRef" ], "type": "object", "additionalProperties": false }, "resourceDetectors": { "description": "An ordered list of resource detectors. Currently supported values are `EnvironmentResourceDetector`", "items": { "description": "ResourceDetector defines the list of supported ResourceDetectors", "maxProperties": 1, "minProperties": 1, "properties": { "environmentResourceDetector": { "description": "EnvironmentResourceDetectorConfig specified the EnvironmentResourceDetector", "type": "object" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "sampler": { "description": "Specifies the sampler to be used by the OpenTelemetry tracer. This field can be left empty. In this case, the default Envoy sampling decision is used.\nCurrently supported values are `AlwaysOn`", "maxProperties": 1, "minProperties": 1, "properties": { "alwaysOnConfig": { "description": "AlwaysOnConfig specified the AlwaysOn samplerc", "type": "object" } }, "type": "object", "additionalProperties": false }, "serviceName": { "description": "The name for the service. This will be populated in the ResourceSpan Resource attributes\nDefaults to the envoy cluster name. Ie: `.`", "type": "string" } }, "required": [ "grpcService" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "randomSampling": { "description": "Target percentage of requests managed by this HTTP connection manager that will be randomly selected for trace generation, if not requested by the client or not forced. Defaults to 100%", "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "spawnUpstreamSpan": { "description": "Create separate tracing span for each upstream request if true. Defaults to false\nLink to envoy docs for more info", "type": "boolean" }, "verbose": { "description": "Whether to annotate spans with additional data. If true, spans will include logs for stream events. Defaults to false", "type": "boolean" } }, "required": [ "provider" ], "type": "object", "additionalProperties": false }, "upgradeConfig": { "description": "UpgradeConfig contains configuration for HTTP upgrades like WebSocket.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/v1.34.1/intro/arch_overview/http/upgrades.html", "properties": { "enabledUpgrades": { "description": "List of upgrade types to enable (e.g. \"websocket\", \"CONNECT\", etc.)", "items": { "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object", "additionalProperties": false }, "useRemoteAddress": { "description": "UseRemoteAddress determines whether to use the remote address for the original client.\nNote: If this field is omitted, it will fallback to the default value of 'true', which we set for all Envoy HCMs.\nThus, setting this explicitly to true is unnecessary (but will not cause any harm).\nWhen true, Envoy will use the remote address of the connection as the client address.\nWhen false, Envoy will use the X-Forwarded-For header to determine the client address.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-use-remote-address", "type": "boolean" }, "xffNumTrustedHops": { "description": "XffNumTrustedHops is the number of additional ingress proxy hops from the right side of the X-Forwarded-For HTTP header to trust when determining the origin client's IP address.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-xff-num-trusted-hops", "format": "int32", "minimum": 0, "type": "integer" } }, "type": "object", "additionalProperties": false }, "perConnectionBufferLimitBytes": { "description": "PerConnectionBufferLimitBytes sets the per-connection buffer limit for all listeners on the gateway.\nThis controls the maximum size of read and write buffers for new connections.\nWhen using Envoy as an edge proxy, configuring the listener buffer limit is important to guard against\npotential attacks or misconfigured downstreams that could hog the proxy's resources.\nIf unspecified, an implementation-defined default is applied (1MiB).\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/listener/v3/listener.proto#envoy-v3-api-field-config-listener-v3-listener-per-connection-buffer-limit-bytes", "format": "int32", "minimum": 0, "type": "integer" }, "proxyProtocol": { "description": "ProxyProtocol configures the PROXY protocol listener filter.\nWhen set, Envoy will expect connections to include the PROXY protocol header.\nThis is commonly used when kgateway is behind a load balancer that preserves client IP information.\nSee here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/listener/proxy_protocol/v3/proxy_protocol.proto", "type": "object" } }, "type": "object", "additionalProperties": false }, "port": { "description": "The Port indicates the Port Number to which the Listener configuration will be\napplied. This configuration will be applied to all Listeners handling\ntraffic that match this port.", "format": "int32", "maximum": 65535, "minimum": 1, "type": "integer" } }, "required": [ "listener", "port" ], "type": "object", "additionalProperties": false }, "maxItems": 64, "type": "array", "x-kubernetes-list-map-keys": [ "port" ], "x-kubernetes-list-type": "map", "x-kubernetes-validations": [ { "message": "Port for listener configuration must be unique within the Gateway", "rule": "self.all(t1, self.exists_one(t2, t1.port == t2.port))" } ] }, "targetRefs": { "description": "TargetRefs specifies the target resources by reference to attach the policy to.\nOnly supports `Gateway` resources", "items": { "description": "Select the object to attach the policy by Group, Kind, and Name.\nThe object must be in the same namespace as the policy.\nYou can target only one object at a time.", "properties": { "group": { "description": "The API group of the target resource.\nFor Kubernetes Gateway API resources, the group is `gateway.networking.k8s.io`.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "kind": { "description": "The API kind of the target resource,\nsuch as Gateway or HTTPRoute.", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": "string" }, "name": { "description": "The name of the target resource.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "group", "kind", "name" ], "type": "object", "additionalProperties": false }, "maxItems": 16, "minItems": 1, "type": "array", "x-kubernetes-validations": [ { "message": "targetRefs may only reference Gateway resource", "rule": "self.all(r, r.kind == 'Gateway' && (!has(r.group) || r.group == 'gateway.networking.k8s.io'))" } ] }, "targetSelectors": { "description": "TargetSelectors specifies the target selectors to select `Gateway` resources to attach the policy to.", "items": { "description": "LocalPolicyTargetSelector selects the object to attach the policy by Group, Kind, and MatchLabels.\nThe object must be in the same namespace as the policy and match the\nspecified labels.\nDo not use targetSelectors when reconciliation times are critical, especially if you\nhave a large number of policies that target the same resource.\nInstead, use targetRefs to attach the policy.", "properties": { "group": { "description": "The API group of the target resource.\nFor Kubernetes Gateway API resources, the group is `gateway.networking.k8s.io`.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "kind": { "description": "The API kind of the target resource,\nsuch as Gateway or HTTPRoute.", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": "string" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "Label selector to select the target resource.", "type": "object" } }, "required": [ "group", "kind", "matchLabels" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-validations": [ { "message": "targetSelectors may only reference Gateway resource", "rule": "self.all(r, r.kind == 'Gateway' && (!has(r.group) || r.group == 'gateway.networking.k8s.io'))" } ] } }, "type": "object", "additionalProperties": false }, "status": { "description": "PolicyStatus defines the common attributes that all Policies should include within\ntheir status.", "properties": { "ancestors": { "description": "Ancestors is a list of ancestor resources (usually Gateways) that are\nassociated with the policy, and the status of the policy with respect to\neach ancestor. When this policy attaches to a parent, the controller that\nmanages the parent and the ancestors MUST add an entry to this list when\nthe controller first sees the policy and SHOULD update the entry as\nappropriate when the relevant ancestor is modified.\n\nNote that choosing the relevant ancestor is left to the Policy designers;\nan important part of Policy design is designing the right object level at\nwhich to namespace this status.\n\nNote also that implementations MUST ONLY populate ancestor status for\nthe Ancestor resources they are responsible for. Implementations MUST\nuse the ControllerName field to uniquely identify the entries in this list\nthat they are responsible for.\n\nNote that to achieve this, the list of PolicyAncestorStatus structs\nMUST be treated as a map with a composite key, made up of the AncestorRef\nand ControllerName fields combined.\n\nA maximum of 16 ancestors will be represented in this list. An empty list\nmeans the Policy is not relevant for any ancestors.\n\nIf this slice is full, implementations MUST NOT add further entries.\nInstead they MUST consider the policy unimplementable and signal that\non any related resources such as the ancestor that would be referenced\nhere. For example, if this list was full on BackendTLSPolicy, no\nadditional Gateways would be able to reference the Service targeted by\nthe BackendTLSPolicy.", "items": { "description": "PolicyAncestorStatus describes the status of a route with respect to an\nassociated Ancestor.\n\nAncestors refer to objects that are either the Target of a policy or above it\nin terms of object hierarchy. For example, if a policy targets a Service, the\nPolicy's Ancestors are, in order, the Service, the HTTPRoute, the Gateway, and\nthe GatewayClass. Almost always, in this hierarchy, the Gateway will be the most\nuseful object to place Policy status on, so we recommend that implementations\nSHOULD use Gateway as the PolicyAncestorStatus object unless the designers\nhave a _very_ good reason otherwise.\n\nIn the context of policy attachment, the Ancestor is used to distinguish which\nresource results in a distinct application of this policy. For example, if a policy\ntargets a Service, it may have a distinct result per attached Gateway.\n\nPolicies targeting the same resource may have different effects depending on the\nancestors of those resources. For example, different Gateways targeting the same\nService may have different capabilities, especially if they have different underlying\nimplementations.\n\nFor example, in BackendTLSPolicy, the Policy attaches to a Service that is\nused as a backend in a HTTPRoute that is itself attached to a Gateway.\nIn this case, the relevant object for status is the Gateway, and that is the\nancestor object referred to in this status.\n\nNote that a parent is also an ancestor, so for objects where the parent is the\nrelevant object for status, this struct SHOULD still be used.\n\nThis struct is intended to be used in a slice that's effectively a map,\nwith a composite key made up of the AncestorRef and the ControllerName.", "properties": { "ancestorRef": { "description": "AncestorRef corresponds with a ParentRef in the spec that this\nPolicyAncestorStatus struct describes the status of.", "properties": { "group": { "default": "gateway.networking.k8s.io", "description": "Group is the group of the referent.\nWhen unspecified, \"gateway.networking.k8s.io\" is inferred.\nTo set the core API group (such as for a \"Service\" kind referent),\nGroup must be explicitly set to \"\" (empty string).\n\nSupport: Core", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "kind": { "default": "Gateway", "description": "Kind is kind of the referent.\n\nThere are two kinds of parent resources with \"Core\" support:\n\n* Gateway (Gateway conformance profile)\n* Service (Mesh conformance profile, ClusterIP Services only)\n\nSupport for other resources is Implementation-Specific.", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": "string" }, "name": { "description": "Name is the name of the referent.\n\nSupport: Core", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the referent. When unspecified, this refers\nto the local namespace of the Route.\n\nNote that there are specific rules for ParentRefs which cross namespace\nboundaries. Cross-namespace references are only valid if they are explicitly\nallowed by something in the namespace they are referring to. For example:\nGateway has the AllowedRoutes field, and ReferenceGrant provides a\ngeneric way to enable any other kind of cross-namespace reference.\n\n\nParentRefs from a Route to a Service in the same namespace are \"producer\"\nroutes, which apply default routing rules to inbound connections from\nany namespace to the Service.\n\nParentRefs from a Route to a Service in a different namespace are\n\"consumer\" routes, and these routing rules are only applied to outbound\nconnections originating from the same namespace as the Route, for which\nthe intended destination of the connections are a Service targeted as a\nParentRef of the Route.\n\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": "string" }, "port": { "description": "Port is the network port this Route targets. It can be interpreted\ndifferently based on the type of parent resource.\n\nWhen the parent resource is a Gateway, this targets all listeners\nlistening on the specified port that also support this kind of Route(and\nselect this Route). It's not recommended to set `Port` unless the\nnetworking behaviors specified in a Route must apply to a specific port\nas opposed to a listener(s) whose port(s) may be changed. When both Port\nand SectionName are specified, the name and port of the selected listener\nmust match both specified values.\n\n\nWhen the parent resource is a Service, this targets a specific port in the\nService spec. When both Port (experimental) and SectionName are specified,\nthe name and port of the selected port must match both specified values.\n\n\nImplementations MAY choose to support other parent resources.\nImplementations supporting other types of parent resources MUST clearly\ndocument how/if Port is interpreted.\n\nFor the purpose of status, an attachment is considered successful as\nlong as the parent resource accepts it partially. For example, Gateway\nlisteners can restrict which Routes can attach to them by Route kind,\nnamespace, or hostname. If 1 of 2 Gateway listeners accept attachment\nfrom the referencing Route, the Route MUST be considered successfully\nattached. If no Gateway listeners accept attachment from this Route,\nthe Route MUST be considered detached from the Gateway.\n\nSupport: Extended", "format": "int32", "maximum": 65535, "minimum": 1, "type": "integer" }, "sectionName": { "description": "SectionName is the name of a section within the target resource. In the\nfollowing resources, SectionName is interpreted as the following:\n\n* Gateway: Listener name. When both Port (experimental) and SectionName\nare specified, the name and port of the selected listener must match\nboth specified values.\n* Service: Port name. When both Port (experimental) and SectionName\nare specified, the name and port of the selected listener must match\nboth specified values.\n\nImplementations MAY choose to support attaching Routes to other resources.\nIf that is the case, they MUST clearly document how SectionName is\ninterpreted.\n\nWhen unspecified (empty string), this will reference the entire resource.\nFor the purpose of status, an attachment is considered successful if at\nleast one section in the parent resource accepts it. For example, Gateway\nlisteners can restrict which Routes can attach to them by Route kind,\nnamespace, or hostname. If 1 of 2 Gateway listeners accept attachment from\nthe referencing Route, the Route MUST be considered successfully\nattached. If no Gateway listeners accept attachment from this Route, the\nRoute MUST be considered detached from the Gateway.\n\nSupport: Core", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "conditions": { "description": "Conditions describes the status of the Policy with respect to the given Ancestor.\n\n\n\nNotes for implementors:\n\nConditions are a listType `map`, which means that they function like a\nmap with a key of the `type` field _in the k8s apiserver_.\n\nThis means that implementations must obey some rules when updating this\nsection.\n\n* Implementations MUST perform a read-modify-write cycle on this field\n before modifying it. That is, when modifying this field, implementations\n must be confident they have fetched the most recent version of this field,\n and ensure that changes they make are on that recent version.\n* Implementations MUST NOT remove or reorder Conditions that they are not\n directly responsible for. For example, if an implementation sees a Condition\n with type `special.io/SomeField`, it MUST NOT remove, change or update that\n Condition.\n* Implementations MUST always _merge_ changes into Conditions of the same Type,\n rather than creating more than one Condition of the same Type.\n* Implementations MUST always update the `observedGeneration` field of the\n Condition to the `metadata.generation` of the Gateway at the time of update creation.\n* If the `observedGeneration` of a Condition is _greater than_ the value the\n implementation knows about, then it MUST NOT perform the update on that Condition,\n but must wait for a future reconciliation and status update. (The assumption is that\n the implementation's copy of the object is stale and an update will be re-triggered\n if relevant.)\n\n", "items": { "description": "Condition contains details for one aspect of the current state of this API Resource.", "properties": { "lastTransitionTime": { "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "format": "date-time", "type": "string" }, "message": { "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", "maxLength": 32768, "type": "string" }, "observedGeneration": { "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", "format": "int64", "minimum": 0, "type": "integer" }, "reason": { "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", "maxLength": 1024, "minLength": 1, "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "type": "string" }, "status": { "description": "status of the condition, one of True, False, Unknown.", "enum": [ "True", "False", "Unknown" ], "type": "string" }, "type": { "description": "type of condition in CamelCase or in foo.example.com/CamelCase.", "maxLength": 316, "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "type": "string" } }, "required": [ "lastTransitionTime", "message", "reason", "status", "type" ], "type": "object", "additionalProperties": false }, "maxItems": 8, "minItems": 1, "type": "array", "x-kubernetes-list-map-keys": [ "type" ], "x-kubernetes-list-type": "map" }, "controllerName": { "description": "ControllerName is a domain/path string that indicates the name of the\ncontroller that wrote this status. This corresponds with the\ncontrollerName field on GatewayClass.\n\nExample: \"example.net/gateway-controller\".\n\nThe format of this field is DOMAIN \"/\" PATH, where DOMAIN and PATH are\nvalid Kubernetes names\n(https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).\n\nControllers MUST populate this field when writing status. Controllers should ensure that\nentries to status populated with their ControllerName are cleaned up when they are no\nlonger necessary.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\\/[A-Za-z0-9\\/\\-._~%!$&'()*+,;=:]+$", "type": "string" } }, "required": [ "ancestorRef", "conditions", "controllerName" ], "type": "object", "additionalProperties": false }, "maxItems": 16, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "ancestors" ], "type": "object", "additionalProperties": false } }, "required": [ "spec" ], "type": "object" }