Skip to content

Commit 13a2688

Browse files
committed
BR v8.5.5: update br compact backup
1 parent ecd58e9 commit 13a2688

8 files changed

+14
-14
lines changed

en/backup-restore-cr.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -260,15 +260,15 @@ This section introduces the fields in the `Backup` CR.
260260
261261
### Prune field
262262
263-
* `.spec.prune`: supported in BR v9.0.0 and later versions. Currently, this field only supports the value `afterFailed`, which enables automatic cleanup of metadata tables when a restore task fails. Enabling the `prune` field affects the final status of the restore task. If the restore task ends in the `Failed` status, a cleanup task is automatically triggered to remove metadata table information. Based on the cleanup task status, the restore task displays one of the following statuses:
263+
* `.spec.prune`: supported in BR v8.5.5 and later versions. Currently, this field only supports the value `afterFailed`, which enables automatic cleanup of metadata tables when a restore task fails. Enabling the `prune` field affects the final status of the restore task. If the restore task ends in the `Failed` status, a cleanup task is automatically triggered to remove metadata table information. Based on the cleanup task status, the restore task displays one of the following statuses:
264264
* `PruneScheduled`: the cleanup task is scheduled but has not started.
265265
* `PruneRunning`: the cleanup task is running.
266266
* `PruneComplete`: the cleanup task completed successfully.
267267
* `PruneFailed`: the cleanup task failed.
268268
269269
## CompactBackup CR fields
270270
271-
For TiDB v9.0.0 and later versions, you can use `CompactBackup` to accelerate PITR (Point-in-time recovery). To compact log backup data into structured SST files, you can create a custom `CompactBackup` CR object to define a backup task. The following introduces the fields in the `CompactBackup` CR:
271+
For TiDB v8.5.5 and later versions, you can use `CompactBackup` to accelerate PITR (Point-in-time recovery). To compact log backup data into structured SST files, you can create a custom `CompactBackup` CR object to define a backup task. The following introduces the fields in the `CompactBackup` CR:
272272
273273
* `.spec.startTs`: the start timestamp for log compaction backup.
274274
* `.spec.endTs`: the end timestamp for log compaction backup.
@@ -277,7 +277,7 @@ For TiDB v9.0.0 and later versions, you can use `CompactBackup` to accelerate PI
277277
* `.spec.toolImage`:the tool image used by `CompactBackup`. BR is the only tool image used in `CompactBackup`. When using BR for backup, you can specify the BR version with this field:
278278
279279
- If not specified or left empty, the `pingcap/br:${tikv_version}` image is used for backup by default.
280-
- If a BR version is specified, such as `.spec.toolImage: pingcap/br:v9.0.0`, the image of the specified version is used for backup.
280+
- If a BR version is specified, such as `.spec.toolImage: pingcap/br:v8.5.5`, the image of the specified version is used for backup.
281281
- If an image is specified without a version, such as `.spec.toolImage: private/registry/br`, the `private/registry/br:${tikv_version}` image is used for backup.
282282
283283
* `.spec.env`: the environment variables for the Pod that runs the compaction task.
@@ -380,7 +380,7 @@ This section introduces the fields in the `Restore` CR.
380380
* `.spec.gcs`: GCS-related configuration. Refer to [GCS fields](#gcs-fields).
381381
* `.spec.azblob`:Azure Blob Storage-related configuration. Refer to [Azure Blob Storage fields](#azure-blob-storage-fields).
382382
* `.spec.local`: persistent volume-related configuration. Refer to [Local storage fields](#local-storage-fields).
383-
* `.spec.prune`: supported in BR v9.0.0 and later versions. Currently, this field only supports the value `afterFailed`, which enables automatic cleanup of metadata tables when a restore task fails. Refer to [Prune field](#prune-field).
383+
* `.spec.prune`: supported in BR v8.5.5 and later versions. Currently, this field only supports the value `afterFailed`, which enables automatic cleanup of metadata tables when a restore task fails. Refer to [Prune field](#prune-field).
384384
385385
## BackupSchedule CR fields
386386

en/backup-to-aws-s3-using-br.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -539,7 +539,7 @@ In TiDB Operator v1.5.4, v1.6.0, and earlier versions, you can use the `logStop:
539539

540540
### Compact log backup
541541

542-
For TiDB v9.0.0 and later versions, you can use a `CompactBackup` CR to compact log backup data into SST format, accelerating downstream PITR (Point-in-time recovery).
542+
For TiDB v8.5.5 and later versions, you can use a `CompactBackup` CR to compact log backup data into SST format, accelerating downstream PITR (Point-in-time recovery).
543543

544544
This section explains how to compact log backup based on the log backup example from previous sections.
545545

en/backup-to-azblob-using-br.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,7 @@ In TiDB Operator v1.5.4, v1.6.0, and earlier versions, you can use the `logStop:
451451

452452
### Compact log backup
453453

454-
For TiDB v9.0.0 and later versions, you can use a `CompactBackup` CR to compact log backup data into SST format, accelerating downstream PITR (Point-in-time recovery).
454+
For TiDB v8.5.5 and later versions, you can use a `CompactBackup` CR to compact log backup data into SST format, accelerating downstream PITR (Point-in-time recovery).
455455

456456
This section explains how to compact log backup based on the log backup example from previous sections.
457457

en/backup-to-gcs-using-br.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,7 @@ In TiDB Operator v1.5.4, v1.6.0, and earlier versions, you can use the `logStop:
451451

452452
### Compact log backup
453453

454-
For TiDB v9.0.0 and later versions, you can use a `CompactBackup` CR to compact log backup data into SST format, accelerating downstream PITR (Point-in-time recovery).
454+
For TiDB v8.5.5 and later versions, you can use a `CompactBackup` CR to compact log backup data into SST format, accelerating downstream PITR (Point-in-time recovery).
455455

456456
This section explains how to compact log backup based on the log backup example from previous sections.
457457

zh/backup-restore-cr.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -249,15 +249,15 @@ summary: 介绍用于备份与恢复的 Custom Resource (CR) 资源的各字段
249249

250250
### Prune 字段介绍
251251

252-
* `.spec.prune`:仅在 BR v9.0.0 及以上版本中支持。该字段目前仅支持设置为 `afterFailed`,用于在恢复任务失败后自动清理相应的元数据表信息。启用 `prune` 字段会影响恢复任务的终止状态。如果恢复任务以 `Failed` 状态结束,清理任务会自动开始,并尝试清理元数据表信息。根据清理任务的执行状态,恢复任务将显示以下新状态:
252+
* `.spec.prune`:仅在 BR v8.5.5 及以上版本中支持。该字段目前仅支持设置为 `afterFailed`,用于在恢复任务失败后自动清理相应的元数据表信息。启用 `prune` 字段会影响恢复任务的终止状态。如果恢复任务以 `Failed` 状态结束,清理任务会自动开始,并尝试清理元数据表信息。根据清理任务的执行状态,恢复任务将显示以下新状态:
253253
- `PruneScheduled`:清理任务已调度,但尚未开始运行
254254
- `PruneRunning`:清理任务正在运行中
255255
- `PruneComplete`:清理任务已成功完成
256256
- `PruneFailed`:清理任务执行失败
257257

258258
## CompactBackup CR 字段介绍
259259

260-
对于 TiDB v9.0.0 及以上版本的集群,你可以使用 `CompactBackup` 加速日志恢复。要将日志备份数据压缩为结构化 SST 文件,你可以通过创建一个自定义的 `CompactBackup` CR 对象来描述一次备份任务。以下是 `CompactBackup` CR 各个字段的具体含义:
260+
对于 TiDB v8.5.5 及以上版本的集群,你可以使用 `CompactBackup` 加速日志恢复。要将日志备份数据压缩为结构化 SST 文件,你可以通过创建一个自定义的 `CompactBackup` CR 对象来描述一次备份任务。以下是 `CompactBackup` CR 各个字段的具体含义:
261261

262262
* `.spec.startTs`:指定日志压缩备份的起始时间戳。
263263
* `.spec.endTs`:指定日志压缩备份的结束时间戳。
@@ -266,7 +266,7 @@ summary: 介绍用于备份与恢复的 Custom Resource (CR) 资源的各字段
266266
* `.spec.toolImage`:指定 `CompactBackup` 使用的工具镜像。在 `CompactBackup` 中,唯一使用的工具镜像为 BR。使用 BR 备份时,你可以使用该字段指定 BR 的版本:
267267

268268
- 如果未指定或者为空,默认使用镜像 `pingcap/br:${tikv_version}` 进行备份。
269-
- 如果指定了 BR 的版本,例如 `.spec.toolImage: pingcap/br:v9.0.0`,那么使用指定的版本镜像进行备份。
269+
- 如果指定了 BR 的版本,例如 `.spec.toolImage: pingcap/br:v8.5.5`,那么使用指定的版本镜像进行备份。
270270
- 如果指定了镜像但未指定版本,例如 `.spec.toolImage: private/registry/br`,那么使用镜像 `private/registry/br:${tikv_version}` 进行备份。
271271

272272
* `.spec.env`:指定运行压缩备份任务的 Pod 的环境变量信息。
@@ -362,7 +362,7 @@ summary: 介绍用于备份与恢复的 Custom Resource (CR) 资源的各字段
362362
* `.spec.gcs`:GCS 存储相关配置,具体介绍参考 [GCS 字段介绍](#gcs-存储字段介绍)。
363363
* `.spec.azblob`:Azure Blob Storage 存储相关配置,具体介绍参考 [Azure Blob Storage 字段介绍](#azure-blob-storage-存储字段介绍)。
364364
* `.spec.local`:持久卷存储相关配置,具体介绍参考 [Local 字段介绍](#local-存储字段介绍)。
365-
* `.spec.prune`:仅在 BR v9.0.0 及以上版本中支持。该字段目前仅支持设置为 `afterFailed`,用于在恢复任务失败后自动清理相应的元数据表信息,具体介绍参考 [Prune 字段介绍](#prune-字段介绍)。
365+
* `.spec.prune`:仅在 BR v8.5.5 及以上版本中支持。该字段目前仅支持设置为 `afterFailed`,用于在恢复任务失败后自动清理相应的元数据表信息,具体介绍参考 [Prune 字段介绍](#prune-字段介绍)。
366366

367367
## BackupSchedule CR 字段介绍
368368

zh/backup-to-aws-s3-using-br.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -535,7 +535,7 @@ demo1-log-backup-s3 log Stopped ....
535535
536536
### 压缩日志备份
537537
538-
对于 TiDB v9.0.0 及以上版本的集群,你可以使用 `CompactBackup` CR 将日志备份数据压缩为 SST 格式,以加速下游的日志恢复 (Point-in-time recovery, PITR)。
538+
对于 TiDB v8.5.5 及以上版本的集群,你可以使用 `CompactBackup` CR 将日志备份数据压缩为 SST 格式,以加速下游的日志恢复 (Point-in-time recovery, PITR)。
539539
540540
本节基于前文的日志备份示例,介绍如何使用压缩日志备份。
541541

zh/backup-to-azblob-using-br.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,7 @@ demo1-log-backup-azblob log Stopped ....
451451

452452
### 压缩日志备份
453453

454-
对于 TiDB v9.0.0 及以上版本的集群,你可以使用 `CompactBackup` CR 将日志备份数据压缩为 SST 格式,以加速下游的日志恢复 (Point-in-time recovery, PITR)。
454+
对于 TiDB v8.5.5 及以上版本的集群,你可以使用 `CompactBackup` CR 将日志备份数据压缩为 SST 格式,以加速下游的日志恢复 (Point-in-time recovery, PITR)。
455455

456456
本节基于前文的日志备份示例,介绍如何使用压缩日志备份。
457457

zh/backup-to-gcs-using-br.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,7 @@ demo1-log-backup-gcs log Stopped ....
451451
452452
### 压缩日志备份
453453
454-
对于 TiDB v9.0.0 及以上版本的集群,你可以使用 `CompactBackup` CR 将日志备份数据压缩为 SST 格式,以加速下游的日志恢复 (Point-in-time recovery, PITR)。
454+
对于 TiDB v8.5.5 及以上版本的集群,你可以使用 `CompactBackup` CR 将日志备份数据压缩为 SST 格式,以加速下游的日志恢复 (Point-in-time recovery, PITR)。
455455
456456
本节基于前文的日志备份示例,介绍如何使用压缩日志备份。
457457

0 commit comments

Comments
 (0)