Skip to content

tiup: complete tiup cluster tls desc (#22861) #22873

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

Open
ti-chi-bot wants to merge 2 commits into
base: release-8.1
Choose a base branch
from
Open

tiup: complete tiup cluster tls desc (#22861) #22873

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
352f2ed
Auto-sync: Update English docs from Chinese PR
github-actions[bot] May 8, 2026
2918305
Update tiup/tiup-component-cluster-tls.md
qiancai May 8, 2026
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 tiup/tiup-component-cluster-tls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ tiup cluster tls <cluster-name> <enable/disable> [flags]

`<cluster-name>` specifies the cluster for which you want to enable or disable TLS.

> **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.
Comment on lines +18 to +20
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 11, 2026

Choose a reason for hiding this comment

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

low

According to the style guide, steps should be presented as an ordered list for better readability. I have also simplified the wording for clarity and to avoid technical jargon like "communication exceptions".

Suggested change
> **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:**
>
> Currently, the `tiup cluster tls` command only supports enabling or disabling TLS for clusters with a single PD node. If a cluster has multiple PD nodes, the command fails because switching the TLS status might 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. Run the `tiup cluster tls` command.
References
  1. Use ordered lists (1., 2.) for steps. (link)
  2. Clarity, simplicity, and readability. Avoid unnecessary words. (link)


## Options

### --clean-certificate
Expand Down
Loading