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.

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

Update garbage collection docs #4552

Merged
merged 21 commits into from
Mar 17, 2021
Merged

Conversation

morgo
Copy link
Contributor

@morgo morgo commented Dec 30, 2020

First-time contributors' checklist

What is changed, added or deleted? (Required)

This updates the docs for pingcap/tidb#21988 (now merged).

21988 still allows the previous methods for updating, but because these changes are not validated, they should not be recommended. Incorrect configuration can lead to strange behaviors.

Partially address #4549 (for backup page mentioned, there are still other pages that need readability improvements)

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v5.0 (TiDB 5.0 versions)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

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

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@TomShawn TomShawn self-assigned this Dec 31, 2020
@TomShawn TomShawn added size/large Changes of a large size. status/DNM status/PTAL This PR is ready for reviewing. translation/doing This PR's assignee is translating this PR. labels Dec 31, 2020
@TomShawn
Copy link
Contributor

  • Is this PR or will it be applicable to v5.0?
  • Please involve technical reviews.

@MyonKeminta
Copy link
Contributor

Can you keep the document for the old configuration way, but mark it to be unrecommended?

@morgo
Copy link
Contributor Author

morgo commented Jan 6, 2021

Can you keep the document for the old configuration way, but mark it to be unrecommended?

The old method does not validate the settings, so I think it should be discouraged. There is a note on garbage-collection-configuration.md which explains the old method:

In previous releases of TiDB, garbage collection was configured via the mysql.tidb table. While changes to this table continue to be supported, it is recommended to use the system variables provided.

I can change it to use a Note: so it is easier to spot.

@morgo
Copy link
Contributor Author

morgo commented Jan 7, 2021

  • Is this PR or will it be applicable to v5.0?

My understanding is that the TiDB 5.0-rc branch is for the RC only, and 5.0 GA will be based on master. So yes, it will be in v5.0. I am not sure of the docs plan fo banching, since there is now a v5.0 branch. I am not sure how docs plans to handle this though.

  • Please involve technical reviews.

Done.

@morgo
Copy link
Contributor Author

morgo commented Jan 9, 2021

/unlabel status/DNM

@ti-srebot
Copy link
Contributor

@MyonKeminta, @youjiali1995, PTAL.

@ti-srebot
Copy link
Contributor

@MyonKeminta, @youjiali1995, PTAL.

Copy link
Contributor

@MyonKeminta MyonKeminta left a comment

Choose a reason for hiding this comment

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

The modification to the document includes how to prevent GC to use tools safely. But I'm afraid currently those tools will block GC by setting service safepoints automatically, and the manual operations are only needed for old versions, where the variable syntax for GC configurations is not supported. @3pointer @kennytm PTAL, thanks

br/backup-and-restore-tool.md Outdated Show resolved Hide resolved
br/backup-and-restore-use-cases.md Outdated Show resolved Hide resolved
garbage-collection-configuration.md Show resolved Hide resolved
tidb-troubleshooting-map.md Show resolved Hide resolved
@ti-chi-bot ti-chi-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/large Changes of a large size. labels Mar 16, 2021
@morgo
Copy link
Contributor Author

morgo commented Mar 16, 2021

/unlabel status/require-change

@yikeke
Copy link
Contributor

yikeke commented Mar 17, 2021

hi @overvenus if you agree with the tool part of this PR, can you leave a comment "/lgtm" to enable the bot to merge?

@overvenus
Copy link
Member

/lgtm

@ti-chi-bot
Copy link
Member

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • overvenus
  • yikeke

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by writing /lgtm in a comment.
Reviewer can cancel approval by writing /lgtm cancel in a comment.

@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Mar 17, 2021
@yikeke
Copy link
Contributor

yikeke commented Mar 17, 2021

/merge

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: 98f36fc

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Mar 17, 2021
@ti-chi-bot ti-chi-bot merged commit ca331fb into pingcap:master Mar 17, 2021
ti-srebot pushed a commit to ti-srebot/docs that referenced this pull request Mar 17, 2021
@ti-srebot
Copy link
Contributor

cherry pick to release-5.0 in PR #5055

ti-chi-bot pushed a commit that referenced this pull request Mar 24, 2021
@yikeke yikeke added the v5.0 This PR/issue applies to TiDB v5.0. label Mar 24, 2021
@yikeke yikeke assigned qiancai and unassigned TomShawn Mar 24, 2021
@qiancai
Copy link
Collaborator

qiancai commented Apr 1, 2021

/remove-translation doing

@ti-chi-bot ti-chi-bot added missing-translation-status This PR does not have translation status info. and removed translation/doing This PR's assignee is translating this PR. labels Apr 1, 2021
@qiancai
Copy link
Collaborator

qiancai commented Apr 1, 2021

/translation done

@ti-chi-bot ti-chi-bot added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed missing-translation-status This PR does not have translation status info. labels Apr 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. status/require-change Needs the author to address comments. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. v5.0 This PR/issue applies to TiDB v5.0.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants