Skip to content

pd-ctl: add notice for member delete (#21374) #21385

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

Merged
ti-chi-bot merged 4 commits into from
Jul 14, 2025
Merged

pd-ctl: add notice for member delete (#21374) #21385

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
02e9bb1
pd-ctl: add notice for `member delete`
Oreoxmt Jul 10, 2025
ebeaf55
Apply suggestions from code review
Oreoxmt Jul 10, 2025
821dd7c
Apply suggestions from code review
Oreoxmt Jul 10, 2025
6ee63ae
Apply suggestions from code review
Oreoxmt Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pd-control.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,6 +441,10 @@ Usage:

### `member [delete | leader_priority | leader [show | resign | transfer <member_name>]]`

> **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/).
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jul 14, 2025

Choose a reason for hiding this comment

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

medium

To enhance clarity and conciseness, rephrase the second sentence to guide users more directly to the relevant documentation based on their deployment type (TiUP or Kubernetes).12

Style Guide References

Suggested change
> **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 the scaling instructions for [TiUP](/scale-tidb-using-tiup.md#scale-in-a-tidbpdtikv-cluster) or [Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable/scale-a-tidb-cluster/) deployments.

Footnotes

  1. The documentation should be clear, simple, complete, and readable. (link) ↩

  2. If something might confuse a new user, suggest a reword. (link) ↩


Use this command to view the PD members, remove a specified member, or configure the priority of leader.

Usage:
Expand Down