{ "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": [ "string", "null" ] }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": [ "string", "null" ] }, "metadata": { "type": [ "object", "null" ] }, "spec": { "additionalProperties": false, "description": "Desired backend configuration.", "properties": { "a2a": { "additionalProperties": false, "description": "A2A backend.", "properties": { "host": { "description": "Hostname or IP address of the A2A backend.", "maxLength": 256, "minLength": 1, "type": "string" }, "port": { "description": "Port number of the A2A backend.", "format": "int32", "maximum": 65535, "minimum": 1, "type": "integer" } }, "required": [ "host", "port" ], "type": [ "object", "null" ] }, "ai": { "additionalProperties": false, "description": "LLM backend.", "properties": { "groups": { "description": "Groups in priority order, where each group\ndefines a set of LLM providers. The priority determines the priority of\nthe backend endpoints chosen.\nNote: provider names must be unique across all providers in all priority\ngroups. Backend policies may target a specific provider by name using\n`targetRefs[].sectionName`.\n\nExample configuration with two priority groups:\n\n\tgroups:\n\t- providers:\n\t - azureopenai:\n\t deploymentName: gpt-4o-mini\n\t apiVersion: 2024-02-15-preview\n\t endpoint: ai-gateway.openai.azure.com\n\t- providers:\n\t - azureopenai:\n\t deploymentName: gpt-4o-mini-2\n\t apiVersion: 2024-02-15-preview\n\t endpoint: ai-gateway-2.openai.azure.com\n\t policies:\n\t auth:\n\t secretRef:\n\t name: azure-secret", "items": { "additionalProperties": false, "properties": { "providers": { "description": "LLM providers within this group. Each provider is treated equally in terms of priority,\nwith automatic weighting based on health.", "items": { "additionalProperties": false, "properties": { "anthropic": { "additionalProperties": false, "description": "Anthropic provider settings.", "properties": { "model": { "description": "Model name override, such as `gpt-4o-mini`.\nIf unset, the model name is taken from the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "azure": { "additionalProperties": false, "description": "Azure provider with resource-based configuration.\nSupports both Azure OpenAI and Azure AI Foundry resource types.", "properties": { "apiVersion": { "description": "The version of the Azure OpenAI API to use.\nIf unset, defaults to `v1`.", "maxLength": 64, "minLength": 1, "type": [ "string", "null" ] }, "model": { "description": "Model name override, such as `gpt-4o-mini`.\nIf unset, the model name is taken from the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "projectName": { "description": "The Foundry project name, required when `resourceType` is `Foundry`.\nUsed to construct paths: /api/projects/{projectName}/openai/v1/...", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "resourceName": { "description": "The Azure resource name used to construct the endpoint host.\nFor OpenAI: {resourceName}.openai.azure.com\nFor Foundry: {resourceName}.services.ai.azure.com\nNote: when the Azure portal \"Foundry legacy\" template was used, the\ngenerated resource name may end in \"-resource\" (e.g. \"myproject-resource\");\nthat suffix is part of the resource name as the user configured it, not\npart of the hostname suffix agentgateway should append.", "maxLength": 256, "minLength": 1, "type": "string" }, "resourceType": { "description": "The type of Azure endpoint. Determines the host suffix.", "enum": [ "Foundry", "OpenAI" ], "type": "string" } }, "required": [ "resourceName", "resourceType" ], "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "projectName is required when resourceType is Foundry", "rule": "self.resourceType != 'Foundry' || has(self.projectName)" } ] }, "azureopenai": { "additionalProperties": false, "description": "Azure OpenAI provider settings.", "properties": { "apiVersion": { "description": "The version of the Azure OpenAI API to use.\nFor more information, see the [Azure OpenAI API version reference](https://learn.microsoft.com/en-us/azure/foundry/openai/reference).\nIf unset, defaults to `v1`.", "maxLength": 64, "minLength": 1, "type": [ "string", "null" ] }, "deploymentName": { "description": "The name of the Azure OpenAI model deployment to use.\nFor more information, see the [Azure OpenAI model docs](https://learn.microsoft.com/en-us/azure/foundry/foundry-models/concepts/models-sold-directly-by-azure?view=foundry-classic).\nThis is required if `apiVersion` is not `v1`. For `v1`, the model can be\nset in the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "endpoint": { "description": "The endpoint for the Azure OpenAI API to use, such as `my-endpoint.openai.azure.com`.\nIf the scheme is included, it is stripped.", "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "endpoint" ], "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "deploymentName is required for this apiVersion", "rule": "!has(self.apiVersion) || self.apiVersion == 'v1' ? true : has(self.deploymentName)" } ] }, "bedrock": { "additionalProperties": false, "description": "Bedrock provider settings.", "properties": { "guardrail": { "additionalProperties": false, "description": "Guardrail policy to use for the backend. See\n\u003chttps://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html\u003e.\nIf not specified, the AWS Guardrail policy will not be used.", "properties": { "identifier": { "description": "Identifier of the Guardrail policy to use for the backend.", "maxLength": 256, "minLength": 1, "type": "string" }, "version": { "description": "Version of the Guardrail policy to use for the backend.", "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "identifier", "version" ], "type": [ "object", "null" ] }, "model": { "description": "Model name override, such as `gpt-4o-mini`.\nIf unset, the model name is taken from the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "region": { "default": "us-east-1", "description": "AWS region to use for the backend.\nDefaults to `us-east-1` if not specified.", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9-]+$", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "custom": { "additionalProperties": false, "description": "Custom provider configures a non-managed or self-hosted LLM provider.\nUse this when the provider target and API formats should be declared\nexplicitly instead of inferred from a managed provider such as OpenAI or\nAnthropic.", "properties": { "backendRef": { "additionalProperties": false, "description": "Kubernetes backend that serves this provider.\n`backendRef` may target only a namespace-local Service or InferencePool.\nIf unset, host and port must be set on the parent provider.", "properties": { "group": { "default": "", "description": "API group of the referenced resource. For example, `gateway.networking.k8s.io`.\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind of the referenced resource. For example, `Service`.\nDefaults to \"Service\" when not specified.", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name of the referenced resource.", "maxLength": 253, "minLength": 1, "type": "string" }, "port": { "description": "Destination port number to use for this resource.\nRequired when the referenced resource is a Kubernetes Service.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] }, "formats": { "description": "Provider-native API formats this provider supports.", "items": { "additionalProperties": false, "description": "Provider-native LLM API format settings.", "properties": { "path": { "description": "Default upstream path override for this format.\nIf unset, agentgateway uses the default path for the format.", "maxLength": 1024, "minLength": 1, "type": [ "string", "null" ] }, "type": { "description": "Provider-native API format.", "enum": [ "AnthropicTokenCount", "Completions", "Embeddings", "Messages", "Realtime", "Rerank", "Responses" ], "type": "string" } }, "required": [ "type" ], "type": "object", "x-kubernetes-validations": [ { "message": "path must start with /", "rule": "!has(self.path) || self.path.startsWith('/')" } ] }, "maxItems": 6, "minItems": 1, "type": "array", "x-kubernetes-list-map-keys": [ "type" ], "x-kubernetes-list-type": "map" }, "model": { "description": "Model name override, such as `gpt-oss`.\nIf unset, the model name is taken from the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "formats" ], "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "custom provider backendRef may target only Service or InferencePool", "rule": "!has(self.backendRef) || (((!has(self.backendRef.group) || self.backendRef.group == \"\") \u0026\u0026 (!has(self.backendRef.kind) || self.backendRef.kind == 'Service')) || (has(self.backendRef.group) \u0026\u0026 self.backendRef.group == 'inference.networking.k8s.io' \u0026\u0026 has(self.backendRef.kind) \u0026\u0026 self.backendRef.kind == 'InferencePool'))" } ] }, "gemini": { "additionalProperties": false, "description": "Gemini provider settings.", "properties": { "model": { "description": "Model name override, such as `gemini-2.5-pro`.\nIf unset, the model name is taken from the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "host": { "description": "Hostname to send requests to.\nFor custom providers without backendRef, host and port specify the target.\nFor managed providers, host and port override the provider default.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "name": { "description": "Name of the provider. Policies can target this provider by name.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "openai": { "additionalProperties": false, "description": "OpenAI provider settings.", "properties": { "model": { "description": "Model name override, such as `gpt-4o-mini`.\nIf unset, the model name is taken from the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "path": { "description": "URL path to use for LLM provider API requests.\nThis is useful when you need to route requests to a different API endpoint while maintaining\ncompatibility with the original provider's API structure.\nIf not specified, the default path for the provider is used.", "maxLength": 1024, "minLength": 1, "type": [ "string", "null" ] }, "pathPrefix": { "description": "Overrides the default base path prefix, such as `/v1`, for upstream requests.\nPath translation for cross-format requests still applies using this prefix.\nOnly supported for OpenAI and Anthropic providers.", "maxLength": 1024, "minLength": 1, "type": [ "string", "null" ] }, "policies": { "additionalProperties": false, "description": "Policies for communicating with this backend.\nPolicies may also be set in `AgentgatewayPolicy`, or in the top-level\n`AgentgatewayBackend`. Policies are merged on a field-level basis, with\norder: `AgentgatewayPolicy` \u003c `AgentgatewayBackend` \u003c `AgentgatewayBackend`\nLLM provider (this field).", "properties": { "ai": { "additionalProperties": false, "description": "Settings for AI workloads. This is only applicable when\nconnecting to a `Backend` of type `ai`.", "properties": { "defaults": { "description": "Defaults to merge with user input fields. If the field is already set, the field in the request is used.", "items": { "additionalProperties": false, "description": "Default value for a field in the JSON request body sent to the LLM provider.\nThese defaults are merged with the user-provided request to ensure missing fields are populated.\n\nUser input fields here refer to the fields in the JSON request body that a client sends when making a request to the LLM provider.\nDefaults set here do _not_ override those user-provided values unless you explicitly set `override` to `true`.\n\nExample: Setting a default system field for Anthropic, which does not support system role messages:\n\n\tdefaults:\n\t - field: \"system\"\n\t value: \"answer all questions in French\"\n\nExample: Setting a default temperature and overriding `max_tokens`:\n\n\tdefaults:\n\t - field: \"temperature\"\n\t value: \"0.5\"\n\t - field: \"max_tokens\"\n\t value: \"100\"\n\t override: true\n\nExample: Setting custom lists fields:\n\n\tdefaults:\n\t - field: \"custom_integer_list\"\n\t value: [1,2,3]\n\n\toverrides:\n\t - field: \"custom_string_list\"\n\t value: [\"one\",\"two\",\"three\"]\n\nNote: The `field` values correspond to keys in the JSON request body, not fields in this CRD.", "properties": { "field": { "allOf": [ { "minLength": 1 }, { "minLength": 1 } ], "description": "Name of the field.", "maxLength": 256, "type": "string" }, "value": { "description": "Default value for the field. This can be any JSON data type.", "x-kubernetes-preserve-unknown-fields": true } }, "required": [ "field", "value" ], "type": "object" }, "maxItems": 64, "minItems": 1, "type": [ "array", "null" ] }, "modelAliases": { "additionalProperties": { "type": "string" }, "description": "Maps friendly model names to actual provider model names.\nExample: `{\"fast\": \"gpt-3.5-turbo\", \"smart\": \"gpt-4-turbo\"}`.\nNote: This field is only applicable when using the agentgateway data plane.", "maxProperties": 64, "type": [ "object", "null" ] }, "overrides": { "description": "Overrides to merge with user input fields. If the field is already set, the field is overwritten.", "items": { "additionalProperties": false, "description": "Default value for a field in the JSON request body sent to the LLM provider.\nThese defaults are merged with the user-provided request to ensure missing fields are populated.\n\nUser input fields here refer to the fields in the JSON request body that a client sends when making a request to the LLM provider.\nDefaults set here do _not_ override those user-provided values unless you explicitly set `override` to `true`.\n\nExample: Setting a default system field for Anthropic, which does not support system role messages:\n\n\tdefaults:\n\t - field: \"system\"\n\t value: \"answer all questions in French\"\n\nExample: Setting a default temperature and overriding `max_tokens`:\n\n\tdefaults:\n\t - field: \"temperature\"\n\t value: \"0.5\"\n\t - field: \"max_tokens\"\n\t value: \"100\"\n\t override: true\n\nExample: Setting custom lists fields:\n\n\tdefaults:\n\t - field: \"custom_integer_list\"\n\t value: [1,2,3]\n\n\toverrides:\n\t - field: \"custom_string_list\"\n\t value: [\"one\",\"two\",\"three\"]\n\nNote: The `field` values correspond to keys in the JSON request body, not fields in this CRD.", "properties": { "field": { "allOf": [ { "minLength": 1 }, { "minLength": 1 } ], "description": "Name of the field.", "maxLength": 256, "type": "string" }, "value": { "description": "Default value for the field. This can be any JSON data type.", "x-kubernetes-preserve-unknown-fields": true } }, "required": [ "field", "value" ], "type": "object" }, "maxItems": 64, "minItems": 1, "type": [ "array", "null" ] }, "prompt": { "additionalProperties": false, "description": "Enriches requests sent to the LLM provider by appending and prepending system prompts. This can be configured only for\nLLM providers that use the `CHAT` or `CHAT_STREAMING` API route type.", "properties": { "append": { "description": "Messages to append to the prompt sent by the client.", "items": { "additionalProperties": false, "description": "An entry for a message to prepend or append to each prompt.", "properties": { "content": { "description": "String content of the message.", "type": "string" }, "role": { "description": "Role of the message. The available roles depend on the backend\nLLM provider model, such as `SYSTEM` or `USER` in the OpenAI API.", "type": "string" } }, "required": [ "content", "role" ], "type": "object" }, "type": [ "array", "null" ] }, "prepend": { "description": "Messages to prepend to the prompt sent by the client.", "items": { "additionalProperties": false, "description": "An entry for a message to prepend or append to each prompt.", "properties": { "content": { "description": "String content of the message.", "type": "string" }, "role": { "description": "Role of the message. The available roles depend on the backend\nLLM provider model, such as `SYSTEM` or `USER` in the OpenAI API.", "type": "string" } }, "required": [ "content", "role" ], "type": "object" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "promptCaching": { "additionalProperties": false, "description": "Automatic prompt caching for supported\nproviders, currently AWS Bedrock.\nReduces API costs by caching static content like system prompts and tool definitions.\nOnly applicable for Bedrock Claude 3+ and Nova models.", "properties": { "cacheMessageOffset": { "default": 0, "description": "Shifts the message cache point further back in the\nconversation. 0 (default) places it at the second-to-last message.\nHigher values move it N additional messages towards the start, clamped\nto bounds.", "minimum": 0, "type": [ "integer", "null" ] }, "cacheMessages": { "default": true, "description": "Enables caching for conversation messages.\nCaches all messages in the conversation for cost savings.", "type": [ "boolean", "null" ] }, "cacheSystem": { "default": true, "description": "Enables caching for system prompts.\nInserts a cache point after all system messages.", "type": [ "boolean", "null" ] }, "cacheTools": { "default": false, "description": "Enables caching for tool definitions.\nInserts a cache point after all tool specifications.", "type": [ "boolean", "null" ] }, "minTokens": { "default": 1024, "description": "Minimum estimated token count\nbefore caching is enabled. Uses rough heuristic (word count × 1.3) to estimate tokens.\nBedrock requires at least 1,024 tokens for caching to be effective.", "minimum": 0, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "promptGuard": { "additionalProperties": false, "description": "Guardrails for LLM requests and responses.", "properties": { "request": { "description": "Prompt guards to apply to requests sent by the client.", "items": { "additionalProperties": false, "description": "Prompt guards to apply to requests sent by the client.", "properties": { "bedrockGuardrails": { "additionalProperties": false, "description": "AWS Bedrock Guardrails settings for prompt\nguarding.", "properties": { "identifier": { "description": "Identifier of the Guardrail policy to use for the backend.", "maxLength": 256, "minLength": 1, "type": "string" }, "policies": { "additionalProperties": false, "description": "Policies for communicating with AWS Bedrock Guardrails.", "properties": { "auth": { "additionalProperties": false, "description": "Settings for managing authentication to the backend.", "properties": { "aws": { "additionalProperties": false, "description": "Explicit AWS authentication method for the backend.\nWhen omitted, default AWS SDK credential discovery is used.", "properties": { "assumeRole": { "additionalProperties": false, "description": "AWS STS AssumeRole settings to use before signing backend requests.\nAmbient AWS credentials are used as the source credentials for STS.", "properties": { "roleArn": { "description": "AWS IAM role ARN to assume.", "minLength": 1, "pattern": "^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$", "type": "string" } }, "required": [ "roleArn" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the AWS credentials. When using the default Secret\nresolver, the `Secret` must have keys `accessKey`, `secretKey`, and\noptionally `sessionToken`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "serviceName": { "description": "AWS SigV4 signing service name, for example\n`bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS\nbackends may provide this automatically.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "secretRef and assumeRole are mutually exclusive", "rule": "!(has(self.secretRef) \u0026\u0026 has(self.assumeRole))" } ] }, "azure": { "additionalProperties": false, "description": "Azure authentication method for the backend.", "properties": { "managedIdentity": { "additionalProperties": false, "description": "Managed identity authentication settings.", "properties": { "clientId": { "type": "string" }, "objectId": { "type": "string" }, "resourceId": { "type": "string" } }, "required": [ "clientId", "objectId", "resourceId" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the Azure credentials. When using the default Secret\nresolver, the `Secret` must have keys `clientID`, `tenantID`, and\n`clientSecret`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ] }, "gcp": { "additionalProperties": false, "description": "Google authentication method for the backend.\nWhen omitted, default Google credential discovery is used.", "properties": { "audience": { "description": "Explicit `aud` value for the ID token. Only\nvalid with `IdToken` type. If not set, the `aud` is automatically\nderived from the backend hostname.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing ADC-compatible Google credential JSON. When using\nthe default Secret resolver, this must be stored in the `credentials.json`\nkey. When omitted, ambient credentials are used.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "type": { "description": "The type of token to generate. To authenticate to GCP services,\ngenerally an `AccessToken` is used. To authenticate to Cloud Run, an\n`IdToken` is used.", "enum": [ "AccessToken", "IdToken" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "audience is only valid with IdToken", "rule": "has(self.audience) ? self.type == 'IdToken' : true" } ] }, "key": { "description": "Inline key to use as the value of the\n`Authorization` header. This option is the least secure; usage of a\n`Secret` is preferred.", "maxLength": 2048, "type": [ "string", "null" ] }, "location": { "additionalProperties": false, "description": "Where backend credentials are inserted.\nIf omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix.\nThis applies to `key`, `secretRef`, and `passthrough`.", "properties": { "cookie": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] }, "header": { "additionalProperties": false, "properties": { "name": { "description": "HTTPHeaderName is the name of an HTTP header.\n\nValid values include:\n\n* \"Authorization\"\n* \"Set-Cookie\"\n\nInvalid values include:\n\n - \":method\" - \":\" is an invalid character. This means that HTTP/2 pseudo\n headers are not currently supported by this type.\n - \"/invalid\" - \"/ \" is an invalid character", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "prefix": { "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "queryParameter": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [header queryParameter cookie] must be set", "rule": "[has(self.header),has(self.queryParameter),has(self.cookie)].filter(x,x==true).size() == 1" } ] }, "passthrough": { "description": "Passes through an existing token that has been sent by the\nclient and validated. Other policies, like JWT and API key\nauthentication, will strip the original client credentials. Passthrough backend authentication\ncauses the original token to be added back into the request. If there are no client authentication policies on the\nrequest, the original token would be unchanged, so this would have no effect.", "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, storing the key to use as the authorization value. When using\nthe default Secret resolver, this must be stored in the `Authorization`\nkey.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "location may only be set for key or passthrough auth", "rule": "has(self.location) ? has(self.key) || has(self.secretRef) || has(self.passthrough) : true" }, { "message": "exactly one of the fields in [key secretRef passthrough aws azure gcp] must be set", "rule": "[has(self.key),has(self.secretRef),has(self.passthrough),has(self.aws),has(self.azure),has(self.gcp)].filter(x,x==true).size() == 1" } ] }, "http": { "additionalProperties": false, "description": "Settings for managing HTTP requests to the backend.", "properties": { "requestTimeout": { "description": "Deadline for receiving a response from the backend.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "requestTimeout must be at least 1ms", "rule": "duration(self) \u003e= duration('1ms')" } ] }, "version": { "description": "HTTP protocol version to use when connecting to\nthe backend.\nIf not specified, the version is automatically determined:\n* `Service` types can specify it with `appProtocol` on the `Service`\n port.\n* If traffic is identified as gRPC, `HTTP2` is used.\n* If the incoming traffic was plaintext HTTP, the original protocol will\n be used.\n* If the incoming traffic was HTTPS, `HTTP1` will be used. This is\n because most clients will transparently upgrade HTTPS traffic to\n `HTTP2`, even if the backend doesn't support it.", "enum": [ "HTTP1", "HTTP2" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "tcp": { "additionalProperties": false, "description": "Settings for managing TCP connections to the backend.", "properties": { "connectTimeout": { "description": "Deadline for establishing a connection to\nthe destination.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "connectTimeout must be at least 100ms", "rule": "duration(self) \u003e= duration('100ms')" } ] }, "keepalive": { "additionalProperties": false, "description": "Settings for enabling TCP keepalives on the\nconnection.", "properties": { "interval": { "description": "Time between keepalive probes.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "interval must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "retries": { "description": "Maximum number of keepalive probes to send before dropping the connection.\nIf unset, this defaults to 9.", "format": "int32", "maximum": 64, "minimum": 1, "type": [ "integer", "null" ] }, "time": { "description": "Time a connection needs to be idle before keepalive probes start being sent.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "time must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "tls": { "additionalProperties": false, "description": "Settings for managing TLS connections to the backend.\n\nIf this field is set, TLS will be initiated to the backend; the system trusted CA certificates will be used to\nvalidate the server, and the SNI will automatically be set based on the destination.", "properties": { "alpnProtocols": { "description": "Application-Layer Protocol Negotiation (`ALPN`)\nvalue to use in the TLS handshake.\n\nIf not present, defaults to `[\"h2\", \"http/1.1\"]`.", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] }, "caCertificateRefs": { "description": "CA certificate `ConfigMap` to use to\nverify the server certificate.\nIf unset, the system's trusted certificates are used.", "items": { "additionalProperties": false, "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "insecureSkipVerify": { "description": "Originates TLS but skips verification of the backend's certificate.\nWARNING: This is an insecure option that should only be used if the risks are understood.\n\nThere are two modes:\n* `All` disables all TLS verification.\n* `Hostname` verifies the CA certificate is trusted, but ignores any\n mismatch of hostname or SANs. Note that this method is still insecure;\n prefer setting `verifySubjectAltNames` to customize the valid hostnames\n if possible.", "enum": [ "All", "Hostname" ], "type": [ "string", "null" ] }, "keyExchangeGroups": { "description": "Ordered list of key exchange groups for a TLS connection.\nFor example: `X25519_MLKEM768,X25519`.", "items": { "enum": [ "P-256", "P-384", "X25519", "X25519_MLKEM768" ], "type": "string" }, "type": [ "array", "null" ] }, "mtlsCertificateRef": { "description": "Enables mutual TLS to the backend, using the\nspecified key (`tls.key`) and cert (`tls.crt`) from the referenced\ncredential source, defaulting to a Kubernetes `Secret`.\n\nAn optional `ca.cert` field, if present, will be used to verify the\nserver certificate. If `caCertificateRefs` is also specified, the\n`caCertificateRefs` field takes priority.\n\nIf unspecified, no client certificate will be used.", "items": { "additionalProperties": false, "description": "References a same-namespace credential.\nSet only `name` to reference a Kubernetes Secret.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "sni": { "description": "Server Name Indicator (`SNI`) to use in the TLS\nhandshake. If unset, the `SNI` is automatically set based on the\ndestination hostname.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "verifySubjectAltNames": { "description": "Subject Alternative Names (`SAN`)\nto verify in the server certificate.\nIf not present, the destination hostname is automatically used.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "insecureSkipVerify All and caCertificateRefs may not be set together", "rule": "has(self.insecureSkipVerify) \u0026\u0026 self.insecureSkipVerify == 'All' ? !has(self.caCertificateRefs) : true" }, { "message": "insecureSkipVerify and verifySubjectAltNames may not be set together", "rule": "has(self.insecureSkipVerify) ? !has(self.verifySubjectAltNames) : true" }, { "message": "at most one of the fields in [verifySubjectAltNames insecureSkipVerify] may be set", "rule": "[has(self.verifySubjectAltNames),has(self.insecureSkipVerify)].filter(x,x==true).size() \u003c= 1" } ] }, "tunnel": { "additionalProperties": false, "description": "Settings for managing tunnel connections, with behavior like `HTTPS_PROXY`, to the backend.", "properties": { "backendRef": { "additionalProperties": false, "description": "Proxy server to reach.\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "region": { "description": "AWS region where the guardrail is deployed, for example\n`us-west-2`).", "maxLength": 256, "minLength": 1, "type": "string" }, "version": { "description": "Version of the Guardrail policy to use for the backend.", "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "identifier", "region", "version" ], "type": [ "object", "null" ] }, "googleModelArmor": { "additionalProperties": false, "description": "Google Model Armor settings for prompt guarding.", "properties": { "location": { "default": "us-central1", "description": "Google Cloud location, for example `us-central1`.\nDefaults to `us-central1` if not specified.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "policies": { "additionalProperties": false, "description": "Policies for communicating with Google Model Armor.", "properties": { "auth": { "additionalProperties": false, "description": "Settings for managing authentication to the backend.", "properties": { "aws": { "additionalProperties": false, "description": "Explicit AWS authentication method for the backend.\nWhen omitted, default AWS SDK credential discovery is used.", "properties": { "assumeRole": { "additionalProperties": false, "description": "AWS STS AssumeRole settings to use before signing backend requests.\nAmbient AWS credentials are used as the source credentials for STS.", "properties": { "roleArn": { "description": "AWS IAM role ARN to assume.", "minLength": 1, "pattern": "^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$", "type": "string" } }, "required": [ "roleArn" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the AWS credentials. When using the default Secret\nresolver, the `Secret` must have keys `accessKey`, `secretKey`, and\noptionally `sessionToken`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "serviceName": { "description": "AWS SigV4 signing service name, for example\n`bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS\nbackends may provide this automatically.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "secretRef and assumeRole are mutually exclusive", "rule": "!(has(self.secretRef) \u0026\u0026 has(self.assumeRole))" } ] }, "azure": { "additionalProperties": false, "description": "Azure authentication method for the backend.", "properties": { "managedIdentity": { "additionalProperties": false, "description": "Managed identity authentication settings.", "properties": { "clientId": { "type": "string" }, "objectId": { "type": "string" }, "resourceId": { "type": "string" } }, "required": [ "clientId", "objectId", "resourceId" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the Azure credentials. When using the default Secret\nresolver, the `Secret` must have keys `clientID`, `tenantID`, and\n`clientSecret`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ] }, "gcp": { "additionalProperties": false, "description": "Google authentication method for the backend.\nWhen omitted, default Google credential discovery is used.", "properties": { "audience": { "description": "Explicit `aud` value for the ID token. Only\nvalid with `IdToken` type. If not set, the `aud` is automatically\nderived from the backend hostname.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing ADC-compatible Google credential JSON. When using\nthe default Secret resolver, this must be stored in the `credentials.json`\nkey. When omitted, ambient credentials are used.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "type": { "description": "The type of token to generate. To authenticate to GCP services,\ngenerally an `AccessToken` is used. To authenticate to Cloud Run, an\n`IdToken` is used.", "enum": [ "AccessToken", "IdToken" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "audience is only valid with IdToken", "rule": "has(self.audience) ? self.type == 'IdToken' : true" } ] }, "key": { "description": "Inline key to use as the value of the\n`Authorization` header. This option is the least secure; usage of a\n`Secret` is preferred.", "maxLength": 2048, "type": [ "string", "null" ] }, "location": { "additionalProperties": false, "description": "Where backend credentials are inserted.\nIf omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix.\nThis applies to `key`, `secretRef`, and `passthrough`.", "properties": { "cookie": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] }, "header": { "additionalProperties": false, "properties": { "name": { "description": "HTTPHeaderName is the name of an HTTP header.\n\nValid values include:\n\n* \"Authorization\"\n* \"Set-Cookie\"\n\nInvalid values include:\n\n - \":method\" - \":\" is an invalid character. This means that HTTP/2 pseudo\n headers are not currently supported by this type.\n - \"/invalid\" - \"/ \" is an invalid character", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "prefix": { "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "queryParameter": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [header queryParameter cookie] must be set", "rule": "[has(self.header),has(self.queryParameter),has(self.cookie)].filter(x,x==true).size() == 1" } ] }, "passthrough": { "description": "Passes through an existing token that has been sent by the\nclient and validated. Other policies, like JWT and API key\nauthentication, will strip the original client credentials. Passthrough backend authentication\ncauses the original token to be added back into the request. If there are no client authentication policies on the\nrequest, the original token would be unchanged, so this would have no effect.", "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, storing the key to use as the authorization value. When using\nthe default Secret resolver, this must be stored in the `Authorization`\nkey.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "location may only be set for key or passthrough auth", "rule": "has(self.location) ? has(self.key) || has(self.secretRef) || has(self.passthrough) : true" }, { "message": "exactly one of the fields in [key secretRef passthrough aws azure gcp] must be set", "rule": "[has(self.key),has(self.secretRef),has(self.passthrough),has(self.aws),has(self.azure),has(self.gcp)].filter(x,x==true).size() == 1" } ] }, "http": { "additionalProperties": false, "description": "Settings for managing HTTP requests to the backend.", "properties": { "requestTimeout": { "description": "Deadline for receiving a response from the backend.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "requestTimeout must be at least 1ms", "rule": "duration(self) \u003e= duration('1ms')" } ] }, "version": { "description": "HTTP protocol version to use when connecting to\nthe backend.\nIf not specified, the version is automatically determined:\n* `Service` types can specify it with `appProtocol` on the `Service`\n port.\n* If traffic is identified as gRPC, `HTTP2` is used.\n* If the incoming traffic was plaintext HTTP, the original protocol will\n be used.\n* If the incoming traffic was HTTPS, `HTTP1` will be used. This is\n because most clients will transparently upgrade HTTPS traffic to\n `HTTP2`, even if the backend doesn't support it.", "enum": [ "HTTP1", "HTTP2" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "tcp": { "additionalProperties": false, "description": "Settings for managing TCP connections to the backend.", "properties": { "connectTimeout": { "description": "Deadline for establishing a connection to\nthe destination.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "connectTimeout must be at least 100ms", "rule": "duration(self) \u003e= duration('100ms')" } ] }, "keepalive": { "additionalProperties": false, "description": "Settings for enabling TCP keepalives on the\nconnection.", "properties": { "interval": { "description": "Time between keepalive probes.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "interval must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "retries": { "description": "Maximum number of keepalive probes to send before dropping the connection.\nIf unset, this defaults to 9.", "format": "int32", "maximum": 64, "minimum": 1, "type": [ "integer", "null" ] }, "time": { "description": "Time a connection needs to be idle before keepalive probes start being sent.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "time must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "tls": { "additionalProperties": false, "description": "Settings for managing TLS connections to the backend.\n\nIf this field is set, TLS will be initiated to the backend; the system trusted CA certificates will be used to\nvalidate the server, and the SNI will automatically be set based on the destination.", "properties": { "alpnProtocols": { "description": "Application-Layer Protocol Negotiation (`ALPN`)\nvalue to use in the TLS handshake.\n\nIf not present, defaults to `[\"h2\", \"http/1.1\"]`.", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] }, "caCertificateRefs": { "description": "CA certificate `ConfigMap` to use to\nverify the server certificate.\nIf unset, the system's trusted certificates are used.", "items": { "additionalProperties": false, "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "insecureSkipVerify": { "description": "Originates TLS but skips verification of the backend's certificate.\nWARNING: This is an insecure option that should only be used if the risks are understood.\n\nThere are two modes:\n* `All` disables all TLS verification.\n* `Hostname` verifies the CA certificate is trusted, but ignores any\n mismatch of hostname or SANs. Note that this method is still insecure;\n prefer setting `verifySubjectAltNames` to customize the valid hostnames\n if possible.", "enum": [ "All", "Hostname" ], "type": [ "string", "null" ] }, "keyExchangeGroups": { "description": "Ordered list of key exchange groups for a TLS connection.\nFor example: `X25519_MLKEM768,X25519`.", "items": { "enum": [ "P-256", "P-384", "X25519", "X25519_MLKEM768" ], "type": "string" }, "type": [ "array", "null" ] }, "mtlsCertificateRef": { "description": "Enables mutual TLS to the backend, using the\nspecified key (`tls.key`) and cert (`tls.crt`) from the referenced\ncredential source, defaulting to a Kubernetes `Secret`.\n\nAn optional `ca.cert` field, if present, will be used to verify the\nserver certificate. If `caCertificateRefs` is also specified, the\n`caCertificateRefs` field takes priority.\n\nIf unspecified, no client certificate will be used.", "items": { "additionalProperties": false, "description": "References a same-namespace credential.\nSet only `name` to reference a Kubernetes Secret.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "sni": { "description": "Server Name Indicator (`SNI`) to use in the TLS\nhandshake. If unset, the `SNI` is automatically set based on the\ndestination hostname.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "verifySubjectAltNames": { "description": "Subject Alternative Names (`SAN`)\nto verify in the server certificate.\nIf not present, the destination hostname is automatically used.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "insecureSkipVerify All and caCertificateRefs may not be set together", "rule": "has(self.insecureSkipVerify) \u0026\u0026 self.insecureSkipVerify == 'All' ? !has(self.caCertificateRefs) : true" }, { "message": "insecureSkipVerify and verifySubjectAltNames may not be set together", "rule": "has(self.insecureSkipVerify) ? !has(self.verifySubjectAltNames) : true" }, { "message": "at most one of the fields in [verifySubjectAltNames insecureSkipVerify] may be set", "rule": "[has(self.verifySubjectAltNames),has(self.insecureSkipVerify)].filter(x,x==true).size() \u003c= 1" } ] }, "tunnel": { "additionalProperties": false, "description": "Settings for managing tunnel connections, with behavior like `HTTPS_PROXY`, to the backend.", "properties": { "backendRef": { "additionalProperties": false, "description": "Proxy server to reach.\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "projectId": { "description": "Google Cloud project ID.", "maxLength": 256, "minLength": 1, "type": "string" }, "templateId": { "description": "Template ID for Google Model Armor.", "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "projectId", "templateId" ], "type": [ "object", "null" ] }, "openAIModeration": { "additionalProperties": false, "description": "Passes prompt data through the OpenAI Moderations\nendpoint.\nSee https://developers.openai.com/api/reference/resources/moderations for more information.", "properties": { "model": { "description": "Moderation model to use. For example,\n`omni-moderation`.", "type": [ "string", "null" ] }, "policies": { "additionalProperties": false, "description": "Policies for communicating with OpenAI.", "properties": { "auth": { "additionalProperties": false, "description": "Settings for managing authentication to the backend.", "properties": { "aws": { "additionalProperties": false, "description": "Explicit AWS authentication method for the backend.\nWhen omitted, default AWS SDK credential discovery is used.", "properties": { "assumeRole": { "additionalProperties": false, "description": "AWS STS AssumeRole settings to use before signing backend requests.\nAmbient AWS credentials are used as the source credentials for STS.", "properties": { "roleArn": { "description": "AWS IAM role ARN to assume.", "minLength": 1, "pattern": "^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$", "type": "string" } }, "required": [ "roleArn" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the AWS credentials. When using the default Secret\nresolver, the `Secret` must have keys `accessKey`, `secretKey`, and\noptionally `sessionToken`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "serviceName": { "description": "AWS SigV4 signing service name, for example\n`bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS\nbackends may provide this automatically.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "secretRef and assumeRole are mutually exclusive", "rule": "!(has(self.secretRef) \u0026\u0026 has(self.assumeRole))" } ] }, "azure": { "additionalProperties": false, "description": "Azure authentication method for the backend.", "properties": { "managedIdentity": { "additionalProperties": false, "description": "Managed identity authentication settings.", "properties": { "clientId": { "type": "string" }, "objectId": { "type": "string" }, "resourceId": { "type": "string" } }, "required": [ "clientId", "objectId", "resourceId" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the Azure credentials. When using the default Secret\nresolver, the `Secret` must have keys `clientID`, `tenantID`, and\n`clientSecret`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ] }, "gcp": { "additionalProperties": false, "description": "Google authentication method for the backend.\nWhen omitted, default Google credential discovery is used.", "properties": { "audience": { "description": "Explicit `aud` value for the ID token. Only\nvalid with `IdToken` type. If not set, the `aud` is automatically\nderived from the backend hostname.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing ADC-compatible Google credential JSON. When using\nthe default Secret resolver, this must be stored in the `credentials.json`\nkey. When omitted, ambient credentials are used.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "type": { "description": "The type of token to generate. To authenticate to GCP services,\ngenerally an `AccessToken` is used. To authenticate to Cloud Run, an\n`IdToken` is used.", "enum": [ "AccessToken", "IdToken" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "audience is only valid with IdToken", "rule": "has(self.audience) ? self.type == 'IdToken' : true" } ] }, "key": { "description": "Inline key to use as the value of the\n`Authorization` header. This option is the least secure; usage of a\n`Secret` is preferred.", "maxLength": 2048, "type": [ "string", "null" ] }, "location": { "additionalProperties": false, "description": "Where backend credentials are inserted.\nIf omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix.\nThis applies to `key`, `secretRef`, and `passthrough`.", "properties": { "cookie": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] }, "header": { "additionalProperties": false, "properties": { "name": { "description": "HTTPHeaderName is the name of an HTTP header.\n\nValid values include:\n\n* \"Authorization\"\n* \"Set-Cookie\"\n\nInvalid values include:\n\n - \":method\" - \":\" is an invalid character. This means that HTTP/2 pseudo\n headers are not currently supported by this type.\n - \"/invalid\" - \"/ \" is an invalid character", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "prefix": { "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "queryParameter": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [header queryParameter cookie] must be set", "rule": "[has(self.header),has(self.queryParameter),has(self.cookie)].filter(x,x==true).size() == 1" } ] }, "passthrough": { "description": "Passes through an existing token that has been sent by the\nclient and validated. Other policies, like JWT and API key\nauthentication, will strip the original client credentials. Passthrough backend authentication\ncauses the original token to be added back into the request. If there are no client authentication policies on the\nrequest, the original token would be unchanged, so this would have no effect.", "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, storing the key to use as the authorization value. When using\nthe default Secret resolver, this must be stored in the `Authorization`\nkey.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "location may only be set for key or passthrough auth", "rule": "has(self.location) ? has(self.key) || has(self.secretRef) || has(self.passthrough) : true" }, { "message": "exactly one of the fields in [key secretRef passthrough aws azure gcp] must be set", "rule": "[has(self.key),has(self.secretRef),has(self.passthrough),has(self.aws),has(self.azure),has(self.gcp)].filter(x,x==true).size() == 1" } ] }, "http": { "additionalProperties": false, "description": "Settings for managing HTTP requests to the backend.", "properties": { "requestTimeout": { "description": "Deadline for receiving a response from the backend.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "requestTimeout must be at least 1ms", "rule": "duration(self) \u003e= duration('1ms')" } ] }, "version": { "description": "HTTP protocol version to use when connecting to\nthe backend.\nIf not specified, the version is automatically determined:\n* `Service` types can specify it with `appProtocol` on the `Service`\n port.\n* If traffic is identified as gRPC, `HTTP2` is used.\n* If the incoming traffic was plaintext HTTP, the original protocol will\n be used.\n* If the incoming traffic was HTTPS, `HTTP1` will be used. This is\n because most clients will transparently upgrade HTTPS traffic to\n `HTTP2`, even if the backend doesn't support it.", "enum": [ "HTTP1", "HTTP2" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "tcp": { "additionalProperties": false, "description": "Settings for managing TCP connections to the backend.", "properties": { "connectTimeout": { "description": "Deadline for establishing a connection to\nthe destination.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "connectTimeout must be at least 100ms", "rule": "duration(self) \u003e= duration('100ms')" } ] }, "keepalive": { "additionalProperties": false, "description": "Settings for enabling TCP keepalives on the\nconnection.", "properties": { "interval": { "description": "Time between keepalive probes.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "interval must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "retries": { "description": "Maximum number of keepalive probes to send before dropping the connection.\nIf unset, this defaults to 9.", "format": "int32", "maximum": 64, "minimum": 1, "type": [ "integer", "null" ] }, "time": { "description": "Time a connection needs to be idle before keepalive probes start being sent.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "time must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "tls": { "additionalProperties": false, "description": "Settings for managing TLS connections to the backend.\n\nIf this field is set, TLS will be initiated to the backend; the system trusted CA certificates will be used to\nvalidate the server, and the SNI will automatically be set based on the destination.", "properties": { "alpnProtocols": { "description": "Application-Layer Protocol Negotiation (`ALPN`)\nvalue to use in the TLS handshake.\n\nIf not present, defaults to `[\"h2\", \"http/1.1\"]`.", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] }, "caCertificateRefs": { "description": "CA certificate `ConfigMap` to use to\nverify the server certificate.\nIf unset, the system's trusted certificates are used.", "items": { "additionalProperties": false, "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "insecureSkipVerify": { "description": "Originates TLS but skips verification of the backend's certificate.\nWARNING: This is an insecure option that should only be used if the risks are understood.\n\nThere are two modes:\n* `All` disables all TLS verification.\n* `Hostname` verifies the CA certificate is trusted, but ignores any\n mismatch of hostname or SANs. Note that this method is still insecure;\n prefer setting `verifySubjectAltNames` to customize the valid hostnames\n if possible.", "enum": [ "All", "Hostname" ], "type": [ "string", "null" ] }, "keyExchangeGroups": { "description": "Ordered list of key exchange groups for a TLS connection.\nFor example: `X25519_MLKEM768,X25519`.", "items": { "enum": [ "P-256", "P-384", "X25519", "X25519_MLKEM768" ], "type": "string" }, "type": [ "array", "null" ] }, "mtlsCertificateRef": { "description": "Enables mutual TLS to the backend, using the\nspecified key (`tls.key`) and cert (`tls.crt`) from the referenced\ncredential source, defaulting to a Kubernetes `Secret`.\n\nAn optional `ca.cert` field, if present, will be used to verify the\nserver certificate. If `caCertificateRefs` is also specified, the\n`caCertificateRefs` field takes priority.\n\nIf unspecified, no client certificate will be used.", "items": { "additionalProperties": false, "description": "References a same-namespace credential.\nSet only `name` to reference a Kubernetes Secret.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "sni": { "description": "Server Name Indicator (`SNI`) to use in the TLS\nhandshake. If unset, the `SNI` is automatically set based on the\ndestination hostname.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "verifySubjectAltNames": { "description": "Subject Alternative Names (`SAN`)\nto verify in the server certificate.\nIf not present, the destination hostname is automatically used.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "insecureSkipVerify All and caCertificateRefs may not be set together", "rule": "has(self.insecureSkipVerify) \u0026\u0026 self.insecureSkipVerify == 'All' ? !has(self.caCertificateRefs) : true" }, { "message": "insecureSkipVerify and verifySubjectAltNames may not be set together", "rule": "has(self.insecureSkipVerify) ? !has(self.verifySubjectAltNames) : true" }, { "message": "at most one of the fields in [verifySubjectAltNames insecureSkipVerify] may be set", "rule": "[has(self.verifySubjectAltNames),has(self.insecureSkipVerify)].filter(x,x==true).size() \u003c= 1" } ] }, "tunnel": { "additionalProperties": false, "description": "Settings for managing tunnel connections, with behavior like `HTTPS_PROXY`, to the backend.", "properties": { "backendRef": { "additionalProperties": false, "description": "Proxy server to reach.\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "regex": { "additionalProperties": false, "description": "Regular expression (regex) matching for prompt guards and data masking.", "properties": { "action": { "default": "Mask", "description": "The action to take if a regex pattern is matched in a request or response.\nThis setting applies only to request matches. `PromptguardResponse`\nmatches are always masked by default.\nDefaults to `Mask`.", "enum": [ "Mask", "Reject" ], "type": [ "string", "null" ] }, "builtins": { "description": "Built-in regex patterns to match against the request or response.\nMatches and built-ins are additive.", "items": { "description": "Built-in regex patterns for specific types of strings in prompts.\nFor example, if you specify `CreditCard`, any credit card numbers\nin the request or response are matched.", "enum": [ "CaSin", "CreditCard", "Email", "PhoneNumber", "Ssn" ], "type": "string" }, "type": [ "array", "null" ] }, "matches": { "description": "Regex patterns to match against the request or response.\nMatches and built-ins are additive.", "items": { "maxLength": 1024, "minLength": 1, "type": "string" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "response": { "additionalProperties": false, "description": "Custom response message to return to the client. If not specified, defaults to\n`The request was rejected due to inappropriate content`.", "properties": { "message": { "default": "The request was rejected due to inappropriate content", "description": "Custom response message to return to the client. If not specified, defaults to\n`The request was rejected due to inappropriate content`.", "type": [ "string", "null" ] }, "statusCode": { "default": 403, "description": "Status code to return to the client. Defaults to 403.", "format": "int32", "maximum": 599, "minimum": 200, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [message statusCode] must be set", "rule": "[has(self.message),has(self.statusCode)].filter(x,x==true).size() \u003e= 1" } ] }, "webhook": { "additionalProperties": false, "description": "Webhook that receives requests for prompt guarding.", "properties": { "backendRef": { "additionalProperties": false, "description": "Webhook server to reach.\n\nSupported types: Service and Backend.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] }, "failureMode": { "description": "Behavior when the webhook guardrail is unavailable\nor returns an error. `FailOpen` allows the request to continue.\n`FailClosed` (default) rejects the request.", "enum": [ "FailClosed", "FailOpen" ], "type": [ "string", "null" ] }, "forwardHeaderMatches": { "description": "HTTP header matches used to select the headers to forward to the webhook.\nRequest headers are used when forwarding requests and response headers\nare used when forwarding responses.\nBy default, no headers are forwarded.", "items": { "additionalProperties": false, "description": "HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request\nheaders.", "properties": { "name": { "description": "Name is the name of the HTTP Header to be matched. Name matching MUST be\ncase-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).\n\nIf multiple entries specify equivalent header names, only the first\nentry with an equivalent name MUST be considered for a match. Subsequent\nentries with an equivalent header name MUST be ignored. Due to the\ncase-insensitivity of header names, \"foo\" and \"Foo\" are considered\nequivalent.\n\nWhen a header is repeated in an HTTP request, it is\nimplementation-specific behavior as to how this is represented.\nGenerally, proxies should follow the guidance from the RFC:\nhttps://www.rfc-editor.org/rfc/rfc7230.html#section-3.2.2 regarding\nprocessing a repeated header, with special handling for \"Set-Cookie\".", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "type": { "default": "Exact", "description": "Type specifies how to match against the value of the header.\n\nSupport: Core (Exact)\n\nSupport: Implementation-specific (RegularExpression)\n\nSince RegularExpression HeaderMatchType has implementation-specific\nconformance, implementations can support POSIX, PCRE or any other dialects\nof regular expressions. Please read the implementation's documentation to\ndetermine the supported dialect.", "enum": [ "Exact", "RegularExpression" ], "type": [ "string", "null" ] }, "value": { "description": "Value is the value of HTTP Header to be matched.\n\u003cgateway:experimental:description\u003e\nMust consist of printable US-ASCII characters, optionally separated\nby single tabs or spaces. See: https://tools.ietf.org/html/rfc7230#section-3.2\n\u003c/gateway:experimental:description\u003e\n\n\u003cgateway:experimental:validation:Pattern=`^[!-~]+([\\t ]?[!-~]+)*$`\u003e", "maxLength": 4096, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": "object", "x-kubernetes-validations": [ { "message": "exactly one of the fields in [regex webhook openAIModeration bedrockGuardrails googleModelArmor] must be set", "rule": "[has(self.regex),has(self.webhook),has(self.openAIModeration),has(self.bedrockGuardrails),has(self.googleModelArmor)].filter(x,x==true).size() == 1" } ] }, "maxItems": 8, "minItems": 1, "type": [ "array", "null" ] }, "response": { "description": "Prompt guards to apply to responses returned by the LLM provider.", "items": { "additionalProperties": false, "description": "Prompt guards to apply to responses returned by the LLM provider.", "properties": { "bedrockGuardrails": { "additionalProperties": false, "description": "AWS Bedrock Guardrails settings for prompt\nguarding.", "properties": { "identifier": { "description": "Identifier of the Guardrail policy to use for the backend.", "maxLength": 256, "minLength": 1, "type": "string" }, "policies": { "additionalProperties": false, "description": "Policies for communicating with AWS Bedrock Guardrails.", "properties": { "auth": { "additionalProperties": false, "description": "Settings for managing authentication to the backend.", "properties": { "aws": { "additionalProperties": false, "description": "Explicit AWS authentication method for the backend.\nWhen omitted, default AWS SDK credential discovery is used.", "properties": { "assumeRole": { "additionalProperties": false, "description": "AWS STS AssumeRole settings to use before signing backend requests.\nAmbient AWS credentials are used as the source credentials for STS.", "properties": { "roleArn": { "description": "AWS IAM role ARN to assume.", "minLength": 1, "pattern": "^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$", "type": "string" } }, "required": [ "roleArn" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the AWS credentials. When using the default Secret\nresolver, the `Secret` must have keys `accessKey`, `secretKey`, and\noptionally `sessionToken`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "serviceName": { "description": "AWS SigV4 signing service name, for example\n`bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS\nbackends may provide this automatically.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "secretRef and assumeRole are mutually exclusive", "rule": "!(has(self.secretRef) \u0026\u0026 has(self.assumeRole))" } ] }, "azure": { "additionalProperties": false, "description": "Azure authentication method for the backend.", "properties": { "managedIdentity": { "additionalProperties": false, "description": "Managed identity authentication settings.", "properties": { "clientId": { "type": "string" }, "objectId": { "type": "string" }, "resourceId": { "type": "string" } }, "required": [ "clientId", "objectId", "resourceId" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the Azure credentials. When using the default Secret\nresolver, the `Secret` must have keys `clientID`, `tenantID`, and\n`clientSecret`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ] }, "gcp": { "additionalProperties": false, "description": "Google authentication method for the backend.\nWhen omitted, default Google credential discovery is used.", "properties": { "audience": { "description": "Explicit `aud` value for the ID token. Only\nvalid with `IdToken` type. If not set, the `aud` is automatically\nderived from the backend hostname.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing ADC-compatible Google credential JSON. When using\nthe default Secret resolver, this must be stored in the `credentials.json`\nkey. When omitted, ambient credentials are used.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "type": { "description": "The type of token to generate. To authenticate to GCP services,\ngenerally an `AccessToken` is used. To authenticate to Cloud Run, an\n`IdToken` is used.", "enum": [ "AccessToken", "IdToken" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "audience is only valid with IdToken", "rule": "has(self.audience) ? self.type == 'IdToken' : true" } ] }, "key": { "description": "Inline key to use as the value of the\n`Authorization` header. This option is the least secure; usage of a\n`Secret` is preferred.", "maxLength": 2048, "type": [ "string", "null" ] }, "location": { "additionalProperties": false, "description": "Where backend credentials are inserted.\nIf omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix.\nThis applies to `key`, `secretRef`, and `passthrough`.", "properties": { "cookie": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] }, "header": { "additionalProperties": false, "properties": { "name": { "description": "HTTPHeaderName is the name of an HTTP header.\n\nValid values include:\n\n* \"Authorization\"\n* \"Set-Cookie\"\n\nInvalid values include:\n\n - \":method\" - \":\" is an invalid character. This means that HTTP/2 pseudo\n headers are not currently supported by this type.\n - \"/invalid\" - \"/ \" is an invalid character", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "prefix": { "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "queryParameter": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [header queryParameter cookie] must be set", "rule": "[has(self.header),has(self.queryParameter),has(self.cookie)].filter(x,x==true).size() == 1" } ] }, "passthrough": { "description": "Passes through an existing token that has been sent by the\nclient and validated. Other policies, like JWT and API key\nauthentication, will strip the original client credentials. Passthrough backend authentication\ncauses the original token to be added back into the request. If there are no client authentication policies on the\nrequest, the original token would be unchanged, so this would have no effect.", "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, storing the key to use as the authorization value. When using\nthe default Secret resolver, this must be stored in the `Authorization`\nkey.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "location may only be set for key or passthrough auth", "rule": "has(self.location) ? has(self.key) || has(self.secretRef) || has(self.passthrough) : true" }, { "message": "exactly one of the fields in [key secretRef passthrough aws azure gcp] must be set", "rule": "[has(self.key),has(self.secretRef),has(self.passthrough),has(self.aws),has(self.azure),has(self.gcp)].filter(x,x==true).size() == 1" } ] }, "http": { "additionalProperties": false, "description": "Settings for managing HTTP requests to the backend.", "properties": { "requestTimeout": { "description": "Deadline for receiving a response from the backend.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "requestTimeout must be at least 1ms", "rule": "duration(self) \u003e= duration('1ms')" } ] }, "version": { "description": "HTTP protocol version to use when connecting to\nthe backend.\nIf not specified, the version is automatically determined:\n* `Service` types can specify it with `appProtocol` on the `Service`\n port.\n* If traffic is identified as gRPC, `HTTP2` is used.\n* If the incoming traffic was plaintext HTTP, the original protocol will\n be used.\n* If the incoming traffic was HTTPS, `HTTP1` will be used. This is\n because most clients will transparently upgrade HTTPS traffic to\n `HTTP2`, even if the backend doesn't support it.", "enum": [ "HTTP1", "HTTP2" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "tcp": { "additionalProperties": false, "description": "Settings for managing TCP connections to the backend.", "properties": { "connectTimeout": { "description": "Deadline for establishing a connection to\nthe destination.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "connectTimeout must be at least 100ms", "rule": "duration(self) \u003e= duration('100ms')" } ] }, "keepalive": { "additionalProperties": false, "description": "Settings for enabling TCP keepalives on the\nconnection.", "properties": { "interval": { "description": "Time between keepalive probes.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "interval must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "retries": { "description": "Maximum number of keepalive probes to send before dropping the connection.\nIf unset, this defaults to 9.", "format": "int32", "maximum": 64, "minimum": 1, "type": [ "integer", "null" ] }, "time": { "description": "Time a connection needs to be idle before keepalive probes start being sent.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "time must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "tls": { "additionalProperties": false, "description": "Settings for managing TLS connections to the backend.\n\nIf this field is set, TLS will be initiated to the backend; the system trusted CA certificates will be used to\nvalidate the server, and the SNI will automatically be set based on the destination.", "properties": { "alpnProtocols": { "description": "Application-Layer Protocol Negotiation (`ALPN`)\nvalue to use in the TLS handshake.\n\nIf not present, defaults to `[\"h2\", \"http/1.1\"]`.", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] }, "caCertificateRefs": { "description": "CA certificate `ConfigMap` to use to\nverify the server certificate.\nIf unset, the system's trusted certificates are used.", "items": { "additionalProperties": false, "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "insecureSkipVerify": { "description": "Originates TLS but skips verification of the backend's certificate.\nWARNING: This is an insecure option that should only be used if the risks are understood.\n\nThere are two modes:\n* `All` disables all TLS verification.\n* `Hostname` verifies the CA certificate is trusted, but ignores any\n mismatch of hostname or SANs. Note that this method is still insecure;\n prefer setting `verifySubjectAltNames` to customize the valid hostnames\n if possible.", "enum": [ "All", "Hostname" ], "type": [ "string", "null" ] }, "keyExchangeGroups": { "description": "Ordered list of key exchange groups for a TLS connection.\nFor example: `X25519_MLKEM768,X25519`.", "items": { "enum": [ "P-256", "P-384", "X25519", "X25519_MLKEM768" ], "type": "string" }, "type": [ "array", "null" ] }, "mtlsCertificateRef": { "description": "Enables mutual TLS to the backend, using the\nspecified key (`tls.key`) and cert (`tls.crt`) from the referenced\ncredential source, defaulting to a Kubernetes `Secret`.\n\nAn optional `ca.cert` field, if present, will be used to verify the\nserver certificate. If `caCertificateRefs` is also specified, the\n`caCertificateRefs` field takes priority.\n\nIf unspecified, no client certificate will be used.", "items": { "additionalProperties": false, "description": "References a same-namespace credential.\nSet only `name` to reference a Kubernetes Secret.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "sni": { "description": "Server Name Indicator (`SNI`) to use in the TLS\nhandshake. If unset, the `SNI` is automatically set based on the\ndestination hostname.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "verifySubjectAltNames": { "description": "Subject Alternative Names (`SAN`)\nto verify in the server certificate.\nIf not present, the destination hostname is automatically used.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "insecureSkipVerify All and caCertificateRefs may not be set together", "rule": "has(self.insecureSkipVerify) \u0026\u0026 self.insecureSkipVerify == 'All' ? !has(self.caCertificateRefs) : true" }, { "message": "insecureSkipVerify and verifySubjectAltNames may not be set together", "rule": "has(self.insecureSkipVerify) ? !has(self.verifySubjectAltNames) : true" }, { "message": "at most one of the fields in [verifySubjectAltNames insecureSkipVerify] may be set", "rule": "[has(self.verifySubjectAltNames),has(self.insecureSkipVerify)].filter(x,x==true).size() \u003c= 1" } ] }, "tunnel": { "additionalProperties": false, "description": "Settings for managing tunnel connections, with behavior like `HTTPS_PROXY`, to the backend.", "properties": { "backendRef": { "additionalProperties": false, "description": "Proxy server to reach.\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "region": { "description": "AWS region where the guardrail is deployed, for example\n`us-west-2`).", "maxLength": 256, "minLength": 1, "type": "string" }, "version": { "description": "Version of the Guardrail policy to use for the backend.", "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "identifier", "region", "version" ], "type": [ "object", "null" ] }, "googleModelArmor": { "additionalProperties": false, "description": "Google Model Armor settings for prompt guarding.", "properties": { "location": { "default": "us-central1", "description": "Google Cloud location, for example `us-central1`.\nDefaults to `us-central1` if not specified.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "policies": { "additionalProperties": false, "description": "Policies for communicating with Google Model Armor.", "properties": { "auth": { "additionalProperties": false, "description": "Settings for managing authentication to the backend.", "properties": { "aws": { "additionalProperties": false, "description": "Explicit AWS authentication method for the backend.\nWhen omitted, default AWS SDK credential discovery is used.", "properties": { "assumeRole": { "additionalProperties": false, "description": "AWS STS AssumeRole settings to use before signing backend requests.\nAmbient AWS credentials are used as the source credentials for STS.", "properties": { "roleArn": { "description": "AWS IAM role ARN to assume.", "minLength": 1, "pattern": "^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$", "type": "string" } }, "required": [ "roleArn" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the AWS credentials. When using the default Secret\nresolver, the `Secret` must have keys `accessKey`, `secretKey`, and\noptionally `sessionToken`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "serviceName": { "description": "AWS SigV4 signing service name, for example\n`bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS\nbackends may provide this automatically.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "secretRef and assumeRole are mutually exclusive", "rule": "!(has(self.secretRef) \u0026\u0026 has(self.assumeRole))" } ] }, "azure": { "additionalProperties": false, "description": "Azure authentication method for the backend.", "properties": { "managedIdentity": { "additionalProperties": false, "description": "Managed identity authentication settings.", "properties": { "clientId": { "type": "string" }, "objectId": { "type": "string" }, "resourceId": { "type": "string" } }, "required": [ "clientId", "objectId", "resourceId" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the Azure credentials. When using the default Secret\nresolver, the `Secret` must have keys `clientID`, `tenantID`, and\n`clientSecret`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ] }, "gcp": { "additionalProperties": false, "description": "Google authentication method for the backend.\nWhen omitted, default Google credential discovery is used.", "properties": { "audience": { "description": "Explicit `aud` value for the ID token. Only\nvalid with `IdToken` type. If not set, the `aud` is automatically\nderived from the backend hostname.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing ADC-compatible Google credential JSON. When using\nthe default Secret resolver, this must be stored in the `credentials.json`\nkey. When omitted, ambient credentials are used.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "type": { "description": "The type of token to generate. To authenticate to GCP services,\ngenerally an `AccessToken` is used. To authenticate to Cloud Run, an\n`IdToken` is used.", "enum": [ "AccessToken", "IdToken" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "audience is only valid with IdToken", "rule": "has(self.audience) ? self.type == 'IdToken' : true" } ] }, "key": { "description": "Inline key to use as the value of the\n`Authorization` header. This option is the least secure; usage of a\n`Secret` is preferred.", "maxLength": 2048, "type": [ "string", "null" ] }, "location": { "additionalProperties": false, "description": "Where backend credentials are inserted.\nIf omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix.\nThis applies to `key`, `secretRef`, and `passthrough`.", "properties": { "cookie": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] }, "header": { "additionalProperties": false, "properties": { "name": { "description": "HTTPHeaderName is the name of an HTTP header.\n\nValid values include:\n\n* \"Authorization\"\n* \"Set-Cookie\"\n\nInvalid values include:\n\n - \":method\" - \":\" is an invalid character. This means that HTTP/2 pseudo\n headers are not currently supported by this type.\n - \"/invalid\" - \"/ \" is an invalid character", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "prefix": { "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "queryParameter": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [header queryParameter cookie] must be set", "rule": "[has(self.header),has(self.queryParameter),has(self.cookie)].filter(x,x==true).size() == 1" } ] }, "passthrough": { "description": "Passes through an existing token that has been sent by the\nclient and validated. Other policies, like JWT and API key\nauthentication, will strip the original client credentials. Passthrough backend authentication\ncauses the original token to be added back into the request. If there are no client authentication policies on the\nrequest, the original token would be unchanged, so this would have no effect.", "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, storing the key to use as the authorization value. When using\nthe default Secret resolver, this must be stored in the `Authorization`\nkey.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "location may only be set for key or passthrough auth", "rule": "has(self.location) ? has(self.key) || has(self.secretRef) || has(self.passthrough) : true" }, { "message": "exactly one of the fields in [key secretRef passthrough aws azure gcp] must be set", "rule": "[has(self.key),has(self.secretRef),has(self.passthrough),has(self.aws),has(self.azure),has(self.gcp)].filter(x,x==true).size() == 1" } ] }, "http": { "additionalProperties": false, "description": "Settings for managing HTTP requests to the backend.", "properties": { "requestTimeout": { "description": "Deadline for receiving a response from the backend.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "requestTimeout must be at least 1ms", "rule": "duration(self) \u003e= duration('1ms')" } ] }, "version": { "description": "HTTP protocol version to use when connecting to\nthe backend.\nIf not specified, the version is automatically determined:\n* `Service` types can specify it with `appProtocol` on the `Service`\n port.\n* If traffic is identified as gRPC, `HTTP2` is used.\n* If the incoming traffic was plaintext HTTP, the original protocol will\n be used.\n* If the incoming traffic was HTTPS, `HTTP1` will be used. This is\n because most clients will transparently upgrade HTTPS traffic to\n `HTTP2`, even if the backend doesn't support it.", "enum": [ "HTTP1", "HTTP2" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "tcp": { "additionalProperties": false, "description": "Settings for managing TCP connections to the backend.", "properties": { "connectTimeout": { "description": "Deadline for establishing a connection to\nthe destination.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "connectTimeout must be at least 100ms", "rule": "duration(self) \u003e= duration('100ms')" } ] }, "keepalive": { "additionalProperties": false, "description": "Settings for enabling TCP keepalives on the\nconnection.", "properties": { "interval": { "description": "Time between keepalive probes.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "interval must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "retries": { "description": "Maximum number of keepalive probes to send before dropping the connection.\nIf unset, this defaults to 9.", "format": "int32", "maximum": 64, "minimum": 1, "type": [ "integer", "null" ] }, "time": { "description": "Time a connection needs to be idle before keepalive probes start being sent.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "time must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "tls": { "additionalProperties": false, "description": "Settings for managing TLS connections to the backend.\n\nIf this field is set, TLS will be initiated to the backend; the system trusted CA certificates will be used to\nvalidate the server, and the SNI will automatically be set based on the destination.", "properties": { "alpnProtocols": { "description": "Application-Layer Protocol Negotiation (`ALPN`)\nvalue to use in the TLS handshake.\n\nIf not present, defaults to `[\"h2\", \"http/1.1\"]`.", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] }, "caCertificateRefs": { "description": "CA certificate `ConfigMap` to use to\nverify the server certificate.\nIf unset, the system's trusted certificates are used.", "items": { "additionalProperties": false, "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "insecureSkipVerify": { "description": "Originates TLS but skips verification of the backend's certificate.\nWARNING: This is an insecure option that should only be used if the risks are understood.\n\nThere are two modes:\n* `All` disables all TLS verification.\n* `Hostname` verifies the CA certificate is trusted, but ignores any\n mismatch of hostname or SANs. Note that this method is still insecure;\n prefer setting `verifySubjectAltNames` to customize the valid hostnames\n if possible.", "enum": [ "All", "Hostname" ], "type": [ "string", "null" ] }, "keyExchangeGroups": { "description": "Ordered list of key exchange groups for a TLS connection.\nFor example: `X25519_MLKEM768,X25519`.", "items": { "enum": [ "P-256", "P-384", "X25519", "X25519_MLKEM768" ], "type": "string" }, "type": [ "array", "null" ] }, "mtlsCertificateRef": { "description": "Enables mutual TLS to the backend, using the\nspecified key (`tls.key`) and cert (`tls.crt`) from the referenced\ncredential source, defaulting to a Kubernetes `Secret`.\n\nAn optional `ca.cert` field, if present, will be used to verify the\nserver certificate. If `caCertificateRefs` is also specified, the\n`caCertificateRefs` field takes priority.\n\nIf unspecified, no client certificate will be used.", "items": { "additionalProperties": false, "description": "References a same-namespace credential.\nSet only `name` to reference a Kubernetes Secret.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "sni": { "description": "Server Name Indicator (`SNI`) to use in the TLS\nhandshake. If unset, the `SNI` is automatically set based on the\ndestination hostname.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "verifySubjectAltNames": { "description": "Subject Alternative Names (`SAN`)\nto verify in the server certificate.\nIf not present, the destination hostname is automatically used.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "insecureSkipVerify All and caCertificateRefs may not be set together", "rule": "has(self.insecureSkipVerify) \u0026\u0026 self.insecureSkipVerify == 'All' ? !has(self.caCertificateRefs) : true" }, { "message": "insecureSkipVerify and verifySubjectAltNames may not be set together", "rule": "has(self.insecureSkipVerify) ? !has(self.verifySubjectAltNames) : true" }, { "message": "at most one of the fields in [verifySubjectAltNames insecureSkipVerify] may be set", "rule": "[has(self.verifySubjectAltNames),has(self.insecureSkipVerify)].filter(x,x==true).size() \u003c= 1" } ] }, "tunnel": { "additionalProperties": false, "description": "Settings for managing tunnel connections, with behavior like `HTTPS_PROXY`, to the backend.", "properties": { "backendRef": { "additionalProperties": false, "description": "Proxy server to reach.\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "projectId": { "description": "Google Cloud project ID.", "maxLength": 256, "minLength": 1, "type": "string" }, "templateId": { "description": "Template ID for Google Model Armor.", "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "projectId", "templateId" ], "type": [ "object", "null" ] }, "regex": { "additionalProperties": false, "description": "Regular expression (regex) matching for prompt guards and data masking.", "properties": { "action": { "default": "Mask", "description": "The action to take if a regex pattern is matched in a request or response.\nThis setting applies only to request matches. `PromptguardResponse`\nmatches are always masked by default.\nDefaults to `Mask`.", "enum": [ "Mask", "Reject" ], "type": [ "string", "null" ] }, "builtins": { "description": "Built-in regex patterns to match against the request or response.\nMatches and built-ins are additive.", "items": { "description": "Built-in regex patterns for specific types of strings in prompts.\nFor example, if you specify `CreditCard`, any credit card numbers\nin the request or response are matched.", "enum": [ "CaSin", "CreditCard", "Email", "PhoneNumber", "Ssn" ], "type": "string" }, "type": [ "array", "null" ] }, "matches": { "description": "Regex patterns to match against the request or response.\nMatches and built-ins are additive.", "items": { "maxLength": 1024, "minLength": 1, "type": "string" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "response": { "additionalProperties": false, "description": "Custom response message to return to the client. If not specified, defaults to\n`The response was rejected due to inappropriate content`.", "properties": { "message": { "default": "The request was rejected due to inappropriate content", "description": "Custom response message to return to the client. If not specified, defaults to\n`The request was rejected due to inappropriate content`.", "type": [ "string", "null" ] }, "statusCode": { "default": 403, "description": "Status code to return to the client. Defaults to 403.", "format": "int32", "maximum": 599, "minimum": 200, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [message statusCode] must be set", "rule": "[has(self.message),has(self.statusCode)].filter(x,x==true).size() \u003e= 1" } ] }, "webhook": { "additionalProperties": false, "description": "Webhook that receives responses for prompt guarding.", "properties": { "backendRef": { "additionalProperties": false, "description": "Webhook server to reach.\n\nSupported types: Service and Backend.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] }, "failureMode": { "description": "Behavior when the webhook guardrail is unavailable\nor returns an error. `FailOpen` allows the request to continue.\n`FailClosed` (default) rejects the request.", "enum": [ "FailClosed", "FailOpen" ], "type": [ "string", "null" ] }, "forwardHeaderMatches": { "description": "HTTP header matches used to select the headers to forward to the webhook.\nRequest headers are used when forwarding requests and response headers\nare used when forwarding responses.\nBy default, no headers are forwarded.", "items": { "additionalProperties": false, "description": "HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request\nheaders.", "properties": { "name": { "description": "Name is the name of the HTTP Header to be matched. Name matching MUST be\ncase-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).\n\nIf multiple entries specify equivalent header names, only the first\nentry with an equivalent name MUST be considered for a match. Subsequent\nentries with an equivalent header name MUST be ignored. Due to the\ncase-insensitivity of header names, \"foo\" and \"Foo\" are considered\nequivalent.\n\nWhen a header is repeated in an HTTP request, it is\nimplementation-specific behavior as to how this is represented.\nGenerally, proxies should follow the guidance from the RFC:\nhttps://www.rfc-editor.org/rfc/rfc7230.html#section-3.2.2 regarding\nprocessing a repeated header, with special handling for \"Set-Cookie\".", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "type": { "default": "Exact", "description": "Type specifies how to match against the value of the header.\n\nSupport: Core (Exact)\n\nSupport: Implementation-specific (RegularExpression)\n\nSince RegularExpression HeaderMatchType has implementation-specific\nconformance, implementations can support POSIX, PCRE or any other dialects\nof regular expressions. Please read the implementation's documentation to\ndetermine the supported dialect.", "enum": [ "Exact", "RegularExpression" ], "type": [ "string", "null" ] }, "value": { "description": "Value is the value of HTTP Header to be matched.\n\u003cgateway:experimental:description\u003e\nMust consist of printable US-ASCII characters, optionally separated\nby single tabs or spaces. See: https://tools.ietf.org/html/rfc7230#section-3.2\n\u003c/gateway:experimental:description\u003e\n\n\u003cgateway:experimental:validation:Pattern=`^[!-~]+([\\t ]?[!-~]+)*$`\u003e", "maxLength": 4096, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": "object", "x-kubernetes-validations": [ { "message": "exactly one of the fields in [regex webhook bedrockGuardrails googleModelArmor] must be set", "rule": "[has(self.regex),has(self.webhook),has(self.bedrockGuardrails),has(self.googleModelArmor)].filter(x,x==true).size() == 1" } ] }, "maxItems": 8, "minItems": 1, "type": [ "array", "null" ] }, "streaming": { "description": "Apply prompt guards to streaming responses and realtime websocket messages.\nDefaults to disabled to preserve streaming throughput unless explicitly enabled.", "enum": [ "Enabled" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [request response] must be set", "rule": "[has(self.request),has(self.response)].filter(x,x==true).size() \u003e= 1" } ] }, "routes": { "additionalProperties": { "description": "How the AI gateway should process incoming requests\nbased on the URL path and the API format expected.", "enum": [ "AnthropicTokenCount", "Completions", "Detect", "Embeddings", "Messages", "Models", "Passthrough", "Realtime", "Rerank", "Responses" ], "type": "string" }, "description": "Rules for identifying the type of traffic to handle.\nThe keys are URL path suffixes matched using ends-with comparison, for\nexample `\"/v1/chat/completions\"`.\nThe special `*` wildcard matches any path.\nIf not specified, all traffic defaults to `completions` type.", "type": [ "object", "null" ] }, "transformations": { "description": "CEL transformations to compute and set fields in the request body.\nThe expression result overwrites any existing value for that field.\nThis has a higher priority than `overrides` if both are set for the same\nkey.", "items": { "additionalProperties": false, "description": "Maps a request JSON field to a CEL expression.\nThe expression is evaluated against the current request body and its result\nis assigned to the configured field.", "properties": { "expression": { "description": "CEL expression used to compute the field value.", "maxLength": 16384, "minLength": 1, "type": "string" }, "field": { "allOf": [ { "minLength": 1 }, { "minLength": 1 } ], "description": "Name of the field to set.", "maxLength": 256, "type": "string" } }, "required": [ "expression", "field" ], "type": "object" }, "maxItems": 64, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [defaults modelAliases overrides prompt promptCaching promptGuard routes transformations] must be set", "rule": "[has(self.defaults),has(self.modelAliases),has(self.overrides),has(self.prompt),has(self.promptCaching),has(self.promptGuard),has(self.routes),has(self.transformations)].filter(x,x==true).size() \u003e= 1" } ] }, "auth": { "additionalProperties": false, "description": "Settings for managing authentication to the backend.", "properties": { "aws": { "additionalProperties": false, "description": "Explicit AWS authentication method for the backend.\nWhen omitted, default AWS SDK credential discovery is used.", "properties": { "assumeRole": { "additionalProperties": false, "description": "AWS STS AssumeRole settings to use before signing backend requests.\nAmbient AWS credentials are used as the source credentials for STS.", "properties": { "roleArn": { "description": "AWS IAM role ARN to assume.", "minLength": 1, "pattern": "^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$", "type": "string" } }, "required": [ "roleArn" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the AWS credentials. When using the default Secret\nresolver, the `Secret` must have keys `accessKey`, `secretKey`, and\noptionally `sessionToken`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "serviceName": { "description": "AWS SigV4 signing service name, for example\n`bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS\nbackends may provide this automatically.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "secretRef and assumeRole are mutually exclusive", "rule": "!(has(self.secretRef) \u0026\u0026 has(self.assumeRole))" } ] }, "azure": { "additionalProperties": false, "description": "Azure authentication method for the backend.", "properties": { "managedIdentity": { "additionalProperties": false, "description": "Managed identity authentication settings.", "properties": { "clientId": { "type": "string" }, "objectId": { "type": "string" }, "resourceId": { "type": "string" } }, "required": [ "clientId", "objectId", "resourceId" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the Azure credentials. When using the default Secret\nresolver, the `Secret` must have keys `clientID`, `tenantID`, and\n`clientSecret`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ] }, "gcp": { "additionalProperties": false, "description": "Google authentication method for the backend.\nWhen omitted, default Google credential discovery is used.", "properties": { "audience": { "description": "Explicit `aud` value for the ID token. Only\nvalid with `IdToken` type. If not set, the `aud` is automatically\nderived from the backend hostname.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing ADC-compatible Google credential JSON. When using\nthe default Secret resolver, this must be stored in the `credentials.json`\nkey. When omitted, ambient credentials are used.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "type": { "description": "The type of token to generate. To authenticate to GCP services,\ngenerally an `AccessToken` is used. To authenticate to Cloud Run, an\n`IdToken` is used.", "enum": [ "AccessToken", "IdToken" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "audience is only valid with IdToken", "rule": "has(self.audience) ? self.type == 'IdToken' : true" } ] }, "key": { "description": "Inline key to use as the value of the\n`Authorization` header. This option is the least secure; usage of a\n`Secret` is preferred.", "maxLength": 2048, "type": [ "string", "null" ] }, "location": { "additionalProperties": false, "description": "Where backend credentials are inserted.\nIf omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix.\nThis applies to `key`, `secretRef`, and `passthrough`.", "properties": { "cookie": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] }, "header": { "additionalProperties": false, "properties": { "name": { "description": "HTTPHeaderName is the name of an HTTP header.\n\nValid values include:\n\n* \"Authorization\"\n* \"Set-Cookie\"\n\nInvalid values include:\n\n - \":method\" - \":\" is an invalid character. This means that HTTP/2 pseudo\n headers are not currently supported by this type.\n - \"/invalid\" - \"/ \" is an invalid character", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "prefix": { "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "queryParameter": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [header queryParameter cookie] must be set", "rule": "[has(self.header),has(self.queryParameter),has(self.cookie)].filter(x,x==true).size() == 1" } ] }, "passthrough": { "description": "Passes through an existing token that has been sent by the\nclient and validated. Other policies, like JWT and API key\nauthentication, will strip the original client credentials. Passthrough backend authentication\ncauses the original token to be added back into the request. If there are no client authentication policies on the\nrequest, the original token would be unchanged, so this would have no effect.", "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, storing the key to use as the authorization value. When using\nthe default Secret resolver, this must be stored in the `Authorization`\nkey.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "location may only be set for key or passthrough auth", "rule": "has(self.location) ? has(self.key) || has(self.secretRef) || has(self.passthrough) : true" }, { "message": "exactly one of the fields in [key secretRef passthrough aws azure gcp] must be set", "rule": "[has(self.key),has(self.secretRef),has(self.passthrough),has(self.aws),has(self.azure),has(self.gcp)].filter(x,x==true).size() == 1" } ] }, "health": { "additionalProperties": false, "description": "Settings for passive and active health checking.", "properties": { "eviction": { "additionalProperties": false, "description": "Settings for evicting unhealthy backends.", "properties": { "consecutiveFailures": { "description": "Number of consecutive unhealthy responses required before the backend is evicted.\nFor example, a value of 5 means the backend must receive 5 unhealthy responses in a row before being evicted.\nWhen both consecutiveFailures and healthThreshold are set, the backend is evicted when either condition is met.\nWhen neither is set, a single unhealthy response can trigger eviction.", "format": "int32", "minimum": 0, "type": [ "integer", "null" ] }, "duration": { "default": "3s", "description": "Base time a backend should be evicted after being marked unhealthy.\nSubsequent evictions use multiplicative backoff (duration * times_evicted).\nIf all endpoints are evicted, the load balancer falls back to returning evicted endpoints\nrather than failing entirely.\nIf unset, defaults to `3s`.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "evictionDuration must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "healthThreshold": { "description": "EWMA health score threshold, expressed as 0 to 100.\nWhen set, a backend is only evicted if its computed health drops below this value after an unhealthy response.\nFor example, 50 means the backend is evicted when its EWMA health falls below 50% following failures.\nUnlike consecutiveFailures (which counts consecutive failures), this uses a sliding-window average\nso a single success in a stream of failures can delay eviction.\nWhen both consecutiveFailures and healthThreshold are set, the backend is evicted when either condition is met.\nWhen neither is set, a single unhealthy response triggers eviction.", "format": "int32", "maximum": 100, "minimum": 0, "type": [ "integer", "null" ] }, "restoreHealth": { "description": "Health score from 0 to 100 assigned to a backend when it returns from eviction.\nFor gradual recovery, set below 100; for full recovery immediately, set 100.\nIf unset, the backend resumes with the health it had when evicted.", "format": "int32", "maximum": 100, "minimum": 0, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "unhealthyCondition": { "description": "CEL expression that determines whether a response indicates an unhealthy backend.\nWhen the expression evaluates to true, the backend is considered unhealthy and may be evicted.\n\nFor example, to evict on 5xx responses: `response.code \u003e= 500`.\n\nWhen unset, any 5xx response, or a connection failure, is treated as unhealthy.\nThis default lowers the backend's health score but does not trigger eviction on its own.", "maxLength": 16384, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "http": { "additionalProperties": false, "description": "Settings for managing HTTP requests to the backend.", "properties": { "requestTimeout": { "description": "Deadline for receiving a response from the backend.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "requestTimeout must be at least 1ms", "rule": "duration(self) \u003e= duration('1ms')" } ] }, "version": { "description": "HTTP protocol version to use when connecting to\nthe backend.\nIf not specified, the version is automatically determined:\n* `Service` types can specify it with `appProtocol` on the `Service`\n port.\n* If traffic is identified as gRPC, `HTTP2` is used.\n* If the incoming traffic was plaintext HTTP, the original protocol will\n be used.\n* If the incoming traffic was HTTPS, `HTTP1` will be used. This is\n because most clients will transparently upgrade HTTPS traffic to\n `HTTP2`, even if the backend doesn't support it.", "enum": [ "HTTP1", "HTTP2" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "tcp": { "additionalProperties": false, "description": "Settings for managing TCP connections to the backend.", "properties": { "connectTimeout": { "description": "Deadline for establishing a connection to\nthe destination.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "connectTimeout must be at least 100ms", "rule": "duration(self) \u003e= duration('100ms')" } ] }, "keepalive": { "additionalProperties": false, "description": "Settings for enabling TCP keepalives on the\nconnection.", "properties": { "interval": { "description": "Time between keepalive probes.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "interval must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "retries": { "description": "Maximum number of keepalive probes to send before dropping the connection.\nIf unset, this defaults to 9.", "format": "int32", "maximum": 64, "minimum": 1, "type": [ "integer", "null" ] }, "time": { "description": "Time a connection needs to be idle before keepalive probes start being sent.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "time must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "tls": { "additionalProperties": false, "description": "Settings for managing TLS connections to the backend.\n\nIf this field is set, TLS will be initiated to the backend; the system trusted CA certificates will be used to\nvalidate the server, and the SNI will automatically be set based on the destination.", "properties": { "alpnProtocols": { "description": "Application-Layer Protocol Negotiation (`ALPN`)\nvalue to use in the TLS handshake.\n\nIf not present, defaults to `[\"h2\", \"http/1.1\"]`.", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] }, "caCertificateRefs": { "description": "CA certificate `ConfigMap` to use to\nverify the server certificate.\nIf unset, the system's trusted certificates are used.", "items": { "additionalProperties": false, "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "insecureSkipVerify": { "description": "Originates TLS but skips verification of the backend's certificate.\nWARNING: This is an insecure option that should only be used if the risks are understood.\n\nThere are two modes:\n* `All` disables all TLS verification.\n* `Hostname` verifies the CA certificate is trusted, but ignores any\n mismatch of hostname or SANs. Note that this method is still insecure;\n prefer setting `verifySubjectAltNames` to customize the valid hostnames\n if possible.", "enum": [ "All", "Hostname" ], "type": [ "string", "null" ] }, "keyExchangeGroups": { "description": "Ordered list of key exchange groups for a TLS connection.\nFor example: `X25519_MLKEM768,X25519`.", "items": { "enum": [ "P-256", "P-384", "X25519", "X25519_MLKEM768" ], "type": "string" }, "type": [ "array", "null" ] }, "mtlsCertificateRef": { "description": "Enables mutual TLS to the backend, using the\nspecified key (`tls.key`) and cert (`tls.crt`) from the referenced\ncredential source, defaulting to a Kubernetes `Secret`.\n\nAn optional `ca.cert` field, if present, will be used to verify the\nserver certificate. If `caCertificateRefs` is also specified, the\n`caCertificateRefs` field takes priority.\n\nIf unspecified, no client certificate will be used.", "items": { "additionalProperties": false, "description": "References a same-namespace credential.\nSet only `name` to reference a Kubernetes Secret.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "sni": { "description": "Server Name Indicator (`SNI`) to use in the TLS\nhandshake. If unset, the `SNI` is automatically set based on the\ndestination hostname.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "verifySubjectAltNames": { "description": "Subject Alternative Names (`SAN`)\nto verify in the server certificate.\nIf not present, the destination hostname is automatically used.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "insecureSkipVerify All and caCertificateRefs may not be set together", "rule": "has(self.insecureSkipVerify) \u0026\u0026 self.insecureSkipVerify == 'All' ? !has(self.caCertificateRefs) : true" }, { "message": "insecureSkipVerify and verifySubjectAltNames may not be set together", "rule": "has(self.insecureSkipVerify) ? !has(self.verifySubjectAltNames) : true" }, { "message": "at most one of the fields in [verifySubjectAltNames insecureSkipVerify] may be set", "rule": "[has(self.verifySubjectAltNames),has(self.insecureSkipVerify)].filter(x,x==true).size() \u003c= 1" } ] }, "transformation": { "additionalProperties": false, "description": "Mutates and transforms requests and responses sent to and from the backend.", "properties": { "request": { "additionalProperties": false, "description": "Request transformation settings.", "properties": { "add": { "description": "Headers to add to the request and what each value\nshould be set to. If there is already a header with these values then\nappend the value as an extra entry.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the header to add.", "maxLength": 256, "minLength": 1, "pattern": "^:?[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string", "x-kubernetes-validations": [ { "message": "pseudo-headers must be one of :authority, :method, :path, :scheme, or :status", "rule": "!self.startsWith(':') || self in [':authority', ':method', ':path', ':scheme', ':status']" } ] }, "value": { "description": "CEL expression that generates the output value for\nthe header.", "maxLength": 16384, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "body": { "description": "HTTP body transformation.", "maxLength": 16384, "minLength": 1, "type": [ "string", "null" ] }, "metadata": { "additionalProperties": { "description": "A Common Expression Language (CEL) expression.", "maxLength": 16384, "minLength": 1, "type": "string" }, "description": "Stores CEL-evaluated values under the `metadata` CEL variable\nfor subsequent policy evaluations. `metadata` is evaluated before header\nor body transformations.", "maxProperties": 16, "minProperties": 1, "type": [ "object", "null" ] }, "remove": { "description": "Header names to remove from the request or\nresponse.", "items": { "description": "HTTP header name.", "maxLength": 256, "minLength": 1, "pattern": "^:?[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string", "x-kubernetes-validations": [ { "message": "pseudo-headers must be one of :authority, :method, :path, :scheme, or :status", "rule": "!self.startsWith(':') || self in [':authority', ':method', ':path', ':scheme', ':status']" } ] }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" }, "set": { "description": "Headers to set and the values to use.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the header to add.", "maxLength": 256, "minLength": 1, "pattern": "^:?[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string", "x-kubernetes-validations": [ { "message": "pseudo-headers must be one of :authority, :method, :path, :scheme, or :status", "rule": "!self.startsWith(':') || self in [':authority', ':method', ':path', ':scheme', ':status']" } ] }, "value": { "description": "CEL expression that generates the output value for\nthe header.", "maxLength": 16384, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [add body metadata remove set] must be set", "rule": "[has(self.add),has(self.body),has(self.metadata),has(self.remove),has(self.set)].filter(x,x==true).size() \u003e= 1" } ] }, "response": { "additionalProperties": false, "description": "Response transformation settings.", "properties": { "add": { "description": "Headers to add to the request and what each value\nshould be set to. If there is already a header with these values then\nappend the value as an extra entry.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the header to add.", "maxLength": 256, "minLength": 1, "pattern": "^:?[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string", "x-kubernetes-validations": [ { "message": "pseudo-headers must be one of :authority, :method, :path, :scheme, or :status", "rule": "!self.startsWith(':') || self in [':authority', ':method', ':path', ':scheme', ':status']" } ] }, "value": { "description": "CEL expression that generates the output value for\nthe header.", "maxLength": 16384, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "body": { "description": "HTTP body transformation.", "maxLength": 16384, "minLength": 1, "type": [ "string", "null" ] }, "metadata": { "additionalProperties": { "description": "A Common Expression Language (CEL) expression.", "maxLength": 16384, "minLength": 1, "type": "string" }, "description": "Stores CEL-evaluated values under the `metadata` CEL variable\nfor subsequent policy evaluations. `metadata` is evaluated before header\nor body transformations.", "maxProperties": 16, "minProperties": 1, "type": [ "object", "null" ] }, "remove": { "description": "Header names to remove from the request or\nresponse.", "items": { "description": "HTTP header name.", "maxLength": 256, "minLength": 1, "pattern": "^:?[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string", "x-kubernetes-validations": [ { "message": "pseudo-headers must be one of :authority, :method, :path, :scheme, or :status", "rule": "!self.startsWith(':') || self in [':authority', ':method', ':path', ':scheme', ':status']" } ] }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" }, "set": { "description": "Headers to set and the values to use.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the header to add.", "maxLength": 256, "minLength": 1, "pattern": "^:?[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string", "x-kubernetes-validations": [ { "message": "pseudo-headers must be one of :authority, :method, :path, :scheme, or :status", "rule": "!self.startsWith(':') || self in [':authority', ':method', ':path', ':scheme', ':status']" } ] }, "value": { "description": "CEL expression that generates the output value for\nthe header.", "maxLength": 16384, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [add body metadata remove set] must be set", "rule": "[has(self.add),has(self.body),has(self.metadata),has(self.remove),has(self.set)].filter(x,x==true).size() \u003e= 1" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [request response] must be set", "rule": "[has(self.request),has(self.response)].filter(x,x==true).size() \u003e= 1" } ] }, "tunnel": { "additionalProperties": false, "description": "Settings for managing tunnel connections, with behavior like `HTTPS_PROXY`, to the backend.", "properties": { "backendRef": { "additionalProperties": false, "description": "Proxy server to reach.\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [ai auth health http tcp tls transformation tunnel] must be set", "rule": "[has(self.ai),has(self.auth),has(self.health),has(self.http),has(self.tcp),has(self.tls),has(self.transformation),has(self.tunnel)].filter(x,x==true).size() \u003e= 1" } ] }, "port": { "description": "Port to send requests to.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] }, "vertexai": { "additionalProperties": false, "description": "Vertex AI provider settings.", "properties": { "model": { "description": "Model name override, such as `gpt-4o-mini`.\nIf unset, the model name is taken from the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "projectId": { "description": "The ID of the Google Cloud Project that you use for the Vertex AI.", "maxLength": 64, "minLength": 1, "type": "string" }, "region": { "default": "global", "description": "The location of the Google Cloud Project that you use for the Vertex AI.\nSpecial values: `global` uses the global endpoint, while `us` and `eu` use restricted\nmulti-region endpoints. Other values are treated as regional locations.\nDefaults to `global` if not specified.", "maxLength": 64, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "projectId" ], "type": [ "object", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "both host and port must be set together", "rule": "has(self.host) || has(self.port) ? has(self.host) \u0026\u0026 has(self.port) : true" }, { "message": "custom providers must specify exactly one of backendRef or host and port", "rule": "has(self.custom) ? has(self.custom.backendRef) != has(self.host) : true" }, { "message": "path and pathPrefix are mutually exclusive", "rule": "!(has(self.path) \u0026\u0026 has(self.pathPrefix))" }, { "message": "path, pathPrefix, and custom format paths are mutually exclusive", "rule": "!(has(self.custom) \u0026\u0026 self.custom.formats.exists(f, has(f.path)) \u0026\u0026 (has(self.path) || has(self.pathPrefix)))" }, { "message": "pathPrefix requires host to be set", "rule": "has(self.pathPrefix) ? has(self.host) : true" }, { "message": "exactly one of the fields in [openai azureopenai azure anthropic gemini vertexai bedrock custom] must be set", "rule": "[has(self.openai),has(self.azureopenai),has(self.azure),has(self.anthropic),has(self.gemini),has(self.vertexai),has(self.bedrock),has(self.custom)].filter(x,x==true).size() == 1" } ] }, "maxItems": 16, "minItems": 1, "type": "array", "x-kubernetes-validations": [ { "message": "provider names must be unique within a group", "rule": "self.all(p1, self.exists_one(p2, p1.name == p2.name))" } ] } }, "required": [ "providers" ], "type": "object" }, "maxItems": 8, "minItems": 1, "type": [ "array", "null" ] }, "provider": { "additionalProperties": false, "description": "Configuration for how to reach the configured LLM\nprovider.", "properties": { "anthropic": { "additionalProperties": false, "description": "Anthropic provider settings.", "properties": { "model": { "description": "Model name override, such as `gpt-4o-mini`.\nIf unset, the model name is taken from the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "azure": { "additionalProperties": false, "description": "Azure provider with resource-based configuration.\nSupports both Azure OpenAI and Azure AI Foundry resource types.", "properties": { "apiVersion": { "description": "The version of the Azure OpenAI API to use.\nIf unset, defaults to `v1`.", "maxLength": 64, "minLength": 1, "type": [ "string", "null" ] }, "model": { "description": "Model name override, such as `gpt-4o-mini`.\nIf unset, the model name is taken from the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "projectName": { "description": "The Foundry project name, required when `resourceType` is `Foundry`.\nUsed to construct paths: /api/projects/{projectName}/openai/v1/...", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "resourceName": { "description": "The Azure resource name used to construct the endpoint host.\nFor OpenAI: {resourceName}.openai.azure.com\nFor Foundry: {resourceName}.services.ai.azure.com\nNote: when the Azure portal \"Foundry legacy\" template was used, the\ngenerated resource name may end in \"-resource\" (e.g. \"myproject-resource\");\nthat suffix is part of the resource name as the user configured it, not\npart of the hostname suffix agentgateway should append.", "maxLength": 256, "minLength": 1, "type": "string" }, "resourceType": { "description": "The type of Azure endpoint. Determines the host suffix.", "enum": [ "Foundry", "OpenAI" ], "type": "string" } }, "required": [ "resourceName", "resourceType" ], "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "projectName is required when resourceType is Foundry", "rule": "self.resourceType != 'Foundry' || has(self.projectName)" } ] }, "azureopenai": { "additionalProperties": false, "description": "Azure OpenAI provider settings.", "properties": { "apiVersion": { "description": "The version of the Azure OpenAI API to use.\nFor more information, see the [Azure OpenAI API version reference](https://learn.microsoft.com/en-us/azure/foundry/openai/reference).\nIf unset, defaults to `v1`.", "maxLength": 64, "minLength": 1, "type": [ "string", "null" ] }, "deploymentName": { "description": "The name of the Azure OpenAI model deployment to use.\nFor more information, see the [Azure OpenAI model docs](https://learn.microsoft.com/en-us/azure/foundry/foundry-models/concepts/models-sold-directly-by-azure?view=foundry-classic).\nThis is required if `apiVersion` is not `v1`. For `v1`, the model can be\nset in the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "endpoint": { "description": "The endpoint for the Azure OpenAI API to use, such as `my-endpoint.openai.azure.com`.\nIf the scheme is included, it is stripped.", "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "endpoint" ], "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "deploymentName is required for this apiVersion", "rule": "!has(self.apiVersion) || self.apiVersion == 'v1' ? true : has(self.deploymentName)" } ] }, "bedrock": { "additionalProperties": false, "description": "Bedrock provider settings.", "properties": { "guardrail": { "additionalProperties": false, "description": "Guardrail policy to use for the backend. See\n\u003chttps://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html\u003e.\nIf not specified, the AWS Guardrail policy will not be used.", "properties": { "identifier": { "description": "Identifier of the Guardrail policy to use for the backend.", "maxLength": 256, "minLength": 1, "type": "string" }, "version": { "description": "Version of the Guardrail policy to use for the backend.", "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "identifier", "version" ], "type": [ "object", "null" ] }, "model": { "description": "Model name override, such as `gpt-4o-mini`.\nIf unset, the model name is taken from the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "region": { "default": "us-east-1", "description": "AWS region to use for the backend.\nDefaults to `us-east-1` if not specified.", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9-]+$", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "custom": { "additionalProperties": false, "description": "Custom provider configures a non-managed or self-hosted LLM provider.\nUse this when the provider target and API formats should be declared\nexplicitly instead of inferred from a managed provider such as OpenAI or\nAnthropic.", "properties": { "backendRef": { "additionalProperties": false, "description": "Kubernetes backend that serves this provider.\n`backendRef` may target only a namespace-local Service or InferencePool.\nIf unset, host and port must be set on the parent provider.", "properties": { "group": { "default": "", "description": "API group of the referenced resource. For example, `gateway.networking.k8s.io`.\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind of the referenced resource. For example, `Service`.\nDefaults to \"Service\" when not specified.", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name of the referenced resource.", "maxLength": 253, "minLength": 1, "type": "string" }, "port": { "description": "Destination port number to use for this resource.\nRequired when the referenced resource is a Kubernetes Service.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] }, "formats": { "description": "Provider-native API formats this provider supports.", "items": { "additionalProperties": false, "description": "Provider-native LLM API format settings.", "properties": { "path": { "description": "Default upstream path override for this format.\nIf unset, agentgateway uses the default path for the format.", "maxLength": 1024, "minLength": 1, "type": [ "string", "null" ] }, "type": { "description": "Provider-native API format.", "enum": [ "AnthropicTokenCount", "Completions", "Embeddings", "Messages", "Realtime", "Rerank", "Responses" ], "type": "string" } }, "required": [ "type" ], "type": "object", "x-kubernetes-validations": [ { "message": "path must start with /", "rule": "!has(self.path) || self.path.startsWith('/')" } ] }, "maxItems": 6, "minItems": 1, "type": "array", "x-kubernetes-list-map-keys": [ "type" ], "x-kubernetes-list-type": "map" }, "model": { "description": "Model name override, such as `gpt-oss`.\nIf unset, the model name is taken from the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "formats" ], "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "custom provider backendRef may target only Service or InferencePool", "rule": "!has(self.backendRef) || (((!has(self.backendRef.group) || self.backendRef.group == \"\") \u0026\u0026 (!has(self.backendRef.kind) || self.backendRef.kind == 'Service')) || (has(self.backendRef.group) \u0026\u0026 self.backendRef.group == 'inference.networking.k8s.io' \u0026\u0026 has(self.backendRef.kind) \u0026\u0026 self.backendRef.kind == 'InferencePool'))" } ] }, "gemini": { "additionalProperties": false, "description": "Gemini provider settings.", "properties": { "model": { "description": "Model name override, such as `gemini-2.5-pro`.\nIf unset, the model name is taken from the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "host": { "description": "Hostname to send requests to.\nFor custom providers without backendRef, host and port specify the target.\nFor managed providers, host and port override the provider default.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "openai": { "additionalProperties": false, "description": "OpenAI provider settings.", "properties": { "model": { "description": "Model name override, such as `gpt-4o-mini`.\nIf unset, the model name is taken from the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "path": { "description": "URL path to use for LLM provider API requests.\nThis is useful when you need to route requests to a different API endpoint while maintaining\ncompatibility with the original provider's API structure.\nIf not specified, the default path for the provider is used.", "maxLength": 1024, "minLength": 1, "type": [ "string", "null" ] }, "pathPrefix": { "description": "Overrides the default base path prefix, such as `/v1`, for upstream requests.\nPath translation for cross-format requests still applies using this prefix.\nOnly supported for OpenAI and Anthropic providers.", "maxLength": 1024, "minLength": 1, "type": [ "string", "null" ] }, "port": { "description": "Port to send requests to.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] }, "vertexai": { "additionalProperties": false, "description": "Vertex AI provider settings.", "properties": { "model": { "description": "Model name override, such as `gpt-4o-mini`.\nIf unset, the model name is taken from the request.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "projectId": { "description": "The ID of the Google Cloud Project that you use for the Vertex AI.", "maxLength": 64, "minLength": 1, "type": "string" }, "region": { "default": "global", "description": "The location of the Google Cloud Project that you use for the Vertex AI.\nSpecial values: `global` uses the global endpoint, while `us` and `eu` use restricted\nmulti-region endpoints. Other values are treated as regional locations.\nDefaults to `global` if not specified.", "maxLength": 64, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "projectId" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "both host and port must be set together", "rule": "has(self.host) || has(self.port) ? has(self.host) \u0026\u0026 has(self.port) : true" }, { "message": "custom providers must specify exactly one of backendRef or host and port", "rule": "has(self.custom) ? has(self.custom.backendRef) != has(self.host) : true" }, { "message": "path and pathPrefix are mutually exclusive", "rule": "!(has(self.path) \u0026\u0026 has(self.pathPrefix))" }, { "message": "path, pathPrefix, and custom format paths are mutually exclusive", "rule": "!(has(self.custom) \u0026\u0026 self.custom.formats.exists(f, has(f.path)) \u0026\u0026 (has(self.path) || has(self.pathPrefix)))" }, { "message": "pathPrefix requires host to be set", "rule": "has(self.pathPrefix) ? has(self.host) : true" }, { "message": "exactly one of the fields in [openai azureopenai azure anthropic gemini vertexai bedrock custom] must be set", "rule": "[has(self.openai),has(self.azureopenai),has(self.azure),has(self.anthropic),has(self.gemini),has(self.vertexai),has(self.bedrock),has(self.custom)].filter(x,x==true).size() == 1" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [provider groups] must be set", "rule": "[has(self.provider),has(self.groups)].filter(x,x==true).size() == 1" } ] }, "aws": { "additionalProperties": false, "description": "AWS service backend, such as AgentCore.", "properties": { "agentCore": { "additionalProperties": false, "description": "Amazon Bedrock AgentCore backend settings.", "properties": { "agentRuntimeArn": { "description": "ARN of the AgentCore runtime.", "type": "string" }, "qualifier": { "description": "Alias or version qualifier.", "type": [ "string", "null" ] } }, "required": [ "agentRuntimeArn" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [agentCore] must be set", "rule": "[has(self.agentCore)].filter(x,x==true).size() == 1" } ] }, "dynamicForwardProxy": { "description": "Dynamically sends requests to the destination based on the incoming\nrequest HTTP host header, or TLS SNI for TLS traffic.\n\nWarning: this backend type can send requests to arbitrary destinations. Proper\naccess controls must be put in place when using this backend type.", "type": [ "object", "null" ] }, "mcp": { "additionalProperties": false, "description": "MCP backend.", "properties": { "failureMode": { "description": "Behavior when MCP targets fail to initialize or\nbecome unavailable at runtime. `FailOpen` skips failed targets and\ncontinues serving from healthy ones. `FailClosed` (default) fails the\nentire session if any target fails.", "enum": [ "FailClosed", "FailOpen" ], "type": [ "string", "null" ] }, "sessionRouting": { "description": "MCP session routing behavior.\nDefaults to `Stateful` if not set.", "enum": [ "Stateful", "Stateless" ], "type": [ "string", "null" ] }, "targets": { "description": "MCP targets to use for this backend. Policies\ntargeting MCP targets must use `targetRefs[].sectionName` to select\nthe target by name.", "items": { "additionalProperties": false, "description": "MCP target selection for this backend.", "properties": { "name": { "description": "Name of the MCP target.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "selector": { "additionalProperties": false, "description": "Label selector used to select `Service` resources.\nIf policies are needed on a per-service basis, `AgentgatewayPolicy` can\ntarget the desired `Service`.", "properties": { "namespaces": { "additionalProperties": false, "description": "`namespace` is the label selector for namespaces that `Service`\nresources should be selected from. If unset, only the namespace of the\n`AgentgatewayBackend` is searched.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "services": { "additionalProperties": false, "description": "`services` is the label selector for which `Service` resources should be\nselected.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [namespaces services] must be set", "rule": "[has(self.namespaces),has(self.services)].filter(x,x==true).size() \u003e= 1" } ] }, "static": { "additionalProperties": false, "description": "Static MCP destination. When connecting to\nin-cluster `Service` resources, it is recommended to use `selector`\ninstead.", "properties": { "backendRef": { "additionalProperties": false, "description": "Namespace-local `Service` resource by name.\nWhen set, this replaces `host` only; `port`, `path`, and `protocol`\nremain configured on this target.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "host": { "description": "Hostname or IP address of the MCP target.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "path": { "description": "URL path of the MCP target endpoint.\nDefaults to `\"/sse\"` for the `SSE` protocol or `\"/mcp\"` for the\n`StreamableHTTP` protocol if not specified.", "maxLength": 1024, "minLength": 1, "type": [ "string", "null" ] }, "policies": { "additionalProperties": false, "description": "Policies for communicating with this backend.\nPolicies may also be set in `AgentgatewayPolicy`, or in the top-level\n`AgentgatewayBackend`. Policies are merged on a field-level basis, with\norder: `AgentgatewayPolicy` \u003c `AgentgatewayBackend` \u003c `AgentgatewayBackend` MCP (this field).\nThis field may only be used with host-based static targets, not\n`backendRef`.", "properties": { "auth": { "additionalProperties": false, "description": "Settings for managing authentication to the backend.", "properties": { "aws": { "additionalProperties": false, "description": "Explicit AWS authentication method for the backend.\nWhen omitted, default AWS SDK credential discovery is used.", "properties": { "assumeRole": { "additionalProperties": false, "description": "AWS STS AssumeRole settings to use before signing backend requests.\nAmbient AWS credentials are used as the source credentials for STS.", "properties": { "roleArn": { "description": "AWS IAM role ARN to assume.", "minLength": 1, "pattern": "^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$", "type": "string" } }, "required": [ "roleArn" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the AWS credentials. When using the default Secret\nresolver, the `Secret` must have keys `accessKey`, `secretKey`, and\noptionally `sessionToken`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "serviceName": { "description": "AWS SigV4 signing service name, for example\n`bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS\nbackends may provide this automatically.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "secretRef and assumeRole are mutually exclusive", "rule": "!(has(self.secretRef) \u0026\u0026 has(self.assumeRole))" } ] }, "azure": { "additionalProperties": false, "description": "Azure authentication method for the backend.", "properties": { "managedIdentity": { "additionalProperties": false, "description": "Managed identity authentication settings.", "properties": { "clientId": { "type": "string" }, "objectId": { "type": "string" }, "resourceId": { "type": "string" } }, "required": [ "clientId", "objectId", "resourceId" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the Azure credentials. When using the default Secret\nresolver, the `Secret` must have keys `clientID`, `tenantID`, and\n`clientSecret`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ] }, "gcp": { "additionalProperties": false, "description": "Google authentication method for the backend.\nWhen omitted, default Google credential discovery is used.", "properties": { "audience": { "description": "Explicit `aud` value for the ID token. Only\nvalid with `IdToken` type. If not set, the `aud` is automatically\nderived from the backend hostname.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing ADC-compatible Google credential JSON. When using\nthe default Secret resolver, this must be stored in the `credentials.json`\nkey. When omitted, ambient credentials are used.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "type": { "description": "The type of token to generate. To authenticate to GCP services,\ngenerally an `AccessToken` is used. To authenticate to Cloud Run, an\n`IdToken` is used.", "enum": [ "AccessToken", "IdToken" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "audience is only valid with IdToken", "rule": "has(self.audience) ? self.type == 'IdToken' : true" } ] }, "key": { "description": "Inline key to use as the value of the\n`Authorization` header. This option is the least secure; usage of a\n`Secret` is preferred.", "maxLength": 2048, "type": [ "string", "null" ] }, "location": { "additionalProperties": false, "description": "Where backend credentials are inserted.\nIf omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix.\nThis applies to `key`, `secretRef`, and `passthrough`.", "properties": { "cookie": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] }, "header": { "additionalProperties": false, "properties": { "name": { "description": "HTTPHeaderName is the name of an HTTP header.\n\nValid values include:\n\n* \"Authorization\"\n* \"Set-Cookie\"\n\nInvalid values include:\n\n - \":method\" - \":\" is an invalid character. This means that HTTP/2 pseudo\n headers are not currently supported by this type.\n - \"/invalid\" - \"/ \" is an invalid character", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "prefix": { "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "queryParameter": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [header queryParameter cookie] must be set", "rule": "[has(self.header),has(self.queryParameter),has(self.cookie)].filter(x,x==true).size() == 1" } ] }, "passthrough": { "description": "Passes through an existing token that has been sent by the\nclient and validated. Other policies, like JWT and API key\nauthentication, will strip the original client credentials. Passthrough backend authentication\ncauses the original token to be added back into the request. If there are no client authentication policies on the\nrequest, the original token would be unchanged, so this would have no effect.", "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, storing the key to use as the authorization value. When using\nthe default Secret resolver, this must be stored in the `Authorization`\nkey.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "location may only be set for key or passthrough auth", "rule": "has(self.location) ? has(self.key) || has(self.secretRef) || has(self.passthrough) : true" }, { "message": "exactly one of the fields in [key secretRef passthrough aws azure gcp] must be set", "rule": "[has(self.key),has(self.secretRef),has(self.passthrough),has(self.aws),has(self.azure),has(self.gcp)].filter(x,x==true).size() == 1" } ] }, "http": { "additionalProperties": false, "description": "Settings for managing HTTP requests to the backend.", "properties": { "requestTimeout": { "description": "Deadline for receiving a response from the backend.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "requestTimeout must be at least 1ms", "rule": "duration(self) \u003e= duration('1ms')" } ] }, "version": { "description": "HTTP protocol version to use when connecting to\nthe backend.\nIf not specified, the version is automatically determined:\n* `Service` types can specify it with `appProtocol` on the `Service`\n port.\n* If traffic is identified as gRPC, `HTTP2` is used.\n* If the incoming traffic was plaintext HTTP, the original protocol will\n be used.\n* If the incoming traffic was HTTPS, `HTTP1` will be used. This is\n because most clients will transparently upgrade HTTPS traffic to\n `HTTP2`, even if the backend doesn't support it.", "enum": [ "HTTP1", "HTTP2" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "tcp": { "additionalProperties": false, "description": "Settings for managing TCP connections to the backend.", "properties": { "connectTimeout": { "description": "Deadline for establishing a connection to\nthe destination.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "connectTimeout must be at least 100ms", "rule": "duration(self) \u003e= duration('100ms')" } ] }, "keepalive": { "additionalProperties": false, "description": "Settings for enabling TCP keepalives on the\nconnection.", "properties": { "interval": { "description": "Time between keepalive probes.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "interval must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "retries": { "description": "Maximum number of keepalive probes to send before dropping the connection.\nIf unset, this defaults to 9.", "format": "int32", "maximum": 64, "minimum": 1, "type": [ "integer", "null" ] }, "time": { "description": "Time a connection needs to be idle before keepalive probes start being sent.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "time must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "tls": { "additionalProperties": false, "description": "Settings for managing TLS connections to the backend.\n\nIf this field is set, TLS will be initiated to the backend; the system trusted CA certificates will be used to\nvalidate the server, and the SNI will automatically be set based on the destination.", "properties": { "alpnProtocols": { "description": "Application-Layer Protocol Negotiation (`ALPN`)\nvalue to use in the TLS handshake.\n\nIf not present, defaults to `[\"h2\", \"http/1.1\"]`.", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] }, "caCertificateRefs": { "description": "CA certificate `ConfigMap` to use to\nverify the server certificate.\nIf unset, the system's trusted certificates are used.", "items": { "additionalProperties": false, "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "insecureSkipVerify": { "description": "Originates TLS but skips verification of the backend's certificate.\nWARNING: This is an insecure option that should only be used if the risks are understood.\n\nThere are two modes:\n* `All` disables all TLS verification.\n* `Hostname` verifies the CA certificate is trusted, but ignores any\n mismatch of hostname or SANs. Note that this method is still insecure;\n prefer setting `verifySubjectAltNames` to customize the valid hostnames\n if possible.", "enum": [ "All", "Hostname" ], "type": [ "string", "null" ] }, "keyExchangeGroups": { "description": "Ordered list of key exchange groups for a TLS connection.\nFor example: `X25519_MLKEM768,X25519`.", "items": { "enum": [ "P-256", "P-384", "X25519", "X25519_MLKEM768" ], "type": "string" }, "type": [ "array", "null" ] }, "mtlsCertificateRef": { "description": "Enables mutual TLS to the backend, using the\nspecified key (`tls.key`) and cert (`tls.crt`) from the referenced\ncredential source, defaulting to a Kubernetes `Secret`.\n\nAn optional `ca.cert` field, if present, will be used to verify the\nserver certificate. If `caCertificateRefs` is also specified, the\n`caCertificateRefs` field takes priority.\n\nIf unspecified, no client certificate will be used.", "items": { "additionalProperties": false, "description": "References a same-namespace credential.\nSet only `name` to reference a Kubernetes Secret.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "sni": { "description": "Server Name Indicator (`SNI`) to use in the TLS\nhandshake. If unset, the `SNI` is automatically set based on the\ndestination hostname.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "verifySubjectAltNames": { "description": "Subject Alternative Names (`SAN`)\nto verify in the server certificate.\nIf not present, the destination hostname is automatically used.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "insecureSkipVerify All and caCertificateRefs may not be set together", "rule": "has(self.insecureSkipVerify) \u0026\u0026 self.insecureSkipVerify == 'All' ? !has(self.caCertificateRefs) : true" }, { "message": "insecureSkipVerify and verifySubjectAltNames may not be set together", "rule": "has(self.insecureSkipVerify) ? !has(self.verifySubjectAltNames) : true" }, { "message": "at most one of the fields in [verifySubjectAltNames insecureSkipVerify] may be set", "rule": "[has(self.verifySubjectAltNames),has(self.insecureSkipVerify)].filter(x,x==true).size() \u003c= 1" } ] }, "tunnel": { "additionalProperties": false, "description": "Settings for managing tunnel connections, with behavior like `HTTPS_PROXY`, to the backend.", "properties": { "backendRef": { "additionalProperties": false, "description": "Proxy server to reach.\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "port": { "description": "Port number of the MCP target.", "format": "int32", "maximum": 65535, "minimum": 1, "type": "integer" }, "protocol": { "description": "Protocol to use for the connection to the MCP\ntarget.", "enum": [ "SSE", "StreamableHTTP" ], "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "mcp target policies may not be used with backendRef", "rule": "!has(self.backendRef) || !has(self.policies)" }, { "message": "exactly one of the fields in [host backendRef] must be set", "rule": "[has(self.host),has(self.backendRef)].filter(x,x==true).size() == 1" } ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "exactly one of the fields in [selector static] must be set", "rule": "[has(self.selector),has(self.static)].filter(x,x==true).size() == 1" } ] }, "maxItems": 32, "minItems": 1, "type": "array", "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map", "x-kubernetes-validations": [ { "message": "target names must be unique", "rule": "self.all(t1, self.exists_one(t2, t1.name == t2.name))" } ] } }, "required": [ "targets" ], "type": [ "object", "null" ] }, "policies": { "additionalProperties": false, "description": "Policies for communicating with this backend. Policies may also be set\nwith AgentgatewayPolicy. Backend policies take precedence over policy\nresources when they set the same field.", "properties": { "ai": { "additionalProperties": false, "description": "Settings for AI workloads. This is only applicable when\nconnecting to a `Backend` of type `ai`.", "properties": { "defaults": { "description": "Defaults to merge with user input fields. If the field is already set, the field in the request is used.", "items": { "additionalProperties": false, "description": "Default value for a field in the JSON request body sent to the LLM provider.\nThese defaults are merged with the user-provided request to ensure missing fields are populated.\n\nUser input fields here refer to the fields in the JSON request body that a client sends when making a request to the LLM provider.\nDefaults set here do _not_ override those user-provided values unless you explicitly set `override` to `true`.\n\nExample: Setting a default system field for Anthropic, which does not support system role messages:\n\n\tdefaults:\n\t - field: \"system\"\n\t value: \"answer all questions in French\"\n\nExample: Setting a default temperature and overriding `max_tokens`:\n\n\tdefaults:\n\t - field: \"temperature\"\n\t value: \"0.5\"\n\t - field: \"max_tokens\"\n\t value: \"100\"\n\t override: true\n\nExample: Setting custom lists fields:\n\n\tdefaults:\n\t - field: \"custom_integer_list\"\n\t value: [1,2,3]\n\n\toverrides:\n\t - field: \"custom_string_list\"\n\t value: [\"one\",\"two\",\"three\"]\n\nNote: The `field` values correspond to keys in the JSON request body, not fields in this CRD.", "properties": { "field": { "allOf": [ { "minLength": 1 }, { "minLength": 1 } ], "description": "Name of the field.", "maxLength": 256, "type": "string" }, "value": { "description": "Default value for the field. This can be any JSON data type.", "x-kubernetes-preserve-unknown-fields": true } }, "required": [ "field", "value" ], "type": "object" }, "maxItems": 64, "minItems": 1, "type": [ "array", "null" ] }, "modelAliases": { "additionalProperties": { "type": "string" }, "description": "Maps friendly model names to actual provider model names.\nExample: `{\"fast\": \"gpt-3.5-turbo\", \"smart\": \"gpt-4-turbo\"}`.\nNote: This field is only applicable when using the agentgateway data plane.", "maxProperties": 64, "type": [ "object", "null" ] }, "overrides": { "description": "Overrides to merge with user input fields. If the field is already set, the field is overwritten.", "items": { "additionalProperties": false, "description": "Default value for a field in the JSON request body sent to the LLM provider.\nThese defaults are merged with the user-provided request to ensure missing fields are populated.\n\nUser input fields here refer to the fields in the JSON request body that a client sends when making a request to the LLM provider.\nDefaults set here do _not_ override those user-provided values unless you explicitly set `override` to `true`.\n\nExample: Setting a default system field for Anthropic, which does not support system role messages:\n\n\tdefaults:\n\t - field: \"system\"\n\t value: \"answer all questions in French\"\n\nExample: Setting a default temperature and overriding `max_tokens`:\n\n\tdefaults:\n\t - field: \"temperature\"\n\t value: \"0.5\"\n\t - field: \"max_tokens\"\n\t value: \"100\"\n\t override: true\n\nExample: Setting custom lists fields:\n\n\tdefaults:\n\t - field: \"custom_integer_list\"\n\t value: [1,2,3]\n\n\toverrides:\n\t - field: \"custom_string_list\"\n\t value: [\"one\",\"two\",\"three\"]\n\nNote: The `field` values correspond to keys in the JSON request body, not fields in this CRD.", "properties": { "field": { "allOf": [ { "minLength": 1 }, { "minLength": 1 } ], "description": "Name of the field.", "maxLength": 256, "type": "string" }, "value": { "description": "Default value for the field. This can be any JSON data type.", "x-kubernetes-preserve-unknown-fields": true } }, "required": [ "field", "value" ], "type": "object" }, "maxItems": 64, "minItems": 1, "type": [ "array", "null" ] }, "prompt": { "additionalProperties": false, "description": "Enriches requests sent to the LLM provider by appending and prepending system prompts. This can be configured only for\nLLM providers that use the `CHAT` or `CHAT_STREAMING` API route type.", "properties": { "append": { "description": "Messages to append to the prompt sent by the client.", "items": { "additionalProperties": false, "description": "An entry for a message to prepend or append to each prompt.", "properties": { "content": { "description": "String content of the message.", "type": "string" }, "role": { "description": "Role of the message. The available roles depend on the backend\nLLM provider model, such as `SYSTEM` or `USER` in the OpenAI API.", "type": "string" } }, "required": [ "content", "role" ], "type": "object" }, "type": [ "array", "null" ] }, "prepend": { "description": "Messages to prepend to the prompt sent by the client.", "items": { "additionalProperties": false, "description": "An entry for a message to prepend or append to each prompt.", "properties": { "content": { "description": "String content of the message.", "type": "string" }, "role": { "description": "Role of the message. The available roles depend on the backend\nLLM provider model, such as `SYSTEM` or `USER` in the OpenAI API.", "type": "string" } }, "required": [ "content", "role" ], "type": "object" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "promptCaching": { "additionalProperties": false, "description": "Automatic prompt caching for supported\nproviders, currently AWS Bedrock.\nReduces API costs by caching static content like system prompts and tool definitions.\nOnly applicable for Bedrock Claude 3+ and Nova models.", "properties": { "cacheMessageOffset": { "default": 0, "description": "Shifts the message cache point further back in the\nconversation. 0 (default) places it at the second-to-last message.\nHigher values move it N additional messages towards the start, clamped\nto bounds.", "minimum": 0, "type": [ "integer", "null" ] }, "cacheMessages": { "default": true, "description": "Enables caching for conversation messages.\nCaches all messages in the conversation for cost savings.", "type": [ "boolean", "null" ] }, "cacheSystem": { "default": true, "description": "Enables caching for system prompts.\nInserts a cache point after all system messages.", "type": [ "boolean", "null" ] }, "cacheTools": { "default": false, "description": "Enables caching for tool definitions.\nInserts a cache point after all tool specifications.", "type": [ "boolean", "null" ] }, "minTokens": { "default": 1024, "description": "Minimum estimated token count\nbefore caching is enabled. Uses rough heuristic (word count × 1.3) to estimate tokens.\nBedrock requires at least 1,024 tokens for caching to be effective.", "minimum": 0, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "promptGuard": { "additionalProperties": false, "description": "Guardrails for LLM requests and responses.", "properties": { "request": { "description": "Prompt guards to apply to requests sent by the client.", "items": { "additionalProperties": false, "description": "Prompt guards to apply to requests sent by the client.", "properties": { "bedrockGuardrails": { "additionalProperties": false, "description": "AWS Bedrock Guardrails settings for prompt\nguarding.", "properties": { "identifier": { "description": "Identifier of the Guardrail policy to use for the backend.", "maxLength": 256, "minLength": 1, "type": "string" }, "policies": { "additionalProperties": false, "description": "Policies for communicating with AWS Bedrock Guardrails.", "properties": { "auth": { "additionalProperties": false, "description": "Settings for managing authentication to the backend.", "properties": { "aws": { "additionalProperties": false, "description": "Explicit AWS authentication method for the backend.\nWhen omitted, default AWS SDK credential discovery is used.", "properties": { "assumeRole": { "additionalProperties": false, "description": "AWS STS AssumeRole settings to use before signing backend requests.\nAmbient AWS credentials are used as the source credentials for STS.", "properties": { "roleArn": { "description": "AWS IAM role ARN to assume.", "minLength": 1, "pattern": "^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$", "type": "string" } }, "required": [ "roleArn" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the AWS credentials. When using the default Secret\nresolver, the `Secret` must have keys `accessKey`, `secretKey`, and\noptionally `sessionToken`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "serviceName": { "description": "AWS SigV4 signing service name, for example\n`bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS\nbackends may provide this automatically.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "secretRef and assumeRole are mutually exclusive", "rule": "!(has(self.secretRef) \u0026\u0026 has(self.assumeRole))" } ] }, "azure": { "additionalProperties": false, "description": "Azure authentication method for the backend.", "properties": { "managedIdentity": { "additionalProperties": false, "description": "Managed identity authentication settings.", "properties": { "clientId": { "type": "string" }, "objectId": { "type": "string" }, "resourceId": { "type": "string" } }, "required": [ "clientId", "objectId", "resourceId" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the Azure credentials. When using the default Secret\nresolver, the `Secret` must have keys `clientID`, `tenantID`, and\n`clientSecret`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ] }, "gcp": { "additionalProperties": false, "description": "Google authentication method for the backend.\nWhen omitted, default Google credential discovery is used.", "properties": { "audience": { "description": "Explicit `aud` value for the ID token. Only\nvalid with `IdToken` type. If not set, the `aud` is automatically\nderived from the backend hostname.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing ADC-compatible Google credential JSON. When using\nthe default Secret resolver, this must be stored in the `credentials.json`\nkey. When omitted, ambient credentials are used.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "type": { "description": "The type of token to generate. To authenticate to GCP services,\ngenerally an `AccessToken` is used. To authenticate to Cloud Run, an\n`IdToken` is used.", "enum": [ "AccessToken", "IdToken" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "audience is only valid with IdToken", "rule": "has(self.audience) ? self.type == 'IdToken' : true" } ] }, "key": { "description": "Inline key to use as the value of the\n`Authorization` header. This option is the least secure; usage of a\n`Secret` is preferred.", "maxLength": 2048, "type": [ "string", "null" ] }, "location": { "additionalProperties": false, "description": "Where backend credentials are inserted.\nIf omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix.\nThis applies to `key`, `secretRef`, and `passthrough`.", "properties": { "cookie": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] }, "header": { "additionalProperties": false, "properties": { "name": { "description": "HTTPHeaderName is the name of an HTTP header.\n\nValid values include:\n\n* \"Authorization\"\n* \"Set-Cookie\"\n\nInvalid values include:\n\n - \":method\" - \":\" is an invalid character. This means that HTTP/2 pseudo\n headers are not currently supported by this type.\n - \"/invalid\" - \"/ \" is an invalid character", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "prefix": { "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "queryParameter": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [header queryParameter cookie] must be set", "rule": "[has(self.header),has(self.queryParameter),has(self.cookie)].filter(x,x==true).size() == 1" } ] }, "passthrough": { "description": "Passes through an existing token that has been sent by the\nclient and validated. Other policies, like JWT and API key\nauthentication, will strip the original client credentials. Passthrough backend authentication\ncauses the original token to be added back into the request. If there are no client authentication policies on the\nrequest, the original token would be unchanged, so this would have no effect.", "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, storing the key to use as the authorization value. When using\nthe default Secret resolver, this must be stored in the `Authorization`\nkey.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "location may only be set for key or passthrough auth", "rule": "has(self.location) ? has(self.key) || has(self.secretRef) || has(self.passthrough) : true" }, { "message": "exactly one of the fields in [key secretRef passthrough aws azure gcp] must be set", "rule": "[has(self.key),has(self.secretRef),has(self.passthrough),has(self.aws),has(self.azure),has(self.gcp)].filter(x,x==true).size() == 1" } ] }, "http": { "additionalProperties": false, "description": "Settings for managing HTTP requests to the backend.", "properties": { "requestTimeout": { "description": "Deadline for receiving a response from the backend.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "requestTimeout must be at least 1ms", "rule": "duration(self) \u003e= duration('1ms')" } ] }, "version": { "description": "HTTP protocol version to use when connecting to\nthe backend.\nIf not specified, the version is automatically determined:\n* `Service` types can specify it with `appProtocol` on the `Service`\n port.\n* If traffic is identified as gRPC, `HTTP2` is used.\n* If the incoming traffic was plaintext HTTP, the original protocol will\n be used.\n* If the incoming traffic was HTTPS, `HTTP1` will be used. This is\n because most clients will transparently upgrade HTTPS traffic to\n `HTTP2`, even if the backend doesn't support it.", "enum": [ "HTTP1", "HTTP2" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "tcp": { "additionalProperties": false, "description": "Settings for managing TCP connections to the backend.", "properties": { "connectTimeout": { "description": "Deadline for establishing a connection to\nthe destination.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "connectTimeout must be at least 100ms", "rule": "duration(self) \u003e= duration('100ms')" } ] }, "keepalive": { "additionalProperties": false, "description": "Settings for enabling TCP keepalives on the\nconnection.", "properties": { "interval": { "description": "Time between keepalive probes.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "interval must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "retries": { "description": "Maximum number of keepalive probes to send before dropping the connection.\nIf unset, this defaults to 9.", "format": "int32", "maximum": 64, "minimum": 1, "type": [ "integer", "null" ] }, "time": { "description": "Time a connection needs to be idle before keepalive probes start being sent.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "time must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "tls": { "additionalProperties": false, "description": "Settings for managing TLS connections to the backend.\n\nIf this field is set, TLS will be initiated to the backend; the system trusted CA certificates will be used to\nvalidate the server, and the SNI will automatically be set based on the destination.", "properties": { "alpnProtocols": { "description": "Application-Layer Protocol Negotiation (`ALPN`)\nvalue to use in the TLS handshake.\n\nIf not present, defaults to `[\"h2\", \"http/1.1\"]`.", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] }, "caCertificateRefs": { "description": "CA certificate `ConfigMap` to use to\nverify the server certificate.\nIf unset, the system's trusted certificates are used.", "items": { "additionalProperties": false, "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "insecureSkipVerify": { "description": "Originates TLS but skips verification of the backend's certificate.\nWARNING: This is an insecure option that should only be used if the risks are understood.\n\nThere are two modes:\n* `All` disables all TLS verification.\n* `Hostname` verifies the CA certificate is trusted, but ignores any\n mismatch of hostname or SANs. Note that this method is still insecure;\n prefer setting `verifySubjectAltNames` to customize the valid hostnames\n if possible.", "enum": [ "All", "Hostname" ], "type": [ "string", "null" ] }, "keyExchangeGroups": { "description": "Ordered list of key exchange groups for a TLS connection.\nFor example: `X25519_MLKEM768,X25519`.", "items": { "enum": [ "P-256", "P-384", "X25519", "X25519_MLKEM768" ], "type": "string" }, "type": [ "array", "null" ] }, "mtlsCertificateRef": { "description": "Enables mutual TLS to the backend, using the\nspecified key (`tls.key`) and cert (`tls.crt`) from the referenced\ncredential source, defaulting to a Kubernetes `Secret`.\n\nAn optional `ca.cert` field, if present, will be used to verify the\nserver certificate. If `caCertificateRefs` is also specified, the\n`caCertificateRefs` field takes priority.\n\nIf unspecified, no client certificate will be used.", "items": { "additionalProperties": false, "description": "References a same-namespace credential.\nSet only `name` to reference a Kubernetes Secret.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "sni": { "description": "Server Name Indicator (`SNI`) to use in the TLS\nhandshake. If unset, the `SNI` is automatically set based on the\ndestination hostname.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "verifySubjectAltNames": { "description": "Subject Alternative Names (`SAN`)\nto verify in the server certificate.\nIf not present, the destination hostname is automatically used.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "insecureSkipVerify All and caCertificateRefs may not be set together", "rule": "has(self.insecureSkipVerify) \u0026\u0026 self.insecureSkipVerify == 'All' ? !has(self.caCertificateRefs) : true" }, { "message": "insecureSkipVerify and verifySubjectAltNames may not be set together", "rule": "has(self.insecureSkipVerify) ? !has(self.verifySubjectAltNames) : true" }, { "message": "at most one of the fields in [verifySubjectAltNames insecureSkipVerify] may be set", "rule": "[has(self.verifySubjectAltNames),has(self.insecureSkipVerify)].filter(x,x==true).size() \u003c= 1" } ] }, "tunnel": { "additionalProperties": false, "description": "Settings for managing tunnel connections, with behavior like `HTTPS_PROXY`, to the backend.", "properties": { "backendRef": { "additionalProperties": false, "description": "Proxy server to reach.\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "region": { "description": "AWS region where the guardrail is deployed, for example\n`us-west-2`).", "maxLength": 256, "minLength": 1, "type": "string" }, "version": { "description": "Version of the Guardrail policy to use for the backend.", "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "identifier", "region", "version" ], "type": [ "object", "null" ] }, "googleModelArmor": { "additionalProperties": false, "description": "Google Model Armor settings for prompt guarding.", "properties": { "location": { "default": "us-central1", "description": "Google Cloud location, for example `us-central1`.\nDefaults to `us-central1` if not specified.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "policies": { "additionalProperties": false, "description": "Policies for communicating with Google Model Armor.", "properties": { "auth": { "additionalProperties": false, "description": "Settings for managing authentication to the backend.", "properties": { "aws": { "additionalProperties": false, "description": "Explicit AWS authentication method for the backend.\nWhen omitted, default AWS SDK credential discovery is used.", "properties": { "assumeRole": { "additionalProperties": false, "description": "AWS STS AssumeRole settings to use before signing backend requests.\nAmbient AWS credentials are used as the source credentials for STS.", "properties": { "roleArn": { "description": "AWS IAM role ARN to assume.", "minLength": 1, "pattern": "^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$", "type": "string" } }, "required": [ "roleArn" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the AWS credentials. When using the default Secret\nresolver, the `Secret` must have keys `accessKey`, `secretKey`, and\noptionally `sessionToken`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "serviceName": { "description": "AWS SigV4 signing service name, for example\n`bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS\nbackends may provide this automatically.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "secretRef and assumeRole are mutually exclusive", "rule": "!(has(self.secretRef) \u0026\u0026 has(self.assumeRole))" } ] }, "azure": { "additionalProperties": false, "description": "Azure authentication method for the backend.", "properties": { "managedIdentity": { "additionalProperties": false, "description": "Managed identity authentication settings.", "properties": { "clientId": { "type": "string" }, "objectId": { "type": "string" }, "resourceId": { "type": "string" } }, "required": [ "clientId", "objectId", "resourceId" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the Azure credentials. When using the default Secret\nresolver, the `Secret` must have keys `clientID`, `tenantID`, and\n`clientSecret`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ] }, "gcp": { "additionalProperties": false, "description": "Google authentication method for the backend.\nWhen omitted, default Google credential discovery is used.", "properties": { "audience": { "description": "Explicit `aud` value for the ID token. Only\nvalid with `IdToken` type. If not set, the `aud` is automatically\nderived from the backend hostname.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing ADC-compatible Google credential JSON. When using\nthe default Secret resolver, this must be stored in the `credentials.json`\nkey. When omitted, ambient credentials are used.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "type": { "description": "The type of token to generate. To authenticate to GCP services,\ngenerally an `AccessToken` is used. To authenticate to Cloud Run, an\n`IdToken` is used.", "enum": [ "AccessToken", "IdToken" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "audience is only valid with IdToken", "rule": "has(self.audience) ? self.type == 'IdToken' : true" } ] }, "key": { "description": "Inline key to use as the value of the\n`Authorization` header. This option is the least secure; usage of a\n`Secret` is preferred.", "maxLength": 2048, "type": [ "string", "null" ] }, "location": { "additionalProperties": false, "description": "Where backend credentials are inserted.\nIf omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix.\nThis applies to `key`, `secretRef`, and `passthrough`.", "properties": { "cookie": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] }, "header": { "additionalProperties": false, "properties": { "name": { "description": "HTTPHeaderName is the name of an HTTP header.\n\nValid values include:\n\n* \"Authorization\"\n* \"Set-Cookie\"\n\nInvalid values include:\n\n - \":method\" - \":\" is an invalid character. This means that HTTP/2 pseudo\n headers are not currently supported by this type.\n - \"/invalid\" - \"/ \" is an invalid character", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "prefix": { "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "queryParameter": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [header queryParameter cookie] must be set", "rule": "[has(self.header),has(self.queryParameter),has(self.cookie)].filter(x,x==true).size() == 1" } ] }, "passthrough": { "description": "Passes through an existing token that has been sent by the\nclient and validated. Other policies, like JWT and API key\nauthentication, will strip the original client credentials. Passthrough backend authentication\ncauses the original token to be added back into the request. If there are no client authentication policies on the\nrequest, the original token would be unchanged, so this would have no effect.", "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, storing the key to use as the authorization value. When using\nthe default Secret resolver, this must be stored in the `Authorization`\nkey.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "location may only be set for key or passthrough auth", "rule": "has(self.location) ? has(self.key) || has(self.secretRef) || has(self.passthrough) : true" }, { "message": "exactly one of the fields in [key secretRef passthrough aws azure gcp] must be set", "rule": "[has(self.key),has(self.secretRef),has(self.passthrough),has(self.aws),has(self.azure),has(self.gcp)].filter(x,x==true).size() == 1" } ] }, "http": { "additionalProperties": false, "description": "Settings for managing HTTP requests to the backend.", "properties": { "requestTimeout": { "description": "Deadline for receiving a response from the backend.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "requestTimeout must be at least 1ms", "rule": "duration(self) \u003e= duration('1ms')" } ] }, "version": { "description": "HTTP protocol version to use when connecting to\nthe backend.\nIf not specified, the version is automatically determined:\n* `Service` types can specify it with `appProtocol` on the `Service`\n port.\n* If traffic is identified as gRPC, `HTTP2` is used.\n* If the incoming traffic was plaintext HTTP, the original protocol will\n be used.\n* If the incoming traffic was HTTPS, `HTTP1` will be used. This is\n because most clients will transparently upgrade HTTPS traffic to\n `HTTP2`, even if the backend doesn't support it.", "enum": [ "HTTP1", "HTTP2" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "tcp": { "additionalProperties": false, "description": "Settings for managing TCP connections to the backend.", "properties": { "connectTimeout": { "description": "Deadline for establishing a connection to\nthe destination.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "connectTimeout must be at least 100ms", "rule": "duration(self) \u003e= duration('100ms')" } ] }, "keepalive": { "additionalProperties": false, "description": "Settings for enabling TCP keepalives on the\nconnection.", "properties": { "interval": { "description": "Time between keepalive probes.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "interval must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "retries": { "description": "Maximum number of keepalive probes to send before dropping the connection.\nIf unset, this defaults to 9.", "format": "int32", "maximum": 64, "minimum": 1, "type": [ "integer", "null" ] }, "time": { "description": "Time a connection needs to be idle before keepalive probes start being sent.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "time must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "tls": { "additionalProperties": false, "description": "Settings for managing TLS connections to the backend.\n\nIf this field is set, TLS will be initiated to the backend; the system trusted CA certificates will be used to\nvalidate the server, and the SNI will automatically be set based on the destination.", "properties": { "alpnProtocols": { "description": "Application-Layer Protocol Negotiation (`ALPN`)\nvalue to use in the TLS handshake.\n\nIf not present, defaults to `[\"h2\", \"http/1.1\"]`.", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] }, "caCertificateRefs": { "description": "CA certificate `ConfigMap` to use to\nverify the server certificate.\nIf unset, the system's trusted certificates are used.", "items": { "additionalProperties": false, "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "insecureSkipVerify": { "description": "Originates TLS but skips verification of the backend's certificate.\nWARNING: This is an insecure option that should only be used if the risks are understood.\n\nThere are two modes:\n* `All` disables all TLS verification.\n* `Hostname` verifies the CA certificate is trusted, but ignores any\n mismatch of hostname or SANs. Note that this method is still insecure;\n prefer setting `verifySubjectAltNames` to customize the valid hostnames\n if possible.", "enum": [ "All", "Hostname" ], "type": [ "string", "null" ] }, "keyExchangeGroups": { "description": "Ordered list of key exchange groups for a TLS connection.\nFor example: `X25519_MLKEM768,X25519`.", "items": { "enum": [ "P-256", "P-384", "X25519", "X25519_MLKEM768" ], "type": "string" }, "type": [ "array", "null" ] }, "mtlsCertificateRef": { "description": "Enables mutual TLS to the backend, using the\nspecified key (`tls.key`) and cert (`tls.crt`) from the referenced\ncredential source, defaulting to a Kubernetes `Secret`.\n\nAn optional `ca.cert` field, if present, will be used to verify the\nserver certificate. If `caCertificateRefs` is also specified, the\n`caCertificateRefs` field takes priority.\n\nIf unspecified, no client certificate will be used.", "items": { "additionalProperties": false, "description": "References a same-namespace credential.\nSet only `name` to reference a Kubernetes Secret.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "sni": { "description": "Server Name Indicator (`SNI`) to use in the TLS\nhandshake. If unset, the `SNI` is automatically set based on the\ndestination hostname.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "verifySubjectAltNames": { "description": "Subject Alternative Names (`SAN`)\nto verify in the server certificate.\nIf not present, the destination hostname is automatically used.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "insecureSkipVerify All and caCertificateRefs may not be set together", "rule": "has(self.insecureSkipVerify) \u0026\u0026 self.insecureSkipVerify == 'All' ? !has(self.caCertificateRefs) : true" }, { "message": "insecureSkipVerify and verifySubjectAltNames may not be set together", "rule": "has(self.insecureSkipVerify) ? !has(self.verifySubjectAltNames) : true" }, { "message": "at most one of the fields in [verifySubjectAltNames insecureSkipVerify] may be set", "rule": "[has(self.verifySubjectAltNames),has(self.insecureSkipVerify)].filter(x,x==true).size() \u003c= 1" } ] }, "tunnel": { "additionalProperties": false, "description": "Settings for managing tunnel connections, with behavior like `HTTPS_PROXY`, to the backend.", "properties": { "backendRef": { "additionalProperties": false, "description": "Proxy server to reach.\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "projectId": { "description": "Google Cloud project ID.", "maxLength": 256, "minLength": 1, "type": "string" }, "templateId": { "description": "Template ID for Google Model Armor.", "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "projectId", "templateId" ], "type": [ "object", "null" ] }, "openAIModeration": { "additionalProperties": false, "description": "Passes prompt data through the OpenAI Moderations\nendpoint.\nSee https://developers.openai.com/api/reference/resources/moderations for more information.", "properties": { "model": { "description": "Moderation model to use. For example,\n`omni-moderation`.", "type": [ "string", "null" ] }, "policies": { "additionalProperties": false, "description": "Policies for communicating with OpenAI.", "properties": { "auth": { "additionalProperties": false, "description": "Settings for managing authentication to the backend.", "properties": { "aws": { "additionalProperties": false, "description": "Explicit AWS authentication method for the backend.\nWhen omitted, default AWS SDK credential discovery is used.", "properties": { "assumeRole": { "additionalProperties": false, "description": "AWS STS AssumeRole settings to use before signing backend requests.\nAmbient AWS credentials are used as the source credentials for STS.", "properties": { "roleArn": { "description": "AWS IAM role ARN to assume.", "minLength": 1, "pattern": "^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$", "type": "string" } }, "required": [ "roleArn" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the AWS credentials. When using the default Secret\nresolver, the `Secret` must have keys `accessKey`, `secretKey`, and\noptionally `sessionToken`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "serviceName": { "description": "AWS SigV4 signing service name, for example\n`bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS\nbackends may provide this automatically.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "secretRef and assumeRole are mutually exclusive", "rule": "!(has(self.secretRef) \u0026\u0026 has(self.assumeRole))" } ] }, "azure": { "additionalProperties": false, "description": "Azure authentication method for the backend.", "properties": { "managedIdentity": { "additionalProperties": false, "description": "Managed identity authentication settings.", "properties": { "clientId": { "type": "string" }, "objectId": { "type": "string" }, "resourceId": { "type": "string" } }, "required": [ "clientId", "objectId", "resourceId" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the Azure credentials. When using the default Secret\nresolver, the `Secret` must have keys `clientID`, `tenantID`, and\n`clientSecret`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ] }, "gcp": { "additionalProperties": false, "description": "Google authentication method for the backend.\nWhen omitted, default Google credential discovery is used.", "properties": { "audience": { "description": "Explicit `aud` value for the ID token. Only\nvalid with `IdToken` type. If not set, the `aud` is automatically\nderived from the backend hostname.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing ADC-compatible Google credential JSON. When using\nthe default Secret resolver, this must be stored in the `credentials.json`\nkey. When omitted, ambient credentials are used.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "type": { "description": "The type of token to generate. To authenticate to GCP services,\ngenerally an `AccessToken` is used. To authenticate to Cloud Run, an\n`IdToken` is used.", "enum": [ "AccessToken", "IdToken" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "audience is only valid with IdToken", "rule": "has(self.audience) ? self.type == 'IdToken' : true" } ] }, "key": { "description": "Inline key to use as the value of the\n`Authorization` header. This option is the least secure; usage of a\n`Secret` is preferred.", "maxLength": 2048, "type": [ "string", "null" ] }, "location": { "additionalProperties": false, "description": "Where backend credentials are inserted.\nIf omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix.\nThis applies to `key`, `secretRef`, and `passthrough`.", "properties": { "cookie": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] }, "header": { "additionalProperties": false, "properties": { "name": { "description": "HTTPHeaderName is the name of an HTTP header.\n\nValid values include:\n\n* \"Authorization\"\n* \"Set-Cookie\"\n\nInvalid values include:\n\n - \":method\" - \":\" is an invalid character. This means that HTTP/2 pseudo\n headers are not currently supported by this type.\n - \"/invalid\" - \"/ \" is an invalid character", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "prefix": { "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "queryParameter": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [header queryParameter cookie] must be set", "rule": "[has(self.header),has(self.queryParameter),has(self.cookie)].filter(x,x==true).size() == 1" } ] }, "passthrough": { "description": "Passes through an existing token that has been sent by the\nclient and validated. Other policies, like JWT and API key\nauthentication, will strip the original client credentials. Passthrough backend authentication\ncauses the original token to be added back into the request. If there are no client authentication policies on the\nrequest, the original token would be unchanged, so this would have no effect.", "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, storing the key to use as the authorization value. When using\nthe default Secret resolver, this must be stored in the `Authorization`\nkey.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "location may only be set for key or passthrough auth", "rule": "has(self.location) ? has(self.key) || has(self.secretRef) || has(self.passthrough) : true" }, { "message": "exactly one of the fields in [key secretRef passthrough aws azure gcp] must be set", "rule": "[has(self.key),has(self.secretRef),has(self.passthrough),has(self.aws),has(self.azure),has(self.gcp)].filter(x,x==true).size() == 1" } ] }, "http": { "additionalProperties": false, "description": "Settings for managing HTTP requests to the backend.", "properties": { "requestTimeout": { "description": "Deadline for receiving a response from the backend.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "requestTimeout must be at least 1ms", "rule": "duration(self) \u003e= duration('1ms')" } ] }, "version": { "description": "HTTP protocol version to use when connecting to\nthe backend.\nIf not specified, the version is automatically determined:\n* `Service` types can specify it with `appProtocol` on the `Service`\n port.\n* If traffic is identified as gRPC, `HTTP2` is used.\n* If the incoming traffic was plaintext HTTP, the original protocol will\n be used.\n* If the incoming traffic was HTTPS, `HTTP1` will be used. This is\n because most clients will transparently upgrade HTTPS traffic to\n `HTTP2`, even if the backend doesn't support it.", "enum": [ "HTTP1", "HTTP2" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "tcp": { "additionalProperties": false, "description": "Settings for managing TCP connections to the backend.", "properties": { "connectTimeout": { "description": "Deadline for establishing a connection to\nthe destination.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "connectTimeout must be at least 100ms", "rule": "duration(self) \u003e= duration('100ms')" } ] }, "keepalive": { "additionalProperties": false, "description": "Settings for enabling TCP keepalives on the\nconnection.", "properties": { "interval": { "description": "Time between keepalive probes.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "interval must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "retries": { "description": "Maximum number of keepalive probes to send before dropping the connection.\nIf unset, this defaults to 9.", "format": "int32", "maximum": 64, "minimum": 1, "type": [ "integer", "null" ] }, "time": { "description": "Time a connection needs to be idle before keepalive probes start being sent.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "time must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "tls": { "additionalProperties": false, "description": "Settings for managing TLS connections to the backend.\n\nIf this field is set, TLS will be initiated to the backend; the system trusted CA certificates will be used to\nvalidate the server, and the SNI will automatically be set based on the destination.", "properties": { "alpnProtocols": { "description": "Application-Layer Protocol Negotiation (`ALPN`)\nvalue to use in the TLS handshake.\n\nIf not present, defaults to `[\"h2\", \"http/1.1\"]`.", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] }, "caCertificateRefs": { "description": "CA certificate `ConfigMap` to use to\nverify the server certificate.\nIf unset, the system's trusted certificates are used.", "items": { "additionalProperties": false, "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "insecureSkipVerify": { "description": "Originates TLS but skips verification of the backend's certificate.\nWARNING: This is an insecure option that should only be used if the risks are understood.\n\nThere are two modes:\n* `All` disables all TLS verification.\n* `Hostname` verifies the CA certificate is trusted, but ignores any\n mismatch of hostname or SANs. Note that this method is still insecure;\n prefer setting `verifySubjectAltNames` to customize the valid hostnames\n if possible.", "enum": [ "All", "Hostname" ], "type": [ "string", "null" ] }, "keyExchangeGroups": { "description": "Ordered list of key exchange groups for a TLS connection.\nFor example: `X25519_MLKEM768,X25519`.", "items": { "enum": [ "P-256", "P-384", "X25519", "X25519_MLKEM768" ], "type": "string" }, "type": [ "array", "null" ] }, "mtlsCertificateRef": { "description": "Enables mutual TLS to the backend, using the\nspecified key (`tls.key`) and cert (`tls.crt`) from the referenced\ncredential source, defaulting to a Kubernetes `Secret`.\n\nAn optional `ca.cert` field, if present, will be used to verify the\nserver certificate. If `caCertificateRefs` is also specified, the\n`caCertificateRefs` field takes priority.\n\nIf unspecified, no client certificate will be used.", "items": { "additionalProperties": false, "description": "References a same-namespace credential.\nSet only `name` to reference a Kubernetes Secret.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "sni": { "description": "Server Name Indicator (`SNI`) to use in the TLS\nhandshake. If unset, the `SNI` is automatically set based on the\ndestination hostname.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "verifySubjectAltNames": { "description": "Subject Alternative Names (`SAN`)\nto verify in the server certificate.\nIf not present, the destination hostname is automatically used.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "insecureSkipVerify All and caCertificateRefs may not be set together", "rule": "has(self.insecureSkipVerify) \u0026\u0026 self.insecureSkipVerify == 'All' ? !has(self.caCertificateRefs) : true" }, { "message": "insecureSkipVerify and verifySubjectAltNames may not be set together", "rule": "has(self.insecureSkipVerify) ? !has(self.verifySubjectAltNames) : true" }, { "message": "at most one of the fields in [verifySubjectAltNames insecureSkipVerify] may be set", "rule": "[has(self.verifySubjectAltNames),has(self.insecureSkipVerify)].filter(x,x==true).size() \u003c= 1" } ] }, "tunnel": { "additionalProperties": false, "description": "Settings for managing tunnel connections, with behavior like `HTTPS_PROXY`, to the backend.", "properties": { "backendRef": { "additionalProperties": false, "description": "Proxy server to reach.\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "regex": { "additionalProperties": false, "description": "Regular expression (regex) matching for prompt guards and data masking.", "properties": { "action": { "default": "Mask", "description": "The action to take if a regex pattern is matched in a request or response.\nThis setting applies only to request matches. `PromptguardResponse`\nmatches are always masked by default.\nDefaults to `Mask`.", "enum": [ "Mask", "Reject" ], "type": [ "string", "null" ] }, "builtins": { "description": "Built-in regex patterns to match against the request or response.\nMatches and built-ins are additive.", "items": { "description": "Built-in regex patterns for specific types of strings in prompts.\nFor example, if you specify `CreditCard`, any credit card numbers\nin the request or response are matched.", "enum": [ "CaSin", "CreditCard", "Email", "PhoneNumber", "Ssn" ], "type": "string" }, "type": [ "array", "null" ] }, "matches": { "description": "Regex patterns to match against the request or response.\nMatches and built-ins are additive.", "items": { "maxLength": 1024, "minLength": 1, "type": "string" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "response": { "additionalProperties": false, "description": "Custom response message to return to the client. If not specified, defaults to\n`The request was rejected due to inappropriate content`.", "properties": { "message": { "default": "The request was rejected due to inappropriate content", "description": "Custom response message to return to the client. If not specified, defaults to\n`The request was rejected due to inappropriate content`.", "type": [ "string", "null" ] }, "statusCode": { "default": 403, "description": "Status code to return to the client. Defaults to 403.", "format": "int32", "maximum": 599, "minimum": 200, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [message statusCode] must be set", "rule": "[has(self.message),has(self.statusCode)].filter(x,x==true).size() \u003e= 1" } ] }, "webhook": { "additionalProperties": false, "description": "Webhook that receives requests for prompt guarding.", "properties": { "backendRef": { "additionalProperties": false, "description": "Webhook server to reach.\n\nSupported types: Service and Backend.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] }, "failureMode": { "description": "Behavior when the webhook guardrail is unavailable\nor returns an error. `FailOpen` allows the request to continue.\n`FailClosed` (default) rejects the request.", "enum": [ "FailClosed", "FailOpen" ], "type": [ "string", "null" ] }, "forwardHeaderMatches": { "description": "HTTP header matches used to select the headers to forward to the webhook.\nRequest headers are used when forwarding requests and response headers\nare used when forwarding responses.\nBy default, no headers are forwarded.", "items": { "additionalProperties": false, "description": "HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request\nheaders.", "properties": { "name": { "description": "Name is the name of the HTTP Header to be matched. Name matching MUST be\ncase-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).\n\nIf multiple entries specify equivalent header names, only the first\nentry with an equivalent name MUST be considered for a match. Subsequent\nentries with an equivalent header name MUST be ignored. Due to the\ncase-insensitivity of header names, \"foo\" and \"Foo\" are considered\nequivalent.\n\nWhen a header is repeated in an HTTP request, it is\nimplementation-specific behavior as to how this is represented.\nGenerally, proxies should follow the guidance from the RFC:\nhttps://www.rfc-editor.org/rfc/rfc7230.html#section-3.2.2 regarding\nprocessing a repeated header, with special handling for \"Set-Cookie\".", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "type": { "default": "Exact", "description": "Type specifies how to match against the value of the header.\n\nSupport: Core (Exact)\n\nSupport: Implementation-specific (RegularExpression)\n\nSince RegularExpression HeaderMatchType has implementation-specific\nconformance, implementations can support POSIX, PCRE or any other dialects\nof regular expressions. Please read the implementation's documentation to\ndetermine the supported dialect.", "enum": [ "Exact", "RegularExpression" ], "type": [ "string", "null" ] }, "value": { "description": "Value is the value of HTTP Header to be matched.\n\u003cgateway:experimental:description\u003e\nMust consist of printable US-ASCII characters, optionally separated\nby single tabs or spaces. See: https://tools.ietf.org/html/rfc7230#section-3.2\n\u003c/gateway:experimental:description\u003e\n\n\u003cgateway:experimental:validation:Pattern=`^[!-~]+([\\t ]?[!-~]+)*$`\u003e", "maxLength": 4096, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": "object", "x-kubernetes-validations": [ { "message": "exactly one of the fields in [regex webhook openAIModeration bedrockGuardrails googleModelArmor] must be set", "rule": "[has(self.regex),has(self.webhook),has(self.openAIModeration),has(self.bedrockGuardrails),has(self.googleModelArmor)].filter(x,x==true).size() == 1" } ] }, "maxItems": 8, "minItems": 1, "type": [ "array", "null" ] }, "response": { "description": "Prompt guards to apply to responses returned by the LLM provider.", "items": { "additionalProperties": false, "description": "Prompt guards to apply to responses returned by the LLM provider.", "properties": { "bedrockGuardrails": { "additionalProperties": false, "description": "AWS Bedrock Guardrails settings for prompt\nguarding.", "properties": { "identifier": { "description": "Identifier of the Guardrail policy to use for the backend.", "maxLength": 256, "minLength": 1, "type": "string" }, "policies": { "additionalProperties": false, "description": "Policies for communicating with AWS Bedrock Guardrails.", "properties": { "auth": { "additionalProperties": false, "description": "Settings for managing authentication to the backend.", "properties": { "aws": { "additionalProperties": false, "description": "Explicit AWS authentication method for the backend.\nWhen omitted, default AWS SDK credential discovery is used.", "properties": { "assumeRole": { "additionalProperties": false, "description": "AWS STS AssumeRole settings to use before signing backend requests.\nAmbient AWS credentials are used as the source credentials for STS.", "properties": { "roleArn": { "description": "AWS IAM role ARN to assume.", "minLength": 1, "pattern": "^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$", "type": "string" } }, "required": [ "roleArn" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the AWS credentials. When using the default Secret\nresolver, the `Secret` must have keys `accessKey`, `secretKey`, and\noptionally `sessionToken`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "serviceName": { "description": "AWS SigV4 signing service name, for example\n`bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS\nbackends may provide this automatically.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "secretRef and assumeRole are mutually exclusive", "rule": "!(has(self.secretRef) \u0026\u0026 has(self.assumeRole))" } ] }, "azure": { "additionalProperties": false, "description": "Azure authentication method for the backend.", "properties": { "managedIdentity": { "additionalProperties": false, "description": "Managed identity authentication settings.", "properties": { "clientId": { "type": "string" }, "objectId": { "type": "string" }, "resourceId": { "type": "string" } }, "required": [ "clientId", "objectId", "resourceId" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the Azure credentials. When using the default Secret\nresolver, the `Secret` must have keys `clientID`, `tenantID`, and\n`clientSecret`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ] }, "gcp": { "additionalProperties": false, "description": "Google authentication method for the backend.\nWhen omitted, default Google credential discovery is used.", "properties": { "audience": { "description": "Explicit `aud` value for the ID token. Only\nvalid with `IdToken` type. If not set, the `aud` is automatically\nderived from the backend hostname.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing ADC-compatible Google credential JSON. When using\nthe default Secret resolver, this must be stored in the `credentials.json`\nkey. When omitted, ambient credentials are used.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "type": { "description": "The type of token to generate. To authenticate to GCP services,\ngenerally an `AccessToken` is used. To authenticate to Cloud Run, an\n`IdToken` is used.", "enum": [ "AccessToken", "IdToken" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "audience is only valid with IdToken", "rule": "has(self.audience) ? self.type == 'IdToken' : true" } ] }, "key": { "description": "Inline key to use as the value of the\n`Authorization` header. This option is the least secure; usage of a\n`Secret` is preferred.", "maxLength": 2048, "type": [ "string", "null" ] }, "location": { "additionalProperties": false, "description": "Where backend credentials are inserted.\nIf omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix.\nThis applies to `key`, `secretRef`, and `passthrough`.", "properties": { "cookie": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] }, "header": { "additionalProperties": false, "properties": { "name": { "description": "HTTPHeaderName is the name of an HTTP header.\n\nValid values include:\n\n* \"Authorization\"\n* \"Set-Cookie\"\n\nInvalid values include:\n\n - \":method\" - \":\" is an invalid character. This means that HTTP/2 pseudo\n headers are not currently supported by this type.\n - \"/invalid\" - \"/ \" is an invalid character", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "prefix": { "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "queryParameter": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [header queryParameter cookie] must be set", "rule": "[has(self.header),has(self.queryParameter),has(self.cookie)].filter(x,x==true).size() == 1" } ] }, "passthrough": { "description": "Passes through an existing token that has been sent by the\nclient and validated. Other policies, like JWT and API key\nauthentication, will strip the original client credentials. Passthrough backend authentication\ncauses the original token to be added back into the request. If there are no client authentication policies on the\nrequest, the original token would be unchanged, so this would have no effect.", "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, storing the key to use as the authorization value. When using\nthe default Secret resolver, this must be stored in the `Authorization`\nkey.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "location may only be set for key or passthrough auth", "rule": "has(self.location) ? has(self.key) || has(self.secretRef) || has(self.passthrough) : true" }, { "message": "exactly one of the fields in [key secretRef passthrough aws azure gcp] must be set", "rule": "[has(self.key),has(self.secretRef),has(self.passthrough),has(self.aws),has(self.azure),has(self.gcp)].filter(x,x==true).size() == 1" } ] }, "http": { "additionalProperties": false, "description": "Settings for managing HTTP requests to the backend.", "properties": { "requestTimeout": { "description": "Deadline for receiving a response from the backend.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "requestTimeout must be at least 1ms", "rule": "duration(self) \u003e= duration('1ms')" } ] }, "version": { "description": "HTTP protocol version to use when connecting to\nthe backend.\nIf not specified, the version is automatically determined:\n* `Service` types can specify it with `appProtocol` on the `Service`\n port.\n* If traffic is identified as gRPC, `HTTP2` is used.\n* If the incoming traffic was plaintext HTTP, the original protocol will\n be used.\n* If the incoming traffic was HTTPS, `HTTP1` will be used. This is\n because most clients will transparently upgrade HTTPS traffic to\n `HTTP2`, even if the backend doesn't support it.", "enum": [ "HTTP1", "HTTP2" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "tcp": { "additionalProperties": false, "description": "Settings for managing TCP connections to the backend.", "properties": { "connectTimeout": { "description": "Deadline for establishing a connection to\nthe destination.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "connectTimeout must be at least 100ms", "rule": "duration(self) \u003e= duration('100ms')" } ] }, "keepalive": { "additionalProperties": false, "description": "Settings for enabling TCP keepalives on the\nconnection.", "properties": { "interval": { "description": "Time between keepalive probes.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "interval must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "retries": { "description": "Maximum number of keepalive probes to send before dropping the connection.\nIf unset, this defaults to 9.", "format": "int32", "maximum": 64, "minimum": 1, "type": [ "integer", "null" ] }, "time": { "description": "Time a connection needs to be idle before keepalive probes start being sent.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "time must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "tls": { "additionalProperties": false, "description": "Settings for managing TLS connections to the backend.\n\nIf this field is set, TLS will be initiated to the backend; the system trusted CA certificates will be used to\nvalidate the server, and the SNI will automatically be set based on the destination.", "properties": { "alpnProtocols": { "description": "Application-Layer Protocol Negotiation (`ALPN`)\nvalue to use in the TLS handshake.\n\nIf not present, defaults to `[\"h2\", \"http/1.1\"]`.", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] }, "caCertificateRefs": { "description": "CA certificate `ConfigMap` to use to\nverify the server certificate.\nIf unset, the system's trusted certificates are used.", "items": { "additionalProperties": false, "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "insecureSkipVerify": { "description": "Originates TLS but skips verification of the backend's certificate.\nWARNING: This is an insecure option that should only be used if the risks are understood.\n\nThere are two modes:\n* `All` disables all TLS verification.\n* `Hostname` verifies the CA certificate is trusted, but ignores any\n mismatch of hostname or SANs. Note that this method is still insecure;\n prefer setting `verifySubjectAltNames` to customize the valid hostnames\n if possible.", "enum": [ "All", "Hostname" ], "type": [ "string", "null" ] }, "keyExchangeGroups": { "description": "Ordered list of key exchange groups for a TLS connection.\nFor example: `X25519_MLKEM768,X25519`.", "items": { "enum": [ "P-256", "P-384", "X25519", "X25519_MLKEM768" ], "type": "string" }, "type": [ "array", "null" ] }, "mtlsCertificateRef": { "description": "Enables mutual TLS to the backend, using the\nspecified key (`tls.key`) and cert (`tls.crt`) from the referenced\ncredential source, defaulting to a Kubernetes `Secret`.\n\nAn optional `ca.cert` field, if present, will be used to verify the\nserver certificate. If `caCertificateRefs` is also specified, the\n`caCertificateRefs` field takes priority.\n\nIf unspecified, no client certificate will be used.", "items": { "additionalProperties": false, "description": "References a same-namespace credential.\nSet only `name` to reference a Kubernetes Secret.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "sni": { "description": "Server Name Indicator (`SNI`) to use in the TLS\nhandshake. If unset, the `SNI` is automatically set based on the\ndestination hostname.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "verifySubjectAltNames": { "description": "Subject Alternative Names (`SAN`)\nto verify in the server certificate.\nIf not present, the destination hostname is automatically used.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "insecureSkipVerify All and caCertificateRefs may not be set together", "rule": "has(self.insecureSkipVerify) \u0026\u0026 self.insecureSkipVerify == 'All' ? !has(self.caCertificateRefs) : true" }, { "message": "insecureSkipVerify and verifySubjectAltNames may not be set together", "rule": "has(self.insecureSkipVerify) ? !has(self.verifySubjectAltNames) : true" }, { "message": "at most one of the fields in [verifySubjectAltNames insecureSkipVerify] may be set", "rule": "[has(self.verifySubjectAltNames),has(self.insecureSkipVerify)].filter(x,x==true).size() \u003c= 1" } ] }, "tunnel": { "additionalProperties": false, "description": "Settings for managing tunnel connections, with behavior like `HTTPS_PROXY`, to the backend.", "properties": { "backendRef": { "additionalProperties": false, "description": "Proxy server to reach.\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "region": { "description": "AWS region where the guardrail is deployed, for example\n`us-west-2`).", "maxLength": 256, "minLength": 1, "type": "string" }, "version": { "description": "Version of the Guardrail policy to use for the backend.", "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "identifier", "region", "version" ], "type": [ "object", "null" ] }, "googleModelArmor": { "additionalProperties": false, "description": "Google Model Armor settings for prompt guarding.", "properties": { "location": { "default": "us-central1", "description": "Google Cloud location, for example `us-central1`.\nDefaults to `us-central1` if not specified.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "policies": { "additionalProperties": false, "description": "Policies for communicating with Google Model Armor.", "properties": { "auth": { "additionalProperties": false, "description": "Settings for managing authentication to the backend.", "properties": { "aws": { "additionalProperties": false, "description": "Explicit AWS authentication method for the backend.\nWhen omitted, default AWS SDK credential discovery is used.", "properties": { "assumeRole": { "additionalProperties": false, "description": "AWS STS AssumeRole settings to use before signing backend requests.\nAmbient AWS credentials are used as the source credentials for STS.", "properties": { "roleArn": { "description": "AWS IAM role ARN to assume.", "minLength": 1, "pattern": "^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$", "type": "string" } }, "required": [ "roleArn" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the AWS credentials. When using the default Secret\nresolver, the `Secret` must have keys `accessKey`, `secretKey`, and\noptionally `sessionToken`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "serviceName": { "description": "AWS SigV4 signing service name, for example\n`bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS\nbackends may provide this automatically.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "secretRef and assumeRole are mutually exclusive", "rule": "!(has(self.secretRef) \u0026\u0026 has(self.assumeRole))" } ] }, "azure": { "additionalProperties": false, "description": "Azure authentication method for the backend.", "properties": { "managedIdentity": { "additionalProperties": false, "description": "Managed identity authentication settings.", "properties": { "clientId": { "type": "string" }, "objectId": { "type": "string" }, "resourceId": { "type": "string" } }, "required": [ "clientId", "objectId", "resourceId" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the Azure credentials. When using the default Secret\nresolver, the `Secret` must have keys `clientID`, `tenantID`, and\n`clientSecret`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ] }, "gcp": { "additionalProperties": false, "description": "Google authentication method for the backend.\nWhen omitted, default Google credential discovery is used.", "properties": { "audience": { "description": "Explicit `aud` value for the ID token. Only\nvalid with `IdToken` type. If not set, the `aud` is automatically\nderived from the backend hostname.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing ADC-compatible Google credential JSON. When using\nthe default Secret resolver, this must be stored in the `credentials.json`\nkey. When omitted, ambient credentials are used.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "type": { "description": "The type of token to generate. To authenticate to GCP services,\ngenerally an `AccessToken` is used. To authenticate to Cloud Run, an\n`IdToken` is used.", "enum": [ "AccessToken", "IdToken" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "audience is only valid with IdToken", "rule": "has(self.audience) ? self.type == 'IdToken' : true" } ] }, "key": { "description": "Inline key to use as the value of the\n`Authorization` header. This option is the least secure; usage of a\n`Secret` is preferred.", "maxLength": 2048, "type": [ "string", "null" ] }, "location": { "additionalProperties": false, "description": "Where backend credentials are inserted.\nIf omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix.\nThis applies to `key`, `secretRef`, and `passthrough`.", "properties": { "cookie": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] }, "header": { "additionalProperties": false, "properties": { "name": { "description": "HTTPHeaderName is the name of an HTTP header.\n\nValid values include:\n\n* \"Authorization\"\n* \"Set-Cookie\"\n\nInvalid values include:\n\n - \":method\" - \":\" is an invalid character. This means that HTTP/2 pseudo\n headers are not currently supported by this type.\n - \"/invalid\" - \"/ \" is an invalid character", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "prefix": { "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "queryParameter": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [header queryParameter cookie] must be set", "rule": "[has(self.header),has(self.queryParameter),has(self.cookie)].filter(x,x==true).size() == 1" } ] }, "passthrough": { "description": "Passes through an existing token that has been sent by the\nclient and validated. Other policies, like JWT and API key\nauthentication, will strip the original client credentials. Passthrough backend authentication\ncauses the original token to be added back into the request. If there are no client authentication policies on the\nrequest, the original token would be unchanged, so this would have no effect.", "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, storing the key to use as the authorization value. When using\nthe default Secret resolver, this must be stored in the `Authorization`\nkey.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "location may only be set for key or passthrough auth", "rule": "has(self.location) ? has(self.key) || has(self.secretRef) || has(self.passthrough) : true" }, { "message": "exactly one of the fields in [key secretRef passthrough aws azure gcp] must be set", "rule": "[has(self.key),has(self.secretRef),has(self.passthrough),has(self.aws),has(self.azure),has(self.gcp)].filter(x,x==true).size() == 1" } ] }, "http": { "additionalProperties": false, "description": "Settings for managing HTTP requests to the backend.", "properties": { "requestTimeout": { "description": "Deadline for receiving a response from the backend.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "requestTimeout must be at least 1ms", "rule": "duration(self) \u003e= duration('1ms')" } ] }, "version": { "description": "HTTP protocol version to use when connecting to\nthe backend.\nIf not specified, the version is automatically determined:\n* `Service` types can specify it with `appProtocol` on the `Service`\n port.\n* If traffic is identified as gRPC, `HTTP2` is used.\n* If the incoming traffic was plaintext HTTP, the original protocol will\n be used.\n* If the incoming traffic was HTTPS, `HTTP1` will be used. This is\n because most clients will transparently upgrade HTTPS traffic to\n `HTTP2`, even if the backend doesn't support it.", "enum": [ "HTTP1", "HTTP2" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "tcp": { "additionalProperties": false, "description": "Settings for managing TCP connections to the backend.", "properties": { "connectTimeout": { "description": "Deadline for establishing a connection to\nthe destination.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "connectTimeout must be at least 100ms", "rule": "duration(self) \u003e= duration('100ms')" } ] }, "keepalive": { "additionalProperties": false, "description": "Settings for enabling TCP keepalives on the\nconnection.", "properties": { "interval": { "description": "Time between keepalive probes.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "interval must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "retries": { "description": "Maximum number of keepalive probes to send before dropping the connection.\nIf unset, this defaults to 9.", "format": "int32", "maximum": 64, "minimum": 1, "type": [ "integer", "null" ] }, "time": { "description": "Time a connection needs to be idle before keepalive probes start being sent.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "time must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "tls": { "additionalProperties": false, "description": "Settings for managing TLS connections to the backend.\n\nIf this field is set, TLS will be initiated to the backend; the system trusted CA certificates will be used to\nvalidate the server, and the SNI will automatically be set based on the destination.", "properties": { "alpnProtocols": { "description": "Application-Layer Protocol Negotiation (`ALPN`)\nvalue to use in the TLS handshake.\n\nIf not present, defaults to `[\"h2\", \"http/1.1\"]`.", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] }, "caCertificateRefs": { "description": "CA certificate `ConfigMap` to use to\nverify the server certificate.\nIf unset, the system's trusted certificates are used.", "items": { "additionalProperties": false, "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "insecureSkipVerify": { "description": "Originates TLS but skips verification of the backend's certificate.\nWARNING: This is an insecure option that should only be used if the risks are understood.\n\nThere are two modes:\n* `All` disables all TLS verification.\n* `Hostname` verifies the CA certificate is trusted, but ignores any\n mismatch of hostname or SANs. Note that this method is still insecure;\n prefer setting `verifySubjectAltNames` to customize the valid hostnames\n if possible.", "enum": [ "All", "Hostname" ], "type": [ "string", "null" ] }, "keyExchangeGroups": { "description": "Ordered list of key exchange groups for a TLS connection.\nFor example: `X25519_MLKEM768,X25519`.", "items": { "enum": [ "P-256", "P-384", "X25519", "X25519_MLKEM768" ], "type": "string" }, "type": [ "array", "null" ] }, "mtlsCertificateRef": { "description": "Enables mutual TLS to the backend, using the\nspecified key (`tls.key`) and cert (`tls.crt`) from the referenced\ncredential source, defaulting to a Kubernetes `Secret`.\n\nAn optional `ca.cert` field, if present, will be used to verify the\nserver certificate. If `caCertificateRefs` is also specified, the\n`caCertificateRefs` field takes priority.\n\nIf unspecified, no client certificate will be used.", "items": { "additionalProperties": false, "description": "References a same-namespace credential.\nSet only `name` to reference a Kubernetes Secret.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "sni": { "description": "Server Name Indicator (`SNI`) to use in the TLS\nhandshake. If unset, the `SNI` is automatically set based on the\ndestination hostname.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "verifySubjectAltNames": { "description": "Subject Alternative Names (`SAN`)\nto verify in the server certificate.\nIf not present, the destination hostname is automatically used.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "insecureSkipVerify All and caCertificateRefs may not be set together", "rule": "has(self.insecureSkipVerify) \u0026\u0026 self.insecureSkipVerify == 'All' ? !has(self.caCertificateRefs) : true" }, { "message": "insecureSkipVerify and verifySubjectAltNames may not be set together", "rule": "has(self.insecureSkipVerify) ? !has(self.verifySubjectAltNames) : true" }, { "message": "at most one of the fields in [verifySubjectAltNames insecureSkipVerify] may be set", "rule": "[has(self.verifySubjectAltNames),has(self.insecureSkipVerify)].filter(x,x==true).size() \u003c= 1" } ] }, "tunnel": { "additionalProperties": false, "description": "Settings for managing tunnel connections, with behavior like `HTTPS_PROXY`, to the backend.", "properties": { "backendRef": { "additionalProperties": false, "description": "Proxy server to reach.\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "projectId": { "description": "Google Cloud project ID.", "maxLength": 256, "minLength": 1, "type": "string" }, "templateId": { "description": "Template ID for Google Model Armor.", "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "projectId", "templateId" ], "type": [ "object", "null" ] }, "regex": { "additionalProperties": false, "description": "Regular expression (regex) matching for prompt guards and data masking.", "properties": { "action": { "default": "Mask", "description": "The action to take if a regex pattern is matched in a request or response.\nThis setting applies only to request matches. `PromptguardResponse`\nmatches are always masked by default.\nDefaults to `Mask`.", "enum": [ "Mask", "Reject" ], "type": [ "string", "null" ] }, "builtins": { "description": "Built-in regex patterns to match against the request or response.\nMatches and built-ins are additive.", "items": { "description": "Built-in regex patterns for specific types of strings in prompts.\nFor example, if you specify `CreditCard`, any credit card numbers\nin the request or response are matched.", "enum": [ "CaSin", "CreditCard", "Email", "PhoneNumber", "Ssn" ], "type": "string" }, "type": [ "array", "null" ] }, "matches": { "description": "Regex patterns to match against the request or response.\nMatches and built-ins are additive.", "items": { "maxLength": 1024, "minLength": 1, "type": "string" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "response": { "additionalProperties": false, "description": "Custom response message to return to the client. If not specified, defaults to\n`The response was rejected due to inappropriate content`.", "properties": { "message": { "default": "The request was rejected due to inappropriate content", "description": "Custom response message to return to the client. If not specified, defaults to\n`The request was rejected due to inappropriate content`.", "type": [ "string", "null" ] }, "statusCode": { "default": 403, "description": "Status code to return to the client. Defaults to 403.", "format": "int32", "maximum": 599, "minimum": 200, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [message statusCode] must be set", "rule": "[has(self.message),has(self.statusCode)].filter(x,x==true).size() \u003e= 1" } ] }, "webhook": { "additionalProperties": false, "description": "Webhook that receives responses for prompt guarding.", "properties": { "backendRef": { "additionalProperties": false, "description": "Webhook server to reach.\n\nSupported types: Service and Backend.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] }, "failureMode": { "description": "Behavior when the webhook guardrail is unavailable\nor returns an error. `FailOpen` allows the request to continue.\n`FailClosed` (default) rejects the request.", "enum": [ "FailClosed", "FailOpen" ], "type": [ "string", "null" ] }, "forwardHeaderMatches": { "description": "HTTP header matches used to select the headers to forward to the webhook.\nRequest headers are used when forwarding requests and response headers\nare used when forwarding responses.\nBy default, no headers are forwarded.", "items": { "additionalProperties": false, "description": "HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request\nheaders.", "properties": { "name": { "description": "Name is the name of the HTTP Header to be matched. Name matching MUST be\ncase-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).\n\nIf multiple entries specify equivalent header names, only the first\nentry with an equivalent name MUST be considered for a match. Subsequent\nentries with an equivalent header name MUST be ignored. Due to the\ncase-insensitivity of header names, \"foo\" and \"Foo\" are considered\nequivalent.\n\nWhen a header is repeated in an HTTP request, it is\nimplementation-specific behavior as to how this is represented.\nGenerally, proxies should follow the guidance from the RFC:\nhttps://www.rfc-editor.org/rfc/rfc7230.html#section-3.2.2 regarding\nprocessing a repeated header, with special handling for \"Set-Cookie\".", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "type": { "default": "Exact", "description": "Type specifies how to match against the value of the header.\n\nSupport: Core (Exact)\n\nSupport: Implementation-specific (RegularExpression)\n\nSince RegularExpression HeaderMatchType has implementation-specific\nconformance, implementations can support POSIX, PCRE or any other dialects\nof regular expressions. Please read the implementation's documentation to\ndetermine the supported dialect.", "enum": [ "Exact", "RegularExpression" ], "type": [ "string", "null" ] }, "value": { "description": "Value is the value of HTTP Header to be matched.\n\u003cgateway:experimental:description\u003e\nMust consist of printable US-ASCII characters, optionally separated\nby single tabs or spaces. See: https://tools.ietf.org/html/rfc7230#section-3.2\n\u003c/gateway:experimental:description\u003e\n\n\u003cgateway:experimental:validation:Pattern=`^[!-~]+([\\t ]?[!-~]+)*$`\u003e", "maxLength": 4096, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": "object", "x-kubernetes-validations": [ { "message": "exactly one of the fields in [regex webhook bedrockGuardrails googleModelArmor] must be set", "rule": "[has(self.regex),has(self.webhook),has(self.bedrockGuardrails),has(self.googleModelArmor)].filter(x,x==true).size() == 1" } ] }, "maxItems": 8, "minItems": 1, "type": [ "array", "null" ] }, "streaming": { "description": "Apply prompt guards to streaming responses and realtime websocket messages.\nDefaults to disabled to preserve streaming throughput unless explicitly enabled.", "enum": [ "Enabled" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [request response] must be set", "rule": "[has(self.request),has(self.response)].filter(x,x==true).size() \u003e= 1" } ] }, "routes": { "additionalProperties": { "description": "How the AI gateway should process incoming requests\nbased on the URL path and the API format expected.", "enum": [ "AnthropicTokenCount", "Completions", "Detect", "Embeddings", "Messages", "Models", "Passthrough", "Realtime", "Rerank", "Responses" ], "type": "string" }, "description": "Rules for identifying the type of traffic to handle.\nThe keys are URL path suffixes matched using ends-with comparison, for\nexample `\"/v1/chat/completions\"`.\nThe special `*` wildcard matches any path.\nIf not specified, all traffic defaults to `completions` type.", "type": [ "object", "null" ] }, "transformations": { "description": "CEL transformations to compute and set fields in the request body.\nThe expression result overwrites any existing value for that field.\nThis has a higher priority than `overrides` if both are set for the same\nkey.", "items": { "additionalProperties": false, "description": "Maps a request JSON field to a CEL expression.\nThe expression is evaluated against the current request body and its result\nis assigned to the configured field.", "properties": { "expression": { "description": "CEL expression used to compute the field value.", "maxLength": 16384, "minLength": 1, "type": "string" }, "field": { "allOf": [ { "minLength": 1 }, { "minLength": 1 } ], "description": "Name of the field to set.", "maxLength": 256, "type": "string" } }, "required": [ "expression", "field" ], "type": "object" }, "maxItems": 64, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [defaults modelAliases overrides prompt promptCaching promptGuard routes transformations] must be set", "rule": "[has(self.defaults),has(self.modelAliases),has(self.overrides),has(self.prompt),has(self.promptCaching),has(self.promptGuard),has(self.routes),has(self.transformations)].filter(x,x==true).size() \u003e= 1" } ] }, "auth": { "additionalProperties": false, "description": "Settings for managing authentication to the backend.", "properties": { "aws": { "additionalProperties": false, "description": "Explicit AWS authentication method for the backend.\nWhen omitted, default AWS SDK credential discovery is used.", "properties": { "assumeRole": { "additionalProperties": false, "description": "AWS STS AssumeRole settings to use before signing backend requests.\nAmbient AWS credentials are used as the source credentials for STS.", "properties": { "roleArn": { "description": "AWS IAM role ARN to assume.", "minLength": 1, "pattern": "^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$", "type": "string" } }, "required": [ "roleArn" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the AWS credentials. When using the default Secret\nresolver, the `Secret` must have keys `accessKey`, `secretKey`, and\noptionally `sessionToken`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "serviceName": { "description": "AWS SigV4 signing service name, for example\n`bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS\nbackends may provide this automatically.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "secretRef and assumeRole are mutually exclusive", "rule": "!(has(self.secretRef) \u0026\u0026 has(self.assumeRole))" } ] }, "azure": { "additionalProperties": false, "description": "Azure authentication method for the backend.", "properties": { "managedIdentity": { "additionalProperties": false, "description": "Managed identity authentication settings.", "properties": { "clientId": { "type": "string" }, "objectId": { "type": "string" }, "resourceId": { "type": "string" } }, "required": [ "clientId", "objectId", "resourceId" ], "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing the Azure credentials. When using the default Secret\nresolver, the `Secret` must have keys `clientID`, `tenantID`, and\n`clientSecret`.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ] }, "gcp": { "additionalProperties": false, "description": "Google authentication method for the backend.\nWhen omitted, default Google credential discovery is used.", "properties": { "audience": { "description": "Explicit `aud` value for the ID token. Only\nvalid with `IdToken` type. If not set, the `aud` is automatically\nderived from the backend hostname.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, containing ADC-compatible Google credential JSON. When using\nthe default Secret resolver, this must be stored in the `credentials.json`\nkey. When omitted, ambient credentials are used.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "type": { "description": "The type of token to generate. To authenticate to GCP services,\ngenerally an `AccessToken` is used. To authenticate to Cloud Run, an\n`IdToken` is used.", "enum": [ "AccessToken", "IdToken" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "audience is only valid with IdToken", "rule": "has(self.audience) ? self.type == 'IdToken' : true" } ] }, "key": { "description": "Inline key to use as the value of the\n`Authorization` header. This option is the least secure; usage of a\n`Secret` is preferred.", "maxLength": 2048, "type": [ "string", "null" ] }, "location": { "additionalProperties": false, "description": "Where backend credentials are inserted.\nIf omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix.\nThis applies to `key`, `secretRef`, and `passthrough`.", "properties": { "cookie": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] }, "header": { "additionalProperties": false, "properties": { "name": { "description": "HTTPHeaderName is the name of an HTTP header.\n\nValid values include:\n\n* \"Authorization\"\n* \"Set-Cookie\"\n\nInvalid values include:\n\n - \":method\" - \":\" is an invalid character. This means that HTTP/2 pseudo\n headers are not currently supported by this type.\n - \"/invalid\" - \"/ \" is an invalid character", "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string" }, "prefix": { "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "queryParameter": { "additionalProperties": false, "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "exactly one of the fields in [header queryParameter cookie] must be set", "rule": "[has(self.header),has(self.queryParameter),has(self.cookie)].filter(x,x==true).size() == 1" } ] }, "passthrough": { "description": "Passes through an existing token that has been sent by the\nclient and validated. Other policies, like JWT and API key\nauthentication, will strip the original client credentials. Passthrough backend authentication\ncauses the original token to be added back into the request. If there are no client authentication policies on the\nrequest, the original token would be unchanged, so this would have no effect.", "type": [ "object", "null" ] }, "secretRef": { "additionalProperties": false, "description": "Credential source, defaulting to a Kubernetes\n`Secret`, storing the key to use as the authorization value. When using\nthe default Secret resolver, this must be stored in the `Authorization`\nkey.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "location may only be set for key or passthrough auth", "rule": "has(self.location) ? has(self.key) || has(self.secretRef) || has(self.passthrough) : true" }, { "message": "exactly one of the fields in [key secretRef passthrough aws azure gcp] must be set", "rule": "[has(self.key),has(self.secretRef),has(self.passthrough),has(self.aws),has(self.azure),has(self.gcp)].filter(x,x==true).size() == 1" } ] }, "extAuth": { "additionalProperties": false, "description": "External authentication configuration for requests\nsent to this backend.", "properties": { "backendRef": { "additionalProperties": false, "description": "External Authorization server to reach.\n\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] }, "cache": { "additionalProperties": false, "description": "Caches gRPC authorization results.\n\nWARNING: the safety of this feature depends on the cache key accurately\ncapturing every request property that the authorization service uses to\nmake a decision. For example, if the service returns different results\nbased on both path and authorization header, both must be included in\n`key`; otherwise, one request may incorrectly reuse another request's\nauthorization result.\n\nIf any key expression fails to evaluate or produces an unsupported value,\nthe request is still sent to the authorization service, but its result is\nnot read from or written to the cache.", "properties": { "key": { "description": "Ordered list of CEL expressions evaluated against the request\nto construct the cache key.", "items": { "description": "A Common Expression Language (CEL) expression.", "maxLength": 16384, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": "array" }, "maxEntries": { "description": "Maximum number of authorization results to keep in\nthe cache. If unset, this defaults to 10000.", "format": "int32", "minimum": 1, "type": [ "integer", "null" ] }, "ttl": { "description": "Duration string, such as `5m`, or a CEL expression that\nreturns the duration that cached authorization results may be reused, or a\ntimestamp when the cached authorization result expires. The expression is\nevaluated after the authorization response has been applied to the request.", "maxLength": 16384, "minLength": 1, "type": "string" } }, "required": [ "key", "ttl" ], "type": [ "object", "null" ] }, "failureMode": { "description": "Behavior when the external authorization service is\nunavailable or returns an error. \"FailOpen\" allows the request to continue.\n\"FailClosed\" (default) denies the request.", "enum": [ "FailClosed", "FailOpen" ], "type": [ "string", "null" ] }, "forwardBody": { "additionalProperties": false, "description": "Whether to include the HTTP body in the authorization request.\nIf enabled, the request body will be buffered.", "properties": { "maxSize": { "description": "Largest body, in bytes, that will be buffered\nand sent to the authorization server. If the body size is larger than\n`maxSize`, then the request will be rejected with a response.", "oneOf": [ { "maxLength": 32, "minLength": 1, "pattern": "^[+-]?([0-9]+(\\.[0-9]*)?|\\.[0-9]+)(([KMGTPE]i)|[numkMGTPE]|[eE](\\+?0*([0-9]|1[0-8])|-0*[0-9]))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true, "x-kubernetes-validations": [ { "message": "value must be at least 1 byte and fit within uint32", "rule": "(self \u003e= 1 \u0026\u0026 self \u003c= 4294967295) || self.size() \u003e 0" } ] } }, "required": [ "maxSize" ], "type": [ "object", "null" ] }, "grpc": { "additionalProperties": false, "description": "Uses the gRPC External Authorization\n[protocol](https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/auth/v3/external_auth.proto) should be used.", "properties": { "contextExtensions": { "additionalProperties": { "type": "string" }, "description": "Additional arbitrary key-value pairs to\nsend to the authorization server in the `context_extensions` field.", "maxProperties": 64, "type": [ "object", "null" ] }, "requestMetadata": { "additionalProperties": { "description": "A Common Expression Language (CEL) expression.", "maxLength": 16384, "minLength": 1, "type": "string" }, "description": "Metadata to send to the authorization\nserver. This maps to the `metadata_context.filter_metadata` field of the\nrequest, and allows dynamic CEL expressions. If unset, by default the\n`envoy.filters.http.jwt_authn` key is set if the JWT policy is used as\nwell, for compatibility.", "maxProperties": 64, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "http": { "additionalProperties": false, "description": "Uses HTTP to connect to\nthe authorization server. The authorization server must return a `200`\nstatus code, otherwise the request is considered an authorization\nfailure.", "properties": { "addRequestHeaders": { "additionalProperties": { "description": "A Common Expression Language (CEL) expression.", "maxLength": 16384, "minLength": 1, "type": "string" }, "description": "Additional headers to add to the\nrequest to the authorization server. While `allowedRequestHeaders` just\npasses the original headers through, `addRequestHeaders` allows defining\ncustom headers based on CEL expressions.", "maxProperties": 64, "type": [ "object", "null" ] }, "allowedRequestHeaders": { "description": "Additional headers from the client request that\nwill be sent to the authorization server.\n\nIf unset, the following headers are sent by default: `Authorization`.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 64, "type": [ "array", "null" ] }, "allowedResponseHeaders": { "description": "Headers from the authorization response that\nwill be copied into the request to the backend.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 64, "type": [ "array", "null" ] }, "path": { "description": "Path to send to the authorization server. If\nunset, this defaults to the original request path.\nThis is a CEL expression, which allows customizing the path based on the\nincoming request. For example, to add a prefix, use\n`\"/prefix/\" + request.path`.", "maxLength": 16384, "minLength": 1, "type": [ "string", "null" ] }, "redirect": { "description": "Optional expression that determines a path to\nredirect to on authorization failure. This is useful to redirect to a\nsign-in page.", "maxLength": 16384, "minLength": 1, "type": [ "string", "null" ] }, "responseMetadata": { "additionalProperties": { "description": "A Common Expression Language (CEL) expression.", "maxLength": 16384, "minLength": 1, "type": "string" }, "description": "Metadata fields to construct\nfrom the authorization response. These will be included under the\n`extauthz` variable in future CEL expressions. Setting this is useful\nfor things like logging usernames, without needing to include them as\nheaders to the backend, as `allowedResponseHeaders` would.", "maxProperties": 64, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "cache requires grpc", "rule": "!has(self.cache) || has(self.grpc)" } ] }, "health": { "additionalProperties": false, "description": "Settings for passive and active health checking.", "properties": { "eviction": { "additionalProperties": false, "description": "Settings for evicting unhealthy backends.", "properties": { "consecutiveFailures": { "description": "Number of consecutive unhealthy responses required before the backend is evicted.\nFor example, a value of 5 means the backend must receive 5 unhealthy responses in a row before being evicted.\nWhen both consecutiveFailures and healthThreshold are set, the backend is evicted when either condition is met.\nWhen neither is set, a single unhealthy response can trigger eviction.", "format": "int32", "minimum": 0, "type": [ "integer", "null" ] }, "duration": { "default": "3s", "description": "Base time a backend should be evicted after being marked unhealthy.\nSubsequent evictions use multiplicative backoff (duration * times_evicted).\nIf all endpoints are evicted, the load balancer falls back to returning evicted endpoints\nrather than failing entirely.\nIf unset, defaults to `3s`.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "evictionDuration must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "healthThreshold": { "description": "EWMA health score threshold, expressed as 0 to 100.\nWhen set, a backend is only evicted if its computed health drops below this value after an unhealthy response.\nFor example, 50 means the backend is evicted when its EWMA health falls below 50% following failures.\nUnlike consecutiveFailures (which counts consecutive failures), this uses a sliding-window average\nso a single success in a stream of failures can delay eviction.\nWhen both consecutiveFailures and healthThreshold are set, the backend is evicted when either condition is met.\nWhen neither is set, a single unhealthy response triggers eviction.", "format": "int32", "maximum": 100, "minimum": 0, "type": [ "integer", "null" ] }, "restoreHealth": { "description": "Health score from 0 to 100 assigned to a backend when it returns from eviction.\nFor gradual recovery, set below 100; for full recovery immediately, set 100.\nIf unset, the backend resumes with the health it had when evicted.", "format": "int32", "maximum": 100, "minimum": 0, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "unhealthyCondition": { "description": "CEL expression that determines whether a response indicates an unhealthy backend.\nWhen the expression evaluates to true, the backend is considered unhealthy and may be evicted.\n\nFor example, to evict on 5xx responses: `response.code \u003e= 500`.\n\nWhen unset, any 5xx response, or a connection failure, is treated as unhealthy.\nThis default lowers the backend's health score but does not trigger eviction on its own.", "maxLength": 16384, "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "http": { "additionalProperties": false, "description": "Settings for managing HTTP requests to the backend.", "properties": { "requestTimeout": { "description": "Deadline for receiving a response from the backend.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "requestTimeout must be at least 1ms", "rule": "duration(self) \u003e= duration('1ms')" } ] }, "version": { "description": "HTTP protocol version to use when connecting to\nthe backend.\nIf not specified, the version is automatically determined:\n* `Service` types can specify it with `appProtocol` on the `Service`\n port.\n* If traffic is identified as gRPC, `HTTP2` is used.\n* If the incoming traffic was plaintext HTTP, the original protocol will\n be used.\n* If the incoming traffic was HTTPS, `HTTP1` will be used. This is\n because most clients will transparently upgrade HTTPS traffic to\n `HTTP2`, even if the backend doesn't support it.", "enum": [ "HTTP1", "HTTP2" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "mcp": { "additionalProperties": false, "description": "Settings for MCP workloads. This is only applicable when\nconnecting to a `Backend` of type `mcp`.", "properties": { "authentication": { "additionalProperties": false, "description": "MCP backend-specific authentication rules.\n\nThis field is deprecated; prefer to use traffic policy `jwtAuthentication.mcp`, which ensures authentication runs before\nother policies such as transformation and rate limiting.", "properties": { "audiences": { "description": "Allowed audiences that are allowed\naccess. This corresponds to the `aud` claim\n([RFC 7519 §4.1.3](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.3)).\nIf unset, any audience is allowed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 1, "type": [ "array", "null" ] }, "clientId": { "description": "Client ID to use for short-circuiting Dynamic Client Registration.\nIf set, the gateway will not proxy registration requests to the IDP and instead return this client ID.", "type": [ "string", "null" ] }, "issuer": { "description": "IdP that issued the JWT. This corresponds to the\n`iss` claim ([RFC 7519 §4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1)).", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "jwks": { "additionalProperties": false, "description": "Remote JSON Web Key used to validate the signature of\nthe JWT.", "properties": { "backendRef": { "additionalProperties": false, "description": "Remote JWKS server to reach.\nSupported types are `Service` and static `Backend`. An\n`AgentgatewayPolicy` containing backend TLS config can then be attached\nto the `Service` or `Backend` in order to set TLS options for a\nconnection to the remote `jwks` source.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] }, "cacheDuration": { "default": "5m", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "cacheDuration must be at least 5m.", "rule": "duration(self) \u003e= duration('5m')" } ] }, "jwksPath": { "description": "Path to the IdP `jwks` endpoint, relative to the root, commonly\n`\".well-known/jwks.json\"`.", "maxLength": 2000, "minLength": 1, "type": "string" } }, "required": [ "backendRef", "jwksPath" ], "type": "object" }, "mode": { "default": "Strict", "description": "Validation mode for JWT authentication.", "enum": [ "Optional", "Permissive", "Strict" ], "type": [ "string", "null" ] }, "provider": { "description": "Identity provider to use for authentication.", "enum": [ "Auth0", "Keycloak", "Okta" ], "type": [ "string", "null" ] }, "resourceMetadata": { "additionalProperties": { "x-kubernetes-preserve-unknown-fields": true }, "description": "Metadata to use for MCP resources.", "type": [ "object", "null" ] } }, "required": [ "jwks" ], "type": [ "object", "null" ] }, "authorization": { "additionalProperties": false, "description": "MCP backend authorization. Unlike authorization at the HTTP level, which rejects\nunauthorized requests with a `403` error, this policy works at the\n`MCPBackend` level.\n\nList operations, such as `list_tools`, will have each item evaluated.\nItems that do not meet the rule will be filtered.\n\nGet or call operations, such as `call_tool`, will evaluate the specific\nitem and reject requests that do not meet the rule.", "properties": { "action": { "default": "Allow", "description": "The effect of this rule when it matches.\nIf unspecified, defaults to `Allow`.\n`Require` rules are cumulative: all require rules must match.", "enum": [ "Allow", "Deny", "Require" ], "type": [ "string", "null" ] }, "policy": { "additionalProperties": false, "description": "The authorization rule to evaluate.\n\n* `Allow`: any matching allow rule allows the request.\n* `Require`: every require rule must match for the request to be allowed.\n* `Deny`: any matching deny rule denies the request.\n\nA CEL expression that fails to evaluate does not match. Prefer `Require`\nfor deny-by-default behavior.\n\nIf at least one `Allow` rule is configured, requests are denied unless at\nleast one allow rule matches.", "properties": { "matchExpressions": { "description": "CEL expressions that must all evaluate to true for the rule to match.", "items": { "description": "A Common Expression Language (CEL) expression.", "maxLength": 16384, "minLength": 1, "type": "string" }, "maxItems": 256, "minItems": 1, "type": "array" } }, "required": [ "matchExpressions" ], "type": "object" } }, "required": [ "policy" ], "type": [ "object", "null" ] }, "guardrails": { "additionalProperties": false, "description": "`guardrails` routes selected JSON-RPC methods through a remote policy server.", "properties": { "processors": { "description": "`processors` is the ordered list of policy processors applied to matched\nmethods. Processors run in the order listed; the first to reject a request\nshort-circuits the chain.", "items": { "additionalProperties": false, "description": "MCPGuardrailsProcessor selects a single policy processor. Exactly one variant must be set.", "properties": { "methods": { "additionalProperties": { "description": "MCPMethodPhase controls when an MCP method is run through the guardrails pipeline.", "enum": [ "Full", "Off", "Request", "Response" ], "type": "string" }, "description": "`methods` is the allowlist of JSON-RPC methods (e.g. `tools/call`,\n`tools/list`) routed through this processor, keyed by method name with the\nphase it runs in. Keys may be exact, a prefix wildcard (`tools/*`), a suffix\nwildcard (`*/list`), or `*` for all methods; the most specific match wins.\nMethods matching no key, including unknown ones, bypass this processor.", "maxProperties": 64, "minProperties": 1, "type": "object", "x-kubernetes-validations": [ { "message": "method wildcards must be '*', a prefix like 'tools/*', or a suffix like '*/list'", "rule": "self.all(k, !k.contains('*') || (k.indexOf('*') == k.lastIndexOf('*') \u0026\u0026 (k.indexOf('*') == 0 || k.indexOf('*') == size(k) - 1)))" } ] }, "remote": { "additionalProperties": false, "description": "`remote` configures a gRPC policy server.", "properties": { "allowedRequestHeaders": { "description": "`allowedRequestHeaders` lists the incoming request headers forwarded to\nthe policy server in `McpRequest.headers`. If empty, all headers and\npseudo-headers (`:authority`, `:method`, ...) are forwarded. Matching is\ncase-insensitive.", "items": { "description": "HTTP header name.", "maxLength": 256, "minLength": 1, "pattern": "^:?[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string", "x-kubernetes-validations": [ { "message": "pseudo-headers must be one of :authority, :method, :path, :scheme, or :status", "rule": "!self.startsWith(':') || self in [':authority', ':method', ':path', ':scheme', ':status']" } ] }, "maxItems": 64, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" }, "backendRef": { "additionalProperties": false, "description": "`backendRef` references the remote guardrails policy server.\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] }, "disallowedRequestHeaders": { "description": "`disallowedRequestHeaders` lists header names never forwarded to the\npolicy server, even if listed in `allowedRequestHeaders`. Matching is\ncase-insensitive.", "items": { "description": "HTTP header name.", "maxLength": 256, "minLength": 1, "pattern": "^:?[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string", "x-kubernetes-validations": [ { "message": "pseudo-headers must be one of :authority, :method, :path, :scheme, or :status", "rule": "!self.startsWith(':') || self in [':authority', ':method', ':path', ':scheme', ':status']" } ] }, "maxItems": 64, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" }, "failureMode": { "description": "`failureMode` controls behavior when the policy server is unreachable\nor returns an error. `FailOpen` allows the request; `FailClosed`\n(default) denies it.", "enum": [ "FailClosed", "FailOpen" ], "type": [ "string", "null" ] }, "metadata": { "additionalProperties": { "description": "A Common Expression Language (CEL) expression.", "maxLength": 16384, "minLength": 1, "type": "string" }, "description": "`metadata` is static or CEL-evaluated context surfaced to the policy\nserver as fields of the `metadata_context` google.protobuf.Struct,\nkeyed by config key. Values are CEL expressions.", "maxProperties": 64, "type": [ "object", "null" ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "required": [ "methods" ], "type": "object", "x-kubernetes-validations": [ { "message": "exactly one of the fields in [remote] must be set", "rule": "[has(self.remote)].filter(x,x==true).size() == 1" } ] }, "maxItems": 16, "minItems": 1, "type": "array" } }, "required": [ "processors" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [authentication authorization guardrails] must be set", "rule": "[has(self.authentication),has(self.authorization),has(self.guardrails)].filter(x,x==true).size() \u003e= 1" } ] }, "tcp": { "additionalProperties": false, "description": "Settings for managing TCP connections to the backend.", "properties": { "connectTimeout": { "description": "Deadline for establishing a connection to\nthe destination.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "connectTimeout must be at least 100ms", "rule": "duration(self) \u003e= duration('100ms')" } ] }, "keepalive": { "additionalProperties": false, "description": "Settings for enabling TCP keepalives on the\nconnection.", "properties": { "interval": { "description": "Time between keepalive probes.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "interval must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] }, "retries": { "description": "Maximum number of keepalive probes to send before dropping the connection.\nIf unset, this defaults to 9.", "format": "int32", "maximum": 64, "minimum": 1, "type": [ "integer", "null" ] }, "time": { "description": "Time a connection needs to be idle before keepalive probes start being sent.\nIf unset, this defaults to 180s.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "invalid duration value", "rule": "matches(self, '^([0-9]{1,5}(h|m|s|ms)){1,4}$')" }, { "message": "time must be at least 1 second", "rule": "duration(self) \u003e= duration('1s')" } ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "tls": { "additionalProperties": false, "description": "Settings for managing TLS connections to the backend.\n\nIf this field is set, TLS will be initiated to the backend; the system trusted CA certificates will be used to\nvalidate the server, and the SNI will automatically be set based on the destination.", "properties": { "alpnProtocols": { "description": "Application-Layer Protocol Negotiation (`ALPN`)\nvalue to use in the TLS handshake.\n\nIf not present, defaults to `[\"h2\", \"http/1.1\"]`.", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] }, "caCertificateRefs": { "description": "CA certificate `ConfigMap` to use to\nverify the server certificate.\nIf unset, the system's trusted certificates are used.", "items": { "additionalProperties": false, "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "insecureSkipVerify": { "description": "Originates TLS but skips verification of the backend's certificate.\nWARNING: This is an insecure option that should only be used if the risks are understood.\n\nThere are two modes:\n* `All` disables all TLS verification.\n* `Hostname` verifies the CA certificate is trusted, but ignores any\n mismatch of hostname or SANs. Note that this method is still insecure;\n prefer setting `verifySubjectAltNames` to customize the valid hostnames\n if possible.", "enum": [ "All", "Hostname" ], "type": [ "string", "null" ] }, "keyExchangeGroups": { "description": "Ordered list of key exchange groups for a TLS connection.\nFor example: `X25519_MLKEM768,X25519`.", "items": { "enum": [ "P-256", "P-384", "X25519", "X25519_MLKEM768" ], "type": "string" }, "type": [ "array", "null" ] }, "mtlsCertificateRef": { "description": "Enables mutual TLS to the backend, using the\nspecified key (`tls.key`) and cert (`tls.crt`) from the referenced\ncredential source, defaulting to a Kubernetes `Secret`.\n\nAn optional `ca.cert` field, if present, will be used to verify the\nserver certificate. If `caCertificateRefs` is also specified, the\n`caCertificateRefs` field takes priority.\n\nIf unspecified, no client certificate will be used.", "items": { "additionalProperties": false, "description": "References a same-namespace credential.\nSet only `name` to reference a Kubernetes Secret.", "properties": { "group": { "description": "The API group of the referenced credential.\nEmpty selects the core API group.", "type": [ "string", "null" ] }, "kind": { "description": "The kind of the referenced credential.\nEmpty defaults to `Secret`.", "type": [ "string", "null" ] }, "name": { "description": "The name of the referenced credential.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-kubernetes-map-type": "atomic", "x-kubernetes-validations": [ { "message": "custom credential refs must set both group and kind", "rule": "(!has(self.group) || size(self.group) == 0) ? (!has(self.kind) || size(self.kind) == 0 || self.kind == 'Secret') : (has(self.kind) \u0026\u0026 size(self.kind) \u003e 0)" } ] }, "maxItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "sni": { "description": "Server Name Indicator (`SNI`) to use in the TLS\nhandshake. If unset, the `SNI` is automatically set based on the\ndestination hostname.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "verifySubjectAltNames": { "description": "Subject Alternative Names (`SAN`)\nto verify in the server certificate.\nIf not present, the destination hostname is automatically used.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "insecureSkipVerify All and caCertificateRefs may not be set together", "rule": "has(self.insecureSkipVerify) \u0026\u0026 self.insecureSkipVerify == 'All' ? !has(self.caCertificateRefs) : true" }, { "message": "insecureSkipVerify and verifySubjectAltNames may not be set together", "rule": "has(self.insecureSkipVerify) ? !has(self.verifySubjectAltNames) : true" }, { "message": "at most one of the fields in [verifySubjectAltNames insecureSkipVerify] may be set", "rule": "[has(self.verifySubjectAltNames),has(self.insecureSkipVerify)].filter(x,x==true).size() \u003c= 1" } ] }, "transformation": { "additionalProperties": false, "description": "Mutates and transforms requests and responses sent to and from the backend.", "properties": { "request": { "additionalProperties": false, "description": "Request transformation settings.", "properties": { "add": { "description": "Headers to add to the request and what each value\nshould be set to. If there is already a header with these values then\nappend the value as an extra entry.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the header to add.", "maxLength": 256, "minLength": 1, "pattern": "^:?[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string", "x-kubernetes-validations": [ { "message": "pseudo-headers must be one of :authority, :method, :path, :scheme, or :status", "rule": "!self.startsWith(':') || self in [':authority', ':method', ':path', ':scheme', ':status']" } ] }, "value": { "description": "CEL expression that generates the output value for\nthe header.", "maxLength": 16384, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "body": { "description": "HTTP body transformation.", "maxLength": 16384, "minLength": 1, "type": [ "string", "null" ] }, "metadata": { "additionalProperties": { "description": "A Common Expression Language (CEL) expression.", "maxLength": 16384, "minLength": 1, "type": "string" }, "description": "Stores CEL-evaluated values under the `metadata` CEL variable\nfor subsequent policy evaluations. `metadata` is evaluated before header\nor body transformations.", "maxProperties": 16, "minProperties": 1, "type": [ "object", "null" ] }, "remove": { "description": "Header names to remove from the request or\nresponse.", "items": { "description": "HTTP header name.", "maxLength": 256, "minLength": 1, "pattern": "^:?[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string", "x-kubernetes-validations": [ { "message": "pseudo-headers must be one of :authority, :method, :path, :scheme, or :status", "rule": "!self.startsWith(':') || self in [':authority', ':method', ':path', ':scheme', ':status']" } ] }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" }, "set": { "description": "Headers to set and the values to use.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the header to add.", "maxLength": 256, "minLength": 1, "pattern": "^:?[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string", "x-kubernetes-validations": [ { "message": "pseudo-headers must be one of :authority, :method, :path, :scheme, or :status", "rule": "!self.startsWith(':') || self in [':authority', ':method', ':path', ':scheme', ':status']" } ] }, "value": { "description": "CEL expression that generates the output value for\nthe header.", "maxLength": 16384, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [add body metadata remove set] must be set", "rule": "[has(self.add),has(self.body),has(self.metadata),has(self.remove),has(self.set)].filter(x,x==true).size() \u003e= 1" } ] }, "response": { "additionalProperties": false, "description": "Response transformation settings.", "properties": { "add": { "description": "Headers to add to the request and what each value\nshould be set to. If there is already a header with these values then\nappend the value as an extra entry.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the header to add.", "maxLength": 256, "minLength": 1, "pattern": "^:?[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string", "x-kubernetes-validations": [ { "message": "pseudo-headers must be one of :authority, :method, :path, :scheme, or :status", "rule": "!self.startsWith(':') || self in [':authority', ':method', ':path', ':scheme', ':status']" } ] }, "value": { "description": "CEL expression that generates the output value for\nthe header.", "maxLength": 16384, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "body": { "description": "HTTP body transformation.", "maxLength": 16384, "minLength": 1, "type": [ "string", "null" ] }, "metadata": { "additionalProperties": { "description": "A Common Expression Language (CEL) expression.", "maxLength": 16384, "minLength": 1, "type": "string" }, "description": "Stores CEL-evaluated values under the `metadata` CEL variable\nfor subsequent policy evaluations. `metadata` is evaluated before header\nor body transformations.", "maxProperties": 16, "minProperties": 1, "type": [ "object", "null" ] }, "remove": { "description": "Header names to remove from the request or\nresponse.", "items": { "description": "HTTP header name.", "maxLength": 256, "minLength": 1, "pattern": "^:?[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string", "x-kubernetes-validations": [ { "message": "pseudo-headers must be one of :authority, :method, :path, :scheme, or :status", "rule": "!self.startsWith(':') || self in [':authority', ':method', ':path', ':scheme', ':status']" } ] }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" }, "set": { "description": "Headers to set and the values to use.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the header to add.", "maxLength": 256, "minLength": 1, "pattern": "^:?[A-Za-z0-9!#$%\u0026'*+\\-.^_\\x60|~]+$", "type": "string", "x-kubernetes-validations": [ { "message": "pseudo-headers must be one of :authority, :method, :path, :scheme, or :status", "rule": "!self.startsWith(':') || self in [':authority', ':method', ':path', ':scheme', ':status']" } ] }, "value": { "description": "CEL expression that generates the output value for\nthe header.", "maxLength": 16384, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "maxItems": 16, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [add body metadata remove set] must be set", "rule": "[has(self.add),has(self.body),has(self.metadata),has(self.remove),has(self.set)].filter(x,x==true).size() \u003e= 1" } ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [request response] must be set", "rule": "[has(self.request),has(self.response)].filter(x,x==true).size() \u003e= 1" } ] }, "tunnel": { "additionalProperties": false, "description": "Settings for managing tunnel connections, with behavior like `HTTPS_PROXY`, to the backend.", "properties": { "backendRef": { "additionalProperties": false, "description": "Proxy server to reach.\nSupported types: `Service` and `Backend`.", "properties": { "group": { "default": "", "description": "Group is the group of the referent. For example, \"gateway.networking.k8s.io\".\nWhen unspecified or empty string, core API group is inferred.", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": [ "string", "null" ] }, "kind": { "default": "Service", "description": "Kind is the Kubernetes resource kind of the referent. For example\n\"Service\".\n\nDefaults to \"Service\" when not specified.\n\nExternalName services can refer to CNAME DNS records that may live\noutside of the cluster and as such are difficult to reason about in\nterms of conformance. They also may not be safe to forward to (see\nCVE-2021-25740 for more information). Implementations SHOULD NOT\nsupport ExternalName Services.\n\nSupport: Core (Services with a type other than ExternalName)\n\nSupport: Implementation-specific (Services with type ExternalName)", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": [ "string", "null" ] }, "name": { "description": "Name is the name of the referent.", "maxLength": 253, "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace is the namespace of the backend. When unspecified, the local\nnamespace is inferred.\n\nNote that when a namespace different than the local namespace is specified,\na ReferenceGrant object is required in the referent namespace to allow that\nnamespace's owner to accept the reference. See the ReferenceGrant\ndocumentation for details.\n\nSupport: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": [ "string", "null" ] }, "port": { "description": "Port specifies the destination port number to use for this resource.\nPort is required when the referent is a Kubernetes Service. In this\ncase, the port number is the service port number, not the target port.\nFor other resources, destination port might be derived from the referent\nresource or this field.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": "object", "x-kubernetes-validations": [ { "message": "Must have port for Service reference", "rule": "(size(self.group) == 0 \u0026\u0026 self.kind == 'Service') ? has(self.port) : true" } ] } }, "required": [ "backendRef" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "at least one of the fields in [ai auth extAuth health http mcp tcp tls transformation tunnel] must be set", "rule": "[has(self.ai),has(self.auth),has(self.extAuth),has(self.health),has(self.http),has(self.mcp),has(self.tcp),has(self.tls),has(self.transformation),has(self.tunnel)].filter(x,x==true).size() \u003e= 1" } ] }, "static": { "additionalProperties": false, "description": "Static hostname, IP address, or Unix Domain Socket backend.", "properties": { "host": { "description": "Host to connect to for TCP backends.", "maxLength": 256, "minLength": 1, "type": [ "string", "null" ] }, "port": { "description": "Port to connect to for TCP backends.", "format": "int32", "maximum": 65535, "minimum": 1, "type": [ "integer", "null" ] }, "unixPath": { "description": "Filesystem path to a Unix Domain Socket. The gateway pod\nmust share a volume with the target (e.g., via emptyDir sidecar pattern).\nMutually exclusive with host/port.", "minLength": 1, "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "must specify either unixPath or both host and port", "rule": "has(self.unixPath) || (has(self.host) \u0026\u0026 has(self.port))" }, { "message": "unixPath and host/port are mutually exclusive", "rule": "!has(self.unixPath) || (!has(self.host) \u0026\u0026 !has(self.port))" } ] } }, "type": "object", "x-kubernetes-validations": [ { "message": "AI policies require AI backend", "rule": "has(self.policies) \u0026\u0026 has(self.policies.ai) ? has(self.ai) : true" }, { "message": "MCP policies require MCP backend", "rule": "has(self.policies) \u0026\u0026 has(self.policies.mcp) ? has(self.mcp) : true" }, { "message": "exactly one of the fields in [ai static dynamicForwardProxy mcp aws a2a] must be set", "rule": "[has(self.ai),has(self.static),has(self.dynamicForwardProxy),has(self.mcp),has(self.aws),has(self.a2a)].filter(x,x==true).size() == 1" } ] }, "status": { "additionalProperties": false, "description": "Current backend status.", "properties": { "conditions": { "description": "Current condition state for the backend.", "items": { "additionalProperties": false, "description": "Condition contains details for one aspect of the current state of this API Resource.", "properties": { "lastTransitionTime": { "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "format": "date-time", "type": "string" }, "message": { "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", "maxLength": 32768, "type": "string" }, "observedGeneration": { "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", "format": "int64", "minimum": 0, "type": [ "integer", "null" ] }, "reason": { "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", "maxLength": 1024, "minLength": 1, "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "type": "string" }, "status": { "description": "status of the condition, one of True, False, Unknown.", "enum": [ "True", "False", "Unknown" ], "type": "string" }, "type": { "description": "type of condition in CamelCase or in foo.example.com/CamelCase.", "maxLength": 316, "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "type": "string" } }, "required": [ "lastTransitionTime", "message", "reason", "status", "type" ], "type": "object" }, "maxItems": 8, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "type" ], "x-kubernetes-list-type": "map" } }, "type": [ "object", "null" ] } }, "required": [ "spec" ], "type": "object" }