Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions en/backup-restore-cr.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,15 +260,15 @@ This section introduces the fields in the `Backup` CR.

### Prune field

* `.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:
* `.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:
* `PruneScheduled`: the cleanup task is scheduled but has not started.
* `PruneRunning`: the cleanup task is running.
* `PruneComplete`: the cleanup task completed successfully.
* `PruneFailed`: the cleanup task failed.

## CompactBackup CR fields

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:
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:

* `.spec.startTs`: the start timestamp for log compaction backup.
* `.spec.endTs`: the end timestamp for log compaction backup.
Expand All @@ -277,7 +277,7 @@ For TiDB v9.0.0 and later versions, you can use `CompactBackup` to accelerate PI
* `.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:

- If not specified or left empty, the `pingcap/br:${tikv_version}` image is used for backup by default.
- 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.
- 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.
- 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.

* `.spec.env`: the environment variables for the Pod that runs the compaction task.
Expand Down Expand Up @@ -380,7 +380,7 @@ This section introduces the fields in the `Restore` CR.
* `.spec.gcs`: GCS-related configuration. Refer to [GCS fields](#gcs-fields).
* `.spec.azblob`:Azure Blob Storage-related configuration. Refer to [Azure Blob Storage fields](#azure-blob-storage-fields).
* `.spec.local`: persistent volume-related configuration. Refer to [Local storage fields](#local-storage-fields).
* `.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).
* `.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).

## BackupSchedule CR fields

Expand Down
2 changes: 1 addition & 1 deletion en/backup-to-aws-s3-using-br.md
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@ In TiDB Operator v1.5.4, v1.6.0, and earlier versions, you can use the `logStop:

### Compact log backup

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).
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).

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

Expand Down
2 changes: 1 addition & 1 deletion en/backup-to-azblob-using-br.md
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@ In TiDB Operator v1.5.4, v1.6.0, and earlier versions, you can use the `logStop:

### Compact log backup

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).
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).

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

Expand Down
2 changes: 1 addition & 1 deletion en/backup-to-gcs-using-br.md
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@ In TiDB Operator v1.5.4, v1.6.0, and earlier versions, you can use the `logStop:

### Compact log backup

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).
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).

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

Expand Down
8 changes: 4 additions & 4 deletions zh/backup-restore-cr.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,15 +249,15 @@ summary: 介绍用于备份与恢复的 Custom Resource (CR) 资源的各字段

### Prune 字段介绍

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

## CompactBackup CR 字段介绍

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

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

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

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

## BackupSchedule CR 字段介绍

Expand Down
2 changes: 1 addition & 1 deletion zh/backup-to-aws-s3-using-br.md
Original file line number Diff line number Diff line change
Expand Up @@ -535,7 +535,7 @@ demo1-log-backup-s3 log Stopped ....

### 压缩日志备份

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

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

Expand Down
2 changes: 1 addition & 1 deletion zh/backup-to-azblob-using-br.md
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@ demo1-log-backup-azblob log Stopped ....

### 压缩日志备份

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

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

Expand Down
2 changes: 1 addition & 1 deletion zh/backup-to-gcs-using-br.md
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@ demo1-log-backup-gcs log Stopped ....

### 压缩日志备份

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

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

Expand Down