使用 BR 备份 TiDB 集群数据到 Azure Blob Storage

本文介绍如何将运行在 Kubernetes 环境中的 TiDB 集群数据备份到 Azure Blob Storage 上。其中包括以下两种备份方式:

  • 快照备份。使用快照备份,你可以通过全量恢复将 TiDB 集群恢复到快照备份的时刻点。
  • 日志备份。使用快照备份与日志备份,你可以通过快照备份与日志备份产生的备份数据将 TiDB 集群恢复到历史任意时刻点,即 Point-in-Time Recovery (PITR)

本文使用的备份方式基于 TiDB Operator 的 Custom Resource Definition(CRD) 实现,底层使用 BR 获取集群数据,然后再将数据上传到 Azure Blob Storage 上。BR 全称为 Backup & Restore,是 TiDB 分布式备份恢复的命令行工具,用于对 TiDB 集群进行数据备份和恢复。

使用场景

如果你对数据备份有以下要求,可考虑使用 BR 的快照备份方式将 TiDB 集群数据以 Ad-hoc 备份定时快照备份的方式备份至 Azure Blob Storage 上:

  • 需要备份的数据量较大(大于 1 TB),而且要求备份速度较快
  • 需要直接备份数据的 SST 文件(键值对)

如果你对数据备份有以下要求,可考虑使用 BR 的日志备份方式将 TiDB 集群数据以 Ad-hoc 备份的方式备份至 Azure Blob Storage 上(同时也需要配合快照备份的数据,来更高效地恢复数据):

  • 需要在新集群上恢复备份集群的历史任意时刻点快照(PITR)
  • 数据的 RPO 在分钟级别

如有其他备份需求,请参考备份与恢复简介选择合适的备份方式。

Ad-hoc 备份

Ad-hoc 备份支持快照备份,也支持启动停止日志备份任务,以及清理日志备份数据等操作。

要进行 Ad-hoc 备份,你需要创建一个自定义的 Backup custom resource (CR) 对象来描述本次备份。创建好 Backup 对象后,TiDB Operator 根据这个对象自动完成具体的备份过程。如果备份过程中出现错误,程序不会自动重试,此时需要手动处理。

本文假设对部署在 Kubernetes test1 这个 namespace 中的 TiDB 集群 demo1 进行数据备份。下面是具体的操作过程。

前置条件:准备 Ad-hoc 备份环境

  1. 创建一个用于管理备份的 namespace,这里创建了名为 backup-test 的 namespace。

    kubectl create namespace backup-test
    
  2. 下载文件 backup-rbac.yaml,并执行以下命令在 backup-test 这个 namespace 中创建备份需要的 RBAC 相关资源:

    kubectl apply -f backup-rbac.yaml -n backup-test
    
  3. 为刚创建的 namespace backup-test 授予远程存储访问权限,可以使用两种方式授予权限,可参考文档 Azure 账号授权。创建成功后, namespace backup-test 就拥有了名为 azblob-secretazblob-secret-ad 的 secret 对象。

  4. 如果你使用的 TiDB 版本低于 v4.0.8,你还需要完成以下步骤。如果你使用的 TiDB 为 v4.0.8 及以上版本,请跳过这些步骤。

    1. 确保你拥有备份数据库 mysql.tidb 表的 SELECTUPDATE 权限,用于备份前后调整 GC 时间。

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

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

快照备份

执行以下步骤,进行快照备份:

backup-test 这个 namespace 中创建一个名为 demo1-full-backup-azblobBackup CR,用于快照备份:

kubectl apply -f full-backup-azblob.yaml

full-backup-azblob.yaml 文件内容如下:

---
apiVersion: pingcap.com/v1alpha1
kind: Backup
metadata:
  name: demo1-full-backup-azblob
  namespace: backup-test
spec:
  backupType: full
  br:
    cluster: demo1
    clusterNamespace: test1
    # logLevel: info
    # statusAddr: ${status_addr}
    # concurrency: 4
    # rateLimit: 0
    # timeAgo: ${time}
    # checksum: true
    # sendCredToTikv: true
    # options:
    # - --lastbackupts=420134118382108673
  # Only needed for TiDB Operator < v1.1.10 or TiDB < v4.0.8
  from:
    host: ${tidb_host}
    port: ${tidb_port}
    user: ${tidb_user}
    secretName: backup-demo1-tidb-secret
  azblob:
    secretName: azblob-secret
    container: my-container
    prefix: my-full-backup-folder
    #accessTier: Hot

在配置 full-backup-azblob.yaml 文件时,请参考以下信息:

  • 自 TiDB Operator v1.1.6 版本起,如果需要增量备份,只需要在 spec.br.options 中指定上一次的备份时间戳 --lastbackupts 即可。有关增量备份的限制,可参考使用 BR 进行备份与恢复
  • 关于 Azure Blob Storage 相关配置,请参考 Azure Blob Storage 存储字段介绍
  • spec.br 中的一些参数是可选的,例如 logLevelstatusAddr 等。完整的 .spec.br 字段的详细解释,请参考 BR 字段介绍
  • spec.azblob.secretName:填写你在创建 secret 对象时自定义的 secret 对象的名字,例如 azblob-secret
  • 如果你使用的 TiDB 为 v4.0.8 及以上版本, BR 会自动调整 tikv_gc_life_time 参数,不需要配置 spec.tikvGCLifeTimespec.from 字段。
  • 更多 Backup CR 字段的详细解释参考 Backup CR 字段介绍

查看快照备份的状态

创建好 Backup CR 后,TiDB Operator 会根据 Backup CR 自动开始备份。你可以通过如下命令查看备份状态:

kubectl get backup -n backup-test -o wide

从上述命令的输出中,你可以找到描述名为 demo1-full-backup-azblobBackup CR 的如下信息,其中 COMMITTS 表示快照备份的时刻点:

NAME                       TYPE   MODE       STATUS     BACKUPPATH                                    COMMITTS             ...
demo1-full-backup-azblob   full   snapshot   Complete   azure://my-container/my-full-backup-folder/   436979621972148225   ...

日志备份

你可以使用一个 Backup CR 来描述日志备份任务的启动、停止以及清理日志备份数据等操作。本节示例创建了名为 demo1-log-backup-azblobBackup CR。具体操作如下所示。

启动日志备份

  1. backup-test 这个 namespace 中创建一个名为 demo1-log-backup-azblobBackup CR。

    kubectl apply -f log-backup-azblob.yaml
    

    log-backup-azblob.yaml 文件内容如下:

    ---
    apiVersion: pingcap.com/v1alpha1
    kind: Backup
    metadata:
      name: demo1-log-backup-azblob
      namespace: backup-test
    spec:
      backupMode: log
      br:
        cluster: demo1
        clusterNamespace: test1
        sendCredToTikv: true
      azblob:
        secretName: azblob-secret
        container: my-container
        prefix: my-log-backup-folder
        #accessTier: Hot
    
  2. 等待启动操作完成:

    kubectl get jobs -n backup-test
    
    NAME                                       COMPLETIONS   ...
    backup-demo1-log-backup-azblob-log-start   1/1           ...
    
  3. 查看新增的 Backup CR:

    kubectl get backup -n backup-test
    
    NAME                       TYPE    MODE   STATUS   ....
    demo1-log-backup-azblob            log    Running  ....
    

查看日志备份的状态

通过查看 Backup CR 的信息,可查看日志备份的状态。

kubectl describe backup -n backup-test

从上述命令的输出中,你可以找到描述名为 demo1-log-backup-azblobBackup CR 的如下信息,其中 Log Checkpoint Ts 表示日志备份可恢复的最近时间点:

Status:
Backup Path:  azure://my-container/my-log-backup-folder/
Commit Ts:    436568622965194754
Conditions:
    Last Transition Time:  2022-10-10T04:45:20Z
    Status:                True
    Type:                  Scheduled
    Last Transition Time:  2022-10-10T04:45:31Z
    Status:                True
    Type:                  Prepare
    Last Transition Time:  2022-10-10T04:45:31Z
    Status:                True
    Type:                  Running
Log Checkpoint Ts:       436569119308644661

停止日志备份

由于你在开启日志备份的时候已经创建了名为 demo1-log-backup-azblobBackup CR,因此可以直接更新该 Backup CR 的配置,来激活停止日志备份的操作。操作激活优先级从高到低分别是停止日志备份任务、删除日志备份数据和开启日志备份任务。

kubectl edit backup demo1-log-backup-azblob -n backup-test

在最后新增一行字段 spec.logStop: true,保存并退出。更新后的内容如下:

---
apiVersion: pingcap.com/v1alpha1
kind: Backup
metadata:
  name: demo1-log-backup-azblob
  namespace: backup-test
spec:
  backupMode: log
  br:
    cluster: demo1
    clusterNamespace: test1
    sendCredToTikv: true
  azblob:
    secretName: azblob-secret
    container: my-container
    prefix: my-log-backup-folder
    #accessTier: Hot
  logStop: true

可以看到名为 demo1-log-backup-azblobBackup CR 的 STATUSRunning 变成了 Complete

kubectl get backup -n backup-test
NAME                       TYPE    MODE   STATUS    ....
demo1-log-backup-azblob            log    Complete  ....

清理日志备份数据

  1. 由于你在开启日志备份的时候已经创建了名为 demo1-log-backup-azblobBackup CR,因此可以直接更新该 Backup CR 的配置,来激活清理日志备份数据的操作。操作激活优先级从高到低分别是停止日志备份任务、删除日志备份数据和开启日志备份任务。执行如下操作来清理 2022-10-10T15:21:00+08:00 之前的所有日志备份数据。

    kubectl edit backup demo1-log-backup-azblob -n backup-test
    

    在最后新增一行字段 spec.logTruncateUntil: "2022-10-10T15:21:00+08:00",保存并退出。更新后的内容如下:

    ---
    apiVersion: pingcap.com/v1alpha1
    kind: Backup
    metadata:
      name: demo1-backup-azblob
      namespace: backup-test
    spec:
      backupMode: log
      br:
        cluster: demo1
        clusterNamespace: test1
        sendCredToTikv: true
      azblob:
        secretName: azblob-secret
        container: my-container
        prefix: my-log-backup-folder
        #accessTier: Hot
      logTruncateUntil: "2022-10-10T15:21:00+08:00"
    
  2. 等待清理操作完成:

    kubectl get jobs -n backup-test
    
    NAME                                          COMPLETIONS   ...
    ...
    backup-demo1-log-backup-azblob-log-truncate   1/1           ...
    
  3. 查看 Backup CR 的信息:

    kubectl describe backup -n backup-test
    
    ...
    Log Success Truncate Until:  2022-10-10T15:21:00+08:00
    ...
    

    也可以通过以下命令查看:

    kubectl get backup -n backup-test -o wide
    
    NAME                TYPE   MODE       STATUS     ...   LOGTRUNCATEUNTIL
    demo1-log-backup           log        Complete   ...   2022-10-10T15:21:00+08:00
    

备份示例

备份全部集群数据
---
apiVersion: pingcap.com/v1alpha1
kind: Backup
metadata:
  name: demo1-backup-azblob
  namespace: backup-test
spec:
  backupType: full
  serviceAccount: tidb-backup-manager
  br:
    cluster: demo1
    sendCredToTikv: false
    clusterNamespace: test1
  # Only needed for TiDB Operator < v1.1.10 or TiDB < v4.0.8
  # from:
    # host: ${tidb_host}
    # port: ${tidb_port}
    # user: ${tidb_user}
    # secretName: backup-demo1-tidb-secret
  azblob:
    secretName: azblob-secret-ad
    container: my-container
    prefix: my-folder
备份单个数据库的数据

以下示例中,备份 db1 数据库的数据。

---
apiVersion: pingcap.com/v1alpha1
kind: Backup
metadata:
  name: demo1-backup-azblob
  namespace: backup-test
spec:
  backupType: full
  serviceAccount: tidb-backup-manager
  tableFilter:
  - "db1.*"
  br:
    cluster: demo1
    sendCredToTikv: false
    clusterNamespace: test1
  # Only needed for TiDB Operator < v1.1.10 or TiDB < v4.0.8
  # from:
    # host: ${tidb_host}
    # port: ${tidb_port}
    # user: ${tidb_user}
    # secretName: backup-demo1-tidb-secret
  azblob:
    secretName: azblob-secret-ad
    container: my-container
    prefix: my-folder
备份单张表的数据

以下示例中,备份 db1.table1 表的数据。

---
apiVersion: pingcap.com/v1alpha1
kind: Backup
metadata:
  name: demo1-backup-azblob
  namespace: backup-test
spec:
  backupType: full
  serviceAccount: tidb-backup-manager
  tableFilter:
  - "db1.table1"
  br:
    cluster: demo1
    sendCredToTikv: false
    clusterNamespace: test1
  # Only needed for TiDB Operator < v1.1.10 or TiDB < v4.0.8
  # from:
    # host: ${tidb_host}
    # port: ${tidb_port}
    # user: ${tidb_user}
    # secretName: backup-demo1-tidb-secret
  azblob:
    secretName: azblob-secret-ad
    container: my-container
    prefix: my-folder
使用表库过滤功能备份多张表的数据

以下示例中,备份 db1.table1 表 和 db1.table2 表的数据。

---
apiVersion: pingcap.com/v1alpha1
kind: Backup
metadata:
  name: demo1-backup-azblob
  namespace: backup-test
spec:
  backupType: full
  serviceAccount: tidb-backup-manager
  tableFilter:
  - "db1.table1"
  - "db1.table2"
  # ...
  br:
    cluster: demo1
    sendCredToTikv: false
    clusterNamespace: test1
  # Only needed for TiDB Operator < v1.1.10 or TiDB < v4.0.8
  # from:
    # host: ${tidb_host}
    # port: ${tidb_port}
    # user: ${tidb_user}
    # secretName: backup-demo1-tidb-secret
  azblob:
    secretName: azblob-secret-ad
    container: my-container
    prefix: my-folder

定时快照备份

你可以通过设置备份策略来对 TiDB 集群进行定时备份,同时设置备份的保留策略以避免产生过多的备份。定时快照备份通过自定义的 BackupSchedule CR 对象来描述。每到备份时间点会触发一次快照备份,定时快照备份底层通过 Ad-hoc 快照备份来实现。

前置条件:准备定时快照备份环境

准备 Ad-hoc 备份环境

执行快照备份

依据准备 Ad-hoc 备份环境时所选择的远程存储访问授权方式,你需要使用下面对应的方法将数据定时备份到 Azure Blob Storage 上:

  • 方法 1:如果通过了访问密钥的方式授权,你可以按照以下说明创建 BackupSchedule CR,开启 TiDB 集群定时快照备份:

    kubectl apply -f backup-scheduler-azblob.yaml
    

    backup-scheduler-azblob.yaml 文件内容如下:

    ---
    apiVersion: pingcap.com/v1alpha1
    kind: BackupSchedule
    metadata:
      name: demo1-backup-schedule-azblob
      namespace: backup-test
    spec:
      #maxBackups: 5
      #pause: true
      maxReservedTime: "3h"
      schedule: "*/2 * * * *"
      backupTemplate:
        backupType: full
        br:
          cluster: demo1
          clusterNamespace: test1
          # logLevel: info
          # statusAddr: ${status_addr}
          # concurrency: 4
          # rateLimit: 0
          # timeAgo: ${time}
          # checksum: true
          # sendCredToTikv: true
        # Only needed for TiDB Operator < v1.1.10 or TiDB < v4.0.8
        from:
          host: ${tidb_host}
          port: ${tidb_port}
          user: ${tidb_user}
          secretName: backup-demo1-tidb-secret
       azblob:
          secretName: azblob-secret-ad
          container: my-container
          prefix: my-folder
    
  • 方法 2:如果通过了 Azure AD 的方式授权,你可以按照以下说明创建 BackupSchedule CR,开启 TiDB 集群定时快照备份:

    kubectl apply -f backup-scheduler-azblob.yaml
    

    backup-scheduler-azblob.yaml 文件内容如下:

    ---
    apiVersion: pingcap.com/v1alpha1
    kind: BackupSchedule
    metadata:
      name: demo1-backup-schedule-azblob
      namespace: backup-test
    spec:
      #maxBackups: 5
      #pause: true
      maxReservedTime: "3h"
      schedule: "*/2 * * * *"
      backupTemplate:
        backupType: full
        br:
          cluster: demo1
          sendCredToTikv: false
          clusterNamespace: test1
          # logLevel: info
          # statusAddr: ${status_addr}
          # concurrency: 4
          # rateLimit: 0
          # timeAgo: ${time}
          # checksum: true
        # Only needed for TiDB Operator < v1.1.10 or TiDB < v4.0.8
        from:
          host: ${tidb_host}
          port: ${tidb_port}
          user: ${tidb_user}
          secretName: backup-demo1-tidb-secret
        azblob:
          secretName: azblob-secret-ad
          container: my-container
          prefix: my-folder
    

从以上 backup-scheduler-azblob.yaml 文件配置示例可知,backupSchedule 的配置由两部分组成。一部分是 backupSchedule 独有的配置,另一部分是 backupTemplate

定时快照备份创建完成后,可以通过以下命令查看定时快照备份的状态:

kubectl get backup -n test1 -o wide

查看定时快照备份下面所有的备份条目:

kubectl get backup -l tidb.pingcap.com/backup-schedule=demo1-backup-schedule-azblob -n test1

删除备份的 Backup CR

如果你不再需要已备份的 Backup CR,请参考删除备份的 Backup CR

故障诊断

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

下载 PDF文档反馈社区交流
文档内容是否有帮助?
产品
TiDB
学习
客户案例
PingCAP Education
TiDB in Action
© 2022 PingCAP. All Rights Reserved.