From 7f411cd226a9a38e1d68c55b8b8ddfb92b2521a6 Mon Sep 17 00:00:00 2001 From: SIGSEGV Date: Mon, 21 Sep 2020 11:24:20 +0800 Subject: [PATCH] cherry pick #4390 to release-4.0 Signed-off-by: ti-srebot --- tiup/tiup-cluster.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/tiup/tiup-cluster.md b/tiup/tiup-cluster.md index 92436cbc675a..b021cd244558 100644 --- a/tiup/tiup-cluster.md +++ b/tiup/tiup-cluster.md @@ -366,6 +366,42 @@ tiup cluster reload prod-cluster 该操作会将配置发送到目标机器，重启集群，使配置生效。 +> **注意：** +> +> 对于监控组件，可以通过执行 `tiup cluster edit-config` 命令在对应实例上添加自定义配置路径来进行配置自定义，例如： + +```yaml +--- + +grafana_servers: + - host: 172.16.5.134 + dashboard_dir: /path/to/local/dashboards/dir + +monitoring_servers: + - host: 172.16.5.134 + rule_dir: /path/to/local/rules/dir + +alertmanager_servers: + - host: 172.16.5.134 + config_file: /path/to/local/alertmanager.yml +``` + +路径内容格式如下： + +- `grafana_servers` 的 `dashboard_dir` 字段指定的文件夹中应当含有完整的 `*.json` +- `monitoring_servers` 的 `rule_dir` 字段定义的文件夹中应当含有完整的 `*.rules.yml` +- `alertmanager_servers` 的 `config_file` 格式请参考[此处](https://github.com/pingcap/tiup/blob/master/templates/config/alertmanager.yml) + +在执行 `tiup reload` 时，TiUP 会将中控机上对应的配置上传到目标机器对应的配置目录中，上传之前会删除目标机器中已有的旧配置文件。如果想要修改某一个配置文件，请确保将所有的（包含未修改的）配置文件都放在同一个目录中。例如，要修改 Grafana 的 `tidb.json` 文件，可以先将 Grafana 的 `dashboards` 目录中所有的 `*.json` 文件拷贝到本地目录中，再修改 `tidb.json` 文件。否则最终的目标机器上将缺失其他的 JSON 文件。 + +> **注意：** +> +> 如果配置了 `grafana_servers` 的 `dashboard_dir` 字段，在执行 `tiup cluster rename` 命令进行集群重命名时需要完成以下操作： +> +> 1. 本地目录中的 `dashboards` 包含了集群名信息，需要修改本地 `dashboards` 中的集群名为新的集群名。 +> 2. 本地目录中 `dashboards` 中的 `datasource` 也要更新为新的集群名（`datasource` 是以集群名命名的）。 +> 3. 执行 `tiup cluster reload -R grafana` 命令。 + ## 更新组件 常规的升级集群可以使用 upgrade 命令，但是在某些场景下（例如 Debug)，可能需要用一个临时的包替换正在运行的组件，此时可以用 patch 命令：