AgentgatewayPolicy

agentgateway.dev / v1alpha1

apiVersion: agentgateway.dev/v1alpha1 kind: AgentgatewayPolicy metadata: name: example

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata object

spec object required

spec defines the desired state of AgentgatewayPolicy.

backend object

backend defines settings for how to connect to destination backends. A backend policy can target a Gateway (optionally, with a sectionName indicating the listener), ListenerSet, Route (optionally, with a sectionName indicating the route rule), or a Service/Backend (optionally, with a sectionName indicating the port (for Service) or sub-backend (for Backend). Note that a backend policy applies when connecting to a specific destination backend. Targeting a higher level resource, like Gateway, is just a way to easily apply a policy to a group of backends. When multiple policies are selected for a given request, they are merged on a field-level basis, but not a deep merge. Precedence is given to more precise policies: Gateway < Listener < Route < Route Rule < Backend/Service. For example, if a Gateway policy sets 'tcp' and 'tls', and a Backend policy sets 'tls', the effective policy would be 'tcp' from the Gateway, and 'tls' from the Backend.

ai object

ai specifies settings for AI workloads. This is only applicable when connecting to a Backend of type 'ai'.

defaults []object

Provide defaults to merge with user input fields. If the field is already set, the field in the request is used.

minItems: 1

maxItems: 64

field string required

The name of the field.

minLength: 1

maxLength: 256

value object required

The field default value, which can be any JSON Data Type.

modelAliases object

ModelAliases maps friendly model names to actual provider model names. Example: {"fast": "gpt-3.5-turbo", "smart": "gpt-4-turbo"} Note: This field is only applicable when using the agentgateway data plane.

overrides []object

Provide overrides to merge with user input fields. If the field is already set, the field will be overwritten.

minItems: 1

maxItems: 64

field string required

The name of the field.

minLength: 1

maxLength: 256

value object required

The field default value, which can be any JSON Data Type.

prompt object

Enrich requests sent to the LLM provider by appending and prepending system prompts. This can be configured only for LLM providers that use the `CHAT` or `CHAT_STREAMING` API route type.

append []object

A list of messages to be appended to the prompt sent by the client.

content string required

String content of the message.

role string required

Role of the message. The available roles depend on the backend LLM provider model, such as `SYSTEM` or `USER` in the OpenAI API.

prepend []object

A list of messages to be prepended to the prompt sent by the client.

content string required

String content of the message.

role string required

Role of the message. The available roles depend on the backend LLM provider model, such as `SYSTEM` or `USER` in the OpenAI API.

promptCaching object

promptCaching enables automatic prompt caching for supported providers (AWS Bedrock). Reduces API costs by caching static content like system prompts and tool definitions. Only applicable for Bedrock Claude 3+ and Nova models.

cacheMessages boolean

CacheMessages enables caching for conversation messages. Caches all messages in the conversation for cost savings.

cacheSystem boolean

CacheSystem enables caching for system prompts. Inserts a cache point after all system messages.

cacheTools boolean

CacheTools enables caching for tool definitions. Inserts a cache point after all tool specifications.

minTokens integer

MinTokens specifies the minimum estimated token count before caching is enabled. Uses rough heuristic (word count × 1.3) to estimate tokens. Bedrock requires at least 1,024 tokens for caching to be effective.

minimum: 0

promptGuard object

promptGuard enables adding guardrails to LLM requests and responses.

request []object

Prompt guards to apply to requests sent by the client.

minItems: 1

maxItems: 8

openAIModeration object

openAIModeration passes prompt data through the OpenAI Moderations endpoint. See https://platform.openai.com/docs/api-reference/moderations for more information.

model string

model specifies the moderation model to use. For example, `omni-moderation`.

policies object

policies controls policies for communicating with OpenAI.

auth object

auth defines settings for managing authentication to the backend

aws object

Auth specifies an explicit AWS authentication method for the backend. When omitted, we will try to use the default AWS SDK authentication methods.

secretRef object required

SecretRef references a Kubernetes Secret containing the AWS credentials. The Secret must have keys "accessKey", "secretKey", and optionally "sessionToken".

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

key string

key provides an inline key to use as the value of the Authorization header. This option is the least secure; usage of a Secret is preferred.

maxLength: 2048

passthrough object

passthrough passes through an existing token that has been sent by the client and validated. Other policies, like JWT and API Key authentication, will strip the original client credentials. Passthrough backend authentication causes the original token to be added back into the request. If there are no client authentication policies on the request, the original token would be unchanged, so this would have no effect.

secretRef object

secretRef references a Kubernetes secret storing the key to use the authorization value. This must be stored in the 'Authorization' key.

name string

http object

http defines settings for managing HTTP requests to the backend.

requestTimeout string

requestTimeout specifies the deadline for receiving a response from the backend.

version string

version specifies the HTTP protocol version to use when connecting to the backend. If not specified, the version is automatically determined: * Service types can specify it with 'appProtocol' on the Service port. * If traffic is identified as gRPC, HTTP2 is used. * If the incoming traffic was plaintext HTTP, the original protocol will be used. * If the incoming traffic was HTTPS, HTTP1 will be used. This is because most clients will transparently upgrade HTTPS traffic to HTTP2, even if the backend doesn't support it

enum: HTTP1, HTTP2

tcp object

tcp defines settings for managing TCP connections to the backend.

connectTimeout string

connectTimeout defines the deadline for establishing a connection to the destination.

keepalive object

keepAlive defines settings for enabling TCP keepalives on the connection.

interval string

interval specifies the number of seconds between keep-alive probes. If unset, this defaults to 180s.

retries integer

retries specifies the maximum number of keep-alive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

time specifies the number of seconds a connection needs to be idle before keep-alive probes start being sent. If unset, this defaults to 180s.

tls object

tls defines settings for managing TLS connections to the backend. If this field is set, TLS will be initiated to the backend; the system trusted CA certificates will be used to validate the server, and the SNI will automatically be set based on the destination.

alpnProtocols []string

alpnProtocols sets the Application Level Protocol Negotiation (ALPN) value to use in the TLS handshake. If not present, defaults to ["h2", "http/1.1"].

minItems: 1

maxItems: 16

caCertificateRefs []object

caCertificateRefs defines the CA certificate ConfigMap to use to verify the server certificate. If unset, the system's trusted certificates are used.

maxItems: 1

name string

insecureSkipVerify string

insecureSkipVerify originates TLS but skips verification of the backend's certificate. WARNING: This is an insecure option that should only be used if the risks are understood. There are two modes: * All disables all TLS verification * Hostname verifies the CA certificate is trusted, but ignores any mismatch of hostname/SANs. Note that this method is still insecure; prefer setting verifySubjectAltNames to customize the valid hostnames if possible.

enum: All, Hostname

mtlsCertificateRef []object

mtlsCertificateRef enables mutual TLS to the backend, using the specified key (tls.key) and cert (tls.crt) from the refenced Secret. An optional 'ca.cert' field, if present, will be used to verify the server certificate if present. If caCertificateRefs is also specified, the caCertificateRefs field takes priority. If unspecified, no client certificate will be used.

maxItems: 1

name string

sni string

sni specifies the Server Name Indicator (SNI) to be used in the TLS handshake. If unset, the SNI is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

verifySubjectAltNames specifies the Subject Alternative Names (SAN) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

regex object

Regular expression (regex) matching for prompt guards and data masking.

action string

The action to take if a regex pattern is matched in a request or response. This setting applies only to request matches. PromptguardResponse matches are always masked by default. Defaults to `Mask`.

enum: Mask, Reject

builtins []string

A list of built-in regex patterns to match against the request or response. Matches and built-ins are additive.

matches []string

A list of regex patterns to match against the request or response. Matches and built-ins are additive.

response object

A custom response message to return to the client. If not specified, defaults to "The request was rejected due to inappropriate content".

message string

A custom response message to return to the client. If not specified, defaults to "The request was rejected due to inappropriate content".

statusCode integer

The status code to return to the client. Defaults to 403.

format: int32

minimum: 200

maximum: 599

webhook object

Configure a webhook to forward requests to for prompt guarding.

backendRef object required

backendRef references the webhook server to reach. Supported types: Service and Backend.

group string

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

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kind is the Kubernetes resource kind of the referent. For example "Service". Defaults to "Service" when not specified. ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services. Support: Core (Services with a type other than ExternalName) Support: Implementation-specific (Services with type ExternalName)

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Port specifies the destination port number to use for this resource. Port is required when the referent is a Kubernetes Service. In this case, the port number is the service port number, not the target port. For other resources, destination port might be derived from the referent resource or this field.

format: int32

minimum: 1

maximum: 65535

forwardHeaderMatches []object

ForwardHeaderMatches defines a list of HTTP header matches that will be used to select the headers to forward to the webhook. Request headers are used when forwarding requests and response headers are used when forwarding responses. By default, no headers are forwarded.

name string required

Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2). If multiple entries specify equivalent header names, only the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent. When a header is repeated in an HTTP request, it is implementation-specific behavior as to how this is represented. Generally, proxies should follow the guidance from the RFC: https://www.rfc-editor.org/rfc/rfc7230.html#section-3.2.2 regarding processing a repeated header, with special handling for "Set-Cookie".

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

type string

Type specifies how to match against the value of the header. Support: Core (Exact) Support: Implementation-specific (RegularExpression) Since RegularExpression HeaderMatchType has implementation-specific conformance, implementations can support POSIX, PCRE or any other dialects of regular expressions. Please read the implementation's documentation to determine the supported dialect.

enum: Exact, RegularExpression

value string required

Value is the value of HTTP Header to be matched.

minLength: 1

maxLength: 4096

response []object

Prompt guards to apply to responses returned by the LLM provider.

minItems: 1

maxItems: 8

regex object

Regular expression (regex) matching for prompt guards and data masking.

action string

The action to take if a regex pattern is matched in a request or response. This setting applies only to request matches. PromptguardResponse matches are always masked by default. Defaults to `Mask`.

enum: Mask, Reject

builtins []string

A list of built-in regex patterns to match against the request or response. Matches and built-ins are additive.

matches []string

A list of regex patterns to match against the request or response. Matches and built-ins are additive.

response object

A custom response message to return to the client. If not specified, defaults to "The response was rejected due to inappropriate content".

message string

A custom response message to return to the client. If not specified, defaults to "The request was rejected due to inappropriate content".

statusCode integer

The status code to return to the client. Defaults to 403.

format: int32

minimum: 200

maximum: 599

webhook object

Configure a webhook to forward responses to for prompt guarding.

backendRef object required

backendRef references the webhook server to reach. Supported types: Service and Backend.

group string

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

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

format: int32

minimum: 1

maximum: 65535

forwardHeaderMatches []object

name string required

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

type string

enum: Exact, RegularExpression

value string required

Value is the value of HTTP Header to be matched.

minLength: 1

maxLength: 4096

routes object

routes defines how to identify the type of traffic to handle. The keys are URL path suffixes matched using ends-with comparison (e.g., "/v1/chat/completions"). The special "*" wildcard matches any path. If not specified, all traffic defaults to "completions" type.

auth object

auth defines settings for managing authentication to the backend

aws object

Auth specifies an explicit AWS authentication method for the backend. When omitted, we will try to use the default AWS SDK authentication methods.

secretRef object required

SecretRef references a Kubernetes Secret containing the AWS credentials. The Secret must have keys "accessKey", "secretKey", and optionally "sessionToken".

name string

key string

key provides an inline key to use as the value of the Authorization header. This option is the least secure; usage of a Secret is preferred.

maxLength: 2048

passthrough object

secretRef object

secretRef references a Kubernetes secret storing the key to use the authorization value. This must be stored in the 'Authorization' key.

name string

http object

http defines settings for managing HTTP requests to the backend.

requestTimeout string

requestTimeout specifies the deadline for receiving a response from the backend.

version string

enum: HTTP1, HTTP2

mcp object

mcp specifies settings for MCP workloads. This is only applicable when connecting to a Backend of type 'mcp'.

authentication object

authentication defines MCPBackend specific authentication rules.

audiences []string

audiences specify the list of allowed audiences that are allowed access. This corresponds to the 'aud' claim (https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.3). If unset, any audience is allowed.

minItems: 1

maxItems: 64

issuer string

Issuer identifies the IdP that issued the JWT. This corresponds to the 'iss' claim (https://tools.ietf.org/html/rfc7519#section-4.1.1).

minLength: 1

maxLength: 256

jwks object required

jwks defines the remote JSON Web Key used to validate the signature of the JWT.

backendRef object required

backendRef references the remote JWKS server to reach. Supported types are Service and (static) Backend. An AgentgatewayPolicy containing backend tls config can then be attached to the service/backend in order to set tls options for a connection to the remote jwks source.

group string

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

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

format: int32

minimum: 1

maximum: 65535

cacheDuration string

jwksPath string required

Path to IdP jwks endpoint, relative to the root, commonly ".well-known/jwks.json".

minLength: 1

maxLength: 2000

mode string

validation mode for JWT authentication.

enum: Strict, Optional, Permissive

provider string

McpIDP specifies the identity provider to use for authentication

enum: Auth0, Keycloak

resourceMetadata object

ResourceMetadata defines the metadata to use for MCP resources.

authorization object

authorization defines MCPBackend level authorization. Unlike authorization at the HTTP level, which will reject unauthorized requests with a 403 error, this policy works at the MCPBackend level. List operations, such as list_tools, will have each item evaluated. Items that do not meet the rule will be filtered. Get or call operations, such as call_tool, will evaluate the specific item and reject requests that do not meet the rule.

action string

Action defines whether the rule allows or denies the request if matched. If unspecified, the default is "Allow".

enum: Allow, Deny

policy object required

Policy specifies the Authorization rule to evaluate. A policy matches when **any** of the conditions evaluates to true.

matchExpressions []string required

MatchExpressions defines a set of conditions that must be satisfied for the rule to match. These expression should be in the form of a Common Expression Language (CEL) expression.

minItems: 1

maxItems: 256

tcp object

tcp defines settings for managing TCP connections to the backend.

connectTimeout string

connectTimeout defines the deadline for establishing a connection to the destination.

keepalive object

keepAlive defines settings for enabling TCP keepalives on the connection.

interval string

interval specifies the number of seconds between keep-alive probes. If unset, this defaults to 180s.

retries integer

retries specifies the maximum number of keep-alive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

time specifies the number of seconds a connection needs to be idle before keep-alive probes start being sent. If unset, this defaults to 180s.

tls object

alpnProtocols []string

alpnProtocols sets the Application Level Protocol Negotiation (ALPN) value to use in the TLS handshake. If not present, defaults to ["h2", "http/1.1"].

minItems: 1

maxItems: 16

caCertificateRefs []object

caCertificateRefs defines the CA certificate ConfigMap to use to verify the server certificate. If unset, the system's trusted certificates are used.

maxItems: 1

name string

insecureSkipVerify string

enum: All, Hostname

mtlsCertificateRef []object

maxItems: 1

name string

sni string

sni specifies the Server Name Indicator (SNI) to be used in the TLS handshake. If unset, the SNI is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

verifySubjectAltNames specifies the Subject Alternative Names (SAN) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

frontend object

frontend defines settings for how to handle incoming traffic. A frontend policy can only target a Gateway. Listener and ListenerSet are not valid targets. When multiple policies are selected for a given request, they are merged on a field-level basis, but not a deep merge. For example, policy A sets 'tcp' and 'tls', and policy B sets 'tls', the effective policy would be 'tcp' from policy A, and 'tls' from policy B.

accessLog object

AccessLoggingConfig contains access logging configuration

attributes object

attributes specifies customizations to the key-value pairs that are logged

add []object

add specifies additional key-value pairs to be added to each entry. The value is a CEL expression. If the CEL expression fails to evaluate, the pair will be excluded.

minItems: 1

expression string required

CELExpression represents a Common Expression Language (CEL) expression.

minLength: 1

maxLength: 16384

name string required

minLength: 1

maxLength: 256

remove []string

remove lists the default fields that should be removed. For example, "http.method".

minItems: 1

maxItems: 32

filter string

filter specifies a CEL expression that is used to filter logs. A log will only be emitted if the expression evaluates to 'true'.

minLength: 1

maxLength: 16384

http object

http defines settings on managing incoming HTTP requests.

http1IdleTimeout string

http1IdleTimeout defines the timeout before an unused connection is closed. If unset, this defaults to 10 minutes.

http1MaxHeaders integer

http1MaxHeaders defines the maximum number of headers that are allowed in HTTP/1.1 requests. If unset, this defaults to 100.

format: int32

minimum: 1

maximum: 4096

http2ConnectionWindowSize integer

http2ConnectionWindowSize indicates the initial window size for connection-level flow control for received data.

format: int32

minimum: 1

http2FrameSize integer

http2FrameSize sets the maximum frame size to use. If unset, this defaults to 16kb

format: int32

minimum: 16384

maximum: 1.677215e+06

http2KeepaliveInterval string

http2KeepaliveTimeout string

http2WindowSize integer

http2WindowSize indicates the initial window size for stream-level flow control for received data.

format: int32

minimum: 1

maxBufferSize integer

maxBufferSize defines the maximum size HTTP body that will be buffered into memory. Bodies will only be buffered for policies which require buffering. If unset, this defaults to 2mb.

format: int32

minimum: 1

tcp object

tcp defines settings on managing incoming TCP connections.

keepalive object

keepalive defines settings for enabling TCP keepalives on the connection.

interval string

interval specifies the number of seconds between keep-alive probes. If unset, this defaults to 180s.

retries integer

retries specifies the maximum number of keep-alive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

time specifies the number of seconds a connection needs to be idle before keep-alive probes start being sent. If unset, this defaults to 180s.

tls object

tls defines settings on managing incoming TLS connections.

alpnProtocols []string

alpnProtocols sets the Application Level Protocol Negotiation (ALPN) value to use in the TLS handshake. If not present, defaults to ["h2", "http/1.1"].

minItems: 1

maxItems: 16

cipherSuites []string

CipherSuites configures the list of cipher suites for a TLS listener. The value is a comma-separated list of cipher suites, e.g "TLS13_AES_256_GCM_SHA384,TLS13_AES_128_GCM_SHA256". Use in the TLS options field of a TLS listener.

handshakeTimeout string

handshakeTimeout specifies the deadline for a TLS handshake to complete. If unset, this defaults to 15s.

maxProtocolVersion string

MaxTLSVersion configures the maximum TLS version to support.

enum: 1.2, 1.3

minProtocolVersion string

MinTLSVersion configures the minimum TLS version to support.

enum: 1.2, 1.3

tracing object

Tracing contains various settings for OpenTelemetry tracer.

attributes object

attributes specify customizations to the key-value pairs that are included in the trace.

add []object

add specifies additional key-value pairs to be added to each entry. The value is a CEL expression. If the CEL expression fails to evaluate, the pair will be excluded.

minItems: 1

expression string required

CELExpression represents a Common Expression Language (CEL) expression.

minLength: 1

maxLength: 16384

name string required

minLength: 1

maxLength: 256

remove []string

remove lists the default fields that should be removed. For example, "http.method".

minItems: 1

maxItems: 32

backendRef object required

backendRef references the OTLP server to reach. Supported types: Service and AgentgatewayBackend.

group string

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

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

format: int32

minimum: 1

maximum: 65535

clientSampling string

clientSampling is an expression to determine the amount of client sampling. Client sampling determines whether to initiate a new trace span if the incoming request does have a trace already. This should evaluate to a float between 0.0-1.0, or a boolean (true/false) If unspecified, client sampling is 100% enabled.

minLength: 1

maxLength: 16384

protocol string

protocol specifies the OTLP protocol variant to use.

enum: HTTP, GRPC

randomSampling string

randomSampling is an expression to determine the amount of random sampling. Random sampling will initiate a new trace span if the incoming request does not have a trace initiated already. This should evaluate to a float between 0.0-1.0, or a boolean (true/false) If unspecified, random sampling is disabled.

minLength: 1

maxLength: 16384

resources []object

resources describe the entity producing telemetry and specify the resources to be included in the trace.

expression string required

CELExpression represents a Common Expression Language (CEL) expression.

minLength: 1

maxLength: 16384

name string required

minLength: 1

maxLength: 256

targetRefs []object

targetRefs specifies the target resources by reference to attach the policy to.

minItems: 1

maxItems: 16

group string required

The API group of the target resource. For Kubernetes Gateway API resources, the group is `gateway.networking.k8s.io`.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string required

The API kind of the target resource, such as Gateway or HTTPRoute.

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

The name of the target resource.

minLength: 1

maxLength: 253

sectionName string

The section name of the target resource.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

targetSelectors []object

targetSelectors specifies the target selectors to select resources to attach the policy to.

minItems: 1

maxItems: 16

group string required

The API group of the target resource. For Kubernetes Gateway API resources, the group is `gateway.networking.k8s.io`.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string required

The API kind of the target resource, such as Gateway or HTTPRoute.

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

matchLabels object required

Label selector to select the target resource.

sectionName string

The section name of the target resource.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

traffic object

traffic defines settings for how process traffic. A traffic policy can target a Gateway (optionally, with a sectionName indicating the listener), ListenerSet, Route (optionally, with a sectionName indicating the route rule). When multiple policies are selected for a given request, they are merged on a field-level basis, but not a deep merge. Precedence is given to more precise policies: Gateway < Listener < Route < Route Rule. For example, policy A sets 'timeouts' and 'retries', and policy B sets 'retries', the effective policy would be 'timeouts' from policy A, and 'retries' from policy B.

apiKeyAuthentication object

apiKeyAuthentication authenticates users based on a configured API Key.

mode string

Validation mode for api key authentication.

enum: Strict, Optional

secretRef object

secretRef references a Kubernetes secret storing a set of API Keys. If there are many keys, 'secretSelector' can be used instead. Each entry in the Secret represents one API Key. The key is an arbitrary identifier. The value can either be: * A string, representing the API Key. * A JSON object, with two fields, `key` and `metadata`. `key` contains the API Key. `metadata` contains arbitrary JSON metadata associated with the key, which may be used by other policies. For example, you may write an authorization policy allow `apiKey.group == 'sales'`. Example: apiVersion: v1 kind: Secret metadata: name: api-key stringData: client1: | { "key": "k-123", "metadata": { "group": "sales", "created_at": "2024-10-01T12:00:00Z", } } client2: "k-456"

name string

secretSelector object

secretSelector selects multiple secrets containing API Keys. If the same key is defined in multiple secrets, the behavior is undefined. Each entry in the Secret represents one API Key. The key is an arbitrary identifier. The value can either be: * A string, representing the API Key. * A JSON object, with two fields, `key` and `metadata`. `key` contains the API Key. `metadata` contains arbitrary JSON metadata associated with the key, which may be used by other policies. For example, you may write an authorization policy allow `apiKey.group == 'sales'`. Example: apiVersion: v1 kind: Secret metadata: name: api-key stringData: client1: | { "key": "k-123", "metadata": { "group": "sales", "created_at": "2024-10-01T12:00:00Z", } } client2: "k-456"

matchLabels object required

Label selector to select the target resource.

authorization object

authorization specifies the access rules based on roles and permissions. If multiple authorization rules are applied across different policies (at the same, or different, attahcment points), all rules are merged.

action string

Action defines whether the rule allows or denies the request if matched. If unspecified, the default is "Allow".

enum: Allow, Deny

policy object required

Policy specifies the Authorization rule to evaluate. A policy matches when **any** of the conditions evaluates to true.

matchExpressions []string required

MatchExpressions defines a set of conditions that must be satisfied for the rule to match. These expression should be in the form of a Common Expression Language (CEL) expression.

minItems: 1

maxItems: 256

basicAuthentication object

basicAuthentication authenticates users based on the "Basic" authentication scheme (RFC 7617), where a username and password are encoded in the request.

mode string

validation mode for basic auth authentication.

enum: Strict, Optional

realm string

realm specifies the 'realm' to return in the WWW-Authenticate header for failed authentication requests. If unset, "Restricted" will be used.

secretRef object

secretRef references a Kubernetes secret storing the .htaccess file. The Secret must have a key named '.htaccess', and should contain the complete .htaccess file. Note: passwords should be the hash of the password, not the raw password. Use the `htpasswd` or similar commands to generate a hash. MD5, bcrypt, crypt, and SHA-1 are supported. Example: apiVersion: v1 kind: Secret metadata: name: basic-auth stringData: .htaccess: | alice:$apr1$3zSE0Abt$IuETi4l5yO87MuOrbSE4V. bob:$apr1$Ukb5LgRD$EPY2lIfY.A54jzLELNIId/

name string

users []string

users provides an inline list of username/password pairs that will be accepted. Each entry represents one line of the htpasswd format: https://httpd.apache.org/docs/2.4/programs/htpasswd.html. Note: passwords should be the hash of the password, not the raw password. Use the `htpasswd` or similar commands to generate a hash. MD5, bcrypt, crypt, and SHA-1 are supported. Example: users: - "user1:$apr1$ivPt0D4C$DmRhnewfHRSrb3DQC.WHC." - "user2:$2y$05$r3J4d3VepzFkedkd/q1vI.pBYIpSqjfN0qOARV3ScUHysatnS0cL2"

minItems: 1

maxItems: 256

cors object

cors specifies the CORS configuration for the policy.

allowCredentials boolean

AllowCredentials indicates whether the actual cross-origin request allows to include credentials. When set to true, the gateway will include the `Access-Control-Allow-Credentials` response header with value true (case-sensitive). When set to false or omitted the gateway will omit the header `Access-Control-Allow-Credentials` entirely (this is the standard CORS behavior). Support: Extended

allowHeaders []string

AllowHeaders indicates which HTTP request headers are supported for accessing the requested resource. Header names are not case sensitive. Multiple header names in the value of the `Access-Control-Allow-Headers` response header are separated by a comma (","). When the `AllowHeaders` field is configured with one or more headers, the gateway must return the `Access-Control-Allow-Headers` response header which value is present in the `AllowHeaders` field. If any header name in the `Access-Control-Request-Headers` request header is not included in the list of header names specified by the response header `Access-Control-Allow-Headers`, it will present an error on the client side. If any header name in the `Access-Control-Allow-Headers` response header does not recognize by the client, it will also occur an error on the client side. A wildcard indicates that the requests with all HTTP headers are allowed. The `Access-Control-Allow-Headers` response header can only use `*` wildcard as value when the `AllowCredentials` field is false or omitted. When the `AllowCredentials` field is true and `AllowHeaders` field specified with the `*` wildcard, the gateway must specify one or more HTTP headers in the value of the `Access-Control-Allow-Headers` response header. The value of the header `Access-Control-Allow-Headers` is same as the `Access-Control-Request-Headers` header provided by the client. If the header `Access-Control-Request-Headers` is not included in the request, the gateway will omit the `Access-Control-Allow-Headers` response header, instead of specifying the `*` wildcard. A Gateway implementation may choose to add implementation-specific default headers. Support: Extended

maxItems: 64

allowMethods []string

AllowMethods indicates which HTTP methods are supported for accessing the requested resource. Valid values are any method defined by RFC9110, along with the special value `*`, which represents all HTTP methods are allowed. Method names are case sensitive, so these values are also case-sensitive. (See https://www.rfc-editor.org/rfc/rfc2616#section-5.1.1) Multiple method names in the value of the `Access-Control-Allow-Methods` response header are separated by a comma (","). A CORS-safelisted method is a method that is `GET`, `HEAD`, or `POST`. (See https://fetch.spec.whatwg.org/#cors-safelisted-method) The CORS-safelisted methods are always allowed, regardless of whether they are specified in the `AllowMethods` field. When the `AllowMethods` field is configured with one or more methods, the gateway must return the `Access-Control-Allow-Methods` response header which value is present in the `AllowMethods` field. If the HTTP method of the `Access-Control-Request-Method` request header is not included in the list of methods specified by the response header `Access-Control-Allow-Methods`, it will present an error on the client side. The `Access-Control-Allow-Methods` response header can only use `*` wildcard as value when the `AllowCredentials` field is false or omitted. When the `AllowCredentials` field is true and `AllowMethods` field specified with the `*` wildcard, the gateway must specify one HTTP method in the value of the Access-Control-Allow-Methods response header. The value of the header `Access-Control-Allow-Methods` is same as the `Access-Control-Request-Method` header provided by the client. If the header `Access-Control-Request-Method` is not included in the request, the gateway will omit the `Access-Control-Allow-Methods` response header, instead of specifying the `*` wildcard. A Gateway implementation may choose to add implementation-specific default methods. Support: Extended

maxItems: 9

allowOrigins []string

AllowOrigins indicates whether the response can be shared with requested resource from the given `Origin`. The `Origin` consists of a scheme and a host, with an optional port, and takes the form `<scheme>://<host>(:<port>)`. Valid values for scheme are: `http` and `https`. Valid values for port are any integer between 1 and 65535 (the list of available TCP/UDP ports). Note that, if not included, port `80` is assumed for `http` scheme origins, and port `443` is assumed for `https` origins. This may affect origin matching. The host part of the origin may contain the wildcard character `*`. These wildcard characters behave as follows: * `*` is a greedy match to the _left_, including any number of DNS labels to the left of its position. This also means that `*` will include any number of period `.` characters to the left of its position. * A wildcard by itself matches all hosts. An origin value that includes _only_ the `*` character indicates requests from all `Origin`s are allowed. When the `AllowOrigins` field is configured with multiple origins, it means the server supports clients from multiple origins. If the request `Origin` matches the configured allowed origins, the gateway must return the given `Origin` and sets value of the header `Access-Control-Allow-Origin` same as the `Origin` header provided by the client. The status code of a successful response to a "preflight" request is always an OK status (i.e., 204 or 200). If the request `Origin` does not match the configured allowed origins, the gateway returns 204/200 response but doesn't set the relevant cross-origin response headers. Alternatively, the gateway responds with 403 status to the "preflight" request is denied, coupled with omitting the CORS headers. The cross-origin request fails on the client side. Therefore, the client doesn't attempt the actual cross-origin request. The `Access-Control-Allow-Origin` response header can only use `*` wildcard as value when the `AllowCredentials` field is false or omitted. When the `AllowCredentials` field is true and `AllowOrigins` field specified with the `*` wildcard, the gateway must return a single origin in the value of the `Access-Control-Allow-Origin` response header, instead of specifying the `*` wildcard. The value of the header `Access-Control-Allow-Origin` is same as the `Origin` header provided by the client. Support: Extended

maxItems: 64

exposeHeaders []string

ExposeHeaders indicates which HTTP response headers can be exposed to client-side scripts in response to a cross-origin request. A CORS-safelisted response header is an HTTP header in a CORS response that it is considered safe to expose to the client scripts. The CORS-safelisted response headers include the following headers: `Cache-Control` `Content-Language` `Content-Length` `Content-Type` `Expires` `Last-Modified` `Pragma` (See https://fetch.spec.whatwg.org/#cors-safelisted-response-header-name) The CORS-safelisted response headers are exposed to client by default. When an HTTP header name is specified using the `ExposeHeaders` field, this additional header will be exposed as part of the response to the client. Header names are not case sensitive. Multiple header names in the value of the `Access-Control-Expose-Headers` response header are separated by a comma (","). A wildcard indicates that the responses with all HTTP headers are exposed to clients. The `Access-Control-Expose-Headers` response header can only use `*` wildcard as value when the `AllowCredentials` field is false or omitted. Support: Extended

maxItems: 64

maxAge integer

MaxAge indicates the duration (in seconds) for the client to cache the results of a "preflight" request. The information provided by the `Access-Control-Allow-Methods` and `Access-Control-Allow-Headers` response headers can be cached by the client until the time specified by `Access-Control-Max-Age` elapses. The default value of `Access-Control-Max-Age` response header is 5 (seconds).

format: int32

minimum: 1

csrf object

csrf specifies the Cross-Site Request Forgery (CSRF) policy for this traffic policy. The CSRF policy has the following behavior: * Safe methods (GET, HEAD, OPTIONS) are automatically allowed * Requests without Sec-Fetch-Site or Origin headers are assumed to be same-origin or non-browser requests and are allowed. * Otherwise, the Sec-Fetch-Site header is checked, with a fallback to comparing the Origin header to the Host header.

additionalOrigins []string

additionalOrigin specifies additional source origins that will be allowed in addition to the destination origin. The `Origin` consists of a scheme and a host, with an optional port, and takes the form `<scheme>://<host>(:<port>)`.

minItems: 1

maxItems: 16

directResponse object

direct response configures the policy to send a direct response to the client.

body string

Body defines the content to be returned in the HTTP response body. The maximum length of the body is restricted to prevent excessively large responses. If this field is omitted, no body is included in the response.

minLength: 1

maxLength: 4096

status integer required

StatusCode defines the HTTP status code to return for this route.

format: int32

minimum: 200

maximum: 599

extAuth object

extAuth specifies the external authentication configuration for the policy. This controls what external server to send requests to for authentication.

backendRef object required

backendRef references the External Authorization server to reach. Supported types: Service and Backend.

group string

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

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

format: int32

minimum: 1

maximum: 65535

forwardBody object

forwardBody configures whether to include the HTTP body in the request. If enabled, the request body will be buffered.

maxSize integer required

maxSize specifies how large in bytes the largest body that will be buffered and sent to the authorization server. If the body size is larger than maxSize, then the request will be rejected with a response.

format: int32

minimum: 1

grpc object

grpc specifies that the gRPC External Authorization [protocol](https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/auth/v3/external_auth.proto) should be used.

contextExtensions object

contextExtensions specifies additional arbitrary key-value pairs to send to the authorization server in the `context_extensions` field.

requestMetadata object

requestMetadata specifies metadata to be sent *to* the authorization server. This maps to the `metadata_context.filter_metadata` field of the request, and allows dynamic CEL expressions. If unset, by default the `envoy.filters.http.jwt_authn` key is set if the JWT policy is used as well, for compatibility.

http object

http specifies that the HTTP protocol should be used for connecting to the authorization server. The authorization server must return a `200` status code, otherwise the request is considered an authorization failure.

addRequestHeaders object

addRequestHeaders specifies what additional headers to add to the request to the authorization server. While allowedRequestHeaders just passes the original headers through, addRequestHeaders allows defining custom headers based on CEL Expressions.

allowedRequestHeaders []string

allowedRequestHeaders specifies what additional headers from the client request will be sent to the authorization server. If unset, the following headers are sent by default: `Authorization`.

maxItems: 64

allowedResponseHeaders []string

allowedResponseHeaders specifies what headers from the authorization response will be copied into the request to the backend.

maxItems: 64

path string

path specifies the path to send to the authorization server. If unset, this defaults to the original request path. This is a CEL expression, which allows customizing the path based on the incoming request. For example, to add a prefix: `path: '"/prefix/" + request.path'`.

minLength: 1

maxLength: 16384

redirect string

redirect defines an optional expression to determine a path to redirect to on authorization failure. This is useful to redirect to a sign-in page.

minLength: 1

maxLength: 16384

responseMetadata object

responseMetadata specifies what metadata fields should be constructed *from* the authorization response. These will be included under the `extauthz` variable in future CEL expressions. Setting this is useful to do things like logging usernames, without needing to include them as headers to the backend (as `allowedResponseHeaders` would).

extProc object

extProc specifies the external processing configuration for the policy.

backendRef object required

backendRef references the External Processor server to reach. Supported types: Service and Backend.

group string

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

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

format: int32

minimum: 1

maximum: 65535

headerModifiers object

headerModifiers defines the policy to modify request and response headers.

request object

Request modifies request headers.

add []object

Add adds the given header(s) (name, value) to the request before the action. It appends to any existing values associated with the header name. Input: GET /foo HTTP/1.1 my-header: foo Config: add: - name: "my-header" value: "bar,baz" Output: GET /foo HTTP/1.1 my-header: foo,bar,baz

maxItems: 16

name string required

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

Value is the value of HTTP Header to be matched.

minLength: 1

maxLength: 4096

remove []string

Remove the given header(s) from the HTTP request before the action. The value of Remove is a list of HTTP header names. Note that the header names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2). Input: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz Config: remove: ["my-header1", "my-header3"] Output: GET /foo HTTP/1.1 my-header2: bar

maxItems: 16

set []object

Set overwrites the request with the given header (name, value) before the action. Input: GET /foo HTTP/1.1 my-header: foo Config: set: - name: "my-header" value: "bar" Output: GET /foo HTTP/1.1 my-header: bar

maxItems: 16

name string required

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

Value is the value of HTTP Header to be matched.

minLength: 1

maxLength: 4096

response object

Response modifies response headers.

add []object

maxItems: 16

name string required

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

Value is the value of HTTP Header to be matched.

minLength: 1

maxLength: 4096

remove []string

maxItems: 16

set []object

maxItems: 16

name string required

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

Value is the value of HTTP Header to be matched.

minLength: 1

maxLength: 4096

hostRewrite object

hostRewrite specifies how to rewrite the Host header for requests. If the HTTPRoute `urlRewrite` filter already specifies a host rewrite, this setting is ignored.

enum: Auto, None

mode string required

mode sets the hostname rewrite mode. The following may be specified: * Auto: automatically set the Host header based on the destination. * None: do not rewrite the Host header. The original Host header will be passed through. This setting defaults to Auto when connecting to hostname-based Backend types, and None otherwise (for Service or IP-based Backends).

jwtAuthentication object

jwtAuthentication authenticates users based on JWT tokens.

mode string

validation mode for JWT authentication.

enum: Strict, Optional, Permissive

providers []object required

minItems: 1

maxItems: 64

audiences []string

audiences specifies the list of allowed audiences that are allowed access. This corresponds to the 'aud' claim (https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.3). If unset, any audience is allowed.

minItems: 1

maxItems: 64

issuer string required

issuer identifies the IdP that issued the JWT. This corresponds to the 'iss' claim (https://tools.ietf.org/html/rfc7519#section-4.1.1).

minLength: 1

maxLength: 256

jwks object required

jwks defines the JSON Web Key Set used to validate the signature of the JWT.

inline string

inline specifies an inline JSON Web Key Set used validate the signature of the JWT.

minLength: 2

maxLength: 65536

remote object

remote specifies how to reach the JSON Web Key Set from a remote address.

backendRef object required

group string

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

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

format: int32

minimum: 1

maximum: 65535

cacheDuration string

jwksPath string required

Path to IdP jwks endpoint, relative to the root, commonly ".well-known/jwks.json".

minLength: 1

maxLength: 2000

phase string

The phase to apply the traffic policy to. If the phase is PreRouting, the targetRef must be a Gateway or a Listener. PreRouting is typically used only when a policy needs to influence the routing decision. Even when using PostRouting mode, the policy can target the Gateway/Listener. This is a helper for applying the policy to all routes under that Gateway/Listener, and follows the merging logic described above. Note: PreRouting and PostRouting rules do not merge together. These are independent execution phases. That is, all PreRouting rules will merge and execute, then all PostRouting rules will merge and execute. If unset, this defaults to PostRouting.

enum: PreRouting, PostRouting

rateLimit object

rateLimit specifies the rate limiting configuration for the policy. This controls the rate at which requests are allowed to be processed.

global object

Global defines a global rate limiting policy using an external service.

backendRef object required

backendRef references the Rate Limit server to reach. Supported types: Service and Backend.

group string

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

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

format: int32

minimum: 1

maximum: 65535

descriptors []object required

Descriptors define the dimensions for rate limiting. These values are passed to the rate limit service which applies configured limits based on them. Each descriptor represents a single rate limit rule with one or more entries.

minItems: 1

maxItems: 16

entries []object required

entries are the individual components that make up this descriptor.

minItems: 1

maxItems: 16

expression string required

expression is a Common Expression Language (CEL) expression that defines the value for the descriptor. For example, to rate limit based on the Client IP: `source.address`. See https://agentgateway.dev/docs/reference/cel/ for more info.

minLength: 1

maxLength: 16384

name string required

name specifies the name of the descriptor.

minLength: 1

maxLength: 64

unit string

unit defines what to use as the cost function. If unspecified, Requests is used.

enum: Requests, Tokens

domain string required

domain specifies the domain under which this limit should apply. This is an arbitrary string that enables a rate limit server to distinguish between different applications.

minLength: 1

maxLength: 256

local []object

Local defines a local rate limiting policy.

minItems: 1

maxItems: 16

burst integer

burst specifies an allowance of requests above the request-per-unit that should be allowed within a short period of time.

format: int32

requests integer

requests specifies the number of HTTP requests per unit of time that are allowed. Requests exceeding this limit will fail with a 429 error.

format: int32

minimum: 1

tokens integer

tokens specifies the number of LLM tokens per unit of time that are allowed. Requests exceeding this limit will fail with a 429 error. Both input and output tokens are counted. However, token counts are not known until the request completes. As a result, token-based rate limits will apply to future requests only.

format: int32

minimum: 1

unit string required

unit specifies the unit of time that requests are limited based on.

enum: Seconds, Minutes, Hours

retry object

retry defines the policy for retrying requests.

attempts integer

Attempts specifies the maximum number of times an individual request from the gateway to a backend should be retried. If the maximum number of retries has been attempted without a successful response from the backend, the Gateway MUST return an error. When this field is unspecified, the number of times to attempt to retry a backend request is implementation-specific. Support: Extended

backoff string

Backoff specifies the minimum duration a Gateway should wait between retry attempts and is represented in Gateway API Duration formatting. For example, setting the `rules[].retry.backoff` field to the value `100ms` will cause a backend request to first be retried approximately 100 milliseconds after timing out or receiving a response code configured to be retryable. An implementation MAY use an exponential or alternative backoff strategy for subsequent retry attempts, MAY cap the maximum backoff duration to some amount greater than the specified minimum, and MAY add arbitrary jitter to stagger requests, as long as unsuccessful backend requests are not retried before the configured minimum duration. If a Request timeout (`rules[].timeouts.request`) is configured on the route, the entire duration of the initial request and any retry attempts MUST not exceed the Request timeout duration. If any retry attempts are still in progress when the Request timeout duration has been reached, these SHOULD be canceled if possible and the Gateway MUST immediately return a timeout error. If a BackendRequest timeout (`rules[].timeouts.backendRequest`) is configured on the route, any retry attempts which reach the configured BackendRequest timeout duration without a response SHOULD be canceled if possible and the Gateway should wait for at least the specified backoff duration before attempting to retry the backend request again. If a BackendRequest timeout is _not_ configured on the route, retry attempts MAY time out after an implementation default duration, or MAY remain pending until a configured Request timeout or implementation default duration for total request time is reached. When this field is unspecified, the time to wait between retry attempts is implementation-specific. Support: Extended

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

codes []integer

Codes defines the HTTP response status codes for which a backend request should be retried. Support: Extended

timeouts object

timeouts defines the timeouts for requests It is applicable to HTTPRoutes and ignored for other targeted kinds.

request string

request specifies a timeout for an individual request from the gateway to a backend. This covers the time from when the request first starts being sent from the gateway to when the full response has been received from the backend.

transformation object

transformation is used to mutate and transform requests and responses before forwarding them to the destination.

request object

request is used to modify the request path.

add []object

add is a list of headers to add to the request and what that value should be set to. If there is already a header with these values then append the value as an extra entry.

minItems: 1

maxItems: 16

name string required

the name of the header to add.

pattern: ^:?[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

value is the CEL expression to apply to generate the output value for the header.

minLength: 1

maxLength: 16384

body string

body controls manipulation of the HTTP body.

minLength: 1

maxLength: 16384

remove []string

Remove is a list of header names to remove from the request/response.

minItems: 1

maxItems: 16

set []object

set is a list of headers and the value they should be set to.

minItems: 1

maxItems: 16

name string required

the name of the header to add.

pattern: ^:?[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

value is the CEL expression to apply to generate the output value for the header.

minLength: 1

maxLength: 16384

response object

response is used to modify the response path.

add []object

add is a list of headers to add to the request and what that value should be set to. If there is already a header with these values then append the value as an extra entry.

minItems: 1

maxItems: 16

name string required

the name of the header to add.

pattern: ^:?[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

value is the CEL expression to apply to generate the output value for the header.

minLength: 1

maxLength: 16384

body string

body controls manipulation of the HTTP body.

minLength: 1

maxLength: 16384

remove []string

Remove is a list of header names to remove from the request/response.

minItems: 1

maxItems: 16

set []object

set is a list of headers and the value they should be set to.

minItems: 1

maxItems: 16

name string required

the name of the header to add.

pattern: ^:?[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

value is the CEL expression to apply to generate the output value for the header.

minLength: 1

maxLength: 16384

status object

status defines the current state of AgentgatewayPolicy.

ancestors []object required

Ancestors is a list of ancestor resources (usually Gateways) that are associated with the policy, and the status of the policy with respect to each ancestor. When this policy attaches to a parent, the controller that manages the parent and the ancestors MUST add an entry to this list when the controller first sees the policy and SHOULD update the entry as appropriate when the relevant ancestor is modified. Note that choosing the relevant ancestor is left to the Policy designers; an important part of Policy design is designing the right object level at which to namespace this status. Note also that implementations MUST ONLY populate ancestor status for the Ancestor resources they are responsible for. Implementations MUST use the ControllerName field to uniquely identify the entries in this list that they are responsible for. Note that to achieve this, the list of PolicyAncestorStatus structs MUST be treated as a map with a composite key, made up of the AncestorRef and ControllerName fields combined. A maximum of 16 ancestors will be represented in this list. An empty list means the Policy is not relevant for any ancestors. If this slice is full, implementations MUST NOT add further entries. Instead they MUST consider the policy unimplementable and signal that on any related resources such as the ancestor that would be referenced here. For example, if this list was full on BackendTLSPolicy, no additional Gateways would be able to reference the Service targeted by the BackendTLSPolicy.

maxItems: 16

ancestorRef object required

AncestorRef corresponds with a ParentRef in the spec that this PolicyAncestorStatus struct describes the status of.

group string

Group is the group of the referent. When unspecified, "gateway.networking.k8s.io" is inferred. To set the core API group (such as for a "Service" kind referent), Group must be explicitly set to "" (empty string). Support: Core

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kind is kind of the referent. There are two kinds of parent resources with "Core" support: * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, ClusterIP Services only) Support for other resources is Implementation-Specific.

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent. Support: Core

minLength: 1

maxLength: 253

namespace string

Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. <gateway:experimental:description> ParentRefs from a Route to a Service in the same namespace are "producer" routes, which apply default routing rules to inbound connections from any namespace to the Service. ParentRefs from a Route to a Service in a different namespace are "consumer" routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route. </gateway:experimental:description> Support: Core

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set `Port` unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. <gateway:experimental:description> When the parent resource is a Service, this targets a specific port in the Service spec. When both Port (experimental) and SectionName are specified, the name and port of the selected port must match both specified values. </gateway:experimental:description> Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Extended

format: int32

minimum: 1

maximum: 65535

sectionName string

SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: * Gateway: Listener name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. * Service: Port name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Core

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

conditions []object required

Conditions describes the status of the Policy with respect to the given Ancestor. <gateway:util:excludeFromCRD> Notes for implementors: Conditions are a listType `map`, which means that they function like a map with a key of the `type` field _in the k8s apiserver_. This means that implementations must obey some rules when updating this section. * Implementations MUST perform a read-modify-write cycle on this field before modifying it. That is, when modifying this field, implementations must be confident they have fetched the most recent version of this field, and ensure that changes they make are on that recent version. * Implementations MUST NOT remove or reorder Conditions that they are not directly responsible for. For example, if an implementation sees a Condition with type `special.io/SomeField`, it MUST NOT remove, change or update that Condition. * Implementations MUST always _merge_ changes into Conditions of the same Type, rather than creating more than one Condition of the same Type. * Implementations MUST always update the `observedGeneration` field of the Condition to the `metadata.generation` of the Gateway at the time of update creation. * If the `observedGeneration` of a Condition is _greater than_ the value the implementation knows about, then it MUST NOT perform the update on that Condition, but must wait for a future reconciliation and status update. (The assumption is that the implementation's copy of the object is stale and an update will be re-triggered if relevant.) </gateway:util:excludeFromCRD>

minItems: 1

maxItems: 8

lastTransitionTime string required

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

format: date-time

message string required

message is a human readable message indicating details about the transition. This may be an empty string.

maxLength: 32768

observedGeneration integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

format: int64

minimum: 0

reason string required

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

minLength: 1

maxLength: 1024

status string required

status of the condition, one of True, False, Unknown.

enum: True, False, Unknown

type string required

type of condition in CamelCase or in foo.example.com/CamelCase.

pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

maxLength: 316

controllerName string required

ControllerName is a domain/path string that indicates the name of the controller that wrote this status. This corresponds with the controllerName field on GatewayClass. Example: "example.net/gateway-controller". The format of this field is DOMAIN "/" PATH, where DOMAIN and PATH are valid Kubernetes names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). Controllers MUST populate this field when writing status. Controllers should ensure that entries to status populated with their ControllerName are cleaned up when they are no longer necessary.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$

minLength: 1

maxLength: 253

No matches. Try .spec.backend for an exact path