使用 BR 备份 TiDB 集群数据到兼容 S3 的存储

本文详细描述了如何将运行在 AWS Kubernetes 环境中的 TiDB 集群数据备份到 AWS 的存储上。BR 会在底层获取集群的逻辑备份，然后再将备份数据上传到 AWS 的存储上。

本文使用的备份方式基于 TiDB Operator v1.1 及以上版本的 Custom Resource Definition(CRD) 实现。

Ad-hoc 备份

Ad-hoc 备份支持全量备份与增量备份。Ad-hoc 备份通过创建一个自定义的 Backup Custom Resource (CR) 对象来描述一次备份。TiDB Operator 根据这个 Backup 对象来完成具体的备份过程。如果备份过程中出现错误，程序不会自动重试，此时需要手动处理。

为了更好地描述备份的使用方式，本文档提供如下备份示例。示例假设对部署在 Kubernetes test1 这个 namespace 中的 TiDB 集群 demo1 进行数据备份，下面是具体操作过程。

Ad-hoc 备份环境准备

注意：

如果使用 TiDB Operator >= v1.1.10 && TiDB >= v4.0.8, BR 会自动调整 tikv_gc_life_time 参数，不需要在 Backup CR 中配置 spec.tikvGCLifeTime 和 spec.from 字段，并且可以省略以下创建 backup-demo1-tidb-secret secret 的步骤和数据库账户权限步骤。

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

    1.  kubectl apply -f backup-rbac.yaml -n test1

  2. 远程存储访问授权。

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

  3. 创建 backup-demo1-tidb-secret secret。该 secret 存放用于访问 TiDB 集群的用户所对应的密码。

    1.  kubectl create secret generic backup-demo1-tidb-secret --from-literal=password=${password} --namespace=test1

数据库账户权限

  • mysql.tidb 表的 SELECT 和 UPDATE 权限：备份前后，Backup CR 需要一个拥有该权限的数据库账户，用于调整 GC 时间

使用 BR 备份数据到 Amazon S3 的存储

  • 创建 Backup CR，通过 accessKey 和 secretKey 授权的方式备份集群:

    1.   kubectl apply -f backup-aws-s3.yaml

    backup-aws-s3.yaml 文件内容如下：

    1.   ---
    2.   apiVersion: pingcap.com/v1alpha1
    3.   kind: Backup
    4.   metadata:
    5.     name: demo1-backup-s3
    6.     namespace: test1
    7.   spec:
    8.     backupType: full
    9.     br:
    10.       cluster: demo1
    11.       clusterNamespace: test1
    12.       # logLevel: info
    13.       # statusAddr: ${status_addr}
    14.       # concurrency: 4
    15.       # rateLimit: 0
    16.       # timeAgo: ${time}
    17.       # checksum: true
    18.       # sendCredToTikv: true
    19.       # options:
    20.       # - --lastbackupts=420134118382108673
    21.     # Only needed for TiDB Operator < v1.1.10 or TiDB < v4.0.8
    22.     from:
    23.       host: ${tidb_host}
    24.       port: ${tidb_port}
    25.       user: ${tidb_user}
    26.       secretName: backup-demo1-tidb-secret
    27.     s3:
    28.       provider: aws
    29.       secretName: s3-secret
    30.       region: us-west-1
    31.       bucket: my-bucket
    32.       prefix: my-folder

  • 创建 Backup CR，通过 IAM 绑定 Pod 授权的方式备份集群:

    1.   kubectl apply -f backup-aws-s3.yaml

    backup-aws-s3.yaml 文件内容如下：

    1.   ---
    2.   apiVersion: pingcap.com/v1alpha1
    3.   kind: Backup
    4.   metadata:
    5.     name: demo1-backup-s3
    6.     namespace: test1
    7.     annotations:
    8.       iam.amazonaws.com/role: arn:aws:iam::123456789012:role/user
    9.   spec:
    10.     backupType: full
    11.     br:
    12.       cluster: demo1
    13.       sendCredToTikv: false
    14.       clusterNamespace: test1
    15.       # logLevel: info
    16.       # statusAddr: ${status_addr}
    17.       # concurrency: 4
    18.       # rateLimit: 0
    19.       # timeAgo: ${time}
    20.       # checksum: true
    21.       # options:
    22.       # - --lastbackupts=420134118382108673
    23.     # Only needed for TiDB Operator < v1.1.10 or TiDB < v4.0.8
    24.     from:
    25.       host: ${tidb_host}
    26.       port: ${tidb_port}
    27.       user: ${tidb_user}
    28.       secretName: backup-demo1-tidb-secret
    29.     s3:
    30.       provider: aws
    31.       region: us-west-1
    32.       bucket: my-bucket
    33.       prefix: my-folder

  • 创建 Backup CR，通过 IAM 绑定 ServiceAccount 授权的方式备份集群:

    1.   kubectl apply -f backup-aws-s3.yaml

    backup-aws-s3.yaml 文件内容如下：

    1.   ---
    2.   apiVersion: pingcap.com/v1alpha1
    3.   kind: Backup
    4.   metadata:
    5.     name: demo1-backup-s3
    6.     namespace: test1
    7.   spec:
    8.     backupType: full
    9.     serviceAccount: tidb-backup-manager
    10.     br:
    11.       cluster: demo1
    12.       sendCredToTikv: false
    13.       clusterNamespace: test1
    14.       # logLevel: info
    15.       # statusAddr: ${status_addr}
    16.       # concurrency: 4
    17.       # rateLimit: 0
    18.       # timeAgo: ${time}
    19.       # checksum: true
    20.       # options:
    21.       # - --lastbackupts=420134118382108673
    22.     # Only needed for TiDB Operator < v1.1.10 or TiDB < v4.0.8
    23.     from:
    24.       host: ${tidb_host}
    25.       port: ${tidb_port}
    26.       user: ${tidb_user}
    27.       secretName: backup-demo1-tidb-secret
    28.     s3:
    29.       provider: aws
    30.       region: us-west-1
    31.       bucket: my-bucket
    32.       prefix: my-folder

以上三个示例分别使用三种授权模式将数据导出到 Amazon S3 存储上。Amazon S3 的 acl、endpoint、storageClass 配置项均可以省略。兼容 S3 的存储相关配置参考 S3 存储字段介绍。

以上示例中，.spec.br 中的一些参数项均可省略，如 logLevel、statusAddr、concurrency、rateLimit、checksum、timeAgo、sendCredToTikv。更多 .spec.br 字段的详细解释参考 BR 字段介绍。

自 v1.1.6 版本起，如果需要增量备份，只需要在 spec.br.options 中指定上一次的备份时间戳 --lastbackupts 即可。有关增量备份的限制，可参考使用 BR 进行备份与恢复。

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

创建好 Backup CR 后，可通过如下命令查看备份状态：

  1. kubectl get bk -n test1 -o wide

定时全量备份

用户通过设置备份策略来对 TiDB 集群进行定时备份，同时设置备份的保留策略以避免产生过多的备份。定时全量备份通过自定义的 BackupSchedule CR 对象来描述。每到备份时间点会触发一次全量备份，定时全量备份底层通过 Ad-hoc 全量备份来实现。下面是创建定时全量备份的具体步骤：

定时全量备份环境准备

同 Ad-hoc 备份环境准备。

使用 BR 定时备份数据到 Amazon S3 的存储

  • 创建 BackupSchedule CR，开启 TiDB 集群定时全量备份，通过 accessKey 和 secretKey 授权的方式备份集群：

    1.   kubectl apply -f backup-scheduler-aws-s3.yaml

    backup-scheduler-aws-s3.yaml 文件内容如下：

    1.   ---
    2.   apiVersion: pingcap.com/v1alpha1
    3.   kind: BackupSchedule
    4.   metadata:
    5.     name: demo1-backup-schedule-s3
    6.     namespace: test1
    7.   spec:
    8.     #maxBackups: 5
    9.     #pause: true
    10.     maxReservedTime: "3h"
    11.     schedule: "*/2 * * * *"
    12.     backupTemplate:
    13.       backupType: full
    14.       br:
    15.         cluster: demo1
    16.         clusterNamespace: test1
    17.         # logLevel: info
    18.         # statusAddr: ${status_addr}
    19.         # concurrency: 4
    20.         # rateLimit: 0
    21.         # timeAgo: ${time}
    22.         # checksum: true
    23.         # sendCredToTikv: true
    24.       # Only needed for TiDB Operator < v1.1.10 or TiDB < v4.0.8
    25.       from:
    26.         host: ${tidb_host}
    27.         port: ${tidb_port}
    28.         user: ${tidb_user}
    29.         secretName: backup-demo1-tidb-secret
    30.       s3:
    31.         provider: aws
    32.         secretName: s3-secret
    33.         region: us-west-1
    34.         bucket: my-bucket
    35.         prefix: my-folder

  • 创建 BackupSchedule CR，开启 TiDB 集群定时全量备份，通过 IAM 绑定 Pod 授权的方式备份集群：

    1.   kubectl apply -f backup-scheduler-aws-s3.yaml

    backup-scheduler-aws-s3.yaml 文件内容如下：

    1.   ---
    2.   apiVersion: pingcap.com/v1alpha1
    3.   kind: BackupSchedule
    4.   metadata:
    5.     name: demo1-backup-schedule-s3
    6.     namespace: test1
    7.     annotations:
    8.       iam.amazonaws.com/role: arn:aws:iam::123456789012:role/user
    9.   spec:
    10.     #maxBackups: 5
    11.     #pause: true
    12.     maxReservedTime: "3h"
    13.     schedule: "*/2 * * * *"
    14.     backupTemplate:
    15.       backupType: full
    16.       br:
    17.         cluster: demo1
    18.         sendCredToTikv: false
    19.         clusterNamespace: test1
    20.         # logLevel: info
    21.         # statusAddr: ${status_addr}
    22.         # concurrency: 4
    23.         # rateLimit: 0
    24.         # timeAgo: ${time}
    25.         # checksum: true
    26.       # Only needed for TiDB Operator < v1.1.10 or TiDB < v4.0.8
    27.       from:
    28.         host: ${tidb_host}
    29.         port: ${tidb_port}
    30.         user: ${tidb_user}
    31.         secretName: backup-demo1-tidb-secret
    32.       s3:
    33.         provider: aws
    34.         region: us-west-1
    35.         bucket: my-bucket
    36.         prefix: my-folder

  • 创建 BackupSchedule CR，开启 TiDB 集群定时全量备份， 通过 IAM 绑定 ServiceAccount 授权的方式备份集群：

    1.   kubectl apply -f backup-scheduler-aws-s3.yaml

    backup-scheduler-aws-s3.yaml 文件内容如下：

    1.   ---
    2.   apiVersion: pingcap.com/v1alpha1
    3.   kind: BackupSchedule
    4.   metadata:
    5.     name: demo1-backup-schedule-s3
    6.     namespace: test1
    7.   spec:
    8.     #maxBackups: 5
    9.     #pause: true
    10.     maxReservedTime: "3h"
    11.     schedule: "*/2 * * * *"
    12.     serviceAccount: tidb-backup-manager
    13.     backupTemplate:
    14.       backupType: full
    15.       br:
    16.         cluster: demo1
    17.         sendCredToTikv: false
    18.         clusterNamespace: test1
    19.         # logLevel: info
    20.         # statusAddr: ${status_addr}
    21.         # concurrency: 4
    22.         # rateLimit: 0
    23.         # timeAgo: ${time}
    24.         # checksum: true
    25.       # Only needed for TiDB Operator < v1.1.10 or TiDB < v4.0.8
    26.       from:
    27.         host: ${tidb_host}
    28.         port: ${tidb_port}
    29.         user: ${tidb_user}
    30.         secretName: backup-demo1-tidb-secret
    31.       s3:
    32.         provider: aws
    33.         region: us-west-1
    34.         bucket: my-bucket
    35.         prefix: my-folder

定时全量备份创建完成后，可以通过以下命令查看定时全量备份的状态：

  1. kubectl get bks -n test1 -o wide

查看定时全量备份下面所有的备份条目：

  1. kubectl get bk -l tidb.pingcap.com/backup-schedule=demo1-backup-schedule-s3 -n test1

从以上示例可知，backupSchedule 的配置由两部分组成。一部分是 backupSchedule 独有的配置，另一部分是 backupTemplate。backupTemplate 指定集群及远程存储相关的配置，字段和 Backup CR 中的 spec 一样，详细介绍可参考 Backup CR 字段介绍。backupSchedule 独有的配置项具体介绍可参考 BackupSchedule CR 字段介绍。

删除备份的 Backup CR

删除备份的 Backup CR 可参考删除备份的 Backup CR。

故障诊断

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