tiup: complete tiup cluster tls desc (#22861)#22869
Conversation
Synced from: pingcap/docs-cn#21612 Target PR: pingcap#22861 AI Provider: azure Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
ti-chi-bot
added
lgtm
size/XS
|
[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. DetailsNeeds 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.
Code Review
This pull request adds a note to the tiup cluster tls documentation explaining that the command currently only supports clusters with a single PD node and provides a workaround for multi-node clusters. The review feedback suggests refining the note for better clarity and style guide compliance, specifically by using an ordered list for the required steps and removing redundant wording.
| > **Note:** | ||
| > | ||
| > Currently, the `tiup cluster tls` command supports enabling or disabling TLS only for clusters with a single PD node. For clusters with multiple PD nodes, executing the `tiup cluster tls` command directly returns an error, because switching the TLS status can cause communication exceptions between PD nodes. To enable or disable TLS for a cluster with multiple PD nodes, first [`scale-in`](/tiup/tiup-component-cluster-scale-in.md) the PD nodes to one node, and then execute the `tiup cluster tls` command. |
There was a problem hiding this comment.
To improve clarity and adhere to the style guide, this note should be more concise and use an ordered list for the steps. Removing unnecessary words like "Currently" and "directly" makes the documentation more direct. Additionally, "communication issues" is more appropriate for user-facing documentation than "communication exceptions".
| > **Note:** | |
| > | |
| > Currently, the `tiup cluster tls` command supports enabling or disabling TLS only for clusters with a single PD node. For clusters with multiple PD nodes, executing the `tiup cluster tls` command directly returns an error, because switching the TLS status can cause communication exceptions between PD nodes. To enable or disable TLS for a cluster with multiple PD nodes, first [`scale-in`](/tiup/tiup-component-cluster-scale-in.md) the PD nodes to one node, and then execute the `tiup cluster tls` command. | |
| > **Note:** | |
| > | |
| > The `tiup cluster tls` command supports enabling or disabling TLS only for clusters with a single PD node. For clusters with multiple PD nodes, the command returns an error because switching the TLS status can cause communication issues between PD nodes. | |
| > | |
| > To enable or disable TLS for a cluster with multiple PD nodes: | |
| > | |
| > 1. [`scale-in`](/tiup/tiup-component-cluster-scale-in.md) the PD nodes to a single node. | |
| > 2. Execute the `tiup cluster tls` command. |
2 participants
This is an automated cherry-pick of #22861
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?