AgentgatewayParameters
agentgateway.dev / v1alpha1
apiVersion: agentgateway.dev/v1alpha1
kind: AgentgatewayParameters
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object required
spec defines the desired state of AgentgatewayParameters.
deployment object
deployment allows specifying overrides for the generated Deployment resource.
metadata object
metadata defines a subset of object metadata to be customized.
annotations
object
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
labels
object
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
spec
object
Spec provides an opaque mechanism to configure the resource Spec.
This field accepts a complete or partial Kubernetes resource spec (e.g., PodSpec, ServiceSpec)
and will be merged with the generated configuration using **Strategic Merge Patch** semantics.
The patch is applied after all other fields are applied.
If you merge-patch the same resource from AgentgatewayParameters on the
GatewayClass and also from AgentgatewayParameters on the Gateway, then
the GatewayClass merge-patch happens first.
# Strategic Merge Patch & Deletion Guide
This merge strategy allows you to override individual fields, merge lists, or delete items
without needing to provide the entire resource definition.
**1. Replacing Values (Scalars):**
Simple fields (strings, integers, booleans) in your config will overwrite the generated defaults.
**2. Merging Lists (Append/Merge):**
Lists with "merge keys" (like `containers` which merges on `name`, or `tolerations` which merges on `key`)
will append your items to the generated list, or update existing items if keys match.
**3. Deleting Fields or List Items ($patch: delete):**
To remove a field or list item from the generated resource, use the
`$patch: delete` directive. This works for both map fields and list items,
and is the recommended approach because it works with both client-side
and server-side apply.
spec:
template:
spec:
# Delete pod-level securityContext
securityContext:
$patch: delete
# Delete nodeSelector
nodeSelector:
$patch: delete
containers:
- name: agentgateway
# Delete container-level securityContext
securityContext:
$patch: delete
**4. Null Values (server-side apply only):**
Setting a field to `null` can also remove it, but this ONLY works with
`kubectl apply --server-side` or equivalent. With regular client-side
`kubectl apply`, null values are stripped by kubectl before reaching
the API server, so the deletion won't occur. Prefer `$patch: delete`
for consistent behavior across both apply modes.
spec:
template:
spec:
nodeSelector: null # Removes nodeSelector (server-side apply only!)
**5. Replacing Maps Entirely ($patch: replace):**
To replace an entire map with your values (instead of merging), use `$patch: replace`.
This removes all existing keys and replaces them with only your specified keys.
spec:
template:
spec:
nodeSelector:
$patch: replace
custom-key: custom-value
**6. Replacing Lists Entirely ($patch: replace):**
If you want to strictly define a list and ignore all generated defaults, use `$patch: replace`.
service:
spec:
ports:
- $patch: replace
- name: http
port: 80
targetPort: 8080
protocol: TCP
- name: https
port: 443
targetPort: 8443
protocol: TCP
env []object
The container environment variables. These override any existing
values. If you want to delete an environment variable entirely, use
`$patch: delete` with AgentgatewayParametersOverlays instead. Note that
[variable
expansion](https://kubernetes.io/docs/tasks/inject-data-application/define-interdependent-environment-variables/)
does apply, but is highly discouraged -- to set dependent environment
variables, you can use $(VAR_NAME), but it's highly
discouraged. `$$(VAR_NAME)` avoids expansion and results in a literal
`$(VAR_NAME)`.
name
string required
Name of the environment variable.
May consist of any printable ASCII characters except '='.
value
string
Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".
valueFrom object
Source for the environment variable's value. Cannot be used if value is not empty.
configMapKeyRef object
Selects a key of a ConfigMap.
key
string required
The key to select.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or its key must be defined
fieldRef object
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
apiVersion
string
Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPath
string required
Path of the field to select in the specified API version.
fileKeyRef object
FileKeyRef selects a key of the env file.
Requires the EnvFiles feature gate to be enabled.
key
string required
The key within the env file. An invalid key will prevent the pod from starting.
The keys defined within a source may consist of any printable ASCII characters except '='.
During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.
optional
boolean
Specify whether the file or its key must be defined. If the file or key
does not exist, then the env var is not published.
If optional is set to true and the specified key does not exist,
the environment variable will not be set in the Pod's containers.
If optional is set to false and the specified key does not exist,
an error will be returned during Pod creation.
path
string required
The path within the volume from which to select the file.
Must be relative and may not contain the '..' path or start with '..'.
volumeName
string required
The name of the volume mount containing the env file.
resourceFieldRef object
Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
containerName
string
Container name: required for volumes, optional for env vars
divisor
string | integer
Specifies the output format of the exposed resources, defaults to "1"
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
Required: resource to select
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
horizontalPodAutoscaler object
horizontalPodAutoscaler allows creating a HorizontalPodAutoscaler for the agentgateway proxy.
If absent, no HPA is created. If present, an HPA is created with its scaleTargetRef
automatically configured to target the agentgateway proxy Deployment.
The metadata and spec fields from this overlay are applied to the generated HPA.
metadata object
metadata defines a subset of object metadata to be customized.
annotations
object
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
labels
object
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
spec
object
Spec provides an opaque mechanism to configure the resource Spec.
This field accepts a complete or partial Kubernetes resource spec (e.g., PodSpec, ServiceSpec)
and will be merged with the generated configuration using **Strategic Merge Patch** semantics.
The patch is applied after all other fields are applied.
If you merge-patch the same resource from AgentgatewayParameters on the
GatewayClass and also from AgentgatewayParameters on the Gateway, then
the GatewayClass merge-patch happens first.
# Strategic Merge Patch & Deletion Guide
This merge strategy allows you to override individual fields, merge lists, or delete items
without needing to provide the entire resource definition.
**1. Replacing Values (Scalars):**
Simple fields (strings, integers, booleans) in your config will overwrite the generated defaults.
**2. Merging Lists (Append/Merge):**
Lists with "merge keys" (like `containers` which merges on `name`, or `tolerations` which merges on `key`)
will append your items to the generated list, or update existing items if keys match.
**3. Deleting Fields or List Items ($patch: delete):**
To remove a field or list item from the generated resource, use the
`$patch: delete` directive. This works for both map fields and list items,
and is the recommended approach because it works with both client-side
and server-side apply.
spec:
template:
spec:
# Delete pod-level securityContext
securityContext:
$patch: delete
# Delete nodeSelector
nodeSelector:
$patch: delete
containers:
- name: agentgateway
# Delete container-level securityContext
securityContext:
$patch: delete
**4. Null Values (server-side apply only):**
Setting a field to `null` can also remove it, but this ONLY works with
`kubectl apply --server-side` or equivalent. With regular client-side
`kubectl apply`, null values are stripped by kubectl before reaching
the API server, so the deletion won't occur. Prefer `$patch: delete`
for consistent behavior across both apply modes.
spec:
template:
spec:
nodeSelector: null # Removes nodeSelector (server-side apply only!)
**5. Replacing Maps Entirely ($patch: replace):**
To replace an entire map with your values (instead of merging), use `$patch: replace`.
This removes all existing keys and replaces them with only your specified keys.
spec:
template:
spec:
nodeSelector:
$patch: replace
custom-key: custom-value
**6. Replacing Lists Entirely ($patch: replace):**
If you want to strictly define a list and ignore all generated defaults, use `$patch: replace`.
service:
spec:
ports:
- $patch: replace
- name: http
port: 80
targetPort: 8080
protocol: TCP
- name: https
port: 443
targetPort: 8443
protocol: TCP
image object
The agentgateway container image. See
https://kubernetes.io/docs/concepts/containers/images
for details.
Default values, which may be overridden individually:
registry: cr.agentgateway.dev
repository: agentgateway
tag: <agentgateway version>
pullPolicy: <omitted, relying on Kubernetes defaults which depend on the tag>
digest
string
The hash digest of the image, e.g. `sha256:12345...`
pullPolicy
string
The image pull policy for the container. See
https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy
for details.
registry
string
The image registry.
repository
string
The image repository (name).
tag
string
The image tag.
istio object
Configure Istio integration. If enabled, Agentgateway can natively connect to Istio enabled pods with mTLS.
caAddress
string
The address of the Istio CA. If unset, defaults to `https://istiod.istio-system.svc:15012`.
trustDomain
string
The Istio trust domain. If not set, defaults to `cluster.local`.
logging object
logging configuration for Agentgateway. By default, all logs are set to "info" level.
format
string
The default logging format is text.
enum:
json, text
level
string
Logging level in standard RUST_LOG syntax, e.g. 'info', the default, or
by module, comma-separated. E.g.,
"rmcp=warn,hickory_server::server::server_future=off,typespec_client_core::http::policies::logging=warn"
podDisruptionBudget object
podDisruptionBudget allows creating a PodDisruptionBudget for the agentgateway proxy.
If absent, no PDB is created. If present, a PDB is created with its selector
automatically configured to target the agentgateway proxy Deployment.
The metadata and spec fields from this overlay are applied to the generated PDB.
metadata object
metadata defines a subset of object metadata to be customized.
annotations
object
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
labels
object
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
spec
object
Spec provides an opaque mechanism to configure the resource Spec.
This field accepts a complete or partial Kubernetes resource spec (e.g., PodSpec, ServiceSpec)
and will be merged with the generated configuration using **Strategic Merge Patch** semantics.
The patch is applied after all other fields are applied.
If you merge-patch the same resource from AgentgatewayParameters on the
GatewayClass and also from AgentgatewayParameters on the Gateway, then
the GatewayClass merge-patch happens first.
# Strategic Merge Patch & Deletion Guide
This merge strategy allows you to override individual fields, merge lists, or delete items
without needing to provide the entire resource definition.
**1. Replacing Values (Scalars):**
Simple fields (strings, integers, booleans) in your config will overwrite the generated defaults.
**2. Merging Lists (Append/Merge):**
Lists with "merge keys" (like `containers` which merges on `name`, or `tolerations` which merges on `key`)
will append your items to the generated list, or update existing items if keys match.
**3. Deleting Fields or List Items ($patch: delete):**
To remove a field or list item from the generated resource, use the
`$patch: delete` directive. This works for both map fields and list items,
and is the recommended approach because it works with both client-side
and server-side apply.
spec:
template:
spec:
# Delete pod-level securityContext
securityContext:
$patch: delete
# Delete nodeSelector
nodeSelector:
$patch: delete
containers:
- name: agentgateway
# Delete container-level securityContext
securityContext:
$patch: delete
**4. Null Values (server-side apply only):**
Setting a field to `null` can also remove it, but this ONLY works with
`kubectl apply --server-side` or equivalent. With regular client-side
`kubectl apply`, null values are stripped by kubectl before reaching
the API server, so the deletion won't occur. Prefer `$patch: delete`
for consistent behavior across both apply modes.
spec:
template:
spec:
nodeSelector: null # Removes nodeSelector (server-side apply only!)
**5. Replacing Maps Entirely ($patch: replace):**
To replace an entire map with your values (instead of merging), use `$patch: replace`.
This removes all existing keys and replaces them with only your specified keys.
spec:
template:
spec:
nodeSelector:
$patch: replace
custom-key: custom-value
**6. Replacing Lists Entirely ($patch: replace):**
If you want to strictly define a list and ignore all generated defaults, use `$patch: replace`.
service:
spec:
ports:
- $patch: replace
- name: http
port: 80
targetPort: 8080
protocol: TCP
- name: https
port: 443
targetPort: 8443
protocol: TCP
rawConfig
object
rawConfig provides an opaque mechanism to configure the agentgateway
config file (the agentgateway binary has a '-f' option to specify a
config file, and this is that file). This will be merged with
configuration derived from typed fields like
AgentgatewayParametersLogging.Format, and those typed fields will take
precedence.
Example:
rawConfig:
binds:
- port: 3000
listeners:
- routes:
- policies:
cors:
allowOrigins:
- "*"
allowHeaders:
- mcp-protocol-version
- content-type
- cache-control
backends:
- mcp:
targets:
- name: everything
stdio:
cmd: npx
args: ["@modelcontextprotocol/server-everything"]
resources object
The compute resources required by this container. See
https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
for details.
claims []object
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
This field depends on the
DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
name
string required
Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container.
request
string
Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request.
limits
object
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests
object
Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
service object
service allows specifying overrides for the generated Service resource.
metadata object
metadata defines a subset of object metadata to be customized.
annotations
object
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
labels
object
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
spec
object
Spec provides an opaque mechanism to configure the resource Spec.
This field accepts a complete or partial Kubernetes resource spec (e.g., PodSpec, ServiceSpec)
and will be merged with the generated configuration using **Strategic Merge Patch** semantics.
The patch is applied after all other fields are applied.
If you merge-patch the same resource from AgentgatewayParameters on the
GatewayClass and also from AgentgatewayParameters on the Gateway, then
the GatewayClass merge-patch happens first.
# Strategic Merge Patch & Deletion Guide
This merge strategy allows you to override individual fields, merge lists, or delete items
without needing to provide the entire resource definition.
**1. Replacing Values (Scalars):**
Simple fields (strings, integers, booleans) in your config will overwrite the generated defaults.
**2. Merging Lists (Append/Merge):**
Lists with "merge keys" (like `containers` which merges on `name`, or `tolerations` which merges on `key`)
will append your items to the generated list, or update existing items if keys match.
**3. Deleting Fields or List Items ($patch: delete):**
To remove a field or list item from the generated resource, use the
`$patch: delete` directive. This works for both map fields and list items,
and is the recommended approach because it works with both client-side
and server-side apply.
spec:
template:
spec:
# Delete pod-level securityContext
securityContext:
$patch: delete
# Delete nodeSelector
nodeSelector:
$patch: delete
containers:
- name: agentgateway
# Delete container-level securityContext
securityContext:
$patch: delete
**4. Null Values (server-side apply only):**
Setting a field to `null` can also remove it, but this ONLY works with
`kubectl apply --server-side` or equivalent. With regular client-side
`kubectl apply`, null values are stripped by kubectl before reaching
the API server, so the deletion won't occur. Prefer `$patch: delete`
for consistent behavior across both apply modes.
spec:
template:
spec:
nodeSelector: null # Removes nodeSelector (server-side apply only!)
**5. Replacing Maps Entirely ($patch: replace):**
To replace an entire map with your values (instead of merging), use `$patch: replace`.
This removes all existing keys and replaces them with only your specified keys.
spec:
template:
spec:
nodeSelector:
$patch: replace
custom-key: custom-value
**6. Replacing Lists Entirely ($patch: replace):**
If you want to strictly define a list and ignore all generated defaults, use `$patch: replace`.
service:
spec:
ports:
- $patch: replace
- name: http
port: 80
targetPort: 8080
protocol: TCP
- name: https
port: 443
targetPort: 8443
protocol: TCP
serviceAccount object
serviceAccount allows specifying overrides for the generated ServiceAccount resource.
metadata object
metadata defines a subset of object metadata to be customized.
annotations
object
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
labels
object
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
spec
object
Spec provides an opaque mechanism to configure the resource Spec.
This field accepts a complete or partial Kubernetes resource spec (e.g., PodSpec, ServiceSpec)
and will be merged with the generated configuration using **Strategic Merge Patch** semantics.
The patch is applied after all other fields are applied.
If you merge-patch the same resource from AgentgatewayParameters on the
GatewayClass and also from AgentgatewayParameters on the Gateway, then
the GatewayClass merge-patch happens first.
# Strategic Merge Patch & Deletion Guide
This merge strategy allows you to override individual fields, merge lists, or delete items
without needing to provide the entire resource definition.
**1. Replacing Values (Scalars):**
Simple fields (strings, integers, booleans) in your config will overwrite the generated defaults.
**2. Merging Lists (Append/Merge):**
Lists with "merge keys" (like `containers` which merges on `name`, or `tolerations` which merges on `key`)
will append your items to the generated list, or update existing items if keys match.
**3. Deleting Fields or List Items ($patch: delete):**
To remove a field or list item from the generated resource, use the
`$patch: delete` directive. This works for both map fields and list items,
and is the recommended approach because it works with both client-side
and server-side apply.
spec:
template:
spec:
# Delete pod-level securityContext
securityContext:
$patch: delete
# Delete nodeSelector
nodeSelector:
$patch: delete
containers:
- name: agentgateway
# Delete container-level securityContext
securityContext:
$patch: delete
**4. Null Values (server-side apply only):**
Setting a field to `null` can also remove it, but this ONLY works with
`kubectl apply --server-side` or equivalent. With regular client-side
`kubectl apply`, null values are stripped by kubectl before reaching
the API server, so the deletion won't occur. Prefer `$patch: delete`
for consistent behavior across both apply modes.
spec:
template:
spec:
nodeSelector: null # Removes nodeSelector (server-side apply only!)
**5. Replacing Maps Entirely ($patch: replace):**
To replace an entire map with your values (instead of merging), use `$patch: replace`.
This removes all existing keys and replaces them with only your specified keys.
spec:
template:
spec:
nodeSelector:
$patch: replace
custom-key: custom-value
**6. Replacing Lists Entirely ($patch: replace):**
If you want to strictly define a list and ignore all generated defaults, use `$patch: replace`.
service:
spec:
ports:
- $patch: replace
- name: http
port: 80
targetPort: 8080
protocol: TCP
- name: https
port: 443
targetPort: 8443
protocol: TCP
shutdown object
Shutdown delay configuration. How graceful planned or unplanned data
plane changes happen is in tension with how quickly rollouts of the data
plane complete. How long a data plane pod must wait for shutdown to be
perfectly graceful depends on how you have configured your Gateways.
max
integer required
Maximum time (in seconds) to wait before allowing Agentgateway to
terminate. Refer to the TERMINATION_GRACE_PERIOD_SECONDS environment
variable for details.
format:
int64minimum:
0maximum:
3.1536e+07
min
integer required
Minimum time (in seconds) to wait before allowing Agentgateway to
terminate. Refer to the CONNECTION_MIN_TERMINATION_DEADLINE environment
variable for details.
format:
int64minimum:
0maximum:
3.1536e+07
status
object
status defines the current state of AgentgatewayParameters.
No matches. Try .spec.deployment for an exact path