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

Refine backup and restore documentation #518

Merged
merged 15 commits into from
Jun 2, 2019
Merged

Refine backup and restore documentation #518

merged 15 commits into from
Jun 2, 2019

Conversation

aylei
Copy link
Contributor

@aylei aylei commented May 24, 2019 •
edited
Loading

What problem does this PR solve?

More documentations!😆
Besides, for better user experience:

  • the adhoc backup name is generated according to the date now.
  • add the cluster name label for both adhoc-backup PVC and scheduled-backup PVC, in order to filter them easily.

Check List

  • Manual Test 👌

Code changes

  • Has Helm charts change
  • Has documents change

Does this PR introduce a user-facing change?:

Adhoc backup now appends the start time to the PVC name by default.

Preview: https://github.com/aylei/tidb-operator/blob/backup-doc/docs/backup-restore.md
@tennix @weekface @xiaojingchen @lilin90 PTAL

@aylei
Refine backup and restore documentation
59c9e4b 
Signed-off-by: Aylei <rayingecho@gmail.com>
@aylei aylei mentioned this pull request May 24, 2019
Closed
@aylei aylei added the area/doc label May 24, 2019
@aylei
Copy link
Contributor Author

aylei commented May 24, 2019

@tennix @weekface Is there anything missing according to your experience in using backup in production environment?

tennix
tennix reviewed May 24, 2019
View reviewed changes
docs/backup-restore.md Outdated Show resolved Hide resolved
docs/backup-restore.md Outdated Show resolved Hide resolved
@aylei
Fix dead link
bb00067 
Signed-off-by: Aylei <rayingecho@gmail.com>
lilin90
lilin90 reviewed May 24, 2019
View reviewed changes
Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

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

Many language or format suggestions, and some questions. Please check, update and reply. Any questions about my suggestions, feel free to contact me. Thanks!

docs/backup-restore.md Outdated Show resolved Hide resolved
docs/backup-restore.md Show resolved Hide resolved
docs/backup-restore.md Outdated Show resolved Hide resolved
docs/backup-restore.md Outdated Show resolved Hide resolved
docs/backup-restore.md Outdated Show resolved Hide resolved
docs/references/tidb-backup-configuration.md Outdated Show resolved Hide resolved
docs/references/tidb-backup-configuration.md Outdated Show resolved Hide resolved
docs/references/tidb-backup-configuration.md Outdated Show resolved Hide resolved
docs/references/tidb-backup-configuration.md Outdated Show resolved Hide resolved
docs/references/tidb-backup-configuration.md Outdated Show resolved Hide resolved
weekface
weekface reviewed May 24, 2019
View reviewed changes
docs/backup-restore.md Outdated Show resolved Hide resolved
@aylei
Copy link
Contributor Author

aylei commented May 25, 2019

@weekface @lilin90 Thanks for your patient review, I will fix these issues soon

aylei and others added 9 commits May 27, 2019 09:40
@aylei @lilin90
Update docs/backup-restore.md
1fb922a 
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
@aylei @lilin90
Update docs/backup-restore.md
dd1cf84 
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
@aylei @lilin90
Update docs/backup-restore.md
7748702 
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
@aylei @lilin90
Update docs/backup-restore.md
9039a0d 
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
@aylei @lilin90
Update docs/backup-restore.md
d0c7fba 
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
@aylei @lilin90
Update docs/backup-restore.md
44711f2 
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
@aylei @lilin90
Update docs/backup-restore.md
7a53ad3 
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
@aylei @lilin90
Update docs/backup-restore.md
630237c 
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
@aylei
Refine backup documents
0176ac7 
Signed-off-by: Aylei <rayingecho@gmail.com>
@aylei
Fix code block indention
97562d1 
Signed-off-by: Aylei <rayingecho@gmail.com>
@aylei aylei requested review from weekface and tennix and removed request for weekface May 30, 2019 07:23
@aylei aylei requested review from weekface, lilin90 and tennix and removed request for tennix and lilin90 May 30, 2019 07:23
@aylei
Copy link
Contributor Author

aylei commented May 30, 2019

I've made some updates based on the feedbacks (thanks!), @lilin90 @weekface @tennix could you please take a look again?

tennix
tennix approved these changes Jun 2, 2019
View reviewed changes
Copy link
Member

@tennix tennix left a comment

Choose a reason for hiding this comment

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

LGTM

@tennix tennix merged commit 8a110da into pingcap:master Jun 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tennix tennix tennix approved these changes

@weekface weekface weekface approved these changes

@xiaojingchen xiaojingchen Awaiting requested review from xiaojingchen

@lilin90 lilin90 Awaiting requested review from lilin90

Assignees
No one assigned
Labels
area/doc
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@aylei @weekface @tennix @lilin90