en, zh: Update description about toolImage field of BR (#1287)

pingcap · Jul 2, 2021 · 38c77a0 · 38c77a0
1 parent 2b802f5
commit 38c77a0
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/en/backup-restore-overview.md b/en/backup-restore-overview.md
@@ -46,8 +46,12 @@ This section introduces the fields in the `Backup` CR.
 
 * `.spec.metadata.namespace`: The namespace where the `Backup` CR is located.
 * `.spec.toolImage`: The tool image used by `Backup`.
-    - When using BR for backup, you can specify the BR version in this field. For example, `.spec.toolImage: pingcap/br:v5.1.0`. If not specified, `pingcap/br:${tikv_version}` is used for backup by default.
-    - When using Dumpling for backup, you can specify the Dumpling version in this field. For example, `spec.toolImage: pingcap/dumpling:v5.1.0`. If not specified, the Dumpling version specified in `TOOLKIT_VERSION` of the [Backup Manager Dockerfile](https://github.com/pingcap/tidb-operator/blob/master/images/tidb-backup-manager/Dockerfile) is used for backup by default.          
+
+    - When using BR for backup, you can specify the BR version in this field.
+        - If the field is not specified or the value is empty, the `pingcap/br:${tikv_version}` image is used for backup by default.
+        - If the BR version is specified in this field, such as `.spec.toolImage: pingcap/br:v5.1.0`, the image of the specified version is used for backup.
+        - If the BR version is not specified in the field, such as `.spec.toolImage: private/registry/br`, the `private/registry/br:${tikv_version}` image is used for backup.
+    - When using Dumpling for backup, you can specify the Dumpling version in this field. For example, `spec.toolImage: pingcap/dumpling:v5.1.0`. If not specified, the Dumpling version specified in `TOOLKIT_VERSION` of the [Backup Manager Dockerfile](https://github.com/pingcap/tidb-operator/blob/master/images/tidb-backup-manager/Dockerfile) is used for backup by default.
     - TiDB Operator supports this configuration starting from v1.1.9.
 * `.spec.tikvGCLifeTime`: The temporary `tikv_gc_life_time` time setting during the backup, which defaults to 72h.
 

diff --git a/zh/backup-restore-overview.md b/zh/backup-restore-overview.md
@@ -44,7 +44,12 @@ TiDB Operator 1.1 及以上版本推荐使用基于 CustomResourceDefinition (CR
 
 * `.spec.metadata.namespace`：`Backup` CR 所在的 namespace。
 * `.spec.toolImage`：用于指定 `Backup` 使用的工具镜像。
-    - 使用 BR 备份时，可以用该字段指定 BR 的版本，例如，`spec.toolImage: pingcap/br:v5.1.0`。如果不指定，默认使用 `pingcap/br:${tikv_version}` 进行备份。
+
+    - 使用 BR 备份时，可以用该字段指定 BR 的版本:
+
+        - 如果未指定或者为空，默认使用镜像 `pingcap/br:${tikv_version}` 进行备份。
+        - 如果指定了 BR 的版本，例如 `.spec.toolImage: pingcap/br:v5.1.0`，那么使用指定的版本镜像进行备份。
+        - 如果指定了镜像但未指定版本，例如 `.spec.toolImage: private/registry/br`，那么使用镜像 `private/registry/br:${tikv_version}` 进行备份。
     - 使用 Dumpling 备份时，可以用该字段指定 Dumpling 的版本，例如， `spec.toolImage: pingcap/dumpling:v5.1.0`。如果不指定，默认使用 [Backup Manager Dockerfile](https://github.com/pingcap/tidb-operator/blob/master/images/tidb-backup-manager/Dockerfile) 文件中 `TOOLKIT_VERSION` 指定的 Dumpling 版本进行备份。           
     - TiDB Operator 从 v1.1.9 版本起支持这项配置。
 * `.spec.tikvGCLifeTime`：备份中的临时 `tikv_gc_life_time` 时间设置，默认为 72h。