Skip to search

AgentgatewayModel

agentgateway.dev / v1alpha1

apiVersion: agentgateway.dev/v1alpha1 kind: AgentgatewayModel metadata: name: example
View raw schema
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
Desired model configuration.
azure object
Provider-specific settings for Azure AI.
apiVersion string
The version of the Azure OpenAI API to use. If unset, defaults to `v1`.
minLength: 1
maxLength: 64
projectName string
The Foundry project name, required when `resourceType` is `Foundry`. Used to construct paths: /api/projects/{projectName}/openai/v1/...
minLength: 1
maxLength: 256
resourceName string required
The Azure resource name used to construct the endpoint host. For OpenAI: {resourceName}.openai.azure.com For Foundry: {resourceName}.services.ai.azure.com Note: when the Azure portal "Foundry legacy" template was used, the generated resource name may end in "-resource" (e.g. "myproject-resource"); that suffix is part of the resource name as the user configured it, not part of the hostname suffix agentgateway should append.
minLength: 1
maxLength: 256
resourceType string required
The type of Azure endpoint. Determines the host suffix.
enum: Foundry, OpenAI
baseURL string
BaseURL overrides the provider address and base path prefix. It must use the http or https scheme. Backend policies may override the default TLS configuration. Query parameters, fragments, and user info are not supported.
format: uri
minLength: 1
maxLength: 1024
bedrock object
Provider-specific settings for Amazon Bedrock.
guardrail object
Guardrail policy to use for the backend. See <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html>. If not specified, the AWS Guardrail policy will not be used.
identifier string required
Identifier of the Guardrail policy to use for the backend.
minLength: 1
maxLength: 256
version string required
Version of the Guardrail policy to use for the backend.
minLength: 1
maxLength: 256
region string
AWS region to use for the backend. Defaults to `us-east-1` if not specified.
pattern: ^[a-z0-9-]+$
minLength: 1
maxLength: 63
custom object
Provider-specific settings for a custom provider.
backendRef object
Kubernetes backend that serves this provider. `backendRef` may target only a namespace-local Service or InferencePool. If unset, host and port must be set on the parent provider.
group string
API group of the referenced resource. 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 of the referenced resource. For example, `Service`. Defaults to "Service" when not specified.
pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
minLength: 1
maxLength: 63
name string required
Name of the referenced resource.
minLength: 1
maxLength: 253
port integer
Destination port number to use for this resource. Required when the referenced resource is a Kubernetes Service.
format: int32
minimum: 1
maximum: 65535
formats []object required
Provider-native API formats this provider supports.
minItems: 1
maxItems: 6
path string
Default upstream path override for this format. If unset, agentgateway uses the default path for the format.
minLength: 1
maxLength: 1024
type string required
Provider-native API format.
enum: AnthropicTokenCount, Completions, Embeddings, Messages, Realtime, Rerank, Responses
match object
Conditions for selecting this model from client requests.
model string
Model name matched against client requests. It may be exact, a suffix wildcard such as `gpt-*`, a prefix wildcard such as `*-latest`, or `*`. When omitted, the model matches metadata.name exactly.
minLength: 1
maxLength: 1024
parentRefs []object required
Gateways and listeners to which this model attaches.
minItems: 1
maxItems: 16
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 of the referent. Defaults to the Route's local namespace. Cross-namespace references must be explicitly allowed, for example via ReferenceGrant. Support: Core
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
minLength: 1
maxLength: 63
port integer
Port this Route targets on the parent, interpreted per parent kind (for example a Gateway listener port or Service port). Support: Extended
format: int32
minimum: 1
maximum: 65535
sectionName string
Name of a section within the target resource, for example a Gateway Listener name or Service port name. Empty references the entire resource. 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
policies object
Policies applied to this concrete model.
auth object
Credentials used to authenticate requests to this model provider.
aws object
Explicit AWS authentication method for the model provider. When omitted, default AWS SDK credential discovery is used.
assumeRole object
AWS STS AssumeRole settings to use before signing backend requests. Ambient AWS credentials are used as the source credentials for STS.
roleArn string required
AWS IAM role ARN to assume.
pattern: ^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$
minLength: 1
sessionName string
SessionName is a custom session name (RoleSessionName) for CloudTrail and Cost & Usage Report attribution. If unset, AWS generates a random name.
pattern: ^[\w+=,.@-]{2,64}$
sessionNameExpression string
SessionNameExpression is a CEL expression evaluated against each request to produce the session name (RoleSessionName), for example `jwt.sub` or `request.headers["x-team"]`. If the expression does not produce a valid session name at request time, the request is rejected.
minLength: 1
maxLength: 16384
tags []object
Session tags passed to STS AssumeRole for cost attribution in the AWS Cost & Usage Report, once activated. STS allows at most 50 per role session.
maxItems: 50
expression string
CEL expression evaluated against each request to produce the tag value, for example `jwt.sub` or `request.headers["x-app"]`. Requests with invalid tag values are rejected.
minLength: 1
maxLength: 16384
key string required
Key is the tag key.
minLength: 1
maxLength: 128
value string
Value is a static tag value.
maxLength: 256
region string
AWS SigV4 signing region, for example `us-east-1`. Set this when the target AWS service is in a different region than the gateway. If unset, typed AWS backends may provide this automatically; otherwise the ambient AWS region is used.
minLength: 1
maxLength: 256
secretRef object
Credential source for AWS credentials, defaulting to a Kubernetes `Secret`. The default Secret resolver expects `accessKey`, `secretKey`, and optional `sessionToken` keys.
group string
API group of the referenced credential; empty selects the core API group
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
serviceName string
AWS SigV4 signing service name, for example `bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS backends may provide this automatically.
minLength: 1
maxLength: 256
azure object
Azure authentication method for the model provider.
managedIdentity object
Managed identity authentication settings.
clientId string required
objectId string required
resourceId string required
secretRef object
Credential source for Azure credentials, defaulting to a Kubernetes `Secret`. The default Secret resolver expects `clientID`, `tenantID`, and `clientSecret` keys.
group string
API group of the referenced credential; empty selects the core API group
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
workloadIdentity object
Workload identity authentication settings. Uses the federated token and Azure env vars projected into the data plane pod. Recommended on AKS with Workload Identity enabled.
credentials []object
Credentials is a list of additional credentials to inject on the backend request. Each entry resolves a Secret key and writes its value to the entry's location. `credentials` is independent of the primary `key`/`secretRef`/`passthrough` mechanism and may be set on its own or alongside it.
minItems: 1
maxItems: 8
location object required
Where the credential is inserted on the backend request.
cookie object
name string required
minLength: 1
maxLength: 256
header object
name string required
Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
minLength: 1
maxLength: 256
prefix string
minLength: 1
maxLength: 256
queryParameter object
name string required
minLength: 1
maxLength: 256
secretRef object required
SecretRef references a Kubernetes Secret holding the credential value, and optionally overrides the key read from it. Defaults to `Authorization`, matching the key convention used by the top-level `secretRef`.
group string
API group of the referenced credential; empty selects the core API group
key string
Key in the referenced Secret. If omitted, a location-specific default is used
minLength: 1
maxLength: 253
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
gcp object
Google authentication method for the model provider. When omitted, default Google credential discovery is used.
audience string
Explicit `aud` value for the ID token. Only valid with `IdToken` type. If not set, the `aud` is automatically derived from the backend hostname.
minLength: 1
maxLength: 256
secretRef object
Credential source for ADC-compatible Google credential JSON, defaulting to a Kubernetes `Secret`. By default, the value is read from `credentials.json`; set `secretRef.key` to override it. When omitted, ambient credentials are used.
group string
API group of the referenced credential; empty selects the core API group
key string
Key in the referenced Secret. If omitted, a location-specific default is used
minLength: 1
maxLength: 253
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
type string
The type of token to generate. To authenticate to GCP services, generally an `AccessToken` is used. To authenticate to Cloud Run, an `IdToken` is used.
enum: AccessToken, IdToken
key string
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
location object
Where backend credentials are inserted. If omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix. This applies to `key`, `secretRef`, and `passthrough`. Entries in `credentials` carry their own location.
cookie object
name string required
minLength: 1
maxLength: 256
header object
name string required
Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
minLength: 1
maxLength: 256
prefix string
minLength: 1
maxLength: 256
queryParameter object
name string required
minLength: 1
maxLength: 256
oauthTokenExchange object
OAuth 2.0 token exchange (RFC 8693) / jwt-bearer (RFC 7523) authentication.
actorToken object
RFC 8693 delegation actor token. TokenExchange grant only.
mayAct string
may_act claim validation mode. When omitted, may_act is not enforced.
enum: Required
source object required
Where to read the actor token. Actor tokens have no default source.
cookie object
name string required
minLength: 1
maxLength: 256
expression string
CEL expression that extracts the credential from the request.
minLength: 1
maxLength: 16384
header object
name string required
Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
minLength: 1
maxLength: 256
prefix string
minLength: 1
maxLength: 256
queryParameter object
name string required
minLength: 1
maxLength: 256
tokenType string
OAuth token type. Empty defaults to AccessToken. Custom absolute URI values are supported for actor tokens.
additionalParams object
Extra form params; values are CEL expressions over the incoming request.
audiences []string
Audiences sent to the token endpoint.
minItems: 1
maxItems: 64
backendRef object required
RFC 8693 token endpoint backend.
group string
Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
maxLength: 253
kind string
Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`
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 of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
minLength: 1
maxLength: 63
port integer
Destination port number. Required when the referent is a Kubernetes `Service`
format: int32
minimum: 1
maximum: 65535
cache object
Response cache configuration.
inMemory object
defaultTtl string
TTL used when the token endpoint omits expires_in. Default 300s.
maxEntries integer
Default 8192; 0 disables the cache.
format: int32
clientAuth object
Client authentication for the token endpoint. When unset, none is sent.
clientId string required
Client ID sent to the token endpoint.
minLength: 1
method string
Client authentication method. Defaults to ClientSecretBasic.
enum: ClientSecretBasic, ClientSecretPost, PrivateKeyJwt
privateKeyJwt object
Client assertion settings. Required when method is PrivateKeyJwt.
alg string
JWS signing algorithm. Defaults to RS256.
enum: ES256, ES384, PS256, RS256, RS384, RS512
assertionAudience string required
Audience for the client assertion, typically the token endpoint URL.
minLength: 1
certificateHeader string
JWS certificate header. Required when certificateRef is set.
enum: x5c, x5t#S256
certificateRef object
PEM-encoded X.509 certificate chain, leaf first, for certificateHeader. The leaf public key should match signingKeyRef; a mismatch only logs a warning but the token endpoint will reject the assertions. Required when certificateHeader is set. The key defaults to `certificate`.
group string
API group of the referenced credential; empty selects the core API group
key string
Key in the referenced Secret. If omitted, a location-specific default is used
minLength: 1
maxLength: 253
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
kid string
Optional JWS key ID header.
signingKeyRef object required
PEM-encoded RSA or EC private key; key defaults to `signingKey`.
group string
API group of the referenced credential; empty selects the core API group
key string
Key in the referenced Secret. If omitted, a location-specific default is used
minLength: 1
maxLength: 253
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
secretRef object
Secret providing the `clientSecret` key by default; override via `secretRef.key`. When omitted, client_id is sent without a secret, which is only valid with ClientSecretPost.
group string
API group of the referenced credential; empty selects the core API group
key string
Key in the referenced Secret. If omitted, a location-specific default is used
minLength: 1
maxLength: 253
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
grantType string
RFC followed by the request. Defaults to TokenExchange (RFC 8693).
enum: JwtBearer, TokenExchange
location object
Where the exchanged token is written to the backend request. Defaults to Authorization: Bearer.
cookie object
name string required
minLength: 1
maxLength: 256
header object
name string required
Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
minLength: 1
maxLength: 256
prefix string
minLength: 1
maxLength: 256
queryParameter object
name string required
minLength: 1
maxLength: 256
path string
Token endpoint path; defaults to "/". Must start with "/".
pattern: ^/
requestedTokenType string
RFC 8693 requested_token_type. Unlike subject/actor token types, only the built-in values may be requested; custom URIs are not supported here.
enum: AccessToken, Jwt, IdToken, IdJag
resources []string
Resources sent to the token endpoint.
minItems: 1
maxItems: 64
scopes []string
Scopes sent to the token endpoint.
minItems: 1
maxItems: 64
subjectToken object
Subject token / assertion source and type. Defaults to Authorization Bearer, AccessToken. The token type may be a built-in value or a custom absolute URI for providers that support custom token exchange profiles.
source object
Where to read the token. CEL `expression` variant is permitted.
cookie object
name string required
minLength: 1
maxLength: 256
expression string
CEL expression that extracts the credential from the request.
minLength: 1
maxLength: 16384
header object
name string required
Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
minLength: 1
maxLength: 256
prefix string
minLength: 1
maxLength: 256
queryParameter object
name string required
minLength: 1
maxLength: 256
tokenType string
OAuth token type. Empty defaults to AccessToken. Custom absolute URI values are supported for subject tokens.
passthrough object
Reuses a client token already validated by another policy. Those policies may strip client credentials; passthrough adds the original token back to the backend request. Without client auth policies, this has no effect.
secretRef object
Credential source for the authorization value, defaulting to a Kubernetes `Secret`. By default, the value is read from the `Authorization` key; set `secretRef.key` to override it. A `Bearer ` prefix is stripped only from the default `Authorization` key.
group string
API group of the referenced credential; empty selects the core API group
key string
Key in the referenced Secret. If omitted, a location-specific default is used
minLength: 1
maxLength: 253
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
authorization object
Authorization rules that clients must satisfy to use this model.
action string
The effect of this rule when it matches. If unspecified, defaults to `Allow`. `Require` rules are cumulative: all require rules must match.
enum: Allow, Deny, Require
policy object required
The authorization rule to evaluate. * `Allow`: any matching allow rule allows the request. * `Require`: every require rule must match for the request to be allowed. * `Deny`: any matching deny rule denies the request. `Deny` is not recommended because expression failures fail to deny; prefer `Allow` or `Require`. If used, design expressions defensively against evaluation errors. If at least one `Allow` rule is configured, requests are denied unless at least one allow rule matches.
matchExpressions []string required
CEL expressions that must all evaluate to true for the rule to match.
minItems: 1
maxItems: 256
headers object
Request and response header changes applied to provider traffic.
request object
Header changes to apply before forwarding a request.
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
Name of the HTTP header, case-insensitive
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
minLength: 1
maxLength: 256
value string required
Value for the HTTP header
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
Name of the HTTP header, case-insensitive
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
minLength: 1
maxLength: 256
value string required
Value for the HTTP header
minLength: 1
maxLength: 4096
response object
Header changes to apply before returning a response.
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
Name of the HTTP header, case-insensitive
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
minLength: 1
maxLength: 256
value string required
Value for the HTTP header
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
Name of the HTTP header, case-insensitive
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
minLength: 1
maxLength: 256
value string required
Value for the HTTP header
minLength: 1
maxLength: 4096
health object
Health checking and eviction behavior for this model provider.
eviction object
Settings for evicting unhealthy backends.
consecutiveFailures integer
Number of consecutive unhealthy responses required before the backend is evicted. For example, a value of 5 means the backend must receive 5 unhealthy responses in a row before being evicted. When both consecutiveFailures and healthThreshold are set, the backend is evicted when either condition is met. When neither is set, a single unhealthy response can trigger eviction.
format: int32
minimum: 0
duration string
Base time a backend should be evicted after being marked unhealthy. Subsequent evictions use multiplicative backoff (duration * times_evicted). If all endpoints are evicted, the load balancer falls back to returning evicted endpoints rather than failing entirely. If unset, defaults to `3s`.
maxLength: 32
healthThreshold integer
EWMA health score threshold, from 0 to 100. When set, a backend is evicted only if its computed health drops below this value after an unhealthy response (e.g. 50 evicts when EWMA health falls below 50%). Unlike consecutiveFailures, this sliding-window average lets a single success delay eviction. If both are set, either condition evicts; if neither, a single unhealthy response evicts.
format: int32
minimum: 0
maximum: 100
restoreHealth integer
Health score from 0 to 100 assigned to a backend when it returns from eviction. For gradual recovery, set below 100; for full recovery immediately, set 100. If unset, the backend resumes with the health it had when evicted.
format: int32
minimum: 0
maximum: 100
unhealthyCondition string
CEL expression that determines whether a response indicates an unhealthy backend. When the expression evaluates to true, the backend is considered unhealthy and may be evicted. For example, to evict on 5xx responses: `response.code >= 500`. When unset, any 5xx response, or a connection failure, is treated as unhealthy. This default lowers the backend's health score but does not trigger eviction on its own.
minLength: 1
maxLength: 16384
promptGuard object
Guardrails for requests and responses sent to this model provider.
request []object
Prompt guards to apply to requests sent by the client.
minItems: 1
maxItems: 8
bedrockGuardrails object
AWS Bedrock Guardrails settings for prompt guarding.
identifier string required
Identifier of the Guardrail policy to use for the backend.
minLength: 1
maxLength: 256
policies object
Policies for communicating with AWS Bedrock Guardrails.
auth object
Settings for authenticating to AWS Bedrock Guardrails.
aws object
AWS authentication method for Bedrock Guardrails. Use `aws: {}` for default AWS SDK credential discovery.
assumeRole object
AWS STS AssumeRole settings to use before signing backend requests. Ambient AWS credentials are used as the source credentials for STS.
roleArn string required
AWS IAM role ARN to assume.
pattern: ^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$
minLength: 1
sessionName string
SessionName is a custom session name (RoleSessionName) for CloudTrail and Cost & Usage Report attribution. If unset, AWS generates a random name.
pattern: ^[\w+=,.@-]{2,64}$
sessionNameExpression string
SessionNameExpression is a CEL expression evaluated against each request to produce the session name (RoleSessionName), for example `jwt.sub` or `request.headers["x-team"]`. If the expression does not produce a valid session name at request time, the request is rejected.
minLength: 1
maxLength: 16384
tags []object
Session tags passed to STS AssumeRole for cost attribution in the AWS Cost & Usage Report, once activated. STS allows at most 50 per role session.
maxItems: 50
expression string
CEL expression evaluated against each request to produce the tag value, for example `jwt.sub` or `request.headers["x-app"]`. Requests with invalid tag values are rejected.
minLength: 1
maxLength: 16384
key string required
Key is the tag key.
minLength: 1
maxLength: 128
value string
Value is a static tag value.
maxLength: 256
region string
AWS SigV4 signing region, for example `us-east-1`. Set this when the target AWS service is in a different region than the gateway. If unset, typed AWS backends may provide this automatically; otherwise the ambient AWS region is used.
minLength: 1
maxLength: 256
secretRef object
Credential source for AWS credentials, defaulting to a Kubernetes `Secret`. The default Secret resolver expects `accessKey`, `secretKey`, and optional `sessionToken` keys.
group string
API group of the referenced credential; empty selects the core API group
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
serviceName string
AWS SigV4 signing service name, for example `bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS backends may provide this automatically.
minLength: 1
maxLength: 256
key string
Inline API key to use as the value of the `Authorization` header. This option is the least secure; usage of a `Secret` is preferred.
maxLength: 2048
location object
Where API keys are inserted. Defaults to the `Authorization` header with the `Bearer ` prefix. Applies to `key` and `secretRef`.
cookie object
name string required
minLength: 1
maxLength: 256
header object
name string required
Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
minLength: 1
maxLength: 256
prefix string
minLength: 1
maxLength: 256
queryParameter object
name string required
minLength: 1
maxLength: 256
secretRef object
Credential source for the API key, defaulting to a Kubernetes `Secret`. By default, the value is read from the `Authorization` key; set `secretRef.key` to override it. A `Bearer ` prefix is stripped only from the default `Authorization` key.
group string
API group of the referenced credential; empty selects the core API group
key string
Key in the referenced Secret. If omitted, a location-specific default is used
minLength: 1
maxLength: 253
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
http object
Settings for managing HTTP requests to the backend
requestTimeout string
Deadline for receiving a response from the backend.
maxLength: 32
version string
HTTP protocol version for backend connections. If unset, it is inferred: `Service` appProtocol, `HTTP2` for gRPC, the original protocol for plaintext HTTP, or `HTTP1` for HTTPS because clients often upgrade HTTPS to HTTP/2 even when the backend does not support it.
enum: HTTP1, HTTP2
tcp object
Settings for managing TCP connections to the backend
connectTimeout string
Deadline for establishing a connection to the destination.
maxLength: 32
keepalive object
Settings for enabling TCP keepalives on the connection.
interval string
Time between keepalive probes. If unset, this defaults to 180s.
maxLength: 32
retries integer
Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.
format: int32
minimum: 1
maximum: 64
time string
Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.
maxLength: 32
tls object
Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.
alpnProtocols []string
Application-Layer 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
CA certificate `ConfigMap` to use to verify the server certificate. If unset, the system's trusted certificates are used.
maxItems: 1
name string
Name of the referent
insecureSkipVerify string
Originates TLS but skips verification of the backend's certificate WARNING: insecure; only use if the risks are understood Modes: * `All` disables all TLS verification * `Hostname` trusts the CA certificate but ignores hostname/SAN mismatches. Still insecure; prefer `verifySubjectAltNames` where possible.
enum: All, Hostname
keyExchangeGroups []string
Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.
mtlsCertificateRef []object
Enables mutual TLS to the backend using `tls.key` and `tls.crt` from the referenced credential source (defaulting to a Kubernetes `Secret`). An optional `ca.cert`, if present, verifies the server certificate, but `caCertificateRefs` takes priority. If unspecified, no client certificate is used.
maxItems: 1
group string
API group of the referenced credential; empty selects the core API group
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
sni string
Server Name Indicator (`SNI`) to use 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
Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.
minItems: 1
maxItems: 16
tunnel object
Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`
backendRef object required
Proxy server to reach. Supported types: `Service` and `Backend`.
group string
Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
maxLength: 253
kind string
Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`
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 of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
minLength: 1
maxLength: 63
port integer
Destination port number. Required when the referent is a Kubernetes `Service`
format: int32
minimum: 1
maximum: 65535
region string required
AWS region where the guardrail is deployed, for example `us-west-2`).
minLength: 1
maxLength: 256
version string required
Version of the Guardrail policy to use for the backend.
minLength: 1
maxLength: 256
googleModelArmor object
Google Model Armor settings for prompt guarding.
location string
Google Cloud location, for example `us-central1`. Defaults to `us-central1` if not specified.
minLength: 1
maxLength: 256
policies object
Policies for communicating with Google Model Armor.
auth object
Settings for authenticating to Google Model Armor.
gcp object
Google authentication method for Model Armor. Use `gcp: {}` for default Google credential discovery.
audience string
Explicit `aud` value for the ID token. Only valid with `IdToken` type. If not set, the `aud` is automatically derived from the backend hostname.
minLength: 1
maxLength: 256
secretRef object
Credential source for ADC-compatible Google credential JSON, defaulting to a Kubernetes `Secret`. By default, the value is read from `credentials.json`; set `secretRef.key` to override it. When omitted, ambient credentials are used.
group string
API group of the referenced credential; empty selects the core API group
key string
Key in the referenced Secret. If omitted, a location-specific default is used
minLength: 1
maxLength: 253
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
type string
The type of token to generate. To authenticate to GCP services, generally an `AccessToken` is used. To authenticate to Cloud Run, an `IdToken` is used.
enum: AccessToken, IdToken
http object
Settings for managing HTTP requests to the backend
requestTimeout string
Deadline for receiving a response from the backend.
maxLength: 32
version string
HTTP protocol version for backend connections. If unset, it is inferred: `Service` appProtocol, `HTTP2` for gRPC, the original protocol for plaintext HTTP, or `HTTP1` for HTTPS because clients often upgrade HTTPS to HTTP/2 even when the backend does not support it.
enum: HTTP1, HTTP2
tcp object
Settings for managing TCP connections to the backend
connectTimeout string
Deadline for establishing a connection to the destination.
maxLength: 32
keepalive object
Settings for enabling TCP keepalives on the connection.
interval string
Time between keepalive probes. If unset, this defaults to 180s.
maxLength: 32
retries integer
Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.
format: int32
minimum: 1
maximum: 64
time string
Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.
maxLength: 32
tls object
Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.
alpnProtocols []string
Application-Layer 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
CA certificate `ConfigMap` to use to verify the server certificate. If unset, the system's trusted certificates are used.
maxItems: 1
name string
Name of the referent
insecureSkipVerify string
Originates TLS but skips verification of the backend's certificate WARNING: insecure; only use if the risks are understood Modes: * `All` disables all TLS verification * `Hostname` trusts the CA certificate but ignores hostname/SAN mismatches. Still insecure; prefer `verifySubjectAltNames` where possible.
enum: All, Hostname
keyExchangeGroups []string
Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.
mtlsCertificateRef []object
Enables mutual TLS to the backend using `tls.key` and `tls.crt` from the referenced credential source (defaulting to a Kubernetes `Secret`). An optional `ca.cert`, if present, verifies the server certificate, but `caCertificateRefs` takes priority. If unspecified, no client certificate is used.
maxItems: 1
group string
API group of the referenced credential; empty selects the core API group
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
sni string
Server Name Indicator (`SNI`) to use 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
Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.
minItems: 1
maxItems: 16
tunnel object
Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`
backendRef object required
Proxy server to reach. Supported types: `Service` and `Backend`.
group string
Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
maxLength: 253
kind string
Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`
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 of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
minLength: 1
maxLength: 63
port integer
Destination port number. Required when the referent is a Kubernetes `Service`
format: int32
minimum: 1
maximum: 65535
projectId string required
Google Cloud project ID.
minLength: 1
maxLength: 256
templateId string required
Template ID for Google Model Armor.
minLength: 1
maxLength: 256
openAIModeration object
Passes prompt data through the OpenAI Moderations endpoint. See https://developers.openai.com/api/reference/resources/moderations for more information.
model string
Moderation model to use. For example, `omni-moderation`.
policies object
Policies for communicating with OpenAI.
auth object
Settings for authenticating to OpenAI.
key string
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
location object
Where backend credentials are inserted. Defaults to the `Authorization` header with the `Bearer ` prefix. Applies to `key` and `secretRef`.
cookie object
name string required
minLength: 1
maxLength: 256
header object
name string required
Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
minLength: 1
maxLength: 256
prefix string
minLength: 1
maxLength: 256
queryParameter object
name string required
minLength: 1
maxLength: 256
secretRef object
Credential source for the authorization value, defaulting to a Kubernetes `Secret`. By default, the value is read from the `Authorization` key; set `secretRef.key` to override it. A `Bearer ` prefix is stripped only from the default `Authorization` key.
group string
API group of the referenced credential; empty selects the core API group
key string
Key in the referenced Secret. If omitted, a location-specific default is used
minLength: 1
maxLength: 253
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
http object
Settings for managing HTTP requests to the backend
requestTimeout string
Deadline for receiving a response from the backend.
maxLength: 32
version string
HTTP protocol version for backend connections. If unset, it is inferred: `Service` appProtocol, `HTTP2` for gRPC, the original protocol for plaintext HTTP, or `HTTP1` for HTTPS because clients often upgrade HTTPS to HTTP/2 even when the backend does not support it.
enum: HTTP1, HTTP2
tcp object
Settings for managing TCP connections to the backend
connectTimeout string
Deadline for establishing a connection to the destination.
maxLength: 32
keepalive object
Settings for enabling TCP keepalives on the connection.
interval string
Time between keepalive probes. If unset, this defaults to 180s.
maxLength: 32
retries integer
Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.
format: int32
minimum: 1
maximum: 64
time string
Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.
maxLength: 32
tls object
Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.
alpnProtocols []string
Application-Layer 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
CA certificate `ConfigMap` to use to verify the server certificate. If unset, the system's trusted certificates are used.
maxItems: 1
name string
Name of the referent
insecureSkipVerify string
Originates TLS but skips verification of the backend's certificate WARNING: insecure; only use if the risks are understood Modes: * `All` disables all TLS verification * `Hostname` trusts the CA certificate but ignores hostname/SAN mismatches. Still insecure; prefer `verifySubjectAltNames` where possible.
enum: All, Hostname
keyExchangeGroups []string
Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.
mtlsCertificateRef []object
Enables mutual TLS to the backend using `tls.key` and `tls.crt` from the referenced credential source (defaulting to a Kubernetes `Secret`). An optional `ca.cert`, if present, verifies the server certificate, but `caCertificateRefs` takes priority. If unspecified, no client certificate is used.
maxItems: 1
group string
API group of the referenced credential; empty selects the core API group
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
sni string
Server Name Indicator (`SNI`) to use 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
Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.
minItems: 1
maxItems: 16
tunnel object
Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`
backendRef object required
Proxy server to reach. Supported types: `Service` and `Backend`.
group string
Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
maxLength: 253
kind string
Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`
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 of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
minLength: 1
maxLength: 63
port integer
Destination port number. Required when the referent is a Kubernetes `Service`
format: int32
minimum: 1
maximum: 65535
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
Built-in regex patterns to match against the request or response. Matches and built-ins are additive.
matches []string
Regex patterns to match against the request or response. Matches and built-ins are additive.
response object
Custom response message to return to the client. If not specified, defaults to `The request was rejected due to inappropriate content`.
message string
Custom response message to return to the client. If not specified, defaults to `The request was rejected due to inappropriate content`.
statusCode integer
Status code to return to the client. Defaults to 403.
format: int32
minimum: 200
maximum: 599
webhook object
Webhook that receives requests for prompt guarding.
backendRef object required
Webhook server to reach. Supported types: Service and Backend.
group string
Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
maxLength: 253
kind string
Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`
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 of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
minLength: 1
maxLength: 63
port integer
Destination port number. Required when the referent is a Kubernetes `Service`
format: int32
minimum: 1
maximum: 65535
failureMode string
Behavior when the webhook guardrail is unavailable or returns an error. `FailOpen` allows the request to continue. `FailClosed` (default) rejects the request.
enum: FailClosed, FailOpen
forwardHeaderMatches []object
HTTP header matches 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 of the HTTP header to match, case-insensitive. When names are equivalent, only the first matching entry is used
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
minLength: 1
maxLength: 256
type string
How to match against the header value: `Exact` (default) or `RegularExpression`. The regex dialect is implementation-specific
enum: Exact, RegularExpression
value string required
Value of the HTTP header to match
minLength: 1
maxLength: 4096
headers object
CEL-computed headers to include in webhook requests.
response []object
Prompt guards to apply to responses returned by the LLM provider.
minItems: 1
maxItems: 8
bedrockGuardrails object
AWS Bedrock Guardrails settings for prompt guarding.
identifier string required
Identifier of the Guardrail policy to use for the backend.
minLength: 1
maxLength: 256
policies object
Policies for communicating with AWS Bedrock Guardrails.
auth object
Settings for authenticating to AWS Bedrock Guardrails.
aws object
AWS authentication method for Bedrock Guardrails. Use `aws: {}` for default AWS SDK credential discovery.
assumeRole object
AWS STS AssumeRole settings to use before signing backend requests. Ambient AWS credentials are used as the source credentials for STS.
roleArn string required
AWS IAM role ARN to assume.
pattern: ^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$
minLength: 1
sessionName string
SessionName is a custom session name (RoleSessionName) for CloudTrail and Cost & Usage Report attribution. If unset, AWS generates a random name.
pattern: ^[\w+=,.@-]{2,64}$
sessionNameExpression string
SessionNameExpression is a CEL expression evaluated against each request to produce the session name (RoleSessionName), for example `jwt.sub` or `request.headers["x-team"]`. If the expression does not produce a valid session name at request time, the request is rejected.
minLength: 1
maxLength: 16384
tags []object
Session tags passed to STS AssumeRole for cost attribution in the AWS Cost & Usage Report, once activated. STS allows at most 50 per role session.
maxItems: 50
expression string
CEL expression evaluated against each request to produce the tag value, for example `jwt.sub` or `request.headers["x-app"]`. Requests with invalid tag values are rejected.
minLength: 1
maxLength: 16384
key string required
Key is the tag key.
minLength: 1
maxLength: 128
value string
Value is a static tag value.
maxLength: 256
region string
AWS SigV4 signing region, for example `us-east-1`. Set this when the target AWS service is in a different region than the gateway. If unset, typed AWS backends may provide this automatically; otherwise the ambient AWS region is used.
minLength: 1
maxLength: 256
secretRef object
Credential source for AWS credentials, defaulting to a Kubernetes `Secret`. The default Secret resolver expects `accessKey`, `secretKey`, and optional `sessionToken` keys.
group string
API group of the referenced credential; empty selects the core API group
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
serviceName string
AWS SigV4 signing service name, for example `bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS backends may provide this automatically.
minLength: 1
maxLength: 256
key string
Inline API key to use as the value of the `Authorization` header. This option is the least secure; usage of a `Secret` is preferred.
maxLength: 2048
location object
Where API keys are inserted. Defaults to the `Authorization` header with the `Bearer ` prefix. Applies to `key` and `secretRef`.
cookie object
name string required
minLength: 1
maxLength: 256
header object
name string required
Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
minLength: 1
maxLength: 256
prefix string
minLength: 1
maxLength: 256
queryParameter object
name string required
minLength: 1
maxLength: 256
secretRef object
Credential source for the API key, defaulting to a Kubernetes `Secret`. By default, the value is read from the `Authorization` key; set `secretRef.key` to override it. A `Bearer ` prefix is stripped only from the default `Authorization` key.
group string
API group of the referenced credential; empty selects the core API group
key string
Key in the referenced Secret. If omitted, a location-specific default is used
minLength: 1
maxLength: 253
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
http object
Settings for managing HTTP requests to the backend
requestTimeout string
Deadline for receiving a response from the backend.
maxLength: 32
version string
HTTP protocol version for backend connections. If unset, it is inferred: `Service` appProtocol, `HTTP2` for gRPC, the original protocol for plaintext HTTP, or `HTTP1` for HTTPS because clients often upgrade HTTPS to HTTP/2 even when the backend does not support it.
enum: HTTP1, HTTP2
tcp object
Settings for managing TCP connections to the backend
connectTimeout string
Deadline for establishing a connection to the destination.
maxLength: 32
keepalive object
Settings for enabling TCP keepalives on the connection.
interval string
Time between keepalive probes. If unset, this defaults to 180s.
maxLength: 32
retries integer
Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.
format: int32
minimum: 1
maximum: 64
time string
Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.
maxLength: 32
tls object
Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.
alpnProtocols []string
Application-Layer 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
CA certificate `ConfigMap` to use to verify the server certificate. If unset, the system's trusted certificates are used.
maxItems: 1
name string
Name of the referent
insecureSkipVerify string
Originates TLS but skips verification of the backend's certificate WARNING: insecure; only use if the risks are understood Modes: * `All` disables all TLS verification * `Hostname` trusts the CA certificate but ignores hostname/SAN mismatches. Still insecure; prefer `verifySubjectAltNames` where possible.
enum: All, Hostname
keyExchangeGroups []string
Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.
mtlsCertificateRef []object
Enables mutual TLS to the backend using `tls.key` and `tls.crt` from the referenced credential source (defaulting to a Kubernetes `Secret`). An optional `ca.cert`, if present, verifies the server certificate, but `caCertificateRefs` takes priority. If unspecified, no client certificate is used.
maxItems: 1
group string
API group of the referenced credential; empty selects the core API group
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
sni string
Server Name Indicator (`SNI`) to use 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
Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.
minItems: 1
maxItems: 16
tunnel object
Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`
backendRef object required
Proxy server to reach. Supported types: `Service` and `Backend`.
group string
Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
maxLength: 253
kind string
Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`
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 of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
minLength: 1
maxLength: 63
port integer
Destination port number. Required when the referent is a Kubernetes `Service`
format: int32
minimum: 1
maximum: 65535
region string required
AWS region where the guardrail is deployed, for example `us-west-2`).
minLength: 1
maxLength: 256
version string required
Version of the Guardrail policy to use for the backend.
minLength: 1
maxLength: 256
googleModelArmor object
Google Model Armor settings for prompt guarding.
location string
Google Cloud location, for example `us-central1`. Defaults to `us-central1` if not specified.
minLength: 1
maxLength: 256
policies object
Policies for communicating with Google Model Armor.
auth object
Settings for authenticating to Google Model Armor.
gcp object
Google authentication method for Model Armor. Use `gcp: {}` for default Google credential discovery.
audience string
Explicit `aud` value for the ID token. Only valid with `IdToken` type. If not set, the `aud` is automatically derived from the backend hostname.
minLength: 1
maxLength: 256
secretRef object
Credential source for ADC-compatible Google credential JSON, defaulting to a Kubernetes `Secret`. By default, the value is read from `credentials.json`; set `secretRef.key` to override it. When omitted, ambient credentials are used.
group string
API group of the referenced credential; empty selects the core API group
key string
Key in the referenced Secret. If omitted, a location-specific default is used
minLength: 1
maxLength: 253
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
type string
The type of token to generate. To authenticate to GCP services, generally an `AccessToken` is used. To authenticate to Cloud Run, an `IdToken` is used.
enum: AccessToken, IdToken
http object
Settings for managing HTTP requests to the backend
requestTimeout string
Deadline for receiving a response from the backend.
maxLength: 32
version string
HTTP protocol version for backend connections. If unset, it is inferred: `Service` appProtocol, `HTTP2` for gRPC, the original protocol for plaintext HTTP, or `HTTP1` for HTTPS because clients often upgrade HTTPS to HTTP/2 even when the backend does not support it.
enum: HTTP1, HTTP2
tcp object
Settings for managing TCP connections to the backend
connectTimeout string
Deadline for establishing a connection to the destination.
maxLength: 32
keepalive object
Settings for enabling TCP keepalives on the connection.
interval string
Time between keepalive probes. If unset, this defaults to 180s.
maxLength: 32
retries integer
Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.
format: int32
minimum: 1
maximum: 64
time string
Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.
maxLength: 32
tls object
Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.
alpnProtocols []string
Application-Layer 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
CA certificate `ConfigMap` to use to verify the server certificate. If unset, the system's trusted certificates are used.
maxItems: 1
name string
Name of the referent
insecureSkipVerify string
Originates TLS but skips verification of the backend's certificate WARNING: insecure; only use if the risks are understood Modes: * `All` disables all TLS verification * `Hostname` trusts the CA certificate but ignores hostname/SAN mismatches. Still insecure; prefer `verifySubjectAltNames` where possible.
enum: All, Hostname
keyExchangeGroups []string
Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.
mtlsCertificateRef []object
Enables mutual TLS to the backend using `tls.key` and `tls.crt` from the referenced credential source (defaulting to a Kubernetes `Secret`). An optional `ca.cert`, if present, verifies the server certificate, but `caCertificateRefs` takes priority. If unspecified, no client certificate is used.
maxItems: 1
group string
API group of the referenced credential; empty selects the core API group
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
sni string
Server Name Indicator (`SNI`) to use 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
Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.
minItems: 1
maxItems: 16
tunnel object
Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`
backendRef object required
Proxy server to reach. Supported types: `Service` and `Backend`.
group string
Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
maxLength: 253
kind string
Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`
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 of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
minLength: 1
maxLength: 63
port integer
Destination port number. Required when the referent is a Kubernetes `Service`
format: int32
minimum: 1
maximum: 65535
projectId string required
Google Cloud project ID.
minLength: 1
maxLength: 256
templateId string required
Template ID for Google Model Armor.
minLength: 1
maxLength: 256
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
Built-in regex patterns to match against the request or response. Matches and built-ins are additive.
matches []string
Regex patterns to match against the request or response. Matches and built-ins are additive.
response object
Custom response message to return to the client. If not specified, defaults to `The response was rejected due to inappropriate content`.
message string
Custom response message to return to the client. If not specified, defaults to `The request was rejected due to inappropriate content`.
statusCode integer
Status code to return to the client. Defaults to 403.
format: int32
minimum: 200
maximum: 599
webhook object
Webhook that receives responses for prompt guarding.
backendRef object required
Webhook server to reach. Supported types: Service and Backend.
group string
Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
maxLength: 253
kind string
Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`
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 of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
minLength: 1
maxLength: 63
port integer
Destination port number. Required when the referent is a Kubernetes `Service`
format: int32
minimum: 1
maximum: 65535
failureMode string
Behavior when the webhook guardrail is unavailable or returns an error. `FailOpen` allows the request to continue. `FailClosed` (default) rejects the request.
enum: FailClosed, FailOpen
forwardHeaderMatches []object
HTTP header matches 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 of the HTTP header to match, case-insensitive. When names are equivalent, only the first matching entry is used
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
minLength: 1
maxLength: 256
type string
How to match against the header value: `Exact` (default) or `RegularExpression`. The regex dialect is implementation-specific
enum: Exact, RegularExpression
value string required
Value of the HTTP header to match
minLength: 1
maxLength: 4096
headers object
CEL-computed headers to include in webhook requests.
streaming string
Apply prompt guards to streaming responses and realtime websocket messages. Defaults to disabled to preserve streaming throughput unless explicitly enabled.
enum: Enabled
tls object
TLS settings for connections to this model provider.
alpnProtocols []string
Application-Layer 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
CA certificate `ConfigMap` to use to verify the server certificate. If unset, the system's trusted certificates are used.
maxItems: 1
name string
Name of the referent
insecureSkipVerify string
Originates TLS but skips verification of the backend's certificate WARNING: insecure; only use if the risks are understood Modes: * `All` disables all TLS verification * `Hostname` trusts the CA certificate but ignores hostname/SAN mismatches. Still insecure; prefer `verifySubjectAltNames` where possible.
enum: All, Hostname
keyExchangeGroups []string
Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.
mtlsCertificateRef []object
Enables mutual TLS to the backend using `tls.key` and `tls.crt` from the referenced credential source (defaulting to a Kubernetes `Secret`). An optional `ca.cert`, if present, verifies the server certificate, but `caCertificateRefs` takes priority. If unspecified, no client certificate is used.
maxItems: 1
group string
API group of the referenced credential; empty selects the core API group
kind string
Kind of the referenced credential; empty defaults to `Secret`
name string required
Name of the referenced credential
minLength: 1
maxLength: 253
sni string
Server Name Indicator (`SNI`) to use 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
Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.
minItems: 1
maxItems: 16
transformations []object
CEL transformations applied to fields in the provider request body.
minItems: 1
maxItems: 64
expression string required
CEL expression used to compute the field value.
minLength: 1
maxLength: 16384
field string required
Name of the field to set.
minLength: 1
maxLength: 256
tunnel object
Proxy tunnel used to reach this model provider.
backendRef object required
Proxy server to reach. Supported types: `Service` and `Backend`.
group string
Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
maxLength: 253
kind string
Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`
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 of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
minLength: 1
maxLength: 63
port integer
Destination port number. Required when the referent is a Kubernetes `Service`
format: int32
minimum: 1
maximum: 65535
provider string
Provider serving this concrete model. Provider-specific configuration is set by the corresponding field below when needed.
enum: Anthropic, Azure, Baseten, Bedrock, Cerebras, Cohere, Custom, Deepinfra, Deepseek, Fireworks, Gemini, Groq, Huggingface,... Anthropic, Azure, Baseten, Bedrock, Cerebras, Cohere, Custom, Deepinfra, Deepseek, Fireworks, Gemini, Groq, Huggingface, Mistral, Ollama, OpenAI, Openrouter, TogetherAI, VertexAI, XAI
vertexai object
Provider-specific settings for Vertex AI.
projectId string required
The ID of the Google Cloud Project that you use for the Vertex AI.
minLength: 1
maxLength: 64
region string
The location of the Google Cloud Project that you use for the Vertex AI. Special values: `global` uses the global endpoint, while `us` and `eu` use restricted multi-region endpoints. Other values are treated as regional locations. Defaults to `global` if not specified.
minLength: 1
maxLength: 64
virtualModel object
Request-time routing among concrete AgentgatewayModel resources.
conditional object
Ordered condition-based model selection.
targets []object required
Concrete model targets evaluated in order. The first matching condition is selected. One final target may omit when to act as the fallback.
minItems: 1
maxItems: 64
model string
Concrete model name selected through the referenced model. It is required when modelRef points to a wildcard match.model. When omitted, the referenced model's exact effective match.model is used.
minLength: 1
maxLength: 1024
modelRef object required
Same-namespace AgentgatewayModel resource selected by this target.
name string
Name of the referent
when string
CEL expression that must evaluate to true for this target to be selected. Omit only on the final fallback target.
minLength: 1
maxLength: 16384
failover object
Priority-based model selection with failover between priority groups.
targets []object required
Concrete model targets grouped by priority. Lower values are preferred.
minItems: 1
maxItems: 64
model string
Concrete model name selected through the referenced model. It is required when modelRef points to a wildcard match.model. When omitted, the referenced model's exact effective match.model is used.
minLength: 1
maxLength: 1024
modelRef object required
Same-namespace AgentgatewayModel resource selected by this target.
name string
Name of the referent
priority integer required
Priority of this target. Lower values are preferred. Targets at the same priority are selected using a score that considers health and latency. The next priority is used only when every target at this priority is degraded. Configure policies.health on concrete target models to customize degradation and eviction behavior.
format: int32
minimum: 0
maximum: 1e+06
weighted object
Weight-based model selection.
targets []object required
Concrete model targets and their relative weights.
minItems: 1
maxItems: 64
model string
Concrete model name selected through the referenced model. It is required when modelRef points to a wildcard match.model. When omitted, the referenced model's exact effective match.model is used.
minLength: 1
maxLength: 1024
modelRef object required
Same-namespace AgentgatewayModel resource selected by this target.
name string
Name of the referent
weight integer
Relative traffic weight. Defaults to 1.
format: int32
minimum: 1
maximum: 1e+06
visibility string
Controls whether clients can request this model directly. Internal models can only be selected by virtual models. Defaults to Public.
enum: Internal, Public
status object
Current model attachment status.
parents []object
Status for each Gateway parent to which this model is attached.
maxItems: 16
conditions []object required
Conditions describes the status of the route with respect to the Gateway. Note that the route's availability is also subject to the Gateway's own status conditions and listener status. If the Route's ParentRef specifies an existing Gateway that supports Routes of this kind AND that Gateway's controller has sufficient access, then that Gateway's controller MUST set the "Accepted" condition on the Route, to indicate whether the route has been accepted or rejected by the Gateway, and why. A Route MUST be considered "Accepted" if at least one of the Route's rules is implemented by the Gateway. There are a number of cases where the "Accepted" condition may not be set due to lack of controller visibility, that includes when: * The Route refers to a nonexistent parent. * The Route is of a type that the controller does not support. * The Route is in a namespace to which the controller does not have access. <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
parentRef object required
ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus 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 of the referent. Defaults to the Route's local namespace. Cross-namespace references must be explicitly allowed, for example via ReferenceGrant. Support: Core
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
minLength: 1
maxLength: 63
port integer
Port this Route targets on the parent, interpreted per parent kind (for example a Gateway listener port or Service port). Support: Extended
format: int32
minimum: 1
maximum: 65535
sectionName string
Name of a section within the target resource, for example a Gateway Listener name or Service port name. Empty references the entire resource. 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

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