用户指南

最佳实践

API 文档

文档中心 > 容器服务 > 最佳实践 > 集群迁移 > 使用 Velero 跨云平台迁移集群资源到 TKE

使用 Velero 跨云平台迁移集群资源到 TKE

最近更新时间:2022-04-15 16:08:18

操作场景

开源工具 Velero(旧版本名称为 Heptio Ark)可以安全地备份和还原、执行灾难恢复以及迁移 Kubernetes 集群资源和持久卷。容器服务 TKE 支持使用 Velero 备份、还原和迁移集群资源,详情请参见 使用对象存储 COS 作为 Velero 存储实现集群资源备份和还原在 TKE 中使用 Velero 迁移复制集群资源。本文将介绍如何使用 Velero 将自建或其他云平台 Kubernetes 集群无缝迁移到容器服务 TKE 平台。

迁移原理

使用 Velero 迁移自建或其他云平台集群架构的原理与 使用 Velero 迁移复制集群资源 过程的原理类似,迁移集群和被迁移集群需要都安装 Velero 实例,且指定同一个腾讯云 对象存储 COS 存储桶,被迁移集群按需执行备份,目标集群按需还原集群资源实现资源迁移。
不同的是,自建或其他云平台的集群资源迁移到 TKE 时,需要考虑和解决因跨平台导致集群环境差异问题,为此需要通过 Velero 提供的众多实用备份和还原策略帮助解决问题。

前提条件

  • 已有自建或其他云平台 Kubernetes 集群(以下称作集群 A ),且集群版本需1.10以上。
  • 已创建迁移目标的容器服务 TKE 集群(以下称作集群 B ),创建 TKE 集群请参见 创建集群
  • 集群 A 和 集群 B 都需要安装 Velero 实例(1.5版本以上),并且共用同一个腾讯云 COS 存储桶作为 Velero 后端存储,安装步骤请参见 配置存储和安装 Velero
  • 确保镜像资源在迁移后可以正常拉取。
  • 确保两个集群的 Kubernetes 版本的 API 兼容,建议使用相同版本。

迁移指导

在进行迁移工作前,建议先理清迁移思路,制定详细的迁移计划,迁移过程中需要考虑以下几点:

分析筛选哪些集群资源需要进行迁移

展开&收起

根据实际情况筛选分类出需要迁移资源清单和不需要迁移的资源清单。

根据业务场景考虑是否需要自定义 Hook 操作

展开&收起
  • 在备份集群资源时,考虑是否需要在备份期间执行 备份 Hooks。例如,需要将正在运行的应用的内存数据落盘场景。
  • 在还原(迁移)集群资源时,考虑是否需要在还原期间执行 还原 Hooks。例如,需要在还原前准备一些初始化工作。
  • 按需编写备份和还原的命令或资源清单

    展开&收起

    根据筛选归类的资源清单编写备份和还原策略,推荐在复杂场景下使用创建资源清单的方式来执行备份和还原,YAML 资源清单比较直观且方便维护,参数指定的方式可以在简单迁移场景或测试时使用。

    处理跨云平台资源的差异性

    展开&收起

    由于是跨云平台迁移,动态创建 PVC 的存储类等关系可能不同,需要提前规划动态 PVC/PV 存储类关系是否需要重新映射。需在还原操作前,创建相关映射的 ConfigMap 配置。如需解决更加个性化的差异,可以手动修改备份后的资源清单。

    操作完成后核查迁移资源

    展开&收起

    检查迁移的集群资源是否符合预期且数据完整可用。

    操作步骤

    以下将介绍某云平台集群 A 中的资源迁移到 TKE 集群 B 中的详细操作步骤,其中涉及到 Velero 备份和还原基础知识,您可以查看本文 Velero 备份/还原实用知识 章节深入了解。

    创建集群 A 示例资源

    在某云平台集群 A 中部署 Velero 实例中含有 PVC 的 Nginx 工作负载,为方便起见可直接使用动态存储类来创建 PVC 和 PV。

    1. 执行以下命令,查看当前集群支持的动态存储类信息。示例如下:
      # 获取当前集群支持的存储类信息,其中 xxx-StorageClass 为存储类代名,xxx-Provider 为提供商代名,下同。  
      $ kubectl  get sc
      NAME                PROVISIONER    RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE
      xxx-StorageClass    xxx-Provider   Delete          Immediate              true                   3d3h
      ...
    2. 修改 with-pv.yaml 文件中的 PVC 资源清单,使用集群中存储类名为 “xxx-StorageClass” 的存储类来动态创建。示例如下:
      ...
      ---
      kind: PersistentVolumeClaim
      apiVersion: v1
      metadata:
      name: nginx-logs
      namespace: nginx-example
      labels:
      app: nginx
      spec:
      # Optional: 修改 PVC 的存储类的值为某云平台
      storageClassName: xxx-StorageClass
      accessModes:
      - ReadWriteOnce
      resources:
      requests:
      storage: 20Gi # 由于该云平台限制存储最小为20Gi,本示例需要同步修改此值为20Gi
      ...
    3. 执行以下命令,应用示例中的 with-pv.yaml,创建如下的集群资源(nginx-example 命名空间)。示例如下:
      $ kubectl apply -f with-pv.yaml 
      namespace/nginx-example created
      persistentvolumeclaim/nginx-logs created
      deployment.apps/nginx-deployment created
      service/my-nginx created
    4. 创建的 PVC “nginx-logs” 已挂载至 Nginx 容器的 /var/log/nginx 目录,作为服务的日志存储。本文示例通过在浏览器测试访问 Nginx 服务,为挂载的 PVC 生产日志数据,以便后续还原后进行数据比对。示例如下:
      $ kubectl exec -it nginx-deployment-5ccc99bffb-6nm5w bash -n nginx-example
      kubectl exec [POD] [COMMAND] is DEPRECATED and will be removed in a future version. Use kubectl kubectl exec [POD] -- [COMMAND]
      Defaulting container name to nginx.
      Use 'kubectl describe pod/nginx-deployment-5ccc99bffb-6nm5w -n nginx-example' to see all of the containers in this pod

      $ du -sh /var/log/nginx/
      84K /var/log/nginx/

      # 查看 accss.log 和 error.log 前两条日志
      $ head -n 2 /var/log/nginx/access.log
      192.168.0.73 - - [29/Dec/2020:03:02:31 +0000] "GET /?spm=5176.2020520152.0.0.22d016ddHXZumX HTTP/1.1" 200 612 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36" "-"
      192.168.0.73 - - [29/Dec/2020:03:02:32 +0000] "GET /favicon.ico HTTP/1.1" 404 555 "http://47.242.233.22/?spm=5176.2020520152.0.0.22d016ddHXZumX" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36" "-"

      $ head -n 2 /var/log/nginx/error.log
      2020/12/29 03:02:32 [error] 6#6: *597 open() "/usr/share/nginx/html/favicon.ico" failed (2: No such file or directory), client: 192.168.0.73, server: localhost, request: "GET /favicon.ico HTTP/1.1", host: "47.242.233.22", referrer: "http://47.242.233.22/?spm=5176.2020520152.0.0.22d016ddHXZumX"
      2020/12/29 03:07:21 [error] 6#6: *1172 open() "/usr/share/nginx/html/0bef" failed (2: No such file or directory), client: 192.168.0.73, server: localhost, request: "GET /0bef HTTP/1.0"

    确认需要迁移的资源清单

    1. 执行以下命令,输出集群 A 中所有的资源清单列表。
      kubectl api-resources --verbs=list -o name  | xargs -n 1 kubectl get --show-kind --ignore-not-found --all-namespaces
      您也可以执行以下命令,根据资源区分命名空间,缩小输出的资源范围:
      • 查看不区分命名空间的资源清单列表:
        kubectl api-resources --namespaced=false --verbs=list -o name | xargs -n 1 kubectl get --show-kind --ignore-not-found
      • 查看区分命名空间的资源清单列表:
        kubectl api-resources --namespaced=true --verbs=list -o name | xargs -n 1 kubectl get --show-kind --ignore-not-found --all-namespaces
    2. 可以根据实际情况筛选出需要被迁移的资源清单。本文示例将直接从该云平台迁移 “nginx-example” 命名空间下 Nginx 工作负载相关的资源到容器服务 TKE,涉及资源如下所示:
      $ kubectl  get all -n nginx-example
      NAME READY STATUS RESTARTS AGE
      pod/nginx-deployment-5ccc99bffb-tn2sh 2/2 Running 0 2d19h

      NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
      service/my-nginx LoadBalancer 172.21.1.185 x.x.x.x 80:31455/TCP 2d19h

      NAME READY UP-TO-DATE AVAILABLE AGE
      deployment.apps/nginx-deployment 1/1 1 1 2d19h

      NAME DESIRED CURRENT READY AGE
      replicaset.apps/nginx-deployment-5ccc99bffb 1 1 1 2d19h

      $ kubectl get pvc -n nginx-example
      NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE
      nginx-logs Bound d-j6ccrq4k1moziu1l6l5r 20Gi RWO xxx-StorageClass 2d19h

      $ kubectl get pv
      NAME CAPACITY ACCESS MODES RECLAIM POLICY STATUS CLAIM STORAGECLASS REASON AGE
      d-j6ccrq4k1moziu1l6l5r 20Gi RWO Delete Bound nginx-example/nginx-logs xxx-StorageClass 2d19h

    确认 Hook 策略

    本文示例在 with-pv.yaml 中已配置“备份 Nginx 工作负载前将文件系统设置为只读,在备份后恢复读写”的 Hook 策略,YAML 文件如下所示:

    ...
    annotations:
    # 备份 Hook 策略的注解表示:在开始备份之前将 nginx 日志目录设置为只读模式,备份完成后恢复读写模式
    pre.hook.backup.velero.io/container: fsfreeze
    pre.hook.backup.velero.io/command: '["/sbin/fsfreeze", "--freeze", "/var/log/nginx"]'
    post.hook.backup.velero.io/container: fsfreeze
    post.hook.backup.velero.io/command: '["/sbin/fsfreeze", "--unfreeze", "/var/log/nginx"]'
    spec:
    volumes:
    - name: nginx-logs
    persistentVolumeClaim:
    claimName: nginx-logs
    containers:
    - image: nginx:1.17.6
    name: nginx
    ports:
    - containerPort: 80
    volumeMounts:
    - mountPath: "/var/log/nginx"
    name: nginx-logs
    readOnly: false
    - image: ubuntu:bionic
    name: fsfreeze
    securityContext:
    privileged: true
    volumeMounts:
    - mountPath: "/var/log/nginx"
    name: nginx-logs
    ...

    开始迁移操作

    以下将根据实际情况编写备份和还原策略,开始迁移该云平台的 Nginx 工作负载相关资源。

    在集群 A 执行备份

    1. 创建如下 YAML 文件,备份需要迁移的资源。
      apiVersion: velero.io/v1
      kind: Backup
      metadata:
      name: migrate-backup
      # 必须得是 velero 安装的命名空间
      namespace: velero
      spec:
      # 仅包含 nginx-example 命名空间的资源
      includedNamespaces:
      - nginx-example
      # 包含不区分命名空间的资源
      includeClusterResources: true
      # 备份数据存储位置指定
      storageLocation: default
      # 卷快照存储位置指定
      volumeSnapshotLocations:
      - default
      # 使用 restic 备份卷
      defaultVolumesToRestic: true
    2. 执行备份过程如下所示,当备份状态为 “Completed” 且 errors 数为0时表示备份过程完整无误。示例如下:
      $ kubectl apply -f backup.yaml 
      backup.velero.io/migrate-backup created
      $ velero backup get 
      NAME             STATUS      ERRORS   WARNINGS   CREATED                EXPIRES   STORAGE LOCATION   SELECTOR
      migrate-backup   InProgress  0        0          2020-12-29 19:24:12 +0800 CST   29d    default     <none>
      $ velero backup get 
      NAME             STATUS      ERRORS   WARNINGS   CREATED                EXPIRES   STORAGE LOCATION   SELECTOR
      migrate-backup   Completed   0        0          2020-12-29 19:24:28 +0800 CST   29d    default     <none>
    3. 备份完成后执行以下命令,将备份存储位置临时更新为只读模式。示例如下:
      说明

      非必须,可以防止在还原过程时, Velero 在备份存储位置中创建或删除备份对象。

      kubectl patch backupstoragelocation default --namespace velero \
          --type merge \
          --patch '{"spec":{"accessMode":"ReadOnly"}}'

    处理跨云平台资源的差异性

    1. 由于使用的动态存储类存在差异,需要通过如下所示的 ConfigMap 为持久卷 “nginx-logs” 创建动态存储类名映射。示例如下:
      apiVersion: v1
      kind: ConfigMap
      metadata:
      name: change-storage-class-config
      namespace: velero
      labels:
      velero.io/plugin-config: ""
      velero.io/change-storage-class: RestoreItemAction
      data:
      # 存储类名映射到腾讯云动态存储类 cbs
      xxx-StorageClass: cbs
    2. 执行以下命令,应用上述的 ConfigMap 配置。示例如下:
      $ kubectl  apply -f cm-storage-class.yaml 
      configmap/change-storage-class-config created
    3. Velero 备份的资源清单以 JSON 格式存放在对象存储 COS 中,如有更加个性化的迁移需求,可以直接下载备份文件并自定义修改。本示例将为 Nginx 的 Deployment 资源自定义添加一个 “jokey-test:jokey-test” 注解,修改过程如下:
      $ Downloads % mkdir migrate-backup
      # 解压备份文件
      $ Downloads % tar -zxvf migrate-backup.tar.gz  -C migrate-backup
      # 编辑修改需要自定义的资源,本示例为 Nginx 的 Deployment 资源添加 "jokey-test":"jokey-test" 的注解项
      $ migrate-backup % cat  resources/deployments.apps/namespaces/nginx-example/nginx-deployment.json 
      {"apiVersion":"apps/v1","kind":"Deployment","metadata":{"annotations":{"jokey-test":"jokey-test",...
      # 重新打包修改后的备份文件
      $ migrate-backup % tar -zcvf migrate-backup.tar.gz *
    4. 完成自定义修改并重新打包,登录 对象存储 COS 控制台上传替换原有备份文件。如下图所示:

    在集群 B 执行还原

    1. 本文示例使用如下所示的资源清单执行还原操作(迁移):
      apiVersion: velero.io/v1
      kind: Restore
      metadata:
      name: migrate-restore
      namespace: velero
      spec:
      backupName: migrate-backup
      includedNamespaces:
      - nginx-example

      # 按需填写需要恢复的资源类型,nginx-example 命名空间下没有想要排除的资源,所以这里直接写 '*'
      includedResources:
      - '*'

      includeClusterResources: null

      # 还原时不包含的资源,这里额外排除 StorageClasses 资源类型。
      excludedResources:
      - storageclasses.storage.k8s.io

      # 使用 labelSelector 选择器选择具有特定 label 的资源,由于此示例中无须再使用 label 选择器筛选,这里先注释。
      # labelSelector:
      # matchLabels:
      # app: nginx

      # 设置命名空间关系映射策略
      namespaceMapping:
      nginx-example: default
      restorePVs: true
    2. 执行还原过程如下所示,当还原状态显示为 “Completed” 且 “errors” 数为0时表示还原过程完整无误。示例如下:
      $ kubectl  apply -f restore.yaml 
      restore.velero.io/migrate-restore created
      $ velero restore get
      NAME              BACKUP           STATUS      STARTED                         COMPLETED                       ERRORS   WARNINGS   CREATED                         SELECTOR
      migrate-restore   migrate-backup   Completed   2021-01-12 20:39:14 +0800 CST   2021-01-12 20:39:17 +0800 CST   0        0          2021-01-12 20:39:14 +0800 CST   <none>

    迁移资源核查

    1. 执行以下命令,查看被迁移的资源的运行状态是否正常。示例如下:
      # 由于在还原时指定了 "nginx-example" 命名空间映射到 "default" 命名空间,所以还原的资源将运行在 "default" 命名空间下 
      $ kubectl  get all -n default 
      NAME                                    READY   STATUS    RESTARTS   AGE
      pod/nginx-deployment-5ccc99bffb-6nm5w   2/2     Running   0          49s
      
      NAME                 TYPE           CLUSTER-IP       EXTERNAL-IP      PORT(S)         AGE
      service/kube-user    LoadBalancer   172.16.253.216   10.0.0.28        443:30060/TCP   8d
      service/kubernetes   ClusterIP      172.16.252.1     <none>           443/TCP         8d
      service/my-nginx     LoadBalancer   172.16.254.16    x.x.x.x          80:30840/TCP    49s
      
      NAME                               READY   UP-TO-DATE   AVAILABLE   AGE
      deployment.apps/nginx-deployment   1/1     1            1           49s
      
      NAME                                          DESIRED   CURRENT   READY   AGE
      replicaset.apps/nginx-deployment-5ccc99bffb   1         1         1       49s
      从命令执行结果可以查看出被迁移的资源的运行状态正常。
    2. 核查设置的还原策略是否成功。
      1. 执行以下命令,核查动态存储类名映射是否正确。示例如下:
        # 可以看到 PVC/PV 的存储类已经是 "cbs",说明存储类映射成功
        $ kubectl  get pvc -n default 
        NAME         STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS   AGE
        nginx-logs   Bound    pvc-bcc17ccd-ec3e-4d27-bec6-b0c8f1c2fa9c   20Gi       RWO            cbs            55s
        $ kubectl  get pv 
        NAME                                       CAPACITY   ACCESS MODES   RECLAIM POLICY   STATUS   CLAIM                STORAGECLASS   REASON   AGE
        pvc-bcc17ccd-ec3e-4d27-bec6-b0c8f1c2fa9c   20Gi       RWO            Delete           Bound    default/nginx-logs   cbs                     57s
        若 PVC/PV 的存储类为 “cbs”,则说明存储类映射成功。从上述命令执行结果可以查看出存储类映射成功。
      2. 执行以下命令,查看还原前为 “deployment.apps/nginx-deployment” 自定义添加的 “jokey-test” 注解是否成功。示例如下:
        # 获取注解 “jokey-test” 成功,说明自定义修改资源成功。  
        $ kubectl  get deployment.apps/nginx-deployment -o custom-columns=annotations:.metadata.annotations.jokey-test
        annotations
        jokey-test
        若可以正常获取注解,则说明成功修改自定义资源。从上述命令执行结果可以查看出命名空间映射配置成功。
    3. 执行以下命令,检查工作负载挂载的 PVC 数据是否成功迁移。
      # 查看挂载的 PVC 数据目录中的数据大小,显示为88K,比迁移前多,原因是腾讯云 CLB 主动发起健康检查产生了一些日志   
      $ kubectl exec -it nginx-deployment-5ccc99bffb-6nm5w -n default -- bash
      Defaulting container name to nginx.
      Use 'kubectl describe pod/nginx-deployment-5ccc99bffb-6nm5w -n default' to see all of the containers in this pod.

      $ du -sh /var/log/nginx
      88K /var/log/nginx

      # 查看前两条日志信息,和迁移前一致,大致说明 PVC 数据未丢失
      $ head -n 2 /var/log/nginx/access.log
      192.168.0.73 - - [29/Dec/2020:03:02:31 +0000] "GET /?spm=5176.2020520152.0.0.22d016ddHXZumX HTTP/1.1" 200 612 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36" "-"
      192.168.0.73 - - [29/Dec/2020:03:02:32 +0000] "GET /favicon.ico HTTP/1.1" 404 555 "http://47.242.233.22/?spm=5176.2020520152.0.0.22d016ddHXZumX" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36" "-"

      $ head -n 2 /var/log/nginx/error.log
      2020/12/29 03:02:32 [error] 6#6: *597 open() "/usr/share/nginx/html/favicon.ico" failed (2: No such file or directory), client: 192.168.0.73, server: localhost, request: "GET /favicon.ico HTTP/1.1", host: "47.242.233.22", referrer: "http://47.242.233.22/?spm=5176.2020520152.0.0.22d016ddHXZumX"
      2020/12/29 03:07:21 [error] 6#6: *1172 open() "/usr/share/nginx/html/0bef" failed (2: No such file or directory), client: 192.168.0.73, server: localhost, request: "GET /0bef HTTP/1.0"
      从上述命令结果可以查看出,工作负载挂载的 PVC 数据成功迁移。至此,本文示例成功迁移某云平台集群 A 的 Nginx ( nginx-example 命名空间)工作负载相关资源和数据到容器服务 TKE 集群 B (default 命名空间)中。

    总结

    本文主要介绍使用 Velero 迁移自建或其他云平台集群到 TKE 的思路和方法步骤,成功的将集群 A 中的集群资源无缝迁移到集群 B 中。若在实际迁移过程中遇到未覆盖到的场景,欢迎 联系我们 咨询和讨论迁移解决方案。

    附录:Velero 备份/还原实用知识

    Velero 提供众多非常实用的备份和还原策略,详细介绍如下:

    资源过滤相关

    当不使用任何筛选选项时,Velero 会将所有对象包括在备份或还原操作中,在备份和还原时可以指定参数按需过滤资源。详情请参见 资源过滤

    • 包含关系的过滤参数:
      参数 参数含义
      --include-resources 指定需要包含的资源对象列表。
      --include-namespaces 指定需要包含的命名空间列表。
      --include-cluster-resources 指定是否要包含集群的资源。
      --selector 指定包含与标签选择器匹配的资源。
    • 不包含关系的过滤参数:
      参数 参数含义
      --exclude-namespaces 指定需要排除的命名空间列表。
      --exclude-resources 指定需要排除的资源对象列表。
      velero.io/exclude-from-backup=true 此配置项为资源对象配置 label 属性,添加了此 label 配置项的资源对象将会排除在外。

    Hook 操作相关

    Restic 备份卷配置

    从 Velero 1.5版本开始,Velero 默认使用 Restic 备份所有 Pod 卷,而不必单独注释每个 Pod,推荐使用 Velero 1.5以上版本

    在 Velero 1.5版本之前,Velero 使用 Restic 在备份卷时,Restic 提供以下两种方式发现需要备份的 Pod 卷:

    • 使用的 Pod 卷备份选择包含注解(默认):
      kubectl -n <YOUR_POD_NAMESPACE> annotate <pod/YOUR_POD_NAME> backup.velero.io/backup-volumes=<YOUR_VOLUME_NAME_1,YOUR_VOLUME_NAME_2,...>
    • 使用的 Pod 卷备份选择不包含注解:
      kubectl -n <YOUR_POD_NAMESPACE> annotate <pod/YOUR_POD_NAME> backup.velero.io/backup-volumes-excludes=<YOUR_VOLUME_NAME_1,YOUR_VOLUME_NAME_2,...>

      相关命令

      • 备份完成后可执行以下命令,查看备份卷信息:
        kubectl -n velero get podvolumebackups -l velero.io/backup-name=<YOUR_BACKUP_NAME> -o yaml
      • 还原完成后可执行以下命令,查看还原卷信息:
        kubectl -n velero get podvolumerestores -l velero.io/restore-name=<YOUR_RESTORE_NAME> -o yaml

    其他操作

    • 除使用 Velero 命令执行备份操作,也可以通过创建备份资源来触发(推荐),配置示例请参见 备份示例 ,API 详细字段定义可参见 备份 API 定义
    • 除使用 Velero 命令执行还原操作,也可以通过创建还原资源来触发(推荐),配置示例请参见 还原示例,API 详细字段定义可参见 还原 API 定义
    • 如有 annonations 、label 等其他个性化资源配置差异,可以在还原前手动编辑备份的 JSON 资源清单文件。
    目录