pd-ctl: add notice for member delete (#21374)#21384
pd-ctl: add notice for member delete (#21374)#21384ti-chi-bot[bot] merged 4 commits intopingcap:release-7.1from
member delete (#21374)#21384Conversation
Co-authored-by: Grace Cai <qqzczy@126.com>
ti-chi-bot
added
lgtm
needs-1-more-lgtm
![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 enhances the pd-control documentation by adding a crucial warning to guide users on the correct and safe methods for removing PD nodes, preventing potential misconfigurations or issues in production environments.
Highlights
- Documentation Update: A critical warning note has been added to the
pd-control.mddocumentation, specifically under themember deletecommand section. - Operational Safety Guidance: The newly added note explicitly advises users NOT to use the
member deletecommand for removing PD nodes in a production environment and provides links to the recommended, safer procedures for scaling in TiDB/PD/TiKV clusters.
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 an important warning note to the pd-ctl documentation, advising against using member delete in production and pointing to the correct procedures for scaling in a cluster. My review includes a minor suggestion to improve the clarity and consistency of the note's wording and links, aligning it better with the style guide.
|
|
||
| > **Note:** | ||
| > | ||
| > **DO NOT** use the `member delete` command to remove PD nodes in a production environment. To remove a PD node, see [Scale in a TiDB/PD/TiKV cluster](/scale-tidb-using-tiup.md#scale-in-a-tidbpdtikv-cluster) and [Manually Scale TiDB on Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable/scale-a-tidb-cluster/). |
There was a problem hiding this comment.
For better clarity and consistency, I suggest a couple of minor changes to this note:
- Using "refer to" instead of "see" is slightly more formal for technical documentation.
- The link text "Manually Scale TiDB on Kubernetes" does not match the title of the linked page ("Scale a TiDB Cluster"). Changing it to "Scale a TiDB cluster on Kubernetes" would be more accurate and less confusing for users.1
These changes will help improve the readability and accuracy of the documentation.2
Style Guide References
| > **DO NOT** use the `member delete` command to remove PD nodes in a production environment. To remove a PD node, see [Scale in a TiDB/PD/TiKV cluster](/scale-tidb-using-tiup.md#scale-in-a-tidbpdtikv-cluster) and [Manually Scale TiDB on Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable/scale-a-tidb-cluster/). | |
| > **DO NOT** use the `member delete` command to remove PD nodes in a production environment. To remove a PD node, refer to [Scale in a TiDB/PD/TiKV cluster](/scale-tidb-using-tiup.md#scale-in-a-tidbpdtikv-cluster) and [Scale a TiDB cluster on Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable/scale-a-tidb-cluster/). |
Footnotes
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Oreoxmt The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
2 participants
This is an automated cherry-pick of #21374
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)?
member deletedocs-cn#20642Do your changes match any of the following descriptions?