From cd9858fea3040d54ed6cd0c47f9c0eea82fee3b9 Mon Sep 17 00:00:00 2001 From: Ti Chi Robot Date: Thu, 12 Aug 2021 20:21:17 +0800 Subject: [PATCH] tiup: fix dead links (#6852) (#6854) --- maintain-tidb-using-tiup.md | 2 +- production-deployment-using-tiup.md | 4 ++-- tiup/tiup-cluster-topology-reference.md | 2 +- tiup/tiup-cluster.md | 2 +- tiup/tiup-dm-topology-reference.md | 2 +- tiup/tiup-faq.md | 2 +- upgrade-tidb-using-tiup.md | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/maintain-tidb-using-tiup.md b/maintain-tidb-using-tiup.md index 151c8c05093f..2c443dc7b514 100644 --- a/maintain-tidb-using-tiup.md +++ b/maintain-tidb-using-tiup.md @@ -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)。 **配置项层次结构使用 `.` 表示**。 diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md index 39586022919b..4f6c314c974d 100644 --- a/production-deployment-using-tiup.md +++ b/production-deployment-using-tiup.md @@ -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)。 @@ -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``` 关键词，表示部署成功。 diff --git a/tiup/tiup-cluster-topology-reference.md b/tiup/tiup-cluster-topology-reference.md index a91b291367b1..e0497bea03e7 100644 --- a/tiup/tiup-cluster-topology-reference.md +++ b/tiup/tiup-cluster-topology-reference.md @@ -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)）来描述集群拓扑。 同样，修改集群配置也是通过编辑拓扑文件来实现的，区别在于修改配置时仅允许修改部分字段。本文档介绍拓扑文件的各个区块以各区块中的各字段。 diff --git a/tiup/tiup-cluster.md b/tiup/tiup-cluster.md index 2a7b16a15957..d9613fb2397c 100644 --- a/tiup/tiup-cluster.md +++ b/tiup/tiup-cluster.md @@ -60,7 +60,7 @@ tiup cluster deploy [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`： > **注意：** > diff --git a/tiup/tiup-dm-topology-reference.md b/tiup/tiup-dm-topology-reference.md index dfbde543106a..69d998e3c942 100644 --- a/tiup/tiup-dm-topology-reference.md +++ b/tiup/tiup-dm-topology-reference.md @@ -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)。 ## 文件结构 diff --git a/tiup/tiup-faq.md b/tiup/tiup-faq.md index 80df32ff5838..f41baef905d8 100644 --- a/tiup/tiup-faq.md +++ b/tiup/tiup-faq.md @@ -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. 最小部署拓扑 diff --git a/upgrade-tidb-using-tiup.md b/upgrade-tidb-using-tiup.md index c9fc38af2be4..35327ec3a5dd 100644 --- a/upgrade-tidb-using-tiup.md +++ b/upgrade-tidb-using-tiup.md @@ -97,7 +97,7 @@ tiup update cluster tiup cluster edit-config ``` -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` 确认变更。