Skip to content

Commit 177da01

Browse files
committed
remove BackupSchedule CR related description
1 parent b34ce3a commit 177da01

File tree

6 files changed

+10
-877
lines changed

6 files changed

+10
-877
lines changed

zh/backup-restore-cr.md

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: 介绍用于备份与恢复的 Custom Resource (CR) 资源的各字段
55

66
# 备份与恢复 CR 介绍
77

8-
本文档介绍用于备份与恢复的 `Backup``CompactBackup``Restore` `BackupSchedule` 等 Custom Resource (CR) 资源的各字段,确保更好地对 Kubernetes 上的 TiDB 集群进行数据备份和数据恢复。
8+
本文档介绍用于备份与恢复的 `Backup``CompactBackup``Restore` 等 Custom Resource (CR) 资源的各字段,确保更好地对 Kubernetes 上的 TiDB 集群进行数据备份和数据恢复。
99

1010
## Backup CR 字段介绍
1111

@@ -258,26 +258,3 @@ summary: 介绍用于备份与恢复的 Custom Resource (CR) 资源的各字段
258258
* `.spec.gcs`:GCS 存储相关配置,具体介绍参考 [GCS 字段介绍](#gcs-存储字段介绍)。
259259
* `.spec.azblob`:Azure Blob Storage 存储相关配置,具体介绍参考 [Azure Blob Storage 字段介绍](#azure-blob-storage-存储字段介绍)。
260260
* `.spec.local`:持久卷存储相关配置,具体介绍参考 [Local 字段介绍](#local-存储字段介绍)。
261-
262-
## BackupSchedule CR 字段介绍
263-
264-
<details>
265-
<summary>目前 v2 版本暂时不支持 BackupSchedule 功能 </summary>
266-
267-
`backupSchedule` 的配置由三部分组成。快照备份相关配置 `backupTemplate`,日志备份相关配置`logBackupTemplate`,`backupSchedule` 独有的配置。
268-
269-
+ `backupTemplate`:快照备份相关配置。指定快照备份集群及远程存储相关的配置,字段和 Backup CR 中的 `spec` 一样,详细介绍可参考 [Backup CR 字段介绍](#backup-cr-字段介绍)。
270-
+ `logBackupTemplate`:日志备份相关配置。指定日志备份集群及远程存储相关的配置,字段和 Backup CR 中的 `spec` 一样,详细介绍可参考 [Backup CR 字段介绍](#backup-cr-字段介绍),日志备份随 `backupSchedule` 创建、删除,且根据 `.spec.maxReservedTime` 进行回收。日志备份名称在 `status.logBackup` 中保存。
271-
+ `compactBackupTemplate`:压缩日志备份的配置模板,字段和 CompactBackup CR 中的 `spec` 一样,详细介绍可参考 [CompactBackup CR 字段介绍](#compactbackup-cr-字段介绍)。压缩日志备份会随 `backupSchedule` 创建和删除,日志备份名称存储在 `status.logBackup` 中。压缩日志备份的存储设置应与同一 `backupSchedule` 中的 `logBackupTemplate` 保持一致。
272-
273-
> **注意:**
274-
>
275-
> 若删除日志备份数据,需要先停止日志备份任务,避免由于未停止 TiKV 中的日志备份任务,造成资源浪费或者后续无法重新开启日志备份。
276-
277-
+ `backupSchedule` 独有的配置:
278-
+ `.spec.maxBackups`:一种备份保留策略,决定定时备份最多可保留的备份个数。超过该数目,就会将过时的备份删除。如果将该项设置为 `0`,则表示保留所有备份。
279-
+ `.spec.maxReservedTime`:一种备份保留策略,按时间保留备份。例如将该参数设置为 `24h`,表示只保留最近 24 小时内的备份条目。超过这个时间的备份都会被清除。时间设置格式参考 [`func ParseDuration`](https://golang.org/pkg/time/#ParseDuration)。如果同时设置 `.spec.maxBackups` 和 `.spec.maxReservedTime`,则以 `.spec.maxReservedTime` 为准。
280-
+ `.spec.schedule`:Cron 的时间调度格式。具体格式可参考 [Cron](https://en.wikipedia.org/wiki/Cron)。
281-
+ `.spec.pause`:是否暂停定时备份,默认为 `false`。如果将该值设置为 `true`,表示暂停定时备份,此时即使到了指定时间点,也不会进行备份。在定时备份暂停期间,备份 Garbage Collection (GC) 仍然正常进行。如需重新开启定时快照备份,将 `true` 改为`false`。由于目前日志备份暂不支持暂停,因此该配置对日志备份无效。
282-
283-
</details>

zh/backup-restore-overview.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,11 @@ BR 相关使用文档可参考:
3939

4040
## 备份与恢复过程
4141

42-
为了对 Kubernetes 上的 TiDB 集群进行数据备份,用户需要创建一个 [`Backup` Custom Resource](backup-restore-cr.md#backup-cr-字段介绍) (CR) 对象来描述一次备份,或者创建一个 [`BackupSchedule` CR](backup-restore-cr.md#backupschedule-cr-字段介绍) 对象来描述一个定时备份。
42+
为了对 Kubernetes 上的 TiDB 集群进行数据备份,用户需要创建一个 [`Backup` Custom Resource](backup-restore-cr.md#backup-cr-字段介绍) (CR) 对象来描述一次备份。
43+
44+
> **警告:**
45+
>
46+
> 目前,TiDB Operator v2 暂不支持 `BackupSchedule` CR。如果需要定时快照备份、日志备份或压缩日志备份,请使用 TiDB Operator v1.x 版本,并参考 [BackupSchedule CR 字段介绍](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/backup-restore-cr/#backupschedule-cr-字段介绍)文档。
4347
4448
为了对 Kubernetes 上的 TiDB 集群进行数据恢复,用户可以通过创建一个 [`Restore` CR](backup-restore-cr.md#restore-cr-字段介绍) 对象来描述一次恢复。
4549

@@ -51,16 +55,15 @@ BR 相关使用文档可参考:
5155

5256
```shell
5357
kubectl delete backup ${name} -n ${namespace}
54-
kubectl delete backupschedule ${name} -n ${namespace}
5558
```
5659

5760
如果将 `spec.cleanPolicy` 设置为 `Delete` 时,TiDB Operator 在删除 CR 时会同时清理备份文件。
5861

5962
当你删除 CR 时,TiDB Operator 会尝试自动停止正在运行的日志备份任务。此自动停止功能仅适用于正常运行的日志备份任务,不会处理出现错误或失败状态的任务。
6063

61-
在满足上述条件时,如果需要删除 namespace,建议首先删除所有的 Backup/BackupSchedule CR,再删除 namespace。
64+
在满足上述条件时,如果需要删除 namespace,建议首先删除所有的 Backup CR,再删除 namespace。
6265

63-
如果直接删除存在 Backup/BackupSchedule CR 的 namespace,TiDB Operator 会持续尝试创建 Job 清理备份的数据,但因为 namespace 处于 `Terminating` 状态而创建失败,从而导致 namespace 卡在该状态。
66+
如果直接删除存在 Backup CR 的 namespace,TiDB Operator 会持续尝试创建 Job 清理备份的数据,但因为 namespace 处于 `Terminating` 状态而创建失败,从而导致 namespace 卡在该状态。
6467

6568
这时需要通过下述命令删除 `finalizers`
6669

0 commit comments

Comments
 (0)