使用 TiDB Lightning 恢复 S3 兼容存储上的备份数据

本文档介绍如何将 Kubernetes 上通过 TiDB Operator 备份的数据恢复到 TiDB 集群。

本文使用的恢复方式基于 TiDB Operator v1.1 及以上的 CustomResourceDefinition (CRD) 实现，底层通过使用 TiDB Lightning TiDB-backend 来恢复数据。

TiDB Lightning 是一款将全量数据高速导入到 TiDB 集群的工具，可用于从本地盘、Google Cloud Storage (GCS) 或 Amazon S3 云盘读取数据。目前，TiDB Lightning 支持三种后端：Importer-backend、Local-backend、TiDB-backend。本文介绍的方法使用 TiDB-backend。关于这三种后端的区别和选择，请参阅 TiDB Lightning 文档。如果要使用 Importer-backend 或者 Local-backend 导入数据，请参阅使用 TiDB Lightning 导入集群数据。

以下示例将兼容 S3 的存储（指定路径）上的备份数据恢复到 TiDB 集群。

使用场景

如果你需要从兼容 S3 的存储导出备份数据到 TiDB 集群，并对数据恢复有以下要求，可使用本文介绍的恢复方案：

• 希望以较低资源占用率和较低网络带宽占用进行恢复，并能接受 50 GB/小时的恢复速度
• 要求导入集群时满足 ACID
• 要求备份期间 TiDB 集群仍可对外提供服务

恢复前的准备

在进行数据恢复前，你需要准备恢复环境，并拥有数据库的相关权限。

准备恢复环境

1. 下载文件 backup-rbac.yaml，并执行以下命令在 test2 这个 namespace 中创建恢复所需的 RBAC 相关资源：

   kubectl apply -f backup-rbac.yaml -n test2
   

2. 远程存储访问授权。

   如果从 Amazon S3 恢复集群数据，可以使用三种权限授予方式授予权限，参考 AWS 账号授权授权访问兼容 S3 的远程存储；使用 Ceph 作为后端存储测试恢复时，是通过 AccessKey 和 SecretKey 模式授权，设置方式可参考通过 AccessKey 和 SecretKey 授权。

3. 创建 restore-demo2-tidb-secret secret，该 secret 存放用来访问 TiDB 集群的 root 账号和密钥：

   kubectl create secret generic restore-demo2-tidb-secret --from-literal=user=root --from-literal=password=${password} --namespace=test2
   

获取所需的数据库权限

使用 TiDB Lightning 将 Amazon S3 上的备份数据恢复至 TiDB 集群前，确保你拥有备份数据库的以下权限：

将指定备份数据恢复到 TiDB 集群

spec:
  ...
  s3:
    ...
    options:
    - --ignore-checksum

本节提供了存储访问的多种方法。只需使用符合你情况的方法即可。

• 通过 AccessKey 和 SecretKey 授权的方式由 Ceph 恢复数据的方法
• 通过 AccessKey 和 SecretKey 授权的方式从 Amazon S3 恢复数据的方法
• 通过绑定 IAM 与 Pod 的方式从 Amazon S3 恢复数据的方法
• 通过绑定 IAM 与 ServiceAccount 的方式从 Amazon S3 恢复数据的方法

1. 创建 Restore customer resource (CR)，将指定备份数据恢复至 TiDB 集群。

   • 方法 1：创建 Restore custom resource (CR)，通过 AccessKey 和 SecretKey 授权的方式将指定的备份数据由 Ceph 恢复至 TiDB 集群。

     kubectl apply -f restore.yaml
     

     restore.yaml 文件内容如下：

     ---
     apiVersion: pingcap.com/v1alpha1
     kind: Restore
     metadata:
       name: demo2-restore
       namespace: test2
     spec:
       backupType: full
       to:
         host: ${tidb_host}
         port: ${tidb_port}
         user: ${tidb_user}
         secretName: restore-demo2-tidb-secret
       s3:
         provider: ceph
         endpoint: ${endpoint}
         secretName: s3-secret
         path: s3://${backup_path}
       # storageClassName: local-storage
       storageSize: 1Gi
     

   • 方法 2：创建 Restore custom resource (CR)，通过 AccessKey 和 SecretKey 授权的方式将指定的备份数据由 Amazon S3 恢复至 TiDB 集群。

     kubectl apply -f restore.yaml
     

     restore.yaml 文件内容如下：

     ---
     apiVersion: pingcap.com/v1alpha1
     kind: Restore
     metadata:
       name: demo2-restore
       namespace: test2
     spec:
       backupType: full
       to:
         host: ${tidb_host}
         port: ${tidb_port}
         user: ${tidb_user}
         secretName: restore-demo2-tidb-secret
       s3:
         provider: aws
         region: ${region}
         secretName: s3-secret
         path: s3://${backup_path}
       # storageClassName: local-storage
       storageSize: 1Gi
     

   • 方法 3：创建 Restore custom resource (CR)，通过 IAM 绑定 Pod 授权的方式将指定的备份数据恢复至 TiDB 集群。

     kubectl apply -f restore.yaml
     

     restore.yaml 文件内容如下：

     ---
     apiVersion: pingcap.com/v1alpha1
     kind: Restore
     metadata:
       name: demo2-restore
       namespace: test2
       annotations:
         iam.amazonaws.com/role: arn:aws:iam::123456789012:role/user
     spec:
       backupType: full
       to:
         host: ${tidb_host}
         port: ${tidb_port}
         user: ${tidb_user}
         secretName: restore-demo2-tidb-secret
       s3:
         provider: aws
         region: ${region}
         path: s3://${backup_path}
       # storageClassName: local-storage
       storageSize: 1Gi
     

   • 方法 4：创建 Restore custom resource (CR)，通过 IAM 绑定 ServiceAccount 授权的方式将指定的备份数据恢复至 TiDB 集群。

     kubectl apply -f restore.yaml
     

     restore.yaml 文件内容如下：

     ---
     apiVersion: pingcap.com/v1alpha1
     kind: Restore
     metadata:
       name: demo2-restore
       namespace: test2
     spec:
       backupType: full
       serviceAccount: tidb-backup-manager
       to:
         host: ${tidb_host}
         port: ${tidb_port}
         user: ${tidb_user}
         secretName: restore-demo2-tidb-secret
       s3:
         provider: aws
         region: ${region}
         path: s3://${backup_path}
       # storageClassName: local-storage
       storageSize: 1Gi
     

2. 创建好 Restore CR 后，可通过以下命令查看恢复的状态：

   kubectl get rt -n test2 -owide
   

以上示例将兼容 S3 的存储（spec.s3.path 路径下）中的备份数据恢复到 TiDB 集群 spec.to.host。有关兼容 S3 的存储的配置项，可以参考 S3 字段介绍。

更多 Restore CR 字段的详细解释参考Restore CR 字段介绍。

故障诊断

在使用过程中如果遇到问题，可以参考故障诊断。