diff --git a/maintain-tidb-using-tiup.md b/maintain-tidb-using-tiup.md index 60ec17d36d14c..944f9978f7e4c 100644 --- a/maintain-tidb-using-tiup.md +++ b/maintain-tidb-using-tiup.md @@ -113,7 +113,7 @@ When the cluster is in operation, if you need to modify the parameters of a comp log.slow-threshold: 300 ``` - For the parameter format, see the [TiUP parameter template](https://github.com/pingcap/tiup/blob/master/examples/topology.example.yaml). + For the parameter format, see the [TiUP parameter template](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/topology.example.yaml). **Use `.` to represent the hierarchy of the configuration items**. diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md index 17f84c5b0fae7..3a4e42c8a3305 100644 --- a/production-deployment-using-tiup.md +++ b/production-deployment-using-tiup.md @@ -117,7 +117,7 @@ The following topology documents provide a cluster configuration template for ea > > - For parameters that should be globally effective, configure these parameters of corresponding components in the `server_configs` section of the configuration file. > - For parameters that should be effective on a specific node, configure these parameters in the `config` of this node. -> - Use `.` to indicate the subcategory of the configuration, such as `log.slow-threshold`. For more formats, see [TiUP configuration template](https://github.com/pingcap/tiup/blob/master/examples/topology.example.yaml). +> - Use `.` to indicate the subcategory of the configuration, such as `log.slow-threshold`. For more formats, see [TiUP configuration template](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/topology.example.yaml). > - For more parameter description, see [TiDB `config.toml.example`](https://github.com/pingcap/tidb/blob/master/config/config.toml.example), [TiKV `config.toml.example`](https://github.com/tikv/tikv/blob/master/etc/config-template.toml), [PD `config.toml.example`](https://github.com/pingcap/pd/blob/master/conf/config.toml), and [TiFlash configuration](/tiflash/tiflash-configuration.md). ## Step 4: Execute the deployment command @@ -148,7 +148,7 @@ In the above command: - The initialization configuration file is `topology.yaml`. - `--user root`: Log in to the target machine through the `root` key to complete the cluster deployment, or you can use other users with `ssh` and `sudo` privileges to complete the deployment. - `[-i]` and `[-p]`: optional. If you have configured login to the target machine without password, these parameters are not required. If not, choose one of the two parameters. `[-i]` is the private key of the `root` user (or other users specified by `--user`) that has access to the target machine. `[-p]` is used to input the user password interactively. -- If you need to specify the user group name to be created on the target machine, see [this example](https://github.com/pingcap/tiup/blob/master/examples/topology.example.yaml#L7). +- If you need to specify the user group name to be created on the target machine, see [this example](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/topology.example.yaml#L7). At the end of the output log, you will see ```Deployed cluster `tidb-test` successfully```. This indicates that the deployment is successful. diff --git a/production-offline-deployment-using-tiup.md b/production-offline-deployment-using-tiup.md index 72215b07cf7b6..0d094211791f4 100644 --- a/production-offline-deployment-using-tiup.md +++ b/production-offline-deployment-using-tiup.md @@ -186,7 +186,7 @@ Take the `/dev/nvme0n1` data disk as an example: ## Step 4: Edit the initialization configuration file `topology.yaml` -You need to manually create and edit the cluster initialization configuration file. For the full configuration template, refer to the [TiUP configuration parameter template](https://github.com/pingcap/tiup/blob/master/examples/topology.example.yaml). +You need to manually create and edit the cluster initialization configuration file. For the full configuration template, refer to the [TiUP configuration parameter template](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/topology.example.yaml). Create a YAML configuration file on the control machine, such as `topology.yaml`: diff --git a/tiup/tiup-cluster.md b/tiup/tiup-cluster.md index 8fa3b53b7f386..cd8646451417f 100644 --- a/tiup/tiup-cluster.md +++ b/tiup/tiup-cluster.md @@ -65,7 +65,7 @@ tiup cluster deploy [flags] This command requires you to provide the cluster name, the TiDB cluster version, and a topology file of the cluster. -To write a topology file, refer to [the example](https://github.com/pingcap/tiup/blob/master/examples/topology.example.yaml). The following file is an example of the simplest topology: +To write a topology file, refer to [the example](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/topology.example.yaml). The following file is an example of the simplest topology: > **Note:** > diff --git a/upgrade-tidb-using-tiup.md b/upgrade-tidb-using-tiup.md index ab44560e93fcc..4cdaf5908aa7a 100644 --- a/upgrade-tidb-using-tiup.md +++ b/upgrade-tidb-using-tiup.md @@ -145,7 +145,7 @@ After the import is complete, you can check the current cluster status by execut tiup cluster edit-config ``` -3. See the configuration template format of [topology](https://github.com/pingcap/tiup/blob/master/examples/topology.example.yaml) and fill in the modified parameters of the original cluster in the `server_configs` section of the topology file. +3. See the configuration template format of [topology](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/topology.example.yaml) and fill in the modified parameters of the original cluster in the `server_configs` section of the topology file. Even if the label has been configured for the cluster, you also need to fill in the label in the configuration according to the format in the template. In later versions, the label will be automatically imported.