Skip to content

Commit

Permalink
tiup: fix dead links (#6852) (#6854)
Browse files Browse the repository at this point in the history
  • Loading branch information
ti-chi-bot authored Aug 12, 2021
1 parent dfe6252 commit cd9858f
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion maintain-tidb-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ tiup cluster display ${cluster-name}
log.slow-threshold: 300
```

参数的格式参考 [TiUP 配置参数模版](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/topology.example.yaml)。
参数的格式参考 [TiUP 配置参数模版](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml)。

**配置项层次结构使用 `.` 表示**

Expand Down
4 changes: 2 additions & 2 deletions production-deployment-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ alertmanager_servers:
>
> - 对于需要某个节点生效的参数,请在具体节点的 `config` 中配置。
>
> - 配置的层次结构使用 `.` 表示。如:`log.slow-threshold`。更多格式参考 [TiUP 配置参数模版](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/topology.example.yaml)。
> - 配置的层次结构使用 `.` 表示。如:`log.slow-threshold`。更多格式参考 [TiUP 配置参数模版](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml)。
>
> - 更多参数说明,请参考 [TiDB `config.toml.example`](https://github.com/pingcap/tidb/blob/release-5.0/config/config.toml.example)、[TiKV `config.toml.example`](https://github.com/tikv/tikv/blob/release-5.0/etc/config-template.toml) 、 [PD `config.toml.example`](https://github.com/pingcap/pd/blob/release-5.0/conf/config.toml) 和 [TiFlash 配置参数](/tiflash/tiflash-configuration.md)。

Expand Down Expand Up @@ -273,7 +273,7 @@ tiup cluster deploy tidb-test v5.0.3 ./topology.yaml --user root [-p] [-i /home/
- 初始化配置文件为 `topology.yaml`
- --user root:通过 root 用户登录到目标主机完成集群部署,该用户需要有 ssh 到目标机器的权限,并且在目标机器有 sudo 权限。也可以用其他有 ssh 和 sudo 权限的用户完成部署。
- [-i] 及 [-p]:非必选项,如果已经配置免密登录目标机,则不需填写。否则选择其一即可,[-i] 为可登录到目标机的 root 用户(或 --user 指定的其他用户)的私钥,也可使用 [-p] 交互式输入该用户的密码
- 如果需要指定在目标机创建的用户组名,可以参考[这个例子](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/topology.example.yaml#L7)。
- 如果需要指定在目标机创建的用户组名,可以参考[这个例子](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml#L7)。

预期日志结尾输出会有 ```Deployed cluster `tidb-test` successfully``` 关键词,表示部署成功。

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-cluster-topology-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: 通过 TiUP 部署 TiDB 集群的拓扑文件配置

# 通过 TiUP 部署 TiDB 集群的拓扑文件配置

通过 TiUP 部署或扩容 TiDB 集群时,需要提供一份拓扑文件([示例](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/topology.example.yaml))来描述集群拓扑。
通过 TiUP 部署或扩容 TiDB 集群时,需要提供一份拓扑文件([示例](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml))来描述集群拓扑。

同样,修改集群配置也是通过编辑拓扑文件来实现的,区别在于修改配置时仅允许修改部分字段。本文档介绍拓扑文件的各个区块以各区块中的各字段。

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ tiup cluster deploy <cluster-name> <version> <topology.yaml> [flags]

该命令需要提供集群的名字、集群使用的 TiDB 版本,以及一个集群的拓扑文件。

拓扑文件的编写可参考[示例](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/topology.example.yaml)。以一个最简单的拓扑为例,将下列文件保存为 `/tmp/topology.yaml`
拓扑文件的编写可参考[示例](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml)。以一个最简单的拓扑为例,将下列文件保存为 `/tmp/topology.yaml`

> **注意:**
>
Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-dm-topology-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: 通过 TiUP 部署 DM 集群的拓扑文件配置

在部署或扩容 TiDB Data Migration (DM) 集群时,需要提供一份拓扑文件来描述集群拓扑,同样,修改配置也是通过编辑拓扑文件来实现的,区别在于修改配置时仅允许修改部分字段。

拓扑文件[示例参考](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/dm/topology.example.yaml)
拓扑文件[示例参考](https://github.com/pingcap/tiup/blob/master/embed/examples/dm/topology.example.yaml)

## 文件结构

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ TiUP Playground 组件主要定位是快速上手和搭建单机的开发环境

## 怎么样编写 tiup-cluster 组件的拓扑文件?

可以参考拓扑文件的[样例](https://github.com/pingcap/tiup/tree/master/embed/templates/examples),样例中包含了:
可以参考拓扑文件的[样例](https://github.com/pingcap/tiup/tree/master/embed/examples/cluster),样例中包含了:

1. 两地三中心
2. 最小部署拓扑
Expand Down
2 changes: 1 addition & 1 deletion upgrade-tidb-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ tiup update cluster
tiup cluster edit-config <cluster-name>
```

2. 参考 [topology](https://github.com/pingcap/tiup/blob/release-1.4/embed/templates/examples/topology.example.yaml) 配置模板的格式,将希望修改的参数填到拓扑文件的 `server_configs` 下面。
2. 参考 [topology](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml) 配置模板的格式,将希望修改的参数填到拓扑文件的 `server_configs` 下面。

修改完成后 `:wq` 保存并退出编辑模式,输入 `Y` 确认变更。

Expand Down

0 comments on commit cd9858f

Please sign in to comment.