diff --git a/maintain-tidb-using-tiup.md b/maintain-tidb-using-tiup.md index ad79bd1e68a8..2139d6d15d6c 100644 --- a/maintain-tidb-using-tiup.md +++ b/maintain-tidb-using-tiup.md @@ -97,7 +97,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 5e585d5d41a6..688e1d633110 100644 --- a/production-deployment-using-tiup.md +++ b/production-deployment-using-tiup.md @@ -111,7 +111,7 @@ aliases: ['/docs-cn/stable/production-deployment-using-tiup/','/docs-cn/v4.0/pro > > - 对于需要某个节点生效的参数,请在具体节点的 `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-4.0/config/config.toml.example)、[TiKV `config.toml.example`](https://github.com/tikv/tikv/blob/release-4.0/etc/config-template.toml) 、 [PD `config.toml.example`](https://github.com/tikv/pd/blob/release-4.0/conf/config.toml) 和 [TiFlash 配置参数](/tiflash/tiflash-configuration.md)。 @@ -143,7 +143,7 @@ tiup cluster deploy tidb-test v4.0.14 ./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 31d332c71ea7..3f47a6e32d00 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 c1ae27aca00a..c65032d42c22 100644 --- a/tiup/tiup-cluster.md +++ b/tiup/tiup-cluster.md @@ -61,7 +61,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 d02037255ec8..dd3cdbe792ad 100644 --- a/tiup/tiup-faq.md +++ b/tiup/tiup-faq.md @@ -24,7 +24,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. 最小部署拓扑