在 KubeVirt 上克隆虚拟机

本文档提供使用 KubeVirt 的 VirtualMachineClone API 克隆虚拟机(VM)的分步指导。

确保先决条件

在开始 VM 克隆操作之前,请确保满足以下要求:

  • 支持快照的存储:Clone API 依赖 Snapshot & Restore 功能。虚拟机的存储类必须支持 volume snapshots,并且必须为该存储后端显式启用快照功能。

快速开始

按照以下快速步骤克隆 VM:

  1. 准备 Clone 清单:

    创建一个名为 clone.yaml 的文件,内容如下:

    apiVersion: clone.kubevirt.io/v1beta1
    kind: VirtualMachineClone
    metadata:
      name: example-vm-clone
      namespace: ns-where-vm-run
    spec:
      source:
        apiGroup: kubevirt.io
        kind: VirtualMachine
        name: source-vm
      target:
        apiGroup: kubevirt.io
        kind: VirtualMachine
        name: target-vm
  2. 执行 Clone 操作:

    应用该清单:

    kubectl create -f clone.yaml
  3. 监控 Clone 状态:

    等待克隆成功完成:

    kubectl wait vmclone example-vm-clone --for=jsonpath='{.status.phase}'=Succeeded --timeout=300s
  4. 验证克隆后的 VM:

    检查克隆后的 VM 配置:

    kubectl get vm target-vm -o yaml
  5. 修复 DataVolume 标签(UI 元数据):

    平台 UI 通过标签 vm.cpaas.io/used-by=<vm-name> 将 VM 与其磁盘关联,该标签会自动添加到每个 DataVolume。 在执行克隆操作后,新的 DataVolume 会继承 source VM 的标签,因此 UI 仍会认为它属于旧 VM。 请更新新创建的 DV 上的标签,使关联关系能够正确显示(不影响功能)。

    # List DataVolumes in the VM's namespace; the cloned DV name usually starts with "restore-"
    kubectl get datavolumes -n <ns-where-vm-run>
    
    # Overwrite the label to point to the cloned VM
    kubectl label datavolume <new-dv-name> -n <ns-where-vm-run> vm.cpaas.io/used-by=<target-vm> --overwrite

理解 VirtualMachineClone 对象

查看完整的 VirtualMachineClone 示例

下面是一个完整的 VirtualMachineClone 资源示例,并包含详细的行内注释:

apiVersion: clone.kubevirt.io/v1beta1
kind: VirtualMachineClone
metadata:
  name: detailed-vm-clone
  namespace: ns-where-vm-run
spec:
  # Source VM details
  source:
    apiGroup: kubevirt.io
    kind: VirtualMachine
    name: vm-source

  # Target VM details
  target:
    apiGroup: kubevirt.io
    kind: VirtualMachine
    name: vm-target

  # Filters for labels and annotations copied from source
  labelFilters:
    - "*"
    - "!exclude-key/*"
  annotationFilters:
    - "include-annotations/*"

  # Template filters to manage network annotations.
  # annotationFilters is a WHITELIST: list "*" first to keep all annotations,
  # then negate the ones to drop. On Kube-OVN, drop the per-VM OVN annotations
  # (fixed IP / pod-bridge live-migration) so the clone gets a fresh identity:
  template:
    labelFilters:
      - "*"
    annotationFilters:
      - "*"
      - "!ovn.kubernetes.io/*"

  # Explicitly set new MAC addresses
  newMacAddresses:
    eth0: "02-00-00-aa-bb-cc"

  # Explicitly set SMBios serial
  newSMBiosSerial: "unique-serial-1234"

  # JSON patches to further customize the cloned VM
  patches:
    - '{"op": "add", "path": "/metadata/labels/new-label", "value": "new-value"}'
    - '{"op": "replace", "path": "/spec/template/metadata/annotations/new-annotation", "value": "updated-value"}'

理解各字段

  • Source 和 Target:

    • 定义原始 VM(source)和克隆后的 VM(target)。
    • 如果省略 target 名称,则会自动生成。
    • 两个 VM 必须位于同一命名空间中。
  • Label 和 Annotation 过滤器:

    • 使用通配符(*)和否定(!)控制从 source VM 复制或排除的 label/annotation。
  • Template Label 和 Annotation 过滤器:

    • 适用于管理与网络相关的 annotation,尤其是使用 Kube-OVN 等 CNI 时。
  • newMacAddresses:

    • 可选地为网络接口指定新的 MAC 地址。
    • 如果省略,则会自动重新生成。
  • newSMBiosSerial:

    • 可选地指定新的 SMBios serial。
    • 如果未提供,则会基于 VM 名称自动生成。
  • JSON Patches:

    • 直接应用于 VM spec 的高级自定义。

检查 Clone 操作阶段

VirtualMachineClone 对象的 .status.phase 会根据克隆过程的进度而变化。下表说明了各个阶段:

阶段说明
SnapshotInProgress正在为 source VM 创建快照,这是克隆运行中 VM 时的初始步骤。
CreatingTargetVM快照已完成;正在为 target VM 创建元数据和规格。
RestoreInProgress正在创建 DataVolume 和 PersistentVolumeClaim,并从快照恢复数据。
Succeeded操作成功完成。target VM 和存储已就绪。
Failed操作失败。请检查 events 和 status.conditions 以获取详细错误信息。
Unknown无法确定克隆操作状态,可能表示控制器存在问题。