Skip to content

Commit

Permalink
Document for tiup-cluster local config directory (#4390)
Browse files Browse the repository at this point in the history
* Document for pingcap/tiup#712

Signed-off-by: lucklove <gnu.crazier@gmail.com>

* More detail

Signed-off-by: lucklove <gnu.crazier@gmail.com>

* Apply suggestions from code review

Co-authored-by: Lonng <heng@lonng.org>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

* Update tiup/tiup-cluster.md

Co-authored-by: Lonng <heng@lonng.org>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
  • Loading branch information
3 people authored Sep 21, 2020
1 parent 5e4b92a commit ee10552
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions tiup/tiup-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 命令:
Expand Down

0 comments on commit ee10552

Please sign in to comment.