gateway.v1alpha1.securityPolicy

"SecurityPolicy allows the user to configure various security settings for a\nGateway."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of SecurityPolicy

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"Spec defines the desired state of SecurityPolicy."

fn spec.withTargetRefs

withTargetRefs(targetRefs)

"TargetRefs are the names of the Gateway resources this policy\nis being attached to."

fn spec.withTargetRefsMixin

withTargetRefsMixin(targetRefs)

"TargetRefs are the names of the Gateway resources this policy\nis being attached to."

Note: This function appends passed data to existing values

fn spec.withTargetSelectors

withTargetSelectors(targetSelectors)

"TargetSelectors allow targeting resources for this policy based on labels"

fn spec.withTargetSelectorsMixin

withTargetSelectorsMixin(targetSelectors)

"TargetSelectors allow targeting resources for this policy based on labels"

Note: This function appends passed data to existing values

obj spec.authorization

"Authorization defines the authorization configuration."

fn spec.authorization.withDefaultAction

withDefaultAction(defaultAction)

"DefaultAction defines the default action to be taken if no rules match.\nIf not specified, the default action is Deny."

fn spec.authorization.withRules

withRules(rules)

"Rules defines a list of authorization rules.\nThese rules are evaluated in order, the first matching rule will be applied,\nand the rest will be skipped.\n\nFor example, if there are two rules: the first rule allows the request\nand the second rule denies it, when a request matches both rules, it will be allowed."

fn spec.authorization.withRulesMixin

withRulesMixin(rules)

"Rules defines a list of authorization rules.\nThese rules are evaluated in order, the first matching rule will be applied,\nand the rest will be skipped.\n\nFor example, if there are two rules: the first rule allows the request\nand the second rule denies it, when a request matches both rules, it will be allowed."

Note: This function appends passed data to existing values

obj spec.authorization.rules

"Rules defines a list of authorization rules.\nThese rules are evaluated in order, the first matching rule will be applied,\nand the rest will be skipped.\n\nFor example, if there are two rules: the first rule allows the request\nand the second rule denies it, when a request matches both rules, it will be allowed."

fn spec.authorization.rules.withAction

withAction(action)

"Action defines the action to be taken if the rule matches."

fn spec.authorization.rules.withName

withName(name)

"Name is a user-friendly name for the rule.\nIf not specified, Envoy Gateway will generate a unique name for the rule."

obj spec.authorization.rules.principal

"Principal specifies the client identity of a request.\nIf there are multiple principal types, all principals must match for the rule to match.\nFor example, if there are two principals: one for client IP and one for JWT claim,\nthe rule will match only if both the client IP and the JWT claim match."

fn spec.authorization.rules.principal.withClientCIDRs

withClientCIDRs(clientCIDRs)

"ClientCIDRs are the IP CIDR ranges of the client.\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\n\nIf multiple CIDR ranges are specified, one of the CIDR ranges must match\nthe client IP for the rule to match.\n\nThe client IP is inferred from the X-Forwarded-For header, a custom header,\nor the proxy protocol.\nYou can use the ClientIPDetection or the EnableProxyProtocol field in\nthe ClientTrafficPolicy to configure how the client IP is detected."

fn spec.authorization.rules.principal.withClientCIDRsMixin

withClientCIDRsMixin(clientCIDRs)

"ClientCIDRs are the IP CIDR ranges of the client.\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\n\nIf multiple CIDR ranges are specified, one of the CIDR ranges must match\nthe client IP for the rule to match.\n\nThe client IP is inferred from the X-Forwarded-For header, a custom header,\nor the proxy protocol.\nYou can use the ClientIPDetection or the EnableProxyProtocol field in\nthe ClientTrafficPolicy to configure how the client IP is detected."

Note: This function appends passed data to existing values

obj spec.authorization.rules.principal.jwt

"JWT authorize the request based on the JWT claims and scopes.\nNote: in order to use JWT claims for authorization, you must configure the\nJWT authentication in the same SecurityPolicy."

fn spec.authorization.rules.principal.jwt.withClaims

withClaims(claims)

"Claims are the claims in a JWT token.\n\nIf multiple claims are specified, all claims must match for the rule to match.\nFor example, if there are two claims: one for the audience and one for the issuer,\nthe rule will match only if both the audience and the issuer match."

fn spec.authorization.rules.principal.jwt.withClaimsMixin

withClaimsMixin(claims)

"Claims are the claims in a JWT token.\n\nIf multiple claims are specified, all claims must match for the rule to match.\nFor example, if there are two claims: one for the audience and one for the issuer,\nthe rule will match only if both the audience and the issuer match."

Note: This function appends passed data to existing values

fn spec.authorization.rules.principal.jwt.withProvider

withProvider(provider)

"Provider is the name of the JWT provider that used to verify the JWT token.\nIn order to use JWT claims for authorization, you must configure the JWT\nauthentication with the same provider in the same SecurityPolicy."

fn spec.authorization.rules.principal.jwt.withScopes

withScopes(scopes)

"Scopes are a special type of claim in a JWT token that represents the permissions of the client.\n\nThe value of the scopes field should be a space delimited string that is expected in the scope parameter,\nas defined in RFC 6749: https://datatracker.ietf.org/doc/html/rfc6749#page-23.\n\nIf multiple scopes are specified, all scopes must match for the rule to match."

fn spec.authorization.rules.principal.jwt.withScopesMixin

withScopesMixin(scopes)

"Scopes are a special type of claim in a JWT token that represents the permissions of the client.\n\nThe value of the scopes field should be a space delimited string that is expected in the scope parameter,\nas defined in RFC 6749: https://datatracker.ietf.org/doc/html/rfc6749#page-23.\n\nIf multiple scopes are specified, all scopes must match for the rule to match."

Note: This function appends passed data to existing values

obj spec.authorization.rules.principal.jwt.claims

"Claims are the claims in a JWT token.\n\nIf multiple claims are specified, all claims must match for the rule to match.\nFor example, if there are two claims: one for the audience and one for the issuer,\nthe rule will match only if both the audience and the issuer match."

fn spec.authorization.rules.principal.jwt.claims.withName

withName(name)

"Name is the name of the claim.\nIf it is a nested claim, use a dot (.) separated string as the name to\nrepresent the full path to the claim.\nFor example, if the claim is in the \"department\" field in the \"organization\" field,\nthe name should be \"organization.department\"."

fn spec.authorization.rules.principal.jwt.claims.withValueType

withValueType(valueType)

"ValueType is the type of the claim value.\nOnly String and StringArray types are supported for now."

fn spec.authorization.rules.principal.jwt.claims.withValues

withValues(values)

"Values are the values that the claim must match.\nIf the claim is a string type, the specified value must match exactly.\nIf the claim is a string array type, the specified value must match one of the values in the array.\nIf multiple values are specified, one of the values must match for the rule to match."

fn spec.authorization.rules.principal.jwt.claims.withValuesMixin

withValuesMixin(values)

"Values are the values that the claim must match.\nIf the claim is a string type, the specified value must match exactly.\nIf the claim is a string array type, the specified value must match one of the values in the array.\nIf multiple values are specified, one of the values must match for the rule to match."

Note: This function appends passed data to existing values

obj spec.basicAuth

"BasicAuth defines the configuration for the HTTP Basic Authentication."

obj spec.basicAuth.users

"The Kubernetes secret which contains the username-password pairs in\nhtpasswd format, used to verify user credentials in the \"Authorization\"\nheader.\n\nThis is an Opaque secret. The username-password pairs should be stored in\nthe key \".htpasswd\". As the key name indicates, the value needs to be the\nhtpasswd format, for example: \"user1:{SHA}hashed_user1_password\".\nRight now, only SHA hash algorithm is supported.\nReference to https://httpd.apache.org/docs/2.4/programs/htpasswd.html\nfor more details.\n\nNote: The secret must be in the same namespace as the SecurityPolicy."

fn spec.basicAuth.users.withGroup

withGroup(group)

"Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred."

fn spec.basicAuth.users.withKind

withKind(kind)

"Kind is kind of the referent. For example \"Secret\"."

fn spec.basicAuth.users.withName

withName(name)

"Name is the name of the referent."

fn spec.basicAuth.users.withNamespace

withNamespace(namespace)

"Namespace is the namespace of the referenced object. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core"

obj spec.cors

"CORS defines the configuration for Cross-Origin Resource Sharing (CORS)."

fn spec.cors.withAllowCredentials

withAllowCredentials(allowCredentials)

"AllowCredentials indicates whether a request can include user credentials\nlike cookies, authentication headers, or TLS client certificates.\nIt specifies the value in the Access-Control-Allow-Credentials CORS response header."

fn spec.cors.withAllowHeaders

withAllowHeaders(allowHeaders)

"AllowHeaders defines the headers that are allowed to be sent with requests.\nIt specifies the allowed headers in the Access-Control-Allow-Headers CORS response header..\nThe value \"*\" allows any header to be sent."

fn spec.cors.withAllowHeadersMixin

withAllowHeadersMixin(allowHeaders)

"AllowHeaders defines the headers that are allowed to be sent with requests.\nIt specifies the allowed headers in the Access-Control-Allow-Headers CORS response header..\nThe value \"*\" allows any header to be sent."

Note: This function appends passed data to existing values

fn spec.cors.withAllowMethods

withAllowMethods(allowMethods)

"AllowMethods defines the methods that are allowed to make requests.\nIt specifies the allowed methods in the Access-Control-Allow-Methods CORS response header..\nThe value \"*\" allows any method to be used."

fn spec.cors.withAllowMethodsMixin

withAllowMethodsMixin(allowMethods)

"AllowMethods defines the methods that are allowed to make requests.\nIt specifies the allowed methods in the Access-Control-Allow-Methods CORS response header..\nThe value \"*\" allows any method to be used."

Note: This function appends passed data to existing values

fn spec.cors.withAllowOrigins

withAllowOrigins(allowOrigins)

"AllowOrigins defines the origins that are allowed to make requests.\nIt specifies the allowed origins in the Access-Control-Allow-Origin CORS response header.\nThe value \"*\" allows any origin to make requests."

fn spec.cors.withAllowOriginsMixin

withAllowOriginsMixin(allowOrigins)

"AllowOrigins defines the origins that are allowed to make requests.\nIt specifies the allowed origins in the Access-Control-Allow-Origin CORS response header.\nThe value \"*\" allows any origin to make requests."

Note: This function appends passed data to existing values

fn spec.cors.withExposeHeaders

withExposeHeaders(exposeHeaders)

"ExposeHeaders defines which response headers should be made accessible to\nscripts running in the browser.\nIt specifies the headers in the Access-Control-Expose-Headers CORS response header..\nThe value \"*\" allows any header to be exposed."

fn spec.cors.withExposeHeadersMixin

withExposeHeadersMixin(exposeHeaders)

"ExposeHeaders defines which response headers should be made accessible to\nscripts running in the browser.\nIt specifies the headers in the Access-Control-Expose-Headers CORS response header..\nThe value \"*\" allows any header to be exposed."

Note: This function appends passed data to existing values

fn spec.cors.withMaxAge

withMaxAge(maxAge)

"MaxAge defines how long the results of a preflight request can be cached.\nIt specifies the value in the Access-Control-Max-Age CORS response header.."

obj spec.extAuth

"ExtAuth defines the configuration for External Authorization."

fn spec.extAuth.withFailOpen

withFailOpen(failOpen)

"FailOpen is a switch used to control the behavior when a response from the External Authorization service cannot be obtained.\nIf FailOpen is set to true, the system allows the traffic to pass through.\nOtherwise, if it is set to false or not set (defaulting to false),\nthe system blocks the traffic and returns a HTTP 5xx error, reflecting a fail-closed approach.\nThis setting determines whether to prioritize accessibility over strict security in case of authorization service failure."

fn spec.extAuth.withHeadersToExtAuth

withHeadersToExtAuth(headersToExtAuth)

"HeadersToExtAuth defines the client request headers that will be included\nin the request to the external authorization service.\nNote: If not specified, the default behavior for gRPC and HTTP external\nauthorization services is different due to backward compatibility reasons.\nAll headers will be included in the check request to a gRPC authorization server.\nOnly the following headers will be included in the check request to an HTTP\nauthorization server: Host, Method, Path, Content-Length, and Authorization.\nAnd these headers will always be included to the check request to an HTTP\nauthorization server by default, no matter whether they are specified\nin HeadersToExtAuth or not."

fn spec.extAuth.withHeadersToExtAuthMixin

withHeadersToExtAuthMixin(headersToExtAuth)

"HeadersToExtAuth defines the client request headers that will be included\nin the request to the external authorization service.\nNote: If not specified, the default behavior for gRPC and HTTP external\nauthorization services is different due to backward compatibility reasons.\nAll headers will be included in the check request to a gRPC authorization server.\nOnly the following headers will be included in the check request to an HTTP\nauthorization server: Host, Method, Path, Content-Length, and Authorization.\nAnd these headers will always be included to the check request to an HTTP\nauthorization server by default, no matter whether they are specified\nin HeadersToExtAuth or not."

Note: This function appends passed data to existing values

fn spec.extAuth.withRecomputeRoute

withRecomputeRoute(recomputeRoute)

"RecomputeRoute clears the route cache and recalculates the routing decision.\nThis field must be enabled if the headers added or modified by the ExtAuth are used for\nroute matching decisions. If the recomputation selects a new route, features targeting\nthe new matched route will be applied."

obj spec.extAuth.grpc

"GRPC defines the gRPC External Authorization service.\nEither GRPCService or HTTPService must be specified,\nand only one of them can be provided."

fn spec.extAuth.grpc.withBackendRefs

withBackendRefs(backendRefs)

"BackendRefs references a Kubernetes object that represents the\nbackend server to which the authorization request will be sent."

fn spec.extAuth.grpc.withBackendRefsMixin

withBackendRefsMixin(backendRefs)

"BackendRefs references a Kubernetes object that represents the\nbackend server to which the authorization request will be sent."

Note: This function appends passed data to existing values

obj spec.extAuth.grpc.backendRef

"BackendRef references a Kubernetes object that represents the\nbackend server to which the authorization request will be sent.\n\nDeprecated: Use BackendRefs instead."

fn spec.extAuth.grpc.backendRef.withGroup

withGroup(group)

"Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred."

fn spec.extAuth.grpc.backendRef.withKind

withKind(kind)

"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)"

fn spec.extAuth.grpc.backendRef.withName

withName(name)

"Name is the name of the referent."

fn spec.extAuth.grpc.backendRef.withNamespace

withNamespace(namespace)

"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"

fn spec.extAuth.grpc.backendRef.withPort

withPort(port)

"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."

obj spec.extAuth.grpc.backendRefs

"BackendRefs references a Kubernetes object that represents the\nbackend server to which the authorization request will be sent."

fn spec.extAuth.grpc.backendRefs.withFallback

withFallback(fallback)

"Fallback indicates whether the backend is designated as a fallback.\nMultiple fallback backends can be configured.\nIt is highly recommended to configure active or passive health checks to ensure that failover can be detected\nwhen the active backends become unhealthy and to automatically readjust once the primary backends are healthy again.\nThe overprovisioning factor is set to 1.4, meaning the fallback backends will only start receiving traffic when\nthe health of the active backends falls below 72%."

fn spec.extAuth.grpc.backendRefs.withGroup

withGroup(group)

"Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred."

fn spec.extAuth.grpc.backendRefs.withKind

withKind(kind)

"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)"

fn spec.extAuth.grpc.backendRefs.withName

withName(name)

"Name is the name of the referent."

fn spec.extAuth.grpc.backendRefs.withNamespace

withNamespace(namespace)

"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"

fn spec.extAuth.grpc.backendRefs.withPort

withPort(port)

"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."

obj spec.extAuth.grpc.backendSettings

"BackendSettings holds configuration for managing the connection\nto the backend."

obj spec.extAuth.grpc.backendSettings.circuitBreaker

"Circuit Breaker settings for the upstream connections and requests.\nIf not set, circuit breakers will be enabled with the default thresholds"

fn spec.extAuth.grpc.backendSettings.circuitBreaker.withMaxConnections

withMaxConnections(maxConnections)

"The maximum number of connections that Envoy will establish to the referenced backend defined within a xRoute rule."

fn spec.extAuth.grpc.backendSettings.circuitBreaker.withMaxParallelRequests

withMaxParallelRequests(maxParallelRequests)

"The maximum number of parallel requests that Envoy will make to the referenced backend defined within a xRoute rule."

fn spec.extAuth.grpc.backendSettings.circuitBreaker.withMaxParallelRetries

withMaxParallelRetries(maxParallelRetries)

"The maximum number of parallel retries that Envoy will make to the referenced backend defined within a xRoute rule."

fn spec.extAuth.grpc.backendSettings.circuitBreaker.withMaxPendingRequests

withMaxPendingRequests(maxPendingRequests)

"The maximum number of pending requests that Envoy will queue to the referenced backend defined within a xRoute rule."

fn spec.extAuth.grpc.backendSettings.circuitBreaker.withMaxRequestsPerConnection

withMaxRequestsPerConnection(maxRequestsPerConnection)

"The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule.\nDefault: unlimited."

obj spec.extAuth.grpc.backendSettings.connection

"Connection includes backend connection settings."

fn spec.extAuth.grpc.backendSettings.connection.withBufferLimit

withBufferLimit(bufferLimit)

"BufferLimit Soft limit on size of the cluster’s connections read and write buffers.\nBufferLimit applies to connection streaming (maybe non-streaming) channel between processes, it's in user space.\nIf unspecified, an implementation defined default is applied (32768 bytes).\nFor example, 20Mi, 1Gi, 256Ki etc.\nNote: that when the suffix is not provided, the value is interpreted as bytes."

fn spec.extAuth.grpc.backendSettings.connection.withSocketBufferLimit

withSocketBufferLimit(socketBufferLimit)

"SocketBufferLimit provides configuration for the maximum buffer size in bytes for each socket\nto backend.\nSocketBufferLimit applies to socket streaming channel between TCP/IP stacks, it's in kernel space.\nFor example, 20Mi, 1Gi, 256Ki etc.\nNote that when the suffix is not provided, the value is interpreted as bytes."

obj spec.extAuth.grpc.backendSettings.dns

"DNS includes dns resolution settings."

fn spec.extAuth.grpc.backendSettings.dns.withDnsRefreshRate

withDnsRefreshRate(dnsRefreshRate)

"DNSRefreshRate specifies the rate at which DNS records should be refreshed.\nDefaults to 30 seconds."

fn spec.extAuth.grpc.backendSettings.dns.withRespectDnsTtl

withRespectDnsTtl(respectDnsTtl)

"RespectDNSTTL indicates whether the DNS Time-To-Live (TTL) should be respected.\nIf the value is set to true, the DNS refresh rate will be set to the resource record’s TTL.\nDefaults to true."

obj spec.extAuth.grpc.backendSettings.healthCheck

"HealthCheck allows gateway to perform active health checking on backends."

obj spec.extAuth.grpc.backendSettings.healthCheck.active

"Active health check configuration"

fn spec.extAuth.grpc.backendSettings.healthCheck.active.withHealthyThreshold

withHealthyThreshold(healthyThreshold)

"HealthyThreshold defines the number of healthy health checks required before a backend host is marked healthy."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.withInterval

withInterval(interval)

"Interval defines the time between active health checks."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.withTimeout

withTimeout(timeout)

"Timeout defines the time to wait for a health check response."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.withType

withType(type)

"Type defines the type of health checker."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.withUnhealthyThreshold

withUnhealthyThreshold(unhealthyThreshold)

"UnhealthyThreshold defines the number of unhealthy health checks required before a backend host is marked unhealthy."

obj spec.extAuth.grpc.backendSettings.healthCheck.active.grpc

"GRPC defines the configuration of the GRPC health checker.\nIt's optional, and can only be used if the specified type is GRPC."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.grpc.withService

withService(service)

"Service to send in the health check request.\nIf this is not specified, then the health check request applies to the entire\nserver and not to a specific service."

obj spec.extAuth.grpc.backendSettings.healthCheck.active.http

"HTTP defines the configuration of http health checker.\nIt's required while the health checker type is HTTP."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.http.withExpectedStatuses

withExpectedStatuses(expectedStatuses)

"ExpectedStatuses defines a list of HTTP response statuses considered healthy.\nDefaults to 200 only"

fn spec.extAuth.grpc.backendSettings.healthCheck.active.http.withExpectedStatusesMixin

withExpectedStatusesMixin(expectedStatuses)

"ExpectedStatuses defines a list of HTTP response statuses considered healthy.\nDefaults to 200 only"

Note: This function appends passed data to existing values

fn spec.extAuth.grpc.backendSettings.healthCheck.active.http.withMethod

withMethod(method)

"Method defines the HTTP method used for health checking.\nDefaults to GET"

fn spec.extAuth.grpc.backendSettings.healthCheck.active.http.withPath

withPath(path)

"Path defines the HTTP path that will be requested during health checking."

obj spec.extAuth.grpc.backendSettings.healthCheck.active.http.expectedResponse

"ExpectedResponse defines a list of HTTP expected responses to match."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.http.expectedResponse.withBinary

withBinary(binary)

"Binary payload base64 encoded."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.http.expectedResponse.withText

withText(text)

"Text payload in plain text."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.http.expectedResponse.withType

withType(type)

"Type defines the type of the payload."

obj spec.extAuth.grpc.backendSettings.healthCheck.active.tcp

"TCP defines the configuration of tcp health checker.\nIt's required while the health checker type is TCP."

obj spec.extAuth.grpc.backendSettings.healthCheck.active.tcp.receive

"Receive defines the expected response payload."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.tcp.receive.withBinary

withBinary(binary)

"Binary payload base64 encoded."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.tcp.receive.withText

withText(text)

"Text payload in plain text."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.tcp.receive.withType

withType(type)

"Type defines the type of the payload."

obj spec.extAuth.grpc.backendSettings.healthCheck.active.tcp.send

"Send defines the request payload."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.tcp.send.withBinary

withBinary(binary)

"Binary payload base64 encoded."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.tcp.send.withText

withText(text)

"Text payload in plain text."

fn spec.extAuth.grpc.backendSettings.healthCheck.active.tcp.send.withType

withType(type)

"Type defines the type of the payload."

obj spec.extAuth.grpc.backendSettings.healthCheck.passive

"Passive passive check configuration"

fn spec.extAuth.grpc.backendSettings.healthCheck.passive.withBaseEjectionTime

withBaseEjectionTime(baseEjectionTime)

"BaseEjectionTime defines the base duration for which a host will be ejected on consecutive failures."

fn spec.extAuth.grpc.backendSettings.healthCheck.passive.withConsecutive5XxErrors

withConsecutive5XxErrors(consecutive5XxErrors)

"Consecutive5xxErrors sets the number of consecutive 5xx errors triggering ejection."

fn spec.extAuth.grpc.backendSettings.healthCheck.passive.withConsecutiveGatewayErrors

withConsecutiveGatewayErrors(consecutiveGatewayErrors)

"ConsecutiveGatewayErrors sets the number of consecutive gateway errors triggering ejection."

fn spec.extAuth.grpc.backendSettings.healthCheck.passive.withConsecutiveLocalOriginFailures

withConsecutiveLocalOriginFailures(consecutiveLocalOriginFailures)

"ConsecutiveLocalOriginFailures sets the number of consecutive local origin failures triggering ejection.\nParameter takes effect only when split_external_local_origin_errors is set to true."

fn spec.extAuth.grpc.backendSettings.healthCheck.passive.withInterval

withInterval(interval)

"Interval defines the time between passive health checks."

fn spec.extAuth.grpc.backendSettings.healthCheck.passive.withMaxEjectionPercent

withMaxEjectionPercent(maxEjectionPercent)

"MaxEjectionPercent sets the maximum percentage of hosts in a cluster that can be ejected."

fn spec.extAuth.grpc.backendSettings.healthCheck.passive.withSplitExternalLocalOriginErrors

withSplitExternalLocalOriginErrors(splitExternalLocalOriginErrors)

"SplitExternalLocalOriginErrors enables splitting of errors between external and local origin."

obj spec.extAuth.grpc.backendSettings.http2

"HTTP2 provides HTTP/2 configuration for backend connections."

fn spec.extAuth.grpc.backendSettings.http2.withInitialConnectionWindowSize

withInitialConnectionWindowSize(initialConnectionWindowSize)

"InitialConnectionWindowSize sets the initial window size for HTTP/2 connections.\nIf not set, the default value is 1 MiB."

fn spec.extAuth.grpc.backendSettings.http2.withInitialStreamWindowSize

withInitialStreamWindowSize(initialStreamWindowSize)

"InitialStreamWindowSize sets the initial window size for HTTP/2 streams.\nIf not set, the default value is 64 KiB(64*1024)."

fn spec.extAuth.grpc.backendSettings.http2.withMaxConcurrentStreams

withMaxConcurrentStreams(maxConcurrentStreams)

"MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection.\nIf not set, the default value is 100."

fn spec.extAuth.grpc.backendSettings.http2.withOnInvalidMessage

withOnInvalidMessage(onInvalidMessage)

"OnInvalidMessage determines if Envoy will terminate the connection or just the offending stream in the event of HTTP messaging error\nIt's recommended for L2 Envoy deployments to set this value to TerminateStream.\nhttps://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/level_two\nDefault: TerminateConnection"

obj spec.extAuth.grpc.backendSettings.loadBalancer

"LoadBalancer policy to apply when routing traffic from the gateway to\nthe backend endpoints. Defaults to LeastRequest."

fn spec.extAuth.grpc.backendSettings.loadBalancer.withType

withType(type)

"Type decides the type of Load Balancer policy.\nValid LoadBalancerType values are\n\"ConsistentHash\",\n\"LeastRequest\",\n\"Random\",\n\"RoundRobin\"."

obj spec.extAuth.grpc.backendSettings.loadBalancer.consistentHash

"ConsistentHash defines the configuration when the load balancer type is\nset to ConsistentHash"

fn spec.extAuth.grpc.backendSettings.loadBalancer.consistentHash.withTableSize

withTableSize(tableSize)

"The table size for consistent hashing, must be prime number limited to 5000011."

fn spec.extAuth.grpc.backendSettings.loadBalancer.consistentHash.withType

withType(type)

"ConsistentHashType defines the type of input to hash on. Valid Type values are\n\"SourceIP\",\n\"Header\",\n\"Cookie\"."

obj spec.extAuth.grpc.backendSettings.loadBalancer.consistentHash.cookie

"Cookie configures the cookie hash policy when the consistent hash type is set to Cookie."

fn spec.extAuth.grpc.backendSettings.loadBalancer.consistentHash.cookie.withAttributes

withAttributes(attributes)

"Additional Attributes to set for the generated cookie."

fn spec.extAuth.grpc.backendSettings.loadBalancer.consistentHash.cookie.withAttributesMixin

withAttributesMixin(attributes)

"Additional Attributes to set for the generated cookie."

Note: This function appends passed data to existing values

fn spec.extAuth.grpc.backendSettings.loadBalancer.consistentHash.cookie.withName

withName(name)

"Name of the cookie to hash.\nIf this cookie does not exist in the request, Envoy will generate a cookie and set\nthe TTL on the response back to the client based on Layer 4\nattributes of the backend endpoint, to ensure that these future requests\ngo to the same backend endpoint. Make sure to set the TTL field for this case."

fn spec.extAuth.grpc.backendSettings.loadBalancer.consistentHash.cookie.withTtl

withTtl(ttl)

"TTL of the generated cookie if the cookie is not present. This value sets the\nMax-Age attribute value."

obj spec.extAuth.grpc.backendSettings.loadBalancer.consistentHash.header

"Header configures the header hash policy when the consistent hash type is set to Header."

fn spec.extAuth.grpc.backendSettings.loadBalancer.consistentHash.header.withName

withName(name)

"Name of the header to hash."

obj spec.extAuth.grpc.backendSettings.loadBalancer.slowStart

"SlowStart defines the configuration related to the slow start load balancer policy.\nIf set, during slow start window, traffic sent to the newly added hosts will gradually increase.\nCurrently this is only supported for RoundRobin and LeastRequest load balancers"

fn spec.extAuth.grpc.backendSettings.loadBalancer.slowStart.withWindow

withWindow(window)

"Window defines the duration of the warm up period for newly added host.\nDuring slow start window, traffic sent to the newly added hosts will gradually increase.\nCurrently only supports linear growth of traffic. For additional details,\nsee https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto#config-cluster-v3-cluster-slowstartconfig"

obj spec.extAuth.grpc.backendSettings.proxyProtocol

"ProxyProtocol enables the Proxy Protocol when communicating with the backend."

fn spec.extAuth.grpc.backendSettings.proxyProtocol.withVersion

withVersion(version)

"Version of ProxyProtol\nValid ProxyProtocolVersion values are\n\"V1\"\n\"V2\

obj spec.extAuth.grpc.backendSettings.retry

"Retry provides more advanced usage, allowing users to customize the number of retries, retry fallback strategy, and retry triggering conditions.\nIf not set, retry will be disabled."

fn spec.extAuth.grpc.backendSettings.retry.withNumRetries

withNumRetries(numRetries)

"NumRetries is the number of retries to be attempted. Defaults to 2."

obj spec.extAuth.grpc.backendSettings.retry.perRetry

"PerRetry is the retry policy to be applied per retry attempt."

fn spec.extAuth.grpc.backendSettings.retry.perRetry.withTimeout

withTimeout(timeout)

"Timeout is the timeout per retry attempt."

obj spec.extAuth.grpc.backendSettings.retry.perRetry.backOff

"Backoff is the backoff policy to be applied per retry attempt. gateway uses a fully jittered exponential\nback-off algorithm for retries. For additional details,\nsee https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#config-http-filters-router-x-envoy-max-retries"

fn spec.extAuth.grpc.backendSettings.retry.perRetry.backOff.withBaseInterval

withBaseInterval(baseInterval)

"BaseInterval is the base interval between retries."

fn spec.extAuth.grpc.backendSettings.retry.perRetry.backOff.withMaxInterval

withMaxInterval(maxInterval)

"MaxInterval is the maximum interval between retries. This parameter is optional, but must be greater than or equal to the base_interval if set.\nThe default is 10 times the base_interval"

obj spec.extAuth.grpc.backendSettings.retry.retryOn

"RetryOn specifies the retry trigger condition.\n\nIf not specified, the default is to retry on connect-failure,refused-stream,unavailable,cancelled,retriable-status-codes(503)."

fn spec.extAuth.grpc.backendSettings.retry.retryOn.withHttpStatusCodes

withHttpStatusCodes(httpStatusCodes)

"HttpStatusCodes specifies the http status codes to be retried.\nThe retriable-status-codes trigger must also be configured for these status codes to trigger a retry."

fn spec.extAuth.grpc.backendSettings.retry.retryOn.withHttpStatusCodesMixin

withHttpStatusCodesMixin(httpStatusCodes)

"HttpStatusCodes specifies the http status codes to be retried.\nThe retriable-status-codes trigger must also be configured for these status codes to trigger a retry."

Note: This function appends passed data to existing values

fn spec.extAuth.grpc.backendSettings.retry.retryOn.withTriggers

withTriggers(triggers)

"Triggers specifies the retry trigger condition(Http/Grpc)."

fn spec.extAuth.grpc.backendSettings.retry.retryOn.withTriggersMixin

withTriggersMixin(triggers)

"Triggers specifies the retry trigger condition(Http/Grpc)."

Note: This function appends passed data to existing values

obj spec.extAuth.grpc.backendSettings.tcpKeepalive

"TcpKeepalive settings associated with the upstream client connection.\nDisabled by default."

fn spec.extAuth.grpc.backendSettings.tcpKeepalive.withIdleTime

withIdleTime(idleTime)

"The duration a connection needs to be idle before keep-alive\nprobes start being sent.\nThe duration format is\nDefaults to 7200s."

fn spec.extAuth.grpc.backendSettings.tcpKeepalive.withInterval

withInterval(interval)

"The duration between keep-alive probes.\nDefaults to 75s."

fn spec.extAuth.grpc.backendSettings.tcpKeepalive.withProbes

withProbes(probes)

"The total number of unacknowledged probes to send before deciding\nthe connection is dead.\nDefaults to 9."

obj spec.extAuth.grpc.backendSettings.timeout

"Timeout settings for the backend connections."

obj spec.extAuth.grpc.backendSettings.timeout.http

"Timeout settings for HTTP."

fn spec.extAuth.grpc.backendSettings.timeout.http.withConnectionIdleTimeout

withConnectionIdleTimeout(connectionIdleTimeout)

"The idle timeout for an HTTP connection. Idle time is defined as a period in which there are no active requests in the connection.\nDefault: 1 hour."

fn spec.extAuth.grpc.backendSettings.timeout.http.withMaxConnectionDuration

withMaxConnectionDuration(maxConnectionDuration)

"The maximum duration of an HTTP connection.\nDefault: unlimited."

fn spec.extAuth.grpc.backendSettings.timeout.http.withRequestTimeout

withRequestTimeout(requestTimeout)

"RequestTimeout is the time until which entire response is received from the upstream."

obj spec.extAuth.grpc.backendSettings.timeout.tcp

"Timeout settings for TCP."

fn spec.extAuth.grpc.backendSettings.timeout.tcp.withConnectTimeout

withConnectTimeout(connectTimeout)

"The timeout for network connection establishment, including TCP and TLS handshakes.\nDefault: 10 seconds."

obj spec.extAuth.http

"HTTP defines the HTTP External Authorization service.\nEither GRPCService or HTTPService must be specified,\nand only one of them can be provided."

fn spec.extAuth.http.withBackendRefs

withBackendRefs(backendRefs)

"BackendRefs references a Kubernetes object that represents the\nbackend server to which the authorization request will be sent."

fn spec.extAuth.http.withBackendRefsMixin

withBackendRefsMixin(backendRefs)

"BackendRefs references a Kubernetes object that represents the\nbackend server to which the authorization request will be sent."

Note: This function appends passed data to existing values

fn spec.extAuth.http.withHeadersToBackend

withHeadersToBackend(headersToBackend)

"HeadersToBackend are the authorization response headers that will be added\nto the original client request before sending it to the backend server.\nNote that coexisting headers will be overridden.\nIf not specified, no authorization response headers will be added to the\noriginal client request."

fn spec.extAuth.http.withHeadersToBackendMixin

withHeadersToBackendMixin(headersToBackend)

"HeadersToBackend are the authorization response headers that will be added\nto the original client request before sending it to the backend server.\nNote that coexisting headers will be overridden.\nIf not specified, no authorization response headers will be added to the\noriginal client request."

Note: This function appends passed data to existing values

fn spec.extAuth.http.withPath

withPath(path)

"Path is the path of the HTTP External Authorization service.\nIf path is specified, the authorization request will be sent to that path,\nor else the authorization request will be sent to the root path."

obj spec.extAuth.http.backendRef

"BackendRef references a Kubernetes object that represents the\nbackend server to which the authorization request will be sent.\n\nDeprecated: Use BackendRefs instead."

fn spec.extAuth.http.backendRef.withGroup

withGroup(group)

"Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred."

fn spec.extAuth.http.backendRef.withKind

withKind(kind)

"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)"

fn spec.extAuth.http.backendRef.withName

withName(name)

"Name is the name of the referent."

fn spec.extAuth.http.backendRef.withNamespace

withNamespace(namespace)

"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"

fn spec.extAuth.http.backendRef.withPort

withPort(port)

"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."

obj spec.extAuth.http.backendRefs

"BackendRefs references a Kubernetes object that represents the\nbackend server to which the authorization request will be sent."

fn spec.extAuth.http.backendRefs.withFallback

withFallback(fallback)

"Fallback indicates whether the backend is designated as a fallback.\nMultiple fallback backends can be configured.\nIt is highly recommended to configure active or passive health checks to ensure that failover can be detected\nwhen the active backends become unhealthy and to automatically readjust once the primary backends are healthy again.\nThe overprovisioning factor is set to 1.4, meaning the fallback backends will only start receiving traffic when\nthe health of the active backends falls below 72%."

fn spec.extAuth.http.backendRefs.withGroup

withGroup(group)

"Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred."

fn spec.extAuth.http.backendRefs.withKind

withKind(kind)

"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)"

fn spec.extAuth.http.backendRefs.withName

withName(name)

"Name is the name of the referent."

fn spec.extAuth.http.backendRefs.withNamespace

withNamespace(namespace)

"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"

fn spec.extAuth.http.backendRefs.withPort

withPort(port)

"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."

obj spec.extAuth.http.backendSettings

"BackendSettings holds configuration for managing the connection\nto the backend."

obj spec.extAuth.http.backendSettings.circuitBreaker

"Circuit Breaker settings for the upstream connections and requests.\nIf not set, circuit breakers will be enabled with the default thresholds"

fn spec.extAuth.http.backendSettings.circuitBreaker.withMaxConnections

withMaxConnections(maxConnections)

"The maximum number of connections that Envoy will establish to the referenced backend defined within a xRoute rule."

fn spec.extAuth.http.backendSettings.circuitBreaker.withMaxParallelRequests

withMaxParallelRequests(maxParallelRequests)

"The maximum number of parallel requests that Envoy will make to the referenced backend defined within a xRoute rule."

fn spec.extAuth.http.backendSettings.circuitBreaker.withMaxParallelRetries

withMaxParallelRetries(maxParallelRetries)

"The maximum number of parallel retries that Envoy will make to the referenced backend defined within a xRoute rule."

fn spec.extAuth.http.backendSettings.circuitBreaker.withMaxPendingRequests

withMaxPendingRequests(maxPendingRequests)

"The maximum number of pending requests that Envoy will queue to the referenced backend defined within a xRoute rule."

fn spec.extAuth.http.backendSettings.circuitBreaker.withMaxRequestsPerConnection

withMaxRequestsPerConnection(maxRequestsPerConnection)

"The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule.\nDefault: unlimited."

obj spec.extAuth.http.backendSettings.connection

"Connection includes backend connection settings."

fn spec.extAuth.http.backendSettings.connection.withBufferLimit

withBufferLimit(bufferLimit)

"BufferLimit Soft limit on size of the cluster’s connections read and write buffers.\nBufferLimit applies to connection streaming (maybe non-streaming) channel between processes, it's in user space.\nIf unspecified, an implementation defined default is applied (32768 bytes).\nFor example, 20Mi, 1Gi, 256Ki etc.\nNote: that when the suffix is not provided, the value is interpreted as bytes."

fn spec.extAuth.http.backendSettings.connection.withSocketBufferLimit

withSocketBufferLimit(socketBufferLimit)

"SocketBufferLimit provides configuration for the maximum buffer size in bytes for each socket\nto backend.\nSocketBufferLimit applies to socket streaming channel between TCP/IP stacks, it's in kernel space.\nFor example, 20Mi, 1Gi, 256Ki etc.\nNote that when the suffix is not provided, the value is interpreted as bytes."

obj spec.extAuth.http.backendSettings.dns

"DNS includes dns resolution settings."

fn spec.extAuth.http.backendSettings.dns.withDnsRefreshRate

withDnsRefreshRate(dnsRefreshRate)

"DNSRefreshRate specifies the rate at which DNS records should be refreshed.\nDefaults to 30 seconds."

fn spec.extAuth.http.backendSettings.dns.withRespectDnsTtl

withRespectDnsTtl(respectDnsTtl)

"RespectDNSTTL indicates whether the DNS Time-To-Live (TTL) should be respected.\nIf the value is set to true, the DNS refresh rate will be set to the resource record’s TTL.\nDefaults to true."

obj spec.extAuth.http.backendSettings.healthCheck

"HealthCheck allows gateway to perform active health checking on backends."

obj spec.extAuth.http.backendSettings.healthCheck.active

"Active health check configuration"

fn spec.extAuth.http.backendSettings.healthCheck.active.withHealthyThreshold

withHealthyThreshold(healthyThreshold)

"HealthyThreshold defines the number of healthy health checks required before a backend host is marked healthy."

fn spec.extAuth.http.backendSettings.healthCheck.active.withInterval

withInterval(interval)

"Interval defines the time between active health checks."

fn spec.extAuth.http.backendSettings.healthCheck.active.withTimeout

withTimeout(timeout)

"Timeout defines the time to wait for a health check response."

fn spec.extAuth.http.backendSettings.healthCheck.active.withType

withType(type)

"Type defines the type of health checker."

fn spec.extAuth.http.backendSettings.healthCheck.active.withUnhealthyThreshold

withUnhealthyThreshold(unhealthyThreshold)

"UnhealthyThreshold defines the number of unhealthy health checks required before a backend host is marked unhealthy."

obj spec.extAuth.http.backendSettings.healthCheck.active.grpc

"GRPC defines the configuration of the GRPC health checker.\nIt's optional, and can only be used if the specified type is GRPC."

fn spec.extAuth.http.backendSettings.healthCheck.active.grpc.withService

withService(service)

"Service to send in the health check request.\nIf this is not specified, then the health check request applies to the entire\nserver and not to a specific service."

obj spec.extAuth.http.backendSettings.healthCheck.active.http

"HTTP defines the configuration of http health checker.\nIt's required while the health checker type is HTTP."

fn spec.extAuth.http.backendSettings.healthCheck.active.http.withExpectedStatuses

withExpectedStatuses(expectedStatuses)

"ExpectedStatuses defines a list of HTTP response statuses considered healthy.\nDefaults to 200 only"

fn spec.extAuth.http.backendSettings.healthCheck.active.http.withExpectedStatusesMixin

withExpectedStatusesMixin(expectedStatuses)

"ExpectedStatuses defines a list of HTTP response statuses considered healthy.\nDefaults to 200 only"

Note: This function appends passed data to existing values

fn spec.extAuth.http.backendSettings.healthCheck.active.http.withMethod

withMethod(method)

"Method defines the HTTP method used for health checking.\nDefaults to GET"

fn spec.extAuth.http.backendSettings.healthCheck.active.http.withPath

withPath(path)

"Path defines the HTTP path that will be requested during health checking."

obj spec.extAuth.http.backendSettings.healthCheck.active.http.expectedResponse

"ExpectedResponse defines a list of HTTP expected responses to match."

fn spec.extAuth.http.backendSettings.healthCheck.active.http.expectedResponse.withBinary

withBinary(binary)

"Binary payload base64 encoded."

fn spec.extAuth.http.backendSettings.healthCheck.active.http.expectedResponse.withText

withText(text)

"Text payload in plain text."

fn spec.extAuth.http.backendSettings.healthCheck.active.http.expectedResponse.withType

withType(type)

"Type defines the type of the payload."

obj spec.extAuth.http.backendSettings.healthCheck.active.tcp

"TCP defines the configuration of tcp health checker.\nIt's required while the health checker type is TCP."

obj spec.extAuth.http.backendSettings.healthCheck.active.tcp.receive

"Receive defines the expected response payload."

fn spec.extAuth.http.backendSettings.healthCheck.active.tcp.receive.withBinary

withBinary(binary)

"Binary payload base64 encoded."

fn spec.extAuth.http.backendSettings.healthCheck.active.tcp.receive.withText

withText(text)

"Text payload in plain text."

fn spec.extAuth.http.backendSettings.healthCheck.active.tcp.receive.withType

withType(type)

"Type defines the type of the payload."

obj spec.extAuth.http.backendSettings.healthCheck.active.tcp.send

"Send defines the request payload."

fn spec.extAuth.http.backendSettings.healthCheck.active.tcp.send.withBinary

withBinary(binary)

"Binary payload base64 encoded."

fn spec.extAuth.http.backendSettings.healthCheck.active.tcp.send.withText

withText(text)

"Text payload in plain text."

fn spec.extAuth.http.backendSettings.healthCheck.active.tcp.send.withType

withType(type)

"Type defines the type of the payload."

obj spec.extAuth.http.backendSettings.healthCheck.passive

"Passive passive check configuration"

fn spec.extAuth.http.backendSettings.healthCheck.passive.withBaseEjectionTime

withBaseEjectionTime(baseEjectionTime)

"BaseEjectionTime defines the base duration for which a host will be ejected on consecutive failures."

fn spec.extAuth.http.backendSettings.healthCheck.passive.withConsecutive5XxErrors

withConsecutive5XxErrors(consecutive5XxErrors)

"Consecutive5xxErrors sets the number of consecutive 5xx errors triggering ejection."

fn spec.extAuth.http.backendSettings.healthCheck.passive.withConsecutiveGatewayErrors

withConsecutiveGatewayErrors(consecutiveGatewayErrors)

"ConsecutiveGatewayErrors sets the number of consecutive gateway errors triggering ejection."

fn spec.extAuth.http.backendSettings.healthCheck.passive.withConsecutiveLocalOriginFailures

withConsecutiveLocalOriginFailures(consecutiveLocalOriginFailures)

"ConsecutiveLocalOriginFailures sets the number of consecutive local origin failures triggering ejection.\nParameter takes effect only when split_external_local_origin_errors is set to true."

fn spec.extAuth.http.backendSettings.healthCheck.passive.withInterval

withInterval(interval)

"Interval defines the time between passive health checks."

fn spec.extAuth.http.backendSettings.healthCheck.passive.withMaxEjectionPercent

withMaxEjectionPercent(maxEjectionPercent)

"MaxEjectionPercent sets the maximum percentage of hosts in a cluster that can be ejected."

fn spec.extAuth.http.backendSettings.healthCheck.passive.withSplitExternalLocalOriginErrors

withSplitExternalLocalOriginErrors(splitExternalLocalOriginErrors)

"SplitExternalLocalOriginErrors enables splitting of errors between external and local origin."

obj spec.extAuth.http.backendSettings.http2

"HTTP2 provides HTTP/2 configuration for backend connections."

fn spec.extAuth.http.backendSettings.http2.withInitialConnectionWindowSize

withInitialConnectionWindowSize(initialConnectionWindowSize)

"InitialConnectionWindowSize sets the initial window size for HTTP/2 connections.\nIf not set, the default value is 1 MiB."

fn spec.extAuth.http.backendSettings.http2.withInitialStreamWindowSize

withInitialStreamWindowSize(initialStreamWindowSize)

"InitialStreamWindowSize sets the initial window size for HTTP/2 streams.\nIf not set, the default value is 64 KiB(64*1024)."

fn spec.extAuth.http.backendSettings.http2.withMaxConcurrentStreams

withMaxConcurrentStreams(maxConcurrentStreams)

"MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection.\nIf not set, the default value is 100."

fn spec.extAuth.http.backendSettings.http2.withOnInvalidMessage

withOnInvalidMessage(onInvalidMessage)

"OnInvalidMessage determines if Envoy will terminate the connection or just the offending stream in the event of HTTP messaging error\nIt's recommended for L2 Envoy deployments to set this value to TerminateStream.\nhttps://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/level_two\nDefault: TerminateConnection"

obj spec.extAuth.http.backendSettings.loadBalancer

"LoadBalancer policy to apply when routing traffic from the gateway to\nthe backend endpoints. Defaults to LeastRequest."

fn spec.extAuth.http.backendSettings.loadBalancer.withType

withType(type)

"Type decides the type of Load Balancer policy.\nValid LoadBalancerType values are\n\"ConsistentHash\",\n\"LeastRequest\",\n\"Random\",\n\"RoundRobin\"."

obj spec.extAuth.http.backendSettings.loadBalancer.consistentHash

"ConsistentHash defines the configuration when the load balancer type is\nset to ConsistentHash"

fn spec.extAuth.http.backendSettings.loadBalancer.consistentHash.withTableSize

withTableSize(tableSize)

"The table size for consistent hashing, must be prime number limited to 5000011."

fn spec.extAuth.http.backendSettings.loadBalancer.consistentHash.withType

withType(type)

"ConsistentHashType defines the type of input to hash on. Valid Type values are\n\"SourceIP\",\n\"Header\",\n\"Cookie\"."

obj spec.extAuth.http.backendSettings.loadBalancer.consistentHash.cookie

"Cookie configures the cookie hash policy when the consistent hash type is set to Cookie."

fn spec.extAuth.http.backendSettings.loadBalancer.consistentHash.cookie.withAttributes

withAttributes(attributes)

"Additional Attributes to set for the generated cookie."

fn spec.extAuth.http.backendSettings.loadBalancer.consistentHash.cookie.withAttributesMixin

withAttributesMixin(attributes)

"Additional Attributes to set for the generated cookie."

Note: This function appends passed data to existing values

fn spec.extAuth.http.backendSettings.loadBalancer.consistentHash.cookie.withName

withName(name)

"Name of the cookie to hash.\nIf this cookie does not exist in the request, Envoy will generate a cookie and set\nthe TTL on the response back to the client based on Layer 4\nattributes of the backend endpoint, to ensure that these future requests\ngo to the same backend endpoint. Make sure to set the TTL field for this case."

fn spec.extAuth.http.backendSettings.loadBalancer.consistentHash.cookie.withTtl

withTtl(ttl)

"TTL of the generated cookie if the cookie is not present. This value sets the\nMax-Age attribute value."

obj spec.extAuth.http.backendSettings.loadBalancer.consistentHash.header

"Header configures the header hash policy when the consistent hash type is set to Header."

fn spec.extAuth.http.backendSettings.loadBalancer.consistentHash.header.withName

withName(name)

"Name of the header to hash."

obj spec.extAuth.http.backendSettings.loadBalancer.slowStart

"SlowStart defines the configuration related to the slow start load balancer policy.\nIf set, during slow start window, traffic sent to the newly added hosts will gradually increase.\nCurrently this is only supported for RoundRobin and LeastRequest load balancers"

fn spec.extAuth.http.backendSettings.loadBalancer.slowStart.withWindow

withWindow(window)

"Window defines the duration of the warm up period for newly added host.\nDuring slow start window, traffic sent to the newly added hosts will gradually increase.\nCurrently only supports linear growth of traffic. For additional details,\nsee https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto#config-cluster-v3-cluster-slowstartconfig"

obj spec.extAuth.http.backendSettings.proxyProtocol

"ProxyProtocol enables the Proxy Protocol when communicating with the backend."

fn spec.extAuth.http.backendSettings.proxyProtocol.withVersion

withVersion(version)

"Version of ProxyProtol\nValid ProxyProtocolVersion values are\n\"V1\"\n\"V2\

obj spec.extAuth.http.backendSettings.retry

"Retry provides more advanced usage, allowing users to customize the number of retries, retry fallback strategy, and retry triggering conditions.\nIf not set, retry will be disabled."

fn spec.extAuth.http.backendSettings.retry.withNumRetries

withNumRetries(numRetries)

"NumRetries is the number of retries to be attempted. Defaults to 2."

obj spec.extAuth.http.backendSettings.retry.perRetry

"PerRetry is the retry policy to be applied per retry attempt."

fn spec.extAuth.http.backendSettings.retry.perRetry.withTimeout

withTimeout(timeout)

"Timeout is the timeout per retry attempt."

obj spec.extAuth.http.backendSettings.retry.perRetry.backOff

"Backoff is the backoff policy to be applied per retry attempt. gateway uses a fully jittered exponential\nback-off algorithm for retries. For additional details,\nsee https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#config-http-filters-router-x-envoy-max-retries"

fn spec.extAuth.http.backendSettings.retry.perRetry.backOff.withBaseInterval

withBaseInterval(baseInterval)

"BaseInterval is the base interval between retries."

fn spec.extAuth.http.backendSettings.retry.perRetry.backOff.withMaxInterval

withMaxInterval(maxInterval)

"MaxInterval is the maximum interval between retries. This parameter is optional, but must be greater than or equal to the base_interval if set.\nThe default is 10 times the base_interval"

obj spec.extAuth.http.backendSettings.retry.retryOn

"RetryOn specifies the retry trigger condition.\n\nIf not specified, the default is to retry on connect-failure,refused-stream,unavailable,cancelled,retriable-status-codes(503)."

fn spec.extAuth.http.backendSettings.retry.retryOn.withHttpStatusCodes

withHttpStatusCodes(httpStatusCodes)

"HttpStatusCodes specifies the http status codes to be retried.\nThe retriable-status-codes trigger must also be configured for these status codes to trigger a retry."

fn spec.extAuth.http.backendSettings.retry.retryOn.withHttpStatusCodesMixin

withHttpStatusCodesMixin(httpStatusCodes)

"HttpStatusCodes specifies the http status codes to be retried.\nThe retriable-status-codes trigger must also be configured for these status codes to trigger a retry."

Note: This function appends passed data to existing values

fn spec.extAuth.http.backendSettings.retry.retryOn.withTriggers

withTriggers(triggers)

"Triggers specifies the retry trigger condition(Http/Grpc)."

fn spec.extAuth.http.backendSettings.retry.retryOn.withTriggersMixin

withTriggersMixin(triggers)

"Triggers specifies the retry trigger condition(Http/Grpc)."

Note: This function appends passed data to existing values

obj spec.extAuth.http.backendSettings.tcpKeepalive

"TcpKeepalive settings associated with the upstream client connection.\nDisabled by default."

fn spec.extAuth.http.backendSettings.tcpKeepalive.withIdleTime

withIdleTime(idleTime)

"The duration a connection needs to be idle before keep-alive\nprobes start being sent.\nThe duration format is\nDefaults to 7200s."

fn spec.extAuth.http.backendSettings.tcpKeepalive.withInterval

withInterval(interval)

"The duration between keep-alive probes.\nDefaults to 75s."

fn spec.extAuth.http.backendSettings.tcpKeepalive.withProbes

withProbes(probes)

"The total number of unacknowledged probes to send before deciding\nthe connection is dead.\nDefaults to 9."

obj spec.extAuth.http.backendSettings.timeout

"Timeout settings for the backend connections."

obj spec.extAuth.http.backendSettings.timeout.http

"Timeout settings for HTTP."

fn spec.extAuth.http.backendSettings.timeout.http.withConnectionIdleTimeout

withConnectionIdleTimeout(connectionIdleTimeout)

"The idle timeout for an HTTP connection. Idle time is defined as a period in which there are no active requests in the connection.\nDefault: 1 hour."

fn spec.extAuth.http.backendSettings.timeout.http.withMaxConnectionDuration

withMaxConnectionDuration(maxConnectionDuration)

"The maximum duration of an HTTP connection.\nDefault: unlimited."

fn spec.extAuth.http.backendSettings.timeout.http.withRequestTimeout

withRequestTimeout(requestTimeout)

"RequestTimeout is the time until which entire response is received from the upstream."

obj spec.extAuth.http.backendSettings.timeout.tcp

"Timeout settings for TCP."

fn spec.extAuth.http.backendSettings.timeout.tcp.withConnectTimeout

withConnectTimeout(connectTimeout)

"The timeout for network connection establishment, including TCP and TLS handshakes.\nDefault: 10 seconds."

obj spec.jwt

"JWT defines the configuration for JSON Web Token (JWT) authentication."

fn spec.jwt.withOptional

withOptional(optional)

"Optional determines whether a missing JWT is acceptable, defaulting to false if not specified.\nNote: Even if optional is set to true, JWT authentication will still fail if an invalid JWT is presented."

fn spec.jwt.withProviders

withProviders(providers)

"Providers defines the JSON Web Token (JWT) authentication provider type.\nWhen multiple JWT providers are specified, the JWT is considered valid if\nany of the providers successfully validate the JWT. For additional details,\nsee https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html."

fn spec.jwt.withProvidersMixin

withProvidersMixin(providers)

"Providers defines the JSON Web Token (JWT) authentication provider type.\nWhen multiple JWT providers are specified, the JWT is considered valid if\nany of the providers successfully validate the JWT. For additional details,\nsee https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html."

Note: This function appends passed data to existing values

obj spec.jwt.providers

"Providers defines the JSON Web Token (JWT) authentication provider type.\nWhen multiple JWT providers are specified, the JWT is considered valid if\nany of the providers successfully validate the JWT. For additional details,\nsee https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html."

fn spec.jwt.providers.withAudiences

withAudiences(audiences)

"Audiences is a list of JWT audiences allowed access. For additional details, see\nhttps://tools.ietf.org/html/rfc7519#section-4.1.3. If not provided, JWT audiences\nare not checked."

fn spec.jwt.providers.withAudiencesMixin

withAudiencesMixin(audiences)

"Audiences is a list of JWT audiences allowed access. For additional details, see\nhttps://tools.ietf.org/html/rfc7519#section-4.1.3. If not provided, JWT audiences\nare not checked."

Note: This function appends passed data to existing values

fn spec.jwt.providers.withClaimToHeaders

withClaimToHeaders(claimToHeaders)

"ClaimToHeaders is a list of JWT claims that must be extracted into HTTP request headers\nFor examples, following config:\nThe claim must be of type; string, int, double, bool. Array type claims are not supported"

fn spec.jwt.providers.withClaimToHeadersMixin

withClaimToHeadersMixin(claimToHeaders)

"ClaimToHeaders is a list of JWT claims that must be extracted into HTTP request headers\nFor examples, following config:\nThe claim must be of type; string, int, double, bool. Array type claims are not supported"

Note: This function appends passed data to existing values

fn spec.jwt.providers.withIssuer

withIssuer(issuer)

"Issuer is the principal that issued the JWT and takes the form of a URL or email address.\nFor additional details, see https://tools.ietf.org/html/rfc7519#section-4.1.1 for\nURL format and https://rfc-editor.org/rfc/rfc5322.html for email format. If not provided,\nthe JWT issuer is not checked."

fn spec.jwt.providers.withName

withName(name)

"Name defines a unique name for the JWT provider. A name can have a variety of forms,\nincluding RFC1123 subdomains, RFC 1123 labels, or RFC 1035 labels."

fn spec.jwt.providers.withRecomputeRoute

withRecomputeRoute(recomputeRoute)

"RecomputeRoute clears the route cache and recalculates the routing decision.\nThis field must be enabled if the headers generated from the claim are used for\nroute matching decisions. If the recomputation selects a new route, features targeting\nthe new matched route will be applied."

obj spec.jwt.providers.claimToHeaders

"ClaimToHeaders is a list of JWT claims that must be extracted into HTTP request headers\nFor examples, following config:\nThe claim must be of type; string, int, double, bool. Array type claims are not supported"

fn spec.jwt.providers.claimToHeaders.withClaim

withClaim(claim)

"Claim is the JWT Claim that should be saved into the header : it can be a nested claim of type\n(eg. \"claim.nested.key\", \"sub\"). The nested claim name must use dot \".\"\nto separate the JSON name path."

fn spec.jwt.providers.claimToHeaders.withHeader

withHeader(header)

"Header defines the name of the HTTP request header that the JWT Claim will be saved into."

obj spec.jwt.providers.extractFrom

"ExtractFrom defines different ways to extract the JWT token from HTTP request.\nIf empty, it defaults to extract JWT token from the Authorization HTTP request header using Bearer schema\nor access_token from query parameters."

fn spec.jwt.providers.extractFrom.withCookies

withCookies(cookies)

"Cookies represents a list of cookie names to extract the JWT token from."

fn spec.jwt.providers.extractFrom.withCookiesMixin

withCookiesMixin(cookies)

"Cookies represents a list of cookie names to extract the JWT token from."

Note: This function appends passed data to existing values

fn spec.jwt.providers.extractFrom.withHeaders

withHeaders(headers)

"Headers represents a list of HTTP request headers to extract the JWT token from."

fn spec.jwt.providers.extractFrom.withHeadersMixin

withHeadersMixin(headers)

"Headers represents a list of HTTP request headers to extract the JWT token from."

Note: This function appends passed data to existing values

fn spec.jwt.providers.extractFrom.withParams

withParams(params)

"Params represents a list of query parameters to extract the JWT token from."

fn spec.jwt.providers.extractFrom.withParamsMixin

withParamsMixin(params)

"Params represents a list of query parameters to extract the JWT token from."

Note: This function appends passed data to existing values

obj spec.jwt.providers.extractFrom.headers

"Headers represents a list of HTTP request headers to extract the JWT token from."

fn spec.jwt.providers.extractFrom.headers.withName

withName(name)

"Name is the HTTP header name to retrieve the token"

fn spec.jwt.providers.extractFrom.headers.withValuePrefix

withValuePrefix(valuePrefix)

"ValuePrefix is the prefix that should be stripped before extracting the token.\nThe format would be used by Envoy like \"{ValuePrefix}\".\nFor example, \"Authorization: Bearer \", then the ValuePrefix=\"Bearer \" with a space at the end."

obj spec.jwt.providers.remoteJWKS

"RemoteJWKS defines how to fetch and cache JSON Web Key Sets (JWKS) from a remote\nHTTP/HTTPS endpoint."

fn spec.jwt.providers.remoteJWKS.withUri

withUri(uri)

"URI is the HTTPS URI to fetch the JWKS. Envoy's system trust bundle is used to\nvalidate the server certificate."

obj spec.oidc

"OIDC defines the configuration for the OpenID Connect (OIDC) authentication."

fn spec.oidc.withClientID

withClientID(clientID)

"The client ID to be used in the OIDC\nAuthentication Request."

fn spec.oidc.withCookieDomain

withCookieDomain(cookieDomain)

"The optional domain to set the access and ID token cookies on.\nIf not set, the cookies will default to the host of the request, not including the subdomains.\nIf set, the cookies will be set on the specified domain and all subdomains.\nThis means that requests to any subdomain will not require reauthentication after users log in to the parent domain."

fn spec.oidc.withDefaultRefreshTokenTTL

withDefaultRefreshTokenTTL(defaultRefreshTokenTTL)

"DefaultRefreshTokenTTL is the default lifetime of the refresh token.\nThis field is only used when the exp (expiration time) claim is omitted in\nthe refresh token or the refresh token is not JWT.\n\nIf not specified, defaults to 604800s (one week).\nNote: this field is only applicable when the \"refreshToken\" field is set to true."

fn spec.oidc.withDefaultTokenTTL

withDefaultTokenTTL(defaultTokenTTL)

"DefaultTokenTTL is the default lifetime of the id token and access token.\nPlease note that Envoy will always use the expiry time from the response\nof the authorization server if it is provided. This field is only used when\nthe expiry time is not provided by the authorization.\n\nIf not specified, defaults to 0. In this case, the \"expires_in\" field in\nthe authorization response must be set by the authorization server, or the\nOAuth flow will fail."

fn spec.oidc.withForwardAccessToken

withForwardAccessToken(forwardAccessToken)

"ForwardAccessToken indicates whether the Envoy should forward the access token\nvia the Authorization header Bearer scheme to the upstream.\nIf not specified, defaults to false."

fn spec.oidc.withLogoutPath

withLogoutPath(logoutPath)

"The path to log a user out, clearing their credential cookies.\n\nIf not specified, uses a default logout path \"/logout\

fn spec.oidc.withRedirectURL

withRedirectURL(redirectURL)

"The redirect URL to be used in the OIDC\nAuthentication Request.\nIf not specified, uses the default redirect URI \"%REQ(x-forwarded-proto)%://%REQ(:authority)%/oauth2/callback\

fn spec.oidc.withRefreshToken

withRefreshToken(refreshToken)

"RefreshToken indicates whether the Envoy should automatically refresh the\nid token and access token when they expire.\nWhen set to true, the Envoy will use the refresh token to get a new id token\nand access token when they expire.\n\nIf not specified, defaults to false."

fn spec.oidc.withResources

withResources(resources)

"The OIDC resources to be used in the\nAuthentication Request."

fn spec.oidc.withResourcesMixin

withResourcesMixin(resources)

"The OIDC resources to be used in the\nAuthentication Request."

Note: This function appends passed data to existing values

fn spec.oidc.withScopes

withScopes(scopes)

"The OIDC scopes to be used in the\nAuthentication Request.\nThe \"openid\" scope is always added to the list of scopes if not already\nspecified."

fn spec.oidc.withScopesMixin

withScopesMixin(scopes)

"The OIDC scopes to be used in the\nAuthentication Request.\nThe \"openid\" scope is always added to the list of scopes if not already\nspecified."

Note: This function appends passed data to existing values

obj spec.oidc.clientSecret

"The Kubernetes secret which contains the OIDC client secret to be used in the\nAuthentication Request.\n\nThis is an Opaque secret. The client secret should be stored in the key\n\"client-secret\"."

fn spec.oidc.clientSecret.withGroup

withGroup(group)

"Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred."

fn spec.oidc.clientSecret.withKind

withKind(kind)

"Kind is kind of the referent. For example \"Secret\"."

fn spec.oidc.clientSecret.withName

withName(name)

"Name is the name of the referent."

fn spec.oidc.clientSecret.withNamespace

withNamespace(namespace)

"Namespace is the namespace of the referenced object. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core"

obj spec.oidc.cookieNames

"The optional cookie name overrides to be used for Bearer and IdToken cookies in the\nAuthentication Request.\nIf not specified, uses a randomly generated suffix"

fn spec.oidc.cookieNames.withAccessToken

withAccessToken(accessToken)

"The name of the cookie used to store the AccessToken in the\nAuthentication Request.\nIf not specified, defaults to \"AccessToken-(randomly generated uid)\

fn spec.oidc.cookieNames.withIdToken

withIdToken(idToken)

"The name of the cookie used to store the IdToken in the\nAuthentication Request.\nIf not specified, defaults to \"IdToken-(randomly generated uid)\

obj spec.oidc.provider

"The OIDC Provider configuration."

fn spec.oidc.provider.withAuthorizationEndpoint

withAuthorizationEndpoint(authorizationEndpoint)

"The OIDC Provider's authorization endpoint.\nIf not provided, EG will try to discover it from the provider's Well-Known Configuration Endpoint."

fn spec.oidc.provider.withBackendRefs

withBackendRefs(backendRefs)

"BackendRefs references a Kubernetes object that represents the\nbackend server to which the authorization request will be sent."

fn spec.oidc.provider.withBackendRefsMixin

withBackendRefsMixin(backendRefs)

"BackendRefs references a Kubernetes object that represents the\nbackend server to which the authorization request will be sent."

Note: This function appends passed data to existing values

fn spec.oidc.provider.withIssuer

withIssuer(issuer)

"The OIDC Provider's issuer identifier.\nIssuer MUST be a URI RFC 3986 [RFC3986] with a scheme component that MUST\nbe https, a host component, and optionally, port and path components and\nno query or fragment components."

fn spec.oidc.provider.withTokenEndpoint

withTokenEndpoint(tokenEndpoint)

"The OIDC Provider's token endpoint.\nIf not provided, EG will try to discover it from the provider's Well-Known Configuration Endpoint."

obj spec.oidc.provider.backendRef

"BackendRef references a Kubernetes object that represents the\nbackend server to which the authorization request will be sent.\n\nDeprecated: Use BackendRefs instead."

fn spec.oidc.provider.backendRef.withGroup

withGroup(group)

"Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred."

fn spec.oidc.provider.backendRef.withKind

withKind(kind)

"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)"

fn spec.oidc.provider.backendRef.withName

withName(name)

"Name is the name of the referent."

fn spec.oidc.provider.backendRef.withNamespace

withNamespace(namespace)

"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"

fn spec.oidc.provider.backendRef.withPort

withPort(port)

"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."

obj spec.oidc.provider.backendRefs

"BackendRefs references a Kubernetes object that represents the\nbackend server to which the authorization request will be sent."

fn spec.oidc.provider.backendRefs.withFallback

withFallback(fallback)

"Fallback indicates whether the backend is designated as a fallback.\nMultiple fallback backends can be configured.\nIt is highly recommended to configure active or passive health checks to ensure that failover can be detected\nwhen the active backends become unhealthy and to automatically readjust once the primary backends are healthy again.\nThe overprovisioning factor is set to 1.4, meaning the fallback backends will only start receiving traffic when\nthe health of the active backends falls below 72%."

fn spec.oidc.provider.backendRefs.withGroup

withGroup(group)

"Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred."

fn spec.oidc.provider.backendRefs.withKind

withKind(kind)

"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)"

fn spec.oidc.provider.backendRefs.withName

withName(name)

"Name is the name of the referent."

fn spec.oidc.provider.backendRefs.withNamespace

withNamespace(namespace)

"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"

fn spec.oidc.provider.backendRefs.withPort

withPort(port)

"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."

obj spec.oidc.provider.backendSettings

"BackendSettings holds configuration for managing the connection\nto the backend."

obj spec.oidc.provider.backendSettings.circuitBreaker

"Circuit Breaker settings for the upstream connections and requests.\nIf not set, circuit breakers will be enabled with the default thresholds"

fn spec.oidc.provider.backendSettings.circuitBreaker.withMaxConnections

withMaxConnections(maxConnections)

"The maximum number of connections that Envoy will establish to the referenced backend defined within a xRoute rule."

fn spec.oidc.provider.backendSettings.circuitBreaker.withMaxParallelRequests

withMaxParallelRequests(maxParallelRequests)

"The maximum number of parallel requests that Envoy will make to the referenced backend defined within a xRoute rule."

fn spec.oidc.provider.backendSettings.circuitBreaker.withMaxParallelRetries

withMaxParallelRetries(maxParallelRetries)

"The maximum number of parallel retries that Envoy will make to the referenced backend defined within a xRoute rule."

fn spec.oidc.provider.backendSettings.circuitBreaker.withMaxPendingRequests

withMaxPendingRequests(maxPendingRequests)

"The maximum number of pending requests that Envoy will queue to the referenced backend defined within a xRoute rule."

fn spec.oidc.provider.backendSettings.circuitBreaker.withMaxRequestsPerConnection

withMaxRequestsPerConnection(maxRequestsPerConnection)

"The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule.\nDefault: unlimited."

obj spec.oidc.provider.backendSettings.connection

"Connection includes backend connection settings."

fn spec.oidc.provider.backendSettings.connection.withBufferLimit

withBufferLimit(bufferLimit)

"BufferLimit Soft limit on size of the cluster’s connections read and write buffers.\nBufferLimit applies to connection streaming (maybe non-streaming) channel between processes, it's in user space.\nIf unspecified, an implementation defined default is applied (32768 bytes).\nFor example, 20Mi, 1Gi, 256Ki etc.\nNote: that when the suffix is not provided, the value is interpreted as bytes."

fn spec.oidc.provider.backendSettings.connection.withSocketBufferLimit

withSocketBufferLimit(socketBufferLimit)

"SocketBufferLimit provides configuration for the maximum buffer size in bytes for each socket\nto backend.\nSocketBufferLimit applies to socket streaming channel between TCP/IP stacks, it's in kernel space.\nFor example, 20Mi, 1Gi, 256Ki etc.\nNote that when the suffix is not provided, the value is interpreted as bytes."

obj spec.oidc.provider.backendSettings.dns

"DNS includes dns resolution settings."

fn spec.oidc.provider.backendSettings.dns.withDnsRefreshRate

withDnsRefreshRate(dnsRefreshRate)

"DNSRefreshRate specifies the rate at which DNS records should be refreshed.\nDefaults to 30 seconds."

fn spec.oidc.provider.backendSettings.dns.withRespectDnsTtl

withRespectDnsTtl(respectDnsTtl)

"RespectDNSTTL indicates whether the DNS Time-To-Live (TTL) should be respected.\nIf the value is set to true, the DNS refresh rate will be set to the resource record’s TTL.\nDefaults to true."

obj spec.oidc.provider.backendSettings.healthCheck

"HealthCheck allows gateway to perform active health checking on backends."

obj spec.oidc.provider.backendSettings.healthCheck.active

"Active health check configuration"

fn spec.oidc.provider.backendSettings.healthCheck.active.withHealthyThreshold

withHealthyThreshold(healthyThreshold)

"HealthyThreshold defines the number of healthy health checks required before a backend host is marked healthy."

fn spec.oidc.provider.backendSettings.healthCheck.active.withInterval

withInterval(interval)

"Interval defines the time between active health checks."

fn spec.oidc.provider.backendSettings.healthCheck.active.withTimeout

withTimeout(timeout)

"Timeout defines the time to wait for a health check response."

fn spec.oidc.provider.backendSettings.healthCheck.active.withType

withType(type)

"Type defines the type of health checker."

fn spec.oidc.provider.backendSettings.healthCheck.active.withUnhealthyThreshold

withUnhealthyThreshold(unhealthyThreshold)

"UnhealthyThreshold defines the number of unhealthy health checks required before a backend host is marked unhealthy."

obj spec.oidc.provider.backendSettings.healthCheck.active.grpc

"GRPC defines the configuration of the GRPC health checker.\nIt's optional, and can only be used if the specified type is GRPC."

fn spec.oidc.provider.backendSettings.healthCheck.active.grpc.withService

withService(service)

"Service to send in the health check request.\nIf this is not specified, then the health check request applies to the entire\nserver and not to a specific service."

obj spec.oidc.provider.backendSettings.healthCheck.active.http

"HTTP defines the configuration of http health checker.\nIt's required while the health checker type is HTTP."

fn spec.oidc.provider.backendSettings.healthCheck.active.http.withExpectedStatuses

withExpectedStatuses(expectedStatuses)

"ExpectedStatuses defines a list of HTTP response statuses considered healthy.\nDefaults to 200 only"

fn spec.oidc.provider.backendSettings.healthCheck.active.http.withExpectedStatusesMixin

withExpectedStatusesMixin(expectedStatuses)

"ExpectedStatuses defines a list of HTTP response statuses considered healthy.\nDefaults to 200 only"

Note: This function appends passed data to existing values

fn spec.oidc.provider.backendSettings.healthCheck.active.http.withMethod

withMethod(method)

"Method defines the HTTP method used for health checking.\nDefaults to GET"

fn spec.oidc.provider.backendSettings.healthCheck.active.http.withPath

withPath(path)

"Path defines the HTTP path that will be requested during health checking."

obj spec.oidc.provider.backendSettings.healthCheck.active.http.expectedResponse

"ExpectedResponse defines a list of HTTP expected responses to match."

fn spec.oidc.provider.backendSettings.healthCheck.active.http.expectedResponse.withBinary

withBinary(binary)

"Binary payload base64 encoded."

fn spec.oidc.provider.backendSettings.healthCheck.active.http.expectedResponse.withText

withText(text)

"Text payload in plain text."

fn spec.oidc.provider.backendSettings.healthCheck.active.http.expectedResponse.withType

withType(type)

"Type defines the type of the payload."

obj spec.oidc.provider.backendSettings.healthCheck.active.tcp

"TCP defines the configuration of tcp health checker.\nIt's required while the health checker type is TCP."

obj spec.oidc.provider.backendSettings.healthCheck.active.tcp.receive

"Receive defines the expected response payload."

fn spec.oidc.provider.backendSettings.healthCheck.active.tcp.receive.withBinary

withBinary(binary)

"Binary payload base64 encoded."

fn spec.oidc.provider.backendSettings.healthCheck.active.tcp.receive.withText

withText(text)

"Text payload in plain text."

fn spec.oidc.provider.backendSettings.healthCheck.active.tcp.receive.withType

withType(type)

"Type defines the type of the payload."

obj spec.oidc.provider.backendSettings.healthCheck.active.tcp.send

"Send defines the request payload."

fn spec.oidc.provider.backendSettings.healthCheck.active.tcp.send.withBinary

withBinary(binary)

"Binary payload base64 encoded."

fn spec.oidc.provider.backendSettings.healthCheck.active.tcp.send.withText

withText(text)

"Text payload in plain text."

fn spec.oidc.provider.backendSettings.healthCheck.active.tcp.send.withType

withType(type)

"Type defines the type of the payload."

obj spec.oidc.provider.backendSettings.healthCheck.passive

"Passive passive check configuration"

fn spec.oidc.provider.backendSettings.healthCheck.passive.withBaseEjectionTime

withBaseEjectionTime(baseEjectionTime)

"BaseEjectionTime defines the base duration for which a host will be ejected on consecutive failures."

fn spec.oidc.provider.backendSettings.healthCheck.passive.withConsecutive5XxErrors

withConsecutive5XxErrors(consecutive5XxErrors)

"Consecutive5xxErrors sets the number of consecutive 5xx errors triggering ejection."

fn spec.oidc.provider.backendSettings.healthCheck.passive.withConsecutiveGatewayErrors

withConsecutiveGatewayErrors(consecutiveGatewayErrors)

"ConsecutiveGatewayErrors sets the number of consecutive gateway errors triggering ejection."

fn spec.oidc.provider.backendSettings.healthCheck.passive.withConsecutiveLocalOriginFailures

withConsecutiveLocalOriginFailures(consecutiveLocalOriginFailures)

"ConsecutiveLocalOriginFailures sets the number of consecutive local origin failures triggering ejection.\nParameter takes effect only when split_external_local_origin_errors is set to true."

fn spec.oidc.provider.backendSettings.healthCheck.passive.withInterval

withInterval(interval)

"Interval defines the time between passive health checks."

fn spec.oidc.provider.backendSettings.healthCheck.passive.withMaxEjectionPercent

withMaxEjectionPercent(maxEjectionPercent)

"MaxEjectionPercent sets the maximum percentage of hosts in a cluster that can be ejected."

fn spec.oidc.provider.backendSettings.healthCheck.passive.withSplitExternalLocalOriginErrors

withSplitExternalLocalOriginErrors(splitExternalLocalOriginErrors)

"SplitExternalLocalOriginErrors enables splitting of errors between external and local origin."

obj spec.oidc.provider.backendSettings.http2

"HTTP2 provides HTTP/2 configuration for backend connections."

fn spec.oidc.provider.backendSettings.http2.withInitialConnectionWindowSize

withInitialConnectionWindowSize(initialConnectionWindowSize)

"InitialConnectionWindowSize sets the initial window size for HTTP/2 connections.\nIf not set, the default value is 1 MiB."

fn spec.oidc.provider.backendSettings.http2.withInitialStreamWindowSize

withInitialStreamWindowSize(initialStreamWindowSize)

"InitialStreamWindowSize sets the initial window size for HTTP/2 streams.\nIf not set, the default value is 64 KiB(64*1024)."

fn spec.oidc.provider.backendSettings.http2.withMaxConcurrentStreams

withMaxConcurrentStreams(maxConcurrentStreams)

"MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection.\nIf not set, the default value is 100."

fn spec.oidc.provider.backendSettings.http2.withOnInvalidMessage

withOnInvalidMessage(onInvalidMessage)

"OnInvalidMessage determines if Envoy will terminate the connection or just the offending stream in the event of HTTP messaging error\nIt's recommended for L2 Envoy deployments to set this value to TerminateStream.\nhttps://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/level_two\nDefault: TerminateConnection"

obj spec.oidc.provider.backendSettings.loadBalancer

"LoadBalancer policy to apply when routing traffic from the gateway to\nthe backend endpoints. Defaults to LeastRequest."

fn spec.oidc.provider.backendSettings.loadBalancer.withType

withType(type)

"Type decides the type of Load Balancer policy.\nValid LoadBalancerType values are\n\"ConsistentHash\",\n\"LeastRequest\",\n\"Random\",\n\"RoundRobin\"."

obj spec.oidc.provider.backendSettings.loadBalancer.consistentHash

"ConsistentHash defines the configuration when the load balancer type is\nset to ConsistentHash"

fn spec.oidc.provider.backendSettings.loadBalancer.consistentHash.withTableSize

withTableSize(tableSize)

"The table size for consistent hashing, must be prime number limited to 5000011."

fn spec.oidc.provider.backendSettings.loadBalancer.consistentHash.withType

withType(type)

"ConsistentHashType defines the type of input to hash on. Valid Type values are\n\"SourceIP\",\n\"Header\",\n\"Cookie\"."

obj spec.oidc.provider.backendSettings.loadBalancer.consistentHash.cookie

"Cookie configures the cookie hash policy when the consistent hash type is set to Cookie."

fn spec.oidc.provider.backendSettings.loadBalancer.consistentHash.cookie.withAttributes

withAttributes(attributes)

"Additional Attributes to set for the generated cookie."

fn spec.oidc.provider.backendSettings.loadBalancer.consistentHash.cookie.withAttributesMixin

withAttributesMixin(attributes)

"Additional Attributes to set for the generated cookie."

Note: This function appends passed data to existing values

fn spec.oidc.provider.backendSettings.loadBalancer.consistentHash.cookie.withName

withName(name)

"Name of the cookie to hash.\nIf this cookie does not exist in the request, Envoy will generate a cookie and set\nthe TTL on the response back to the client based on Layer 4\nattributes of the backend endpoint, to ensure that these future requests\ngo to the same backend endpoint. Make sure to set the TTL field for this case."

fn spec.oidc.provider.backendSettings.loadBalancer.consistentHash.cookie.withTtl

withTtl(ttl)

"TTL of the generated cookie if the cookie is not present. This value sets the\nMax-Age attribute value."

obj spec.oidc.provider.backendSettings.loadBalancer.consistentHash.header

"Header configures the header hash policy when the consistent hash type is set to Header."

fn spec.oidc.provider.backendSettings.loadBalancer.consistentHash.header.withName

withName(name)

"Name of the header to hash."

obj spec.oidc.provider.backendSettings.loadBalancer.slowStart

"SlowStart defines the configuration related to the slow start load balancer policy.\nIf set, during slow start window, traffic sent to the newly added hosts will gradually increase.\nCurrently this is only supported for RoundRobin and LeastRequest load balancers"

fn spec.oidc.provider.backendSettings.loadBalancer.slowStart.withWindow

withWindow(window)

"Window defines the duration of the warm up period for newly added host.\nDuring slow start window, traffic sent to the newly added hosts will gradually increase.\nCurrently only supports linear growth of traffic. For additional details,\nsee https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto#config-cluster-v3-cluster-slowstartconfig"

obj spec.oidc.provider.backendSettings.proxyProtocol

"ProxyProtocol enables the Proxy Protocol when communicating with the backend."

fn spec.oidc.provider.backendSettings.proxyProtocol.withVersion

withVersion(version)

"Version of ProxyProtol\nValid ProxyProtocolVersion values are\n\"V1\"\n\"V2\

obj spec.oidc.provider.backendSettings.retry

"Retry provides more advanced usage, allowing users to customize the number of retries, retry fallback strategy, and retry triggering conditions.\nIf not set, retry will be disabled."

fn spec.oidc.provider.backendSettings.retry.withNumRetries

withNumRetries(numRetries)

"NumRetries is the number of retries to be attempted. Defaults to 2."

obj spec.oidc.provider.backendSettings.retry.perRetry

"PerRetry is the retry policy to be applied per retry attempt."

fn spec.oidc.provider.backendSettings.retry.perRetry.withTimeout

withTimeout(timeout)

"Timeout is the timeout per retry attempt."

obj spec.oidc.provider.backendSettings.retry.perRetry.backOff

"Backoff is the backoff policy to be applied per retry attempt. gateway uses a fully jittered exponential\nback-off algorithm for retries. For additional details,\nsee https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#config-http-filters-router-x-envoy-max-retries"

fn spec.oidc.provider.backendSettings.retry.perRetry.backOff.withBaseInterval

withBaseInterval(baseInterval)

"BaseInterval is the base interval between retries."

fn spec.oidc.provider.backendSettings.retry.perRetry.backOff.withMaxInterval

withMaxInterval(maxInterval)

"MaxInterval is the maximum interval between retries. This parameter is optional, but must be greater than or equal to the base_interval if set.\nThe default is 10 times the base_interval"

obj spec.oidc.provider.backendSettings.retry.retryOn

"RetryOn specifies the retry trigger condition.\n\nIf not specified, the default is to retry on connect-failure,refused-stream,unavailable,cancelled,retriable-status-codes(503)."

fn spec.oidc.provider.backendSettings.retry.retryOn.withHttpStatusCodes

withHttpStatusCodes(httpStatusCodes)

"HttpStatusCodes specifies the http status codes to be retried.\nThe retriable-status-codes trigger must also be configured for these status codes to trigger a retry."

fn spec.oidc.provider.backendSettings.retry.retryOn.withHttpStatusCodesMixin

withHttpStatusCodesMixin(httpStatusCodes)

"HttpStatusCodes specifies the http status codes to be retried.\nThe retriable-status-codes trigger must also be configured for these status codes to trigger a retry."

Note: This function appends passed data to existing values

fn spec.oidc.provider.backendSettings.retry.retryOn.withTriggers

withTriggers(triggers)

"Triggers specifies the retry trigger condition(Http/Grpc)."

fn spec.oidc.provider.backendSettings.retry.retryOn.withTriggersMixin

withTriggersMixin(triggers)

"Triggers specifies the retry trigger condition(Http/Grpc)."

Note: This function appends passed data to existing values

obj spec.oidc.provider.backendSettings.tcpKeepalive

"TcpKeepalive settings associated with the upstream client connection.\nDisabled by default."

fn spec.oidc.provider.backendSettings.tcpKeepalive.withIdleTime

withIdleTime(idleTime)

"The duration a connection needs to be idle before keep-alive\nprobes start being sent.\nThe duration format is\nDefaults to 7200s."

fn spec.oidc.provider.backendSettings.tcpKeepalive.withInterval

withInterval(interval)

"The duration between keep-alive probes.\nDefaults to 75s."

fn spec.oidc.provider.backendSettings.tcpKeepalive.withProbes

withProbes(probes)

"The total number of unacknowledged probes to send before deciding\nthe connection is dead.\nDefaults to 9."

obj spec.oidc.provider.backendSettings.timeout

"Timeout settings for the backend connections."

obj spec.oidc.provider.backendSettings.timeout.http

"Timeout settings for HTTP."

fn spec.oidc.provider.backendSettings.timeout.http.withConnectionIdleTimeout

withConnectionIdleTimeout(connectionIdleTimeout)

"The idle timeout for an HTTP connection. Idle time is defined as a period in which there are no active requests in the connection.\nDefault: 1 hour."

fn spec.oidc.provider.backendSettings.timeout.http.withMaxConnectionDuration

withMaxConnectionDuration(maxConnectionDuration)

"The maximum duration of an HTTP connection.\nDefault: unlimited."

fn spec.oidc.provider.backendSettings.timeout.http.withRequestTimeout

withRequestTimeout(requestTimeout)

"RequestTimeout is the time until which entire response is received from the upstream."

obj spec.oidc.provider.backendSettings.timeout.tcp

"Timeout settings for TCP."

fn spec.oidc.provider.backendSettings.timeout.tcp.withConnectTimeout

withConnectTimeout(connectTimeout)

"The timeout for network connection establishment, including TCP and TLS handshakes.\nDefault: 10 seconds."

obj spec.targetRef

"TargetRef is the name of the resource this policy is being attached to.\nThis policy and the TargetRef MUST be in the same namespace for this\nPolicy to have effect\n\nDeprecated: use targetRefs/targetSelectors instead"

fn spec.targetRef.withGroup

withGroup(group)

"Group is the group of the target resource."

fn spec.targetRef.withKind

withKind(kind)

"Kind is kind of the target resource."

fn spec.targetRef.withName

withName(name)

"Name is the name of the target resource."

fn spec.targetRef.withSectionName

withSectionName(sectionName)

"SectionName is the name of a section within the target resource. When\nunspecified, this targetRef targets the entire resource. In the following\nresources, SectionName is interpreted as the following:\n\n Gateway: Listener name\n HTTPRoute: HTTPRouteRule name\n* Service: Port name\n\nIf a SectionName is specified, but does not exist on the targeted object,\nthe Policy must fail to attach, and the policy implementation should record\na ResolvedRefs or similar Condition in the Policy's status."

obj spec.targetRefs

"TargetRefs are the names of the Gateway resources this policy\nis being attached to."

fn spec.targetRefs.withGroup

withGroup(group)

"Group is the group of the target resource."

fn spec.targetRefs.withKind

withKind(kind)

"Kind is kind of the target resource."

fn spec.targetRefs.withName

withName(name)

"Name is the name of the target resource."

fn spec.targetRefs.withSectionName

withSectionName(sectionName)

"SectionName is the name of a section within the target resource. When\nunspecified, this targetRef targets the entire resource. In the following\nresources, SectionName is interpreted as the following:\n\n Gateway: Listener name\n HTTPRoute: HTTPRouteRule name\n* Service: Port name\n\nIf a SectionName is specified, but does not exist on the targeted object,\nthe Policy must fail to attach, and the policy implementation should record\na ResolvedRefs or similar Condition in the Policy's status."

obj spec.targetSelectors

"TargetSelectors allow targeting resources for this policy based on labels"

fn spec.targetSelectors.withGroup

withGroup(group)

"Group is the group that this selector targets. Defaults to gateway.networking.k8s.io"

fn spec.targetSelectors.withKind

withKind(kind)

"Kind is the resource kind that this selector targets."

fn spec.targetSelectors.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels are the set of label selectors for identifying the targeted resource"

fn spec.targetSelectors.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels are the set of label selectors for identifying the targeted resource"

Note: This function appends passed data to existing values