使用Checkpoint功能克隆Agent Sandbox

创建原始沙箱

以下示例通过 SandboxSet 模板演示恢复效果。

1. 部署 SandboxSet，将以下内容保存为YAML文件，然后执行kubectl apply -f <YAML_FILE>命令。

   code-interpreter-fs.yaml

   apiVersion: agents.kruise.io/v1alpha1
   kind: SandboxSet
   metadata:
     name: code-interpreter-fs
     namespace: default
   spec:
     # 预热池的大小，建议比预估的请求突发量略大
     replicas: 2
     persistentContents: # 仅保留文件系统
       - filesystem
     template:
       metadata:
         labels:
           # 可选，用于在 ACK 集群中将沙箱 Pod 调度到 ACS
           alibabacloud.com/acs: "true"
           alibabacloud.com/compute-class: agent-sandbox # Agent Sandbox 实例类型
       spec:
         initContainers:
           # 以 Sidecar 形式声明 agent-runtime，自动给沙箱容器注入 envd 等运行时组件
           - name: runtime
             image: registry-cn-zhangjiakou-vpc.ack.aliyuncs.com/acs/agent-runtime:v0.0.5 # 请将 cn-zhangjiakou 替换为实际地域ID 
             command: [ "sh", "/workspace/entrypoint_inner.sh" ]
             volumeMounts:
               # 与主容器的共享目录
               - name: envd-volume
                 mountPath: /mnt/envd
             env:
               - name: ENVD_DIR
                 value: /mnt/envd
               # 这个环境变量使得 Sidecar 共享主容器的资源，不产生额外费用
               - name: __IGNORE_RESOURCE__
                 value: "true"
             restartPolicy: Always
         containers:
         - name: sandbox
           # E2B code-interpreter 镜像，支持全地域、vpc 拉取
           image: registry-cn-zhangjiakou-vpc.ack.aliyuncs.com/acs/code-interpreter:v1.6 # 请将 cn-zhangjiakou 替换为实际地域ID
           imagePullPolicy: IfNotPresent
           # 推荐设置资源需求，否则在 ACS 环境下会被设置成超小规格影响运行
           resources:
             limits:
               cpu: 1
               memory: 1Gi
             requests:
               cpu: 1
               memory: 1Gi
           startupProbe:
             failureThreshold: 10
             httpGet:
               path: /health
               port: 49999
             initialDelaySeconds: 1
             periodSeconds: 2
             timeoutSeconds: 1
           env:
             # 指定 runtime 注入的 envd 组件位置
             - name: ENVD_DIR
               value: /mnt/envd
           volumeMounts:
             # 与 runtime 的共享目录
             - name: envd-volume
               mountPath: /mnt/envd
           lifecycle:
             postStart:
               exec:
                 command: [ "/bin/bash", "-c", "/mnt/envd/envd-run.sh" ]
         # 保证容器快速销毁，提高复用的概率
         terminationGracePeriodSeconds: 1
         volumes:
           - name: envd-volume
             emptyDir: { }

2. 通过 E2B SDK创建沙箱，详细操作请参考创建Agent Sandbox。

   # Import the E2B SDK
   from e2b_code_interpreter import Sandbox
   
   # 创建仅保留文件系统的沙箱
   sbx_with_fs = Sandbox.create("code-interpreter-fs")
   print(f"fs-sandbox id: {sbx_with_fs.sandbox_id}")

3. 初始化状态：在沙箱中写入文件系统数据。

   def init_mem_fs(sbx):
     sbx.files.write("/my-file", "hello") # 写入文件
     
     # 验证数据写入成功
     print(sbx.files.read("/my-file"))
   
   init_mem_fs(sbx_with_fs)

创建 Checkpoint

将以下<YOUR_SANDBOX_ID>替换成实际沙箱ID，为沙箱创建当前状态的快照。

sbx_with_fs = Sandbox.connect("<YOUR_SANDBOX_ID>")

snapshot_with_fs = sbx_with_fs.create_snapshot(headers={
  "x-e2b-kruise-snapshot-keep-running": "true",                 # Checkpoint 创建后 Sandbox 是否继续运行。如果是 false，对应 Pod 状态将会变为 Succeeded。默认为 true
  "x-e2b-kruise-snapshot-ttl": "30m",                           # 创建的 Checkpoint 存在时间，超期后自动删除。默认不配置，除非手动删除，永久存在
  "x-e2b-kruise-snapshot-persistent-contents": "filesystem",    # Checkpoint 的保留内容，默认继承 Sandbox 的保留内容。目前仅支持 filesystem
  "x-e2b-kruise-snapshot-wait-success-seconds": "60",           # 创建 Checkpoint 时，服务端等待其完成的超时时间。默认为 60
})

print(f"Snapshot ID with file system: {snapshot_with_fs.snapshot_id}")

# Checkpoint 创建完成后，可安全删除原始沙箱
sbx_with_fs.kill()

从 Checkpoint 克隆沙箱

1. 将<YOUR_SNAPSHOT_ID>替换为上一步返回的Snapshot ID，作为 template 参数传入 create 接口进行克隆。标准的timeout、auto_pause及CSI挂载等扩展参数在克隆接口中依然有效。

   # 使用快照 ID 作为模板创建新沙箱
   clone_with_fs = Sandbox.create("<YOUR_SNAPSHOT_ID>")  # E2B 客户端会默认配置 300秒的超时清理时间，可按需配置此超时时长

2. 检查克隆后的沙箱数据，验证恢复效果。

   # 验证开启文件系统保留的克隆沙箱
   print(clone_with_fs.files.read("/my-file"))

   预期输出：克隆沙箱均能正确恢复文件系统中的 /my-file。

   hello

创建沙箱

将以下内容保存为sandbox.yaml文件，然后执行kubectl apply -f sandbox.yaml命令。

apiVersion: agents.kruise.io/v1alpha1
kind: Sandbox
metadata:
  name: code-demo
spec:
  template: 
    metadata:
      labels:
        agent: code-demo
        # 使用ACS算力
        alibabacloud.com/acs: "true"
        alibabacloud.com/compute-class: agent-sandbox # Agent Sandbox 实例类型
    spec:
      automountServiceAccountToken: false
      initContainers:
        # 以 Sidecar 形式声明 agent-runtime，自动给沙箱容器注入 envd 等运行时组件
        - name: runtime
          image: registry-cn-zhangjiakou-vpc.ack.aliyuncs.com/acs/agent-runtime:v0.0.5 # 请将 cn-zhangjiakou 替换为实际地域ID
          command: [ "sh", "/workspace/entrypoint_inner.sh" ]
          volumeMounts:
            # 与主容器的共享目录
            - name: envd-volume
              mountPath: /mnt/envd
          env:
            - name: ENVD_DIR
              value: /mnt/envd
            # 这个环境变量使得 Sidecar 共享主容器的资源，不产生额外费用
            - name: __IGNORE_RESOURCE__
              value: "true"
          restartPolicy: Always
      containers:
      - name: my-session
        image: registry-ap-southeast-1.ack.aliyuncs.com/acs/code-interpreter:v1.6
        env:
        - name: GODEBUG
          value: multipathtcp=0
        # 指定 runtime 注入的 envd 组件位置
        - name: ENVD_DIR
          value: /mnt/envd
        resources:
          requests:
            cpu: 1
            memory: 1Gi
            ephemeral-storage: "30Gi" #声明临时存储空间为30 GiB
        ports:
        - containerPort: 49999
          name: interpreter
        volumeMounts:
        # 与 runtime 的共享目录
        - name: envd-volume
          mountPath: /mnt/envd
        lifecycle:
          postStart:
            exec:
              command: [ "/bin/bash", "-c", "/mnt/envd/envd-run.sh" ]
      terminationGracePeriodSeconds: 1
      volumes:
        - name: envd-volume
          emptyDir: { }