Skip to content

Commit f46aa36

Browse files
authored
tiup: add tiup cluster tls (#20831)
1 parent fe95412 commit f46aa36

File tree

4 files changed

+59
-0
lines changed

4 files changed

+59
-0
lines changed

TOC.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -502,6 +502,7 @@
502502
- [tiup cluster start](/tiup/tiup-component-cluster-start.md)
503503
- [tiup cluster stop](/tiup/tiup-component-cluster-stop.md)
504504
- [tiup cluster template](/tiup/tiup-component-cluster-template.md)
505+
- [tiup cluster tls](/tiup/tiup-component-cluster-tls.md)
505506
- [tiup cluster upgrade](/tiup/tiup-component-cluster-upgrade.md)
506507
- TiUP DM 命令
507508
- [TiUP DM 命令概览](/tiup/tiup-component-dm.md)

tiup/tiup-cluster-topology-reference.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ summary: 介绍通过 TiUP 部署或扩容 TiDB 集群时提供的拓扑文件
6666
- `io_read_bandwidth_max`:读磁盘 I/O 的最大带宽,例如:"/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 100M"
6767
- `io_write_bandwidth_max`:写磁盘 I/O 的最大带宽,例如:"/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 100M"
6868
- `limit_core`:控制 core dump 的大小
69+
- `timeout_stop_sec`:控制 systemd 服务停止的超时时间
70+
- `timeout_start_sec`:控制 systemd 服务启动的超时时间
6971

7072
`global` 配置示例:
7173

tiup/tiup-component-cluster-tls.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: tiup cluster tls
3+
summary: tiup cluster tls 命令用于开启、或关闭集群组件之间的 TLS。
4+
---
5+
6+
# tiup cluster tls
7+
8+
命令 `tiup cluster tls` 用于开启集群组件之间的 TLS (Transport Layer Security),会自签发证书下发到各个节点。
9+
10+
## 语法
11+
12+
```shell
13+
tiup cluster tls <cluster-name> <enable/disable> [flags]
14+
```
15+
16+
`<cluster-name>` 为要启用自启的集群。
17+
18+
## 选项
19+
20+
### --clean-certificate
21+
22+
- 当 TLS 关闭时,指定此选项可清理之前生成的证书。
23+
- 数据类型:`BOOLEAN`
24+
- 默认值:`false`
25+
- 如果不指定该选项,之后开启 TLS 时,可能沿用旧证书。
26+
27+
### --force
28+
29+
- 强制执行开启或关闭 TLS 的流程,不管当前集群是否开启 TLS。
30+
- 数据类型:`BOOLEAN`
31+
- 默认值:`false`
32+
- 如果不指定该选项,开关状态相同时跳过执行。
33+
34+
### --reload-certificate
35+
36+
- 当 TLS 开启时,指定此选项可重新生成证书。
37+
- 数据类型:`BOOLEAN`
38+
- 默认值:`false`
39+
- 如果不指定该选项,已经生成过证书后,不会再生成新证书。
40+
41+
### -h, --help
42+
43+
- 输出帮助信息。
44+
- 数据类型:`BOOLEAN`
45+
- 该选项默认关闭,默认值为 `false`。在命令中添加该选项,并传入 `true` 值或不传值,均可开启此功能。
46+
47+
## 输出
48+
49+
tiup-cluster 的执行日志。

tiup/tiup-component-cluster-upgrade.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,13 @@ tiup cluster upgrade <cluster-name> <version> [flags]
114114
- 数据类型:`STRINGS`
115115
- 不指定该选项时,Node Exporter 的版本与集群版本保持一致。
116116

117+
### --restart-timeout
118+
119+
- 指定滚动升级之间的间隔,即在升级组件后等待一段时间。
120+
- 数据类型: `STRINGS`。支持所有 [`golang time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) 能够解析的数据类型。
121+
- 默认值:`0`
122+
- 不指定该选项时,升级组件后不会等待。
123+
117124
### -h, --help
118125

119126
- 输出帮助信息。

0 commit comments

Comments
 (0)