Skip to content

Commit

Permalink
zh/: update br usage documents for aws and gcs (#713)
Browse files Browse the repository at this point in the history
  • Loading branch information
lichunzhu authored Sep 19, 2020
1 parent c614ed9 commit 4a33b3c
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 1 deletion.
12 changes: 12 additions & 0 deletions zh/backup-to-aws-s3-using-br.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,18 @@ kubectl get bk -n test1 -o wide
- "!db.table"
```
以上示例中,`.spec.br` 中的一些参数项均可省略,如 `logLevel``statusAddr``concurrency``rateLimit``checksum``timeAgo``sendCredToTikv`
* `.spec.br.cluster`:代表需要备份的集群名字。
* `.spec.br.clusterNamespace`:代表需要备份的集群所在的 `namespace`
* `.spec.br.logLevel`:代表日志的级别。默认为 `info`
* `.spec.br.statusAddr`:为 BR 进程监听一个进程状态的 HTTP 端口,方便用户调试。如果不填,则默认不监听。
* `.spec.br.concurrency`:备份时每一个 TiKV 进程使用的线程数。备份时默认为 4,恢复时默认为 128。
* `.spec.br.rateLimit`:是否对流量进行限制。单位为 MB/s,例如设置为 `4` 代表限速 4 MB/s,默认不限速。
* `.spec.br.checksum`:是否在备份结束之后对文件进行验证。默认为 `true`
* `.spec.br.timeAgo`:备份 timeAgo 以前的数据,默认为空(备份当前数据),[支持](https://golang.org/pkg/time/#ParseDuration) "1.5h", "2h45m" 等数据。
* `.spec.br.sendCredToTikv`:BR 进程是否将自己的 GCP 权限传输给 TiKV 进程。默认为 `true`
更多支持的兼容 S3 的 `provider` 如下:
* `alibaba`:Alibaba Cloud Object Storage System (OSS) formerly Aliyun
Expand Down
3 changes: 2 additions & 1 deletion zh/backup-to-gcs-using-br.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Ad-hoc 全量备份通过创建一个自定义的 `Backup` custom resource (CR)
# objectAcl: private
```

以上示例中,`spec.br` 中的一些参数项均可省略,如 `logLevel``statusAddr``concurrency``rateLimit``checksum``sendCredToTikv`
以上示例中,`spec.br` 中的一些参数项均可省略,如 `logLevel``statusAddr``concurrency``rateLimit``checksum``timeAgo``sendCredToTikv`

部分参数的含义如下:

Expand All @@ -104,6 +104,7 @@ Ad-hoc 全量备份通过创建一个自定义的 `Backup` custom resource (CR)
- `spec.br.concurrency`:备份时每一个 TiKV 进程使用的线程数。备份时默认为 4,恢复时默认为 128。
- `spec.br.rateLimit`:是否对流量进行限制。单位为 MB/s,例如设置为 `4` 代表限速 4 MB/s,默认不限速。
- `spec.br.checksum`:是否在备份结束之后对文件进行验证。默认为 `true`
- `spec.br.timeAgo`:备份 timeAgo 以前的数据,默认为空(备份当前数据),[支持](https://golang.org/pkg/time/#ParseDuration) "1.5h", "2h45m" 等数据。
- `spec.br.sendCredToTikv`:BR 进程是否将自己的 GCP 权限传输给 TiKV 进程。默认为 `true`

该示例将 TiDB 集群的数据全量导出备份到 GCS。`spec.gcs` 中的一些参数项均可省略,如 `location``objectAcl``storageClass`
Expand Down
12 changes: 12 additions & 0 deletions zh/restore-from-aws-s3-using-br.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,18 @@ kubectl get rt -n test2 -o wide
- "!db.table"
```

以上示例中,`.spec.br` 中的一些参数项均可省略,如 `logLevel``statusAddr``concurrency``rateLimit``checksum``timeAgo``sendCredToTikv`

* `.spec.br.cluster`:代表需要备份的集群名字。
* `.spec.br.clusterNamespace`:代表需要备份的集群所在的 `namespace`
* `.spec.br.logLevel`:代表日志的级别。默认为 `info`
* `.spec.br.statusAddr`:为 BR 进程监听一个进程状态的 HTTP 端口,方便用户调试。如果不填,则默认不监听。
* `.spec.br.concurrency`:备份时每一个 TiKV 进程使用的线程数。备份时默认为 4,恢复时默认为 128。
* `.spec.br.rateLimit`:是否对流量进行限制。单位为 MB/s,例如设置为 `4` 代表限速 4 MB/s,默认不限速。
* `.spec.br.checksum`:是否在备份结束之后对文件进行验证。默认为 `true`
* `.spec.br.timeAgo`:备份 timeAgo 以前的数据,默认为空(备份当前数据),[支持](https://golang.org/pkg/time/#ParseDuration) "1.5h", "2h45m" 等数据。
* `.spec.br.sendCredToTikv`:BR 进程是否将自己的 GCP 权限传输给 TiKV 进程。默认为 `true`

## 故障诊断

在使用过程中如果遇到问题,可以参考[故障诊断](deploy-failures.md)。
12 changes: 12 additions & 0 deletions zh/restore-from-gcs-using-br.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,18 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/restore-from-gcs-using-br/']
- "!db.table"
```

以上示例中,`.spec.br` 中的一些参数项均可省略,如 `logLevel``statusAddr``concurrency``rateLimit``checksum``timeAgo``sendCredToTikv`

* `.spec.br.cluster`:代表需要备份的集群名字。
* `.spec.br.clusterNamespace`:代表需要备份的集群所在的 `namespace`
* `.spec.br.logLevel`:代表日志的级别。默认为 `info`
* `.spec.br.statusAddr`:为 BR 进程监听一个进程状态的 HTTP 端口,方便用户调试。如果不填,则默认不监听。
* `.spec.br.concurrency`:备份时每一个 TiKV 进程使用的线程数。备份时默认为 4,恢复时默认为 128。
* `.spec.br.rateLimit`:是否对流量进行限制。单位为 MB/s,例如设置为 `4` 代表限速 4 MB/s,默认不限速。
* `.spec.br.checksum`:是否在备份结束之后对文件进行验证。默认为 `true`
* `.spec.br.timeAgo`:备份 timeAgo 以前的数据,默认为空(备份当前数据),[支持](https://golang.org/pkg/time/#ParseDuration) "1.5h", "2h45m" 等数据。
* `.spec.br.sendCredToTikv`:BR 进程是否将自己的 GCP 权限传输给 TiKV 进程。默认为 `true`

## 故障诊断

在使用过程中如果遇到问题,可以参考[故障诊断](deploy-failures.md)。

0 comments on commit 4a33b3c

Please sign in to comment.