Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

zh: update mydumper backup docs #273

Merged
merged 7 commits into from
May 15, 2020
Merged

zh: update mydumper backup docs #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b23066b
update mydumper backup docs
May 12, 2020
b89088b
Merge remote-tracking branch 'upstream/master' into update-backup-docs
May 12, 2020
cb5a51e
fix CI
May 14, 2020
96e616e
Merge remote-tracking branch 'upstream/master' into update-backup-docs
May 14, 2020
674f479
Merge branch 'master' into update-backup-docs
DanielZhangQD May 14, 2020
4304a81
Apply suggestions from code review
ran-huang May 15, 2020
e5ad721
Merge branch 'master' into update-backup-docs
ran-huang May 15, 2020
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
37 changes: 37 additions & 0 deletions zh/backup-to-gcs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,21 @@ spec:
gcs:
secretName: gcs-secret
projectId: ${project_id}
bucket: ${bucket}
# prefix: ${prefix}
# location: us-east1
# storageClass: STANDARD_IA
# objectAcl: private
# bucketAcl: private
# mydumper:
# options:
# - --tidb-force-priority=LOW_PRIORITY
# - --long-query-guard=3600
# - --threads=16
# - --rows=10000
# - --skip-tz-utc
# - --verbose=3
# tableRegex: "^test"
storageClassName: local-storage
storageSize: 10Gi
```
Expand Down Expand Up @@ -128,6 +139,21 @@ GCS 支持以下几种 bucket ACL 策略：
* `.spec.from.port`：待备份 TiDB 集群的访问端口。
* `.spec.from.user`：待备份 TiDB 集群的访问用户。
* `.spec.from.tidbSecretName`：待备份 TiDB 集群所需凭证的 secret。
* `.spec.gcs.bucket`：存储数据的 bucket 名字。
* `.spec.gcs.prefix`：这个字段可以省略，如果设置了这个字段，则会使用这个字段来拼接在远端存储的存储路径 `s3://${.spec.s3.bucket}/${.spec.s3.prefix}/backupName`。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@onlymellb s3://${.spec.s3.bucket}/${.spec.s3.prefix}/backupName 里并没有出现 .spec.gcs.prefix 这个字段哦，是不是写错了呢？

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in #327

* `.spec.mydumper`：Mydumper 相关的配置，主要有两个字段：一个是 [`options`](https://pingcap.com/docs-cn/stable/reference/tools/mydumper/) 字段，里面可以指定 mydumper 需要的一些参数；一个是 `tableRegex` 字段，可以指定让 Mydumper 备份符合这个正则表达式的表。默认情况下 Mydumper 这个字段可以不用配置。当不指定 Mydumper 的配置时，`options` 和 `tableRegex` 字段的默认值如下：

```
options:
--tidb-force-priority=LOW_PRIORITY
--long-query-guard=3600
--threads=16
--rows=10000
--skip-tz-utc
--verbose=3
tableRegex: "^(?!(mysql|test|INFORMATION_SCHEMA|PERFORMANCE_SCHEMA|METRICS_SCHEMA|INSPECTION_SCHEMA))"
```

* `.spec.storageClassName`：备份时指定所需的 persistent volume (PV) 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值，该值默认为 `standard`。
* `.spec.storageSize`：备份时指定所需的 PV 大小。该值应大于备份 TiDB 集群数据的大小。

Expand Down Expand Up @@ -172,10 +198,21 @@ spec:
gcs:
secretName: gcs-secret
projectId: ${project_id}
bucket: ${bucket}
# prefix: ${prefix}
# location: us-east1
# storageClass: STANDARD_IA
# objectAcl: private
# bucketAcl: private
# mydumper:
# options:
# - --tidb-force-priority=LOW_PRIORITY
# - --long-query-guard=3600
# - --threads=16
# - --rows=10000
# - --skip-tz-utc
# - --verbose=3
# tableRegex: "^test"
storageClassName: local-storage
storageSize: 10Gi
```
Expand Down
102 changes: 98 additions & 4 deletions zh/backup-to-s3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,19 @@ Ad-hoc 全量备份通过创建一个自定义的 `Backup` custom resource (CR)
secretName: s3-secret
region: ${region}
bucket: ${bucket}
# prefix: ${prefix}
# storageClass: STANDARD_IA
# acl: private
# endpoint:
# mydumper:
# options:
# - --tidb-force-priority=LOW_PRIORITY
# - --long-query-guard=3600
# - --threads=16
# - --rows=10000
# - --skip-tz-utc
# - --verbose=3
# tableRegex: "^test"
storageClassName: local-storage
storageSize: 10Gi
```
Expand Down Expand Up @@ -101,7 +111,17 @@ Ad-hoc 全量备份通过创建一个自定义的 `Backup` custom resource (CR)
provider: ceph
secretName: s3-secret
endpoint: ${endpoint}
# prefix: ${prefix}
bucket: ${bucket}
# mydumper:
# options:
# - --tidb-force-priority=LOW_PRIORITY
# - --long-query-guard=3600
# - --threads=16
# - --rows=10000
# - --skip-tz-utc
# - --verbose=3
# tableRegex: "^test"
storageClassName: local-storage
storageSize: 10Gi
```
Expand Down Expand Up @@ -136,9 +156,19 @@ Ad-hoc 全量备份通过创建一个自定义的 `Backup` custom resource (CR)
provider: aws
region: ${region}
bucket: ${bucket}
# prefix: ${prefix}
# storageClass: STANDARD_IA
# acl: private
# endpoint:
# mydumper:
# options:
# - --tidb-force-priority=LOW_PRIORITY
# - --long-query-guard=3600
# - --threads=16
# - --rows=10000
# - --skip-tz-utc
# - --verbose=3
# tableRegex: "^test"
storageClassName: local-storage
storageSize: 10Gi
```
Expand Down Expand Up @@ -172,9 +202,19 @@ Ad-hoc 全量备份通过创建一个自定义的 `Backup` custom resource (CR)
provider: aws
region: ${region}
bucket: ${bucket}
# prefix: ${prefix}
# storageClass: STANDARD_IA
# acl: private
# endpoint:
# mydumper:
# options:
# - --tidb-force-priority=LOW_PRIORITY
# - --long-query-guard=3600
# - --threads=16
# - --rows=10000
# - --skip-tz-utc
# - --verbose=3
# tableRegex: "^test"
storageClassName: local-storage
storageSize: 10Gi
```
Expand Down Expand Up @@ -218,10 +258,24 @@ Amazon S3 支持以下几种 `storageClass` 类型：
* `.spec.from.port`：待备份 TiDB 集群的访问端口。
* `.spec.from.user`：待备份 TiDB 集群的访问用户。
* `.spec.from.secretName`：存储 `.spec.from.user` 用户的密码的 secret。
* `.spec.s3.region`: 使用 Amazon S3 存储备份，需要配置 Amazon S3 所在的 region。
* `.spec.s3.bucket`: 兼容 S3 存储的 bucket 名字。
* `.spec.storageClassName`: 备份时所需的 persistent volume (PV) 类型。
* `.spec.storageSize`: 备份时指定所需的 PV 大小。该值须大于 TiDB 集群备份的数据大小。
* `.spec.s3.region`：使用 Amazon S3 存储备份，需要配置 Amazon S3 所在的 region。
* `.spec.s3.bucket`：兼容 S3 存储的 bucket 名字。
* `.spec.s3.prefix`：这个字段可以省略，如果设置了这个字段，则会使用这个字段来拼接在远端存储的存储路径 `s3://${.spec.s3.bucket}/${.spec.s3.prefix}/backupName`。
* `.spec.mydumper`：Mydumper 相关的配置，主要有两个字段：一个是 [`options`](https://pingcap.com/docs-cn/stable/reference/tools/mydumper/) 字段，里面可以指定 Mydumper 需要的一些参数；一个是 `tableRegex` 字段，可以指定让 Mydumper 备份符合这个正则表达式的表。默认情况下 Mydumper 这个字段可以不用配置。当不指定 Mydumper 的配置时，`options` 和 `tableRegex` 字段的默认值如下：

```
options:
--tidb-force-priority=LOW_PRIORITY
--long-query-guard=3600
--threads=16
--rows=10000
--skip-tz-utc
--verbose=3
tableRegex: "^(?!(mysql|test|INFORMATION_SCHEMA|PERFORMANCE_SCHEMA|METRICS_SCHEMA|INSPECTION_SCHEMA))"
```

* `.spec.storageClassName`：备份时所需的 persistent volume (PV) 类型。
* `.spec.storageSize`：备份时指定所需的 PV 大小。该值须大于 TiDB 集群备份的数据大小。

更多支持的兼容 S3 的 `provider` 如下：

Expand Down Expand Up @@ -292,9 +346,19 @@ Amazon S3 支持以下几种 `storageClass` 类型：
secretName: s3-secret
region: ${region}
bucket: ${bucket}
# prefix: ${prefix}
# storageClass: STANDARD_IA
# acl: private
# endpoint:
# mydumper:
# options:
# - --tidb-force-priority=LOW_PRIORITY
# - --long-query-guard=3600
# - --threads=16
# - --rows=10000
# - --skip-tz-utc
# - --verbose=3
# tableRegex: "^test"
storageClassName: local-storage
storageSize: 10Gi
```
Expand Down Expand Up @@ -332,6 +396,16 @@ Amazon S3 支持以下几种 `storageClass` 类型：
secretName: s3-secret
endpoint: ${endpoint}
bucket: ${bucket}
# prefix: ${prefix}
# mydumper:
# options:
# - --tidb-force-priority=LOW_PRIORITY
# - --long-query-guard=3600
# - --threads=16
# - --rows=10000
# - --skip-tz-utc
# - --verbose=3
# tableRegex: "^test"
storageClassName: local-storage
storageSize: 10Gi
```
Expand Down Expand Up @@ -370,9 +444,19 @@ Amazon S3 支持以下几种 `storageClass` 类型：
provider: aws
region: ${region}
bucket: ${bucket}
# prefix: ${prefix}
# storageClass: STANDARD_IA
# acl: private
# endpoint:
# mydumper:
# options:
# - --tidb-force-priority=LOW_PRIORITY
# - --long-query-guard=3600
# - --threads=16
# - --rows=10000
# - --skip-tz-utc
# - --verbose=3
# tableRegex: "^test"
storageClassName: local-storage
storageSize: 10Gi
```
Expand Down Expand Up @@ -410,9 +494,19 @@ Amazon S3 支持以下几种 `storageClass` 类型：
provider: aws
region: ${region}
bucket: ${bucket}
# prefix: ${prefix}
# storageClass: STANDARD_IA
# acl: private
# endpoint:
# mydumper:
# options:
# - --tidb-force-priority=LOW_PRIORITY
# - --long-query-guard=3600
# - --threads=16
# - --rows=10000
# - --skip-tz-utc
# - --verbose=3
# tableRegex: "^test"
storageClassName: local-storage
storageSize: 10Gi

Expand Down