tiup cluster edit-config

在部署集群之后，如果需要再调整集群服务的配置，则可以使用命令 tiup cluster edit-config，它会启动一个编辑器（默认为 $EDITOR 环境变量指定的值，当 EDITOR 环境变量不存在时，使用 vi 打开）允许用户修改指定集群的拓扑文件。

语法

tiup cluster edit-config <cluster-name> [flags]

<cluster-name> 代表要操作的集群名。

选项

-h, --help

  • 输出帮助信息。
  • 数据类型：BOOLEAN
  • 该选项默认关闭，默认值为 false。在命令中添加该选项，并传入 true 值或不传值，均可开启此功能。

--kind

  • 切换集群的模式，可选值为 standard 和 fusion，代表标准模式和敏捷模式。指定该选项后将不进入编辑器也无需执行 tiup cluster reload 命令重新加载配置，而是执行标准模式和敏捷模式切换。
  • 数据类型：STRING
  • 默认值为空字符串。

输出

  • 正常情况无输出
  • 若修改了不能修改的字段，则保存文件时报错并提示用户重新编辑，不能修改的字段参考拓扑文件中的相关描述

切换集群模式示例

当需要在标准模式（standard）与敏捷模式（fusion）之间切换时，可以直接使用 --kind 进行切换。该操作会在后台迁移组件二进制并滚动重启核心组件（TiDB/PD/TiKV），因此请在业务低峰期执行。

示例

tiup cluster edit-config <cluster-name> --kind standard
tiup cluster edit-config <cluster-name> --kind fusion

状态确认

  • 使用 tiup cluster display <cluster-name> 查看 kind 字段是否更新。

<< 返回上一页 - TiUP Cluster 命令清单

下载 PDF