pd: complement pd section (#21204) #21212
Conversation
Signed-off-by: ti-chi-bot <[email protected]>
ti-chi-bot
added
do-not-merge/hold
|
@qiancai This PR has conflicts, I have hold it. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ti-chi-bot, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request aims to update and complement the existing documentation for TiDB's Placement Driver (PD) configuration. It primarily introduces a comprehensive set of new dynamic configuration parameters to the dynamic-config.md file and provides detailed explanations for specific new parameters, such as max-movable-hot-peer-size, in pd-configuration-file.md. The changes ensure the PD documentation is current and provides users with complete information on available settings.
Highlights
- Documentation Update: Added a significant number of new dynamic configuration parameters for the Placement Driver (PD) to
dynamic-config.md, ensuring the documentation reflects the latest available settings. - New Configuration Detail: Provided a detailed explanation for the
schedule.max-movable-hot-peer-sizeparameter inpd-configuration-file.md, including its purpose, default value, and unit. - Wording Improvement: Refined the description for
schedule.patrol-region-intervalindynamic-config.mdfor improved clarity.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request adds several new PD configuration items to dynamic-config.md and details for max-movable-hot-peer-size to pd-configuration-file.md. The changes enhance documentation completeness.
A critical issue with merge conflict markers in dynamic-config.md needs to be resolved. A minor punctuation suggestion is also provided for consistency. Once these are addressed, the PR will be a good addition.
| | `schedule.patrol-region-interval` | Determines the frequency at which `replicaChecker` checks the health state of a Region | | ||
| ======= | ||
| | `schedule.patrol-region-interval` | Determines the frequency at which the checker inspects the health state of a Region | |
There was a problem hiding this comment.
This section contains merge conflict markers (<<<<<<< HEAD, =======, >>>>>>>) that need to be resolved. Please remove these markers and ensure the correct version of the content for schedule.patrol-region-interval is retained. Based on the context, it appears the version from the cherry-picked commit is the intended one.
| | `schedule.patrol-region-interval` | Determines the frequency at which `replicaChecker` checks the health state of a Region | | |
| ======= | |
| | `schedule.patrol-region-interval` | Determines the frequency at which the checker inspects the health state of a Region | | |
| | `schedule.patrol-region-interval` | Determines the frequency at which the checker inspects the health state of a Region | |
| | `schedule.enable-joint-consensus` | Controls whether to use Joint Consensus for replica scheduling | | ||
| | `schedule.hot-regions-write-interval` | The time interval at which PD stores hot Region information | | ||
| | `schedule.hot-regions-reserved-days` | Specifies how many days the hot Region information is retained | | ||
| | `schedule.max-movable-hot-peer-size` | Controls the maximum Region size that can be scheduled for hot Region scheduling. | |
There was a problem hiding this comment.
The description for schedule.max-movable-hot-peer-size ends with an unnecessary period. For consistency within this table, where other descriptions do not end with a period, it's better to remove it.1
Style Guide References
| | `schedule.max-movable-hot-peer-size` | Controls the maximum Region size that can be scheduled for hot Region scheduling. | | |
| | `schedule.max-movable-hot-peer-size` | Controls the maximum Region size that can be scheduled for hot Region scheduling | |
Footnotes
|
@ti-chi-bot: The following test failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
This is an automated cherry-pick of #21204
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions (in Chinese).
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?