Skip to content

reference/tools: add a BR tool doc#2020

Merged
TomShawn merged 38 commits into
pingcap:masterfrom
overvenus:br
Nov 25, 2019
Merged

reference/tools: add a BR tool doc#2020
TomShawn merged 38 commits into
pingcap:masterfrom
overvenus:br

Conversation

@overvenus
Copy link
Copy Markdown
Member

@overvenus overvenus commented Nov 7, 2019

What is changed, added or deleted?

Add the backup/restore tool (BR) document.

What is the related PR or file link(s)?

N/A

Which version does your change affect?

3.1/dev

Note: This PR is working in progress since BR is still under heavy development.

@overvenus
Add br doc
ebb3aaf 
Signed-off-by: Neil Shen <overvenus@gmail.com>
@overvenus overvenus added the dev label Nov 7, 2019
@overvenus
address lint
1dd8593 
Signed-off-by: Neil Shen <overvenus@gmail.com>
@lilin90 lilin90 requested a review from TomShawn November 8, 2019 02:58
@lilin90 lilin90 added the translation/doing This PR’s assignee is translating this PR. label Nov 8, 2019
@lilin90 lilin90 changed the title Add br doc reference/tools: add a BR doc Nov 8, 2019
@lilin90 lilin90 changed the title reference/tools: add a BR doc reference/tools: add a BR tool doc Nov 8, 2019
@lilin90
Copy link
Copy Markdown
Member

lilin90 commented Nov 8, 2019 •
edited
Loading

@TomShawn Please help review the language and organization. Note that some necessary content or description might be missing. Please review to help make it user-friendly. Thanks!

@TomShawn TomShawn added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. translation/doing This PR’s assignee is translating this PR. and removed translation/doing This PR’s assignee is translating this PR. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. labels Nov 8, 2019
@TomShawn
Copy link
Copy Markdown
Contributor

TomShawn commented Nov 8, 2019

@TomShawn Please help review the language and organization. Note that some necessary content or description might be missing. Please review to help make it user-friendly. Thanks!

OK.

@lilin90 lilin90 added the v3.1 label Nov 8, 2019
IANTHEREAL
IANTHEREAL reviewed Nov 8, 2019
View reviewed changes
Comment thread dev/reference/tools/br.md Outdated
IANTHEREAL
IANTHEREAL reviewed Nov 8, 2019
View reviewed changes
Comment thread dev/reference/tools/br.md Outdated
IANTHEREAL
IANTHEREAL reviewed Nov 8, 2019
View reviewed changes
Comment thread dev/reference/tools/br.md Outdated
IANTHEREAL
IANTHEREAL reviewed Nov 8, 2019
View reviewed changes
Comment thread dev/reference/tools/br.md Outdated
IANTHEREAL
IANTHEREAL reviewed Nov 8, 2019
View reviewed changes
Comment thread dev/reference/tools/br.md Outdated
IANTHEREAL
IANTHEREAL reviewed Nov 8, 2019
View reviewed changes
Comment thread dev/reference/tools/br.md Outdated
IANTHEREAL
IANTHEREAL reviewed Nov 8, 2019
View reviewed changes
Comment thread dev/reference/tools/br.md Outdated
IANTHEREAL
IANTHEREAL reviewed Nov 8, 2019
View reviewed changes
Comment thread dev/reference/tools/br.md Outdated
TomShawn and others added 4 commits November 11, 2019 10:16
@TomShawn
Merge branch 'master' into br
aadc75e
@overvenus
address comments
bbdf0c2 
Signed-off-by: Neil Shen <overvenus@gmail.com>
@overvenus
explain restore concurrency
a897164 
Signed-off-by: Neil Shen <overvenus@gmail.com>
@TomShawn
Merge branch 'master' into br
cbf0000
@TomShawn
Copy link
Copy Markdown
Contributor

TomShawn commented Nov 11, 2019

@GregoryIan PTAL again, thanks.

overvenus and others added 3 commits November 21, 2019 14:00
@overvenus
remove --connect
8cbe1b5 
Signed-off-by: Neil Shen <overvenus@gmail.com>
@overvenus
Merge branch 'br' of github.com:overvenus/docs-cn into br
887d03c 
Signed-off-by: Neil Shen <overvenus@gmail.com>
@TomShawn
Merge branch 'master' into br
412b383
@IANTHEREAL
Copy link
Copy Markdown
Contributor

IANTHEREAL commented Nov 25, 2019

can we merge this pr now? @TomShawn @overvenus

@lilin90
Copy link
Copy Markdown
Member

lilin90 commented Nov 25, 2019

@overvenus Please address the unresolved comments. @TomShawn PTAL, help to improve wording, and add aliases.

TomShawn
TomShawn reviewed Nov 25, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@TomShawn TomShawn left a comment

Choose a reason for hiding this comment

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

Rest LGMT.
Please address all comments and update v3.1.

Comment thread dev/how-to/maintain/backup-and-restore/mydumper-loader.md Outdated
Comment thread dev/how-to/maintain/backup-and-restore/br.md
Comment thread dev/how-to/maintain/backup-and-restore/br.md
@IANTHEREAL
Copy link
Copy Markdown
Contributor

IANTHEREAL commented Nov 25, 2019

Thanks @TomShawn

@TomShawn
Copy link
Copy Markdown
Contributor

TomShawn commented Nov 25, 2019

@kennytm @DanielZhangQD PLAT again, Thanks.

DanielZhangQD
DanielZhangQD reviewed Nov 25, 2019
View reviewed changes
Comment thread dev/how-to/maintain/backup-and-restore/br.md Outdated
BR 还包含以下三个子命令：

* `full`：可用于备份或恢复全部数据。
* `db`：可用于备份或恢复集群中的指定数据库。
Copy link
Copy Markdown
Contributor

@DanielZhangQD DanielZhangQD Nov 25, 2019

Choose a reason for hiding this comment

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

db is not supported yet.

Comment thread dev/how-to/maintain/backup-and-restore/br.md Outdated
--log-file backupfull.log
```

以上命令通过 `--ratelimit` 和 `--concurrency` 选项限制了 **每个 TiKV** 执行备份任务的并发数上限和速度上限，同时把 BR 的 log 写到 `backupfull.log` 文件中。
Copy link
Copy Markdown
Contributor

@DanielZhangQD DanielZhangQD Nov 25, 2019

Choose a reason for hiding this comment

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

Suggested change
以上命令通过 `--ratelimit` 和 `--concurrency` 选项限制了 **每个 TiKV** 执行备份任务的并发数上限和速度上限，同时把 BR 的 log 写到 `backupfull.log` 文件中。
以上命令通过 `--ratelimit` 和 `--concurrency` 选项限制了 **每个 TiKV** 执行备份任务的速度上限和并发数上限，同时把 BR 的 log 写到 `backupfull.log` 文件中。

Comment thread dev/how-to/maintain/backup-and-restore/br.md Outdated
## 注意事项

- BR 只支持 TiDB 3.1 版本及以上。
- 如果在没有网络存储的集群上备份，在恢复前需要将所有备份下来的 SST 文件拷贝到各个 TiKV 节点上。
Copy link
Copy Markdown
Contributor

@DanielZhangQD DanielZhangQD Nov 25, 2019

Choose a reason for hiding this comment

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

Suggested change
- 如果在没有网络存储的集群上备份，在恢复前需要将所有备份下来的 SST 文件拷贝到各个 TiKV 节点上。
- 如果在没有网络存储的集群上备份，在恢复前需要将所有备份下来的 SST 文件拷贝到各个 TiKV 节点上 --storage 指定的目录下。

jebter
jebter reviewed Nov 25, 2019
View reviewed changes
Comment thread dev/how-to/maintain/backup-and-restore/br.md Outdated
--log-file backupfull.log
```

以上命令通过 `--ratelimit` 和 `--concurrency` 选项限制了 **每个 TiKV** 执行备份任务的并发数上限和速度上限，同时把 BR 的 log 写到 `backupfull.log` 文件中。
Copy link
Copy Markdown
Contributor

@jebter jebter Nov 25, 2019

Choose a reason for hiding this comment

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

并发数上限和速度上限-->速度上限和并发数上限

jebter
jebter approved these changes Nov 25, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@jebter jebter left a comment

Choose a reason for hiding this comment

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

LGTM

kennytm
kennytm reviewed Nov 25, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@kennytm kennytm left a comment

Choose a reason for hiding this comment

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

Rest LGTM

Comment thread dev/TOC.md Outdated
Comment thread dev/how-to/maintain/backup-and-restore/mydumper-loader.md Outdated
Comment thread dev/how-to/maintain/backup-and-restore/br.md Outdated
Comment thread dev/how-to/maintain/backup-and-restore/br.md Outdated
Comment thread dev/how-to/maintain/backup-and-restore/br.md Outdated
Comment thread dev/how-to/maintain/backup-and-restore/br.md Outdated
Comment thread dev/how-to/maintain/backup-and-restore/br.md Outdated
Comment thread dev/how-to/maintain/backup-and-restore/br.md Outdated
Comment thread dev/how-to/maintain/backup-and-restore/br.md Outdated
Comment thread dev/how-to/maintain/backup-and-restore/br.md Outdated
@overvenus
Address comments
ea2d13d 
Signed-off-by: Neil Shen <overvenus@gmail.com>
kennytm
kennytm reviewed Nov 25, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@kennytm kennytm left a comment

Choose a reason for hiding this comment

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

LGTM

DanielZhangQD
DanielZhangQD approved these changes Nov 25, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@DanielZhangQD DanielZhangQD left a comment

Choose a reason for hiding this comment

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

LGTM

TomShawn
TomShawn approved these changes Nov 25, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@TomShawn TomShawn left a comment

Choose a reason for hiding this comment

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

LGTM

@TomShawn TomShawn merged commit 8dc9dcb into pingcap:master Nov 25, 2019
@overvenus overvenus deleted the br branch November 25, 2019 12:16
@lilin90 lilin90 added priority/P1 The issue has P1 priority. size/large Changes of a large size. labels Nov 26, 2019
@TomShawn TomShawn added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Nov 29, 2019
@TomShawn TomShawn mentioned this pull request Nov 29, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kennytm kennytm kennytm left review comments

@3pointer 3pointer 3pointer left review comments

@IANTHEREAL IANTHEREAL IANTHEREAL left review comments

@jebter jebter jebter approved these changes

+4 more reviewers

@scsldb scsldb scsldb left review comments

@lichunzhu lichunzhu lichunzhu left review comments

@DanielZhangQD DanielZhangQD DanielZhangQD approved these changes

@TomShawn TomShawn TomShawn approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@TomShawn TomShawn

Labels

priority/P1 The issue has P1 priority. size/large Changes of a large size. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.