Volcengine Kubernetes Engine
Volcengine Kubernetes Engine
Volcengine Kubernetes Engine
Document
Volcengine Kubernetes Engine
What's New
History feature release notes
Kubernetes version release notes
Containerd runtime release notes
Add-on release notes
Monitoring add-ons
Scheduling add-ons
DNS add-ons
Security add-ons
GPU add-ons
Sandbox add-on
Security announcements
Product Announcement
Historical announcements
Overview
Getting started
User guide
Clusters
Creating clusters
Connecting to clusters
Upgrading clusters
Node pool
Creating node pools
Scaling out/in node pools
Nodes
Authorization management
Image
Namespaces
Networking
Cluster network
Container Network
Service
LoadBalancer
CLB
Ingress
APIG Ingress
ALB Ingress
Customize ALB Ingress forwarding rules
Certificate and security
CLB Ingress
Nginx Ingress
Gateway API
Workloads
Creating workloads
Configure workloads
Pods
Configuration management
Image acceleration
Storage
FSX client
EBS Volumes
TOS Volumes
NAS volumes
FSX access methods
NFS access methods
EFS volumes
vePFS volumes
FSX access methods
vePFS Client access methods
NFS access methods
CloudFS volumes
Local volumes
Autoscale
Node autoscaler
Workload autoscaler
Horizontal Pod Autoscaler (HPA)
Cron Horizontal Pod Autoscaler (CronHPA)
Intelligent Horizontal Pod Autoscaler (IHPA)
Horizontal Pod Autoscaler based on event-driven (KEDA)
Add-on management
Network add-ons
Storage add-ons
Monitoring add-ons
Scheduling add-ons
DNS add-ons
GPU add-ons
Core add-ons
Sandbox add-on
Upgrading add-ons
Heterogeneous computing
NVIDIA GPU
mGPU scheduling
RDMA high-performance computing
Scheduling management
Topology-aware scheduling
QoS-aware scheduling
Observability
Log management
Basic observation
Setup & Configuration
Cluster observation
Storage observation
Other observation
Using metrics
Full stack observation
Alert management
Diagnosis and inspection
Node check and self-healing
Application center
Backup center
Stability
Large-scale cluster management
Best practices
Authorization
Clusters
Nodes and node pools
Networking
Storage
Scheduling
Observability
Solution
Security and compliance
API reference
Cluster management
NodePool management
Node management
Virtual nodes management
Add-on management
Tag management
Access policy management
Instance images management
Cloud native observability
Inspection and diagnosis
Task management
Volcengine Container Instance
Appendix
SDK reference
Development guide
Terraform
FAQs
General FAQs
Cluster FAQ
cluster management
cluster network
cluster upgrade
Node and Node pool FAQs
Authorization FAQs
Workload FAQs
Service and Ingress FAQs
Storage FAQs
Heterogeneous computing FAQs
Observability FAQs
Quota FAQs
Add-on FAQs
Cloud-native AI
ServingKit
LLM applications
ComfyUI application
Deploying the Al inference application through Helm
Deepseek practices
Qwen practices
Kimi practice
Seed practices
Best practices
DeepSeek model deployment
GLM model deployment
MiniMax model deployment
Qwen model deployment
Kimi model deployment
Volcengine Container Instance
What's new
Historical feature release notes
Product Announcement
Overview
Billing
User guide
Integrating with VCI
Virtual node
VKE cluster uses virtual nodes
Self-managed/third-party cluster uses virtual node
Creating an instance
General purpose instance
GPU-accelerated computing instance
VCI Agent Sandbox
Startup acceleration
E2B-based management
Upgrade guide
Networking
Monitoring
Scheduling
Container configuration
VCI Image Cache
Best practices
Security and compliance
FAQs
- Documentation
Volcengine Kubernetes EngineVolcengine Container InstanceUser guideVCI Agent SandboxData persistence
Copy page
Download PDFVCI Agent Sandbox
Data persistence
Copy pageDownload PDFData persistence
This topic mainly describes how to achieve sandbox data persistence in VCI Agent Sandbox.
System volume
For system volume snapshots, SandboxSnapShot (Namespaced) and SandboxSnapShotClass (Cluster-scoped) are introduced to abstract the snapshot capability of sandboxes in a unified manner.
- SandboxSnapShot: Creates a snapshot for a specific sandbox and records the snapshot status, ID, retention duration, and other information.
- SandboxSnapShotClass: Describes the underlying snapshot generation parameters and the default deletion policy.
tip
The time required to create a system volume snapshot is related to the size of temporary data generated in the system volume. Therefore, you need to avoid restoring sandboxes before the system volume snapshot is created.
SandboxSnapShot
At the namespace level, it creates a snapshot for a specific sandbox and records the snapshot status, ID, retention duration, and other information.
apiVersion: extensions.agents.x-k8s.io/v1alpha1
kind: SandboxSnapShot
metadata:
name: demo-sandbox-snap-001
namespace: default
spec:
sandboxRef: # Specify the Sandbox Reference used for creating the snapshot.
apiVersion: agents.x-k8s.io/v1alpha1
kind: Sandbox
name: demo-sandbox
namespace: default
snapshotClassName: vci-provider-class # The type of snapshot storage service used. It is optional.
deletionPolicy: Delete # The snapshot deletion policy. Valid values: Delete and Retain. If you set the value to Delete, underlying snapshots are also deleted after SandboxSnapShot is deleted. If you set the value to Retain, underlying snapshots are retained after SandboxSnapShot is deleted.
retentionDays: 15 # The snapshot retention duration. Default value: 15 days.
status:
phase: Completed # The snapshot status. Valid values: Pending (The snapshot creation task has not been submitted), InProgress (The snapshot is being created), Completed (The snapshot is created), and Failed (The snapshot fails to be created).
snapshotID: vci-snap-123456 # The snapshot ID.
sizeBytes: 40GB # The snapshot size.
creationTime: "2025-12-04 12:00:00" # The snapshot creation time.
expirationTime: "2025-12-19 12:00:00" # The snapshot expiration time.
conditions: # This field records the snapshot status, which indicates whether the current snapshot is Ready, and records snapshot error information.
- type: Ready
status: "True"
lastTransitionTime: "2025-12-04T12:00:10Z"
reason: SnapshotCreated
message: "Snapshot successfully created by VCI provider"
- type: Error
status: "False"
SandboxSnapShotClass
It describes parameters related to snapshot creation and the snapshot deletion policy.
apiVersion: extensions.agents.x-k8s.io/v1alpha1
kind: SandboxSnapShotClass
metadata:
name: vci-snapshot-class
spec:
driver: sandbox.agent.io/vci # The snapshot back-end provider. Currently only "vci" is supported.
deletionPolicy: Delete # The snapshot deletion policy. Valid values: Delete and Retain. If you set the value to Delete, underlying snapshots are also deleted after SandboxSnapShot is deleted. If you set the value to Retain, underlying snapshots are retained after SandboxSnapShot is deleted.
retentionDays: 20
Data volume
Data volumes can be mounted on NAS. This allows users to share data across multiple sandboxes.
Data generated during the sandbox lifecycle can be stored in persistent storage (PV and PVC). After a Pod is deleted and recreated, the data from the PVC can still be mounted into the container. The Sandbox CRD defines a volumeClaimTemplates template, which allows users to specify the accessmode, storage size, and storageClassName of the Volume. This is similar to the way the StatefulSet CRD is used.
The data retention policy for data volumes is determined by the retention policy of the Volume:
- Retain: After the PVC is released, the PV remains Released and is not automatically deleted or reclaimed.
- Delete: After the PVC is released, the PV and its underlying storage resources are automatically deleted.
- Recycle: After the PVC is released, the PV is reclaimed into the unbound PV pool and can be reused by other PVCs.
apiVersion: agents.x-k8s.io/v1alpha1
kind: Sandbox
metadata:
name: demo-sandbox
spec:
replicas: 1
volumeClaimTemplates:
- metadata:
name: nginx-data
spec:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 5Gi
storageClassName: sandbox-nfs
podTemplate:
spec:
tolerations:
- key: "vci.vke.volcengine.com/node-type"
operator: "Exists"
effect: "NoSchedule"
containers:
- name: ubuntu-sshd
image: vke-qa-cn-beijing.cr.volces.com/qa/ubuntu-sshd:12.04
command: ["/usr/sbin/sshd", "-D"]
ports:
- containerPort: 22
volumeMounts:
- name: nginx-data
mountPath: /usr/share/nginx/html
Last updated: 2026.07.24 16:18:07
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
