# API Reference ## Packages - [agents.x-k8s.io/v1beta1](#agentsx-k8siov1beta1) - [extensions.agents.x-k8s.io/v1beta1](#extensionsagentsx-k8siov1beta1) ## agents.x-k8s.io/v1beta1 Package v1beta1 contains API Schema definitions for the agents v1beta1 API group Package v1beta1 contains API Schema definitions for the agents v1beta1 API group. ### Resource Types - [Sandbox](#sandbox) #### EmbeddedObjectMetadata _Appears in:_ - [PersistentVolumeClaimTemplate](#persistentvolumeclaimtemplate) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `name` _string_ | name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names | | Optional: \{\}
| | `labels` _object (keys:string, values:string)_ | labels defines the 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 | | Optional: \{\}
| | `annotations` _object (keys:string, values:string)_ | 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 | | Optional: \{\}
| #### Lifecycle Lifecycle defines the lifecycle management for the Sandbox. _Appears in:_ - [SandboxSpec](#sandboxspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `shutdownTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#time-v1-meta)_ | shutdownTime is the absolute time when the sandbox expires. | | Format: date-time
Optional: \{\}
| | `shutdownPolicy` _[ShutdownPolicy](#shutdownpolicy)_ | shutdownPolicy determines if the Sandbox resource itself should be deleted when it expires.
Underlying resources(Pods, Services) are always deleted on expiry. | Retain | Enum: [Delete Retain]
Optional: \{\}
| #### PersistentVolumeClaimTemplate _Appears in:_ - [SandboxSpec](#sandboxspec) - [SandboxTemplateSpec](#sandboxtemplatespec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `metadata` _[EmbeddedObjectMetadata](#embeddedobjectmetadata)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| | `spec` _[PersistentVolumeClaimSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#persistentvolumeclaimspec-v1-core)_ | spec is the PVC's spec | | Required: \{\}
| #### PodMetadata _Appears in:_ - [PodTemplate](#podtemplate) - [SandboxClaimSpec](#sandboxclaimspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `labels` _object (keys:string, values:string)_ | labels defines the 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 | | Optional: \{\}
| | `annotations` _object (keys:string, values:string)_ | 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 | | Optional: \{\}
| #### PodTemplate _Appears in:_ - [SandboxSpec](#sandboxspec) - [SandboxTemplateSpec](#sandboxtemplatespec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `spec` _[PodSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#podspec-v1-core)_ | spec is the Pod's spec | | Required: \{\}
| | `metadata` _[PodMetadata](#podmetadata)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| #### Sandbox Sandbox is the Schema for the sandboxes API. | Field | Description | Default | Validation | | --- | --- | --- | --- | | `apiVersion` _string_ | `agents.x-k8s.io/v1beta1` | | | | `kind` _string_ | `Sandbox` | | | | `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 | | Optional: \{\}
| | `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 | | Optional: \{\}
| | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| | `spec` _[SandboxSpec](#sandboxspec)_ | spec defines the desired state of Sandbox | | Required: \{\}
| | `status` _[SandboxStatus](#sandboxstatus)_ | status defines the observed state of Sandbox | | Optional: \{\}
| #### SandboxOperatingMode _Underlying type:_ _string_ SandboxOperatingMode defines the desired operational state of the Sandbox. _Appears in:_ - [SandboxSpec](#sandboxspec) | Field | Description | | --- | --- | | `Running` | SandboxOperatingModeRunning indicates the sandbox should be actively running.
| | `Suspended` | SandboxOperatingModeSuspended indicates the sandbox should be suspended.
| #### SandboxSpec SandboxSpec defines the desired state of Sandbox. _Appears in:_ - [Sandbox](#sandbox) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `podTemplate` _[PodTemplate](#podtemplate)_ | podTemplate describes the pod spec that will be used to create an agent sandbox. | | Required: \{\}
| | `volumeClaimTemplates` _[PersistentVolumeClaimTemplate](#persistentvolumeclaimtemplate) array_ | volumeClaimTemplates is a list of claims that the sandbox pod is allowed to reference.
Every claim in this list must have at least one matching access mode with a provisioner volume. | | Optional: \{\}
| | `shutdownTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#time-v1-meta)_ | shutdownTime is the absolute time when the sandbox expires. | | Format: date-time
Optional: \{\}
| | `shutdownPolicy` _[ShutdownPolicy](#shutdownpolicy)_ | shutdownPolicy determines if the Sandbox resource itself should be deleted when it expires.
Underlying resources(Pods, Services) are always deleted on expiry. | Retain | Enum: [Delete Retain]
Optional: \{\}
| | `operatingMode` _[SandboxOperatingMode](#sandboxoperatingmode)_ | operatingMode specifies the desired operational state of the Sandbox.
Defaults to Running if not specified. | Running | Enum: [Running Suspended]
Optional: \{\}
| | `service` _boolean_ | service controls whether the controller should automatically create a
headless Service for this Sandbox.
When unset, the controller preserves existing Services for backward
compatibility but does not create new ones. Set to true to enable or false
to explicitly disable and remove the Service. | | Optional: \{\}
| #### SandboxStatus SandboxStatus defines the observed state of Sandbox. _Appears in:_ - [Sandbox](#sandbox) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `serviceFQDN` _string_ | serviceFQDN that is valid for default cluster settings
The domain defaults to cluster.local but is configurable via the controller's --cluster-domain flag. | | Optional: \{\}
| | `service` _string_ | service is a sandbox-example | | Optional: \{\}
| | `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#condition-v1-meta) array_ | conditions defines the status conditions array | | Optional: \{\}
| | `selector` _string_ | selector is the label selector for pods. | | Optional: \{\}
| | `podIPs` _string array_ | podIPs are the IP addresses of the underlying pod.
A pod may have multiple IPs in dual-stack clusters. | | Optional: \{\}
| #### ShutdownPolicy _Underlying type:_ _string_ ShutdownPolicy describes the policy for deleting the Sandbox when it expires. _Validation:_ - Enum: [Delete Retain] _Appears in:_ - [Lifecycle](#lifecycle) - [SandboxSpec](#sandboxspec) | Field | Description | | --- | --- | | `Delete` | ShutdownPolicyDelete deletes the Sandbox when expired.
| | `Retain` | ShutdownPolicyRetain keeps the Sandbox when expired (Status will show Expired).
| ## extensions.agents.x-k8s.io/v1beta1 Package v1beta1 contains API Schema definitions for the extensions v1beta1 API group Package v1beta1 contains API Schema definitions for the agents v1beta1 API group. ### Resource Types - [SandboxClaim](#sandboxclaim) - [SandboxTemplate](#sandboxtemplate) - [SandboxWarmPool](#sandboxwarmpool) #### EnvVar EnvVar represents a custom environment variable key-value pair. _Appears in:_ - [SandboxClaimSpec](#sandboxclaimspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `name` _string_ | name of the environment variable. | | Required: \{\}
| | `value` _string_ | value of the environment variable. | | Required: \{\}
| | `containerName` _string_ | containerName specifies the target container for the environment variable.
If not specified, it defaults to the first container defined in the template. | | Optional: \{\}
| #### EnvVarsInjectionPolicy _Underlying type:_ _string_ EnvVarsInjectionPolicy defines whether a SandboxClaim is allowed to inject or override environment variables. _Appears in:_ - [SandboxTemplateSpec](#sandboxtemplatespec) | Field | Description | | --- | --- | | `Allowed` | EnvVarsInjectionPolicyAllowed allows a SandboxClaim to inject new environment variables, but not override existing ones.
| | `Overrides` | EnvVarsInjectionPolicyOverrides allows a SandboxClaim to inject new and override existing environment variables.
| | `Disallowed` | EnvVarsInjectionPolicyDisallowed prevents a SandboxClaim from injecting any environment variables.
| #### Lifecycle Lifecycle defines the lifecycle management for the SandboxClaim. _Appears in:_ - [SandboxClaimSpec](#sandboxclaimspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `shutdownTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#time-v1-meta)_ | shutdownTime is the absolute time when the SandboxClaim expires.
This time governs the lifecycle of the claim. It is not propagated to the
underlying Sandbox. Instead, the SandboxClaim controller enforces this
expiration by deleting the Sandbox resources when the time is reached.
If this field is omitted or set to nil, the SandboxClaim itself won't expire.
This implies unsetting a Sandbox's ShutdownTime via SandboxClaim isn't supported. | | Format: date-time
Optional: \{\}
| | `ttlSecondsAfterFinished` _integer_ | ttlSecondsAfterFinished limits how long a finished claim is retained.
The timer starts from the mirrored Finished condition's LastTransitionTime. | | Minimum: 0
Optional: \{\}
| | `shutdownPolicy` _[ShutdownPolicy](#shutdownpolicy)_ | shutdownPolicy determines the behavior when the SandboxClaim expires. | Retain | Enum: [Delete DeleteForeground Retain]
Optional: \{\}
| #### NetworkPolicyManagement _Underlying type:_ _string_ NetworkPolicyManagement defines whether the controller automatically generates and manages a shared NetworkPolicy for this template. _Appears in:_ - [SandboxTemplateSpec](#sandboxtemplatespec) | Field | Description | | --- | --- | | `Managed` | NetworkPolicyManagementManaged means the controller will ensure a shared NetworkPolicy exists.
This shared NetworkPolicy will be a user provide one or a default controller created policy.
This is the default behavior if the field is omitted.
| | `Unmanaged` | NetworkPolicyManagementUnmanaged means the controller will skip NetworkPolicy
creation entirely, allowing external systems (like Cilium) to manage networking.
| #### NetworkPolicySpec NetworkPolicySpec defines the desired state of the NetworkPolicy. _Appears in:_ - [SandboxTemplateSpec](#sandboxtemplatespec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `ingress` _[NetworkPolicyIngressRule](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#networkpolicyingressrule-v1-networking) array_ | ingress is a list of ingress rules to be applied to the sandbox.
Traffic is allowed to the sandbox if it matches at least one rule.
If this list is empty, all ingress traffic is blocked (Default Deny). | | Optional: \{\}
| | `egress` _[NetworkPolicyEgressRule](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#networkpolicyegressrule-v1-networking) array_ | egress is a list of egress rules to be applied to the sandbox.
Traffic is allowed out of the sandbox if it matches at least one rule.
If this list is empty, all egress traffic is blocked (Default Deny). | | Optional: \{\}
| #### SandboxClaim SandboxClaim is the Schema for the sandbox Claim API. | Field | Description | Default | Validation | | --- | --- | --- | --- | | `apiVersion` _string_ | `extensions.agents.x-k8s.io/v1beta1` | | | | `kind` _string_ | `SandboxClaim` | | | | `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 | | Optional: \{\}
| | `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 | | Optional: \{\}
| | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| | `spec` _[SandboxClaimSpec](#sandboxclaimspec)_ | spec defines the desired state of Sandbox | | Required: \{\}
| | `status` _[SandboxClaimStatus](#sandboxclaimstatus)_ | status defines the observed state of Sandbox | | Optional: \{\}
| #### SandboxClaimSpec SandboxClaimSpec defines the desired state of Sandbox. _Appears in:_ - [SandboxClaim](#sandboxclaim) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `warmPoolRef` _[SandboxWarmPoolRef](#sandboxwarmpoolref)_ | warmPoolRef targets the specific pre-warmed infrastructure pool to check out from. | | Required: \{\}
| | `lifecycle` _[Lifecycle](#lifecycle)_ | lifecycle defines when and how the SandboxClaim should be shut down. | | Optional: \{\}
| | `additionalPodMetadata` _[PodMetadata](#podmetadata)_ | additionalPodMetadata defines the labels and annotations to be propagated to the Sandbox Pod.
Label values are limited to 63 characters and must match Kubernetes label value patterns. | | Optional: \{\}
| | `env` _[EnvVar](#envvar) array_ | env is a list of environment variables to inject into the sandbox.
Please note adding this field means the Sandbox will always be cold-started from the
template of the warmpool. | | Optional: \{\}
| #### SandboxClaimStatus SandboxClaimStatus defines the observed state of Sandbox. _Appears in:_ - [SandboxClaim](#sandboxclaim) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#condition-v1-meta) array_ | conditions represent the latest available observations of a Sandbox's current state. | | Optional: \{\}
| | `sandbox` _[SandboxStatus](#sandboxstatus)_ | sandbox defines the state of Sandbox | | Optional: \{\}
| #### SandboxStatus _Appears in:_ - [SandboxClaimStatus](#sandboxclaimstatus) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `name` _string_ | name is the name of the Sandbox created from this claim | | Optional: \{\}
| | `podIPs` _string array_ | podIPs are the IP addresses of the underlying pod.
A pod may have multiple IPs in dual-stack clusters. | | Optional: \{\}
| #### SandboxTemplate SandboxTemplate is the Schema for the sandbox template API. | Field | Description | Default | Validation | | --- | --- | --- | --- | | `apiVersion` _string_ | `extensions.agents.x-k8s.io/v1beta1` | | | | `kind` _string_ | `SandboxTemplate` | | | | `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 | | Optional: \{\}
| | `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 | | Optional: \{\}
| | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| | `spec` _[SandboxTemplateSpec](#sandboxtemplatespec)_ | spec defines the desired state of Sandbox | | Required: \{\}
| #### SandboxTemplateRef SandboxTemplateRef references a SandboxTemplate. _Appears in:_ - [SandboxWarmPoolSpec](#sandboxwarmpoolspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `name` _string_ | name of the SandboxTemplate | | Required: \{\}
| #### SandboxTemplateSpec SandboxTemplateSpec defines the desired state of Sandbox. _Appears in:_ - [SandboxTemplate](#sandboxtemplate) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `podTemplate` _[PodTemplate](#podtemplate)_ | podTemplate defines the object template that describes the pod spec that will be used to create
an agent sandbox.
If AutomountServiceAccountToken is not specified in the PodSpec, it defaults to false
to ensure a secure-by-default environment. | | Required: \{\}
| | `volumeClaimTemplates` _[PersistentVolumeClaimTemplate](#persistentvolumeclaimtemplate) array_ | volumeClaimTemplates is a list of claims that pods created from this template
are allowed to reference. When a SandboxClaim or SandboxWarmPool creates a sandbox
from this template, PVCs will be created from these templates.
Every claim in this list must have at least one matching access mode with a provisioner volume.
NOTE: This list is atomic. Updates to this field will replace the entire list rather than merging with existing entries. | | Optional: \{\}
| | `networkPolicy` _[NetworkPolicySpec](#networkpolicyspec)_ | networkPolicy defines the network policy to be applied to the sandboxes
created from this template. A single shared NetworkPolicy is created per Template.
Behavior is dictated by the NetworkPolicyManagement field:
- If Management is "Unmanaged": This field is completely ignored.
- If Management is "Managed" (default) and this field is omitted (nil): The controller
automatically applies a strict Secure Default policy:
* Ingress: Allow traffic only from the Sandbox Router.
* Egress: Allow Public Internet only. Blocks internal IPs (RFC1918), Metadata Server, etc.
- If Management is "Managed" and this field is provided: The controller applies your custom rules.
Update Behavior:
Because the NetworkPolicy is shared at the template level, any updates to these rules
will be applied to the single shared policy object. The underlying Kubernetes CNI will then
dynamically enforce the updated rules across all existing and future sandboxes
referencing this template.
NOTE: This is a restricted subset of the standard Kubernetes NetworkPolicySpec.
Fields like 'PodSelector' and 'PolicyTypes' are intentionally excluded because
they are managed by the controller to ensure strict isolation and default-deny posture.
WARNING: This policy enforces a strict "Default Deny" ingress posture.
If your Pod uses sidecars (e.g., Istio proxy, monitoring agents) that listen
on their own ports, the NetworkPolicy will BLOCK traffic to them by default.
You MUST explicitly allow traffic to these sidecar ports using 'Ingress',
otherwise the sidecars may fail health checks. | | Optional: \{\}
| | `networkPolicyManagement` _[NetworkPolicyManagement](#networkpolicymanagement)_ | networkPolicyManagement defines whether the controller manages the NetworkPolicy.
Valid values are "Managed" (default) or "Unmanaged". | Managed | Enum: [Managed Unmanaged]
Optional: \{\}
| | `envVarsInjectionPolicy` _[EnvVarsInjectionPolicy](#envvarsinjectionpolicy)_ | envVarsInjectionPolicy allows a SandboxClaim to inject or override environment variables defined in the template.
If set to Disallowed, the SandboxClaim will be rejected if it specifies any environment variables. | Disallowed | Enum: [Allowed Overrides Disallowed]
Optional: \{\}
| | `service` _boolean_ | service controls whether the controller should automatically create a
headless Service for Sandboxes created from this template.
When unset, the controller preserves existing Services for backward
compatibility but does not create new ones. Set to true to enable or false
to explicitly disable and remove the Service. | | Optional: \{\}
| #### SandboxWarmPool SandboxWarmPool is the Schema for the sandboxwarmpools API. | Field | Description | Default | Validation | | --- | --- | --- | --- | | `apiVersion` _string_ | `extensions.agents.x-k8s.io/v1beta1` | | | | `kind` _string_ | `SandboxWarmPool` | | | | `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 | | Optional: \{\}
| | `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 | | Optional: \{\}
| | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| | `spec` _[SandboxWarmPoolSpec](#sandboxwarmpoolspec)_ | spec defines the desired state of SandboxWarmPool | | Required: \{\}
| | `status` _[SandboxWarmPoolStatus](#sandboxwarmpoolstatus)_ | status defines the observed state of SandboxWarmPool | | Optional: \{\}
| #### SandboxWarmPoolRef SandboxWarmPoolRef references a SandboxWarmPool. _Appears in:_ - [SandboxClaimSpec](#sandboxclaimspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `name` _string_ | name of the SandboxWarmPool | | Required: \{\}
| #### SandboxWarmPoolSpec SandboxWarmPoolSpec defines the desired state of SandboxWarmPool. _Appears in:_ - [SandboxWarmPool](#sandboxwarmpool) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `replicas` _integer_ | replicas is the desired number of sandboxes in the pool.
This field is controlled by an HPA if specified. | | Minimum: 0
Required: \{\}
| | `sandboxTemplateRef` _[SandboxTemplateRef](#sandboxtemplateref)_ | sandboxTemplateRef - name of the SandboxTemplate to be used for creating a Sandbox
Warning: Any change to the json tag "sandboxTemplateRef" must be synchronized with the TemplateRefField constant. | | Required: \{\}
| | `updateStrategy` _[SandboxWarmPoolUpdateStrategy](#sandboxwarmpoolupdatestrategy)_ | updateStrategy - strategy for updating the SandboxWarmPool pods based on sandboxTemplateRef name change or underlying template changes | | Optional: \{\}
| #### SandboxWarmPoolStatus SandboxWarmPoolStatus defines the observed state of SandboxWarmPool. _Appears in:_ - [SandboxWarmPool](#sandboxwarmpool) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `replicas` _integer_ | replicas is the total number of sandboxes in the pool. | | Optional: \{\}
| | `readyReplicas` _integer_ | readyReplicas is the total number of sandboxes in the pool that are in a ready state. | | Optional: \{\}
| | `selector` _string_ | selector is the label selector used to find the pods in the pool. | | Optional: \{\}
| #### SandboxWarmPoolUpdateStrategy SandboxWarmPoolUpdateStrategy defines the update strategy for the SandboxWarmPool. _Appears in:_ - [SandboxWarmPoolSpec](#sandboxwarmpoolspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `type` _[SandboxWarmPoolUpdateStrategyType](#sandboxwarmpoolupdatestrategytype)_ | type indicates the type of the SandboxWarmPoolUpdateStrategy.
Default is OnReplenish. | OnReplenish | Enum: [Recreate OnReplenish]
Optional: \{\}
| #### SandboxWarmPoolUpdateStrategyType _Underlying type:_ _string_ SandboxWarmPoolUpdateStrategyType is a string enumeration type that enumerates all possible update strategies for the SandboxWarmPool controller. _Validation:_ - Enum: [Recreate OnReplenish] _Appears in:_ - [SandboxWarmPoolUpdateStrategy](#sandboxwarmpoolupdatestrategy) | Field | Description | | --- | --- | | `Recreate` | RecreateSandboxWarmPoolUpdateStrategyType indicates that stale pods are deleted immediately to ensure the pool only contains fresh pods.
Note: This applies to PodTemplate spec changes only. Changes to annotations or labels in the template do not trigger recreate.
| | `OnReplenish` | OnReplenishSandboxWarmPoolUpdateStrategyType indicates that stale pods are only replaced when they are manually deleted or when these stale pods are adopted by sandboxclaims and hence replaced by fresh pods.
| #### ShutdownPolicy _Underlying type:_ _string_ ShutdownPolicy describes the policy for shutting down the underlying Sandbox when the SandboxClaim expires. _Validation:_ - Enum: [Delete DeleteForeground Retain] _Appears in:_ - [Lifecycle](#lifecycle) | Field | Description | | --- | --- | | `Delete` | ShutdownPolicyDelete deletes the SandboxClaim (and cascadingly the Sandbox) when expired.
| | `DeleteForeground` | ShutdownPolicyDeleteForeground deletes the SandboxClaim when expired using foreground
cascade deletion. The claim remains in the API (with a deletionTimestamp) until its
underlying Sandbox and Pod are fully terminated. This allows external systems to observe
shutdown progress by checking whether the claim still exists.
| | `Retain` | ShutdownPolicyRetain keeps the SandboxClaim when expired (Status will show Expired).
The underlying SandboxClaim resources (Sandbox, Pod, Service) are deleted to save resources,
but the SandboxClaim object itself remains.
|