From 83e71a59ab07dbd8be1b05a3f1d95293ba4eeb14 Mon Sep 17 00:00:00 2001 From: Allen Zhong Date: Thu, 12 Aug 2021 19:53:17 +0800 Subject: [PATCH 1/2] This is an automated cherry-pick of #6153 Signed-off-by: ti-chi-bot --- maintain-tidb-using-tiup.md | 2 +- production-deployment-using-tiup.md | 7 ++++++- tiup/tiup-cluster-topology-reference.md | 2 +- tiup/tiup-cluster.md | 2 +- tiup/tiup-dm-topology-reference.md | 2 +- upgrade-tidb-using-tiup.md | 4 ++++ 6 files changed, 14 insertions(+), 5 deletions(-) diff --git a/maintain-tidb-using-tiup.md b/maintain-tidb-using-tiup.md index fe7cd5f35ac5f..cbf99e291357f 100644 --- a/maintain-tidb-using-tiup.md +++ b/maintain-tidb-using-tiup.md @@ -109,7 +109,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/embed/templates/examples/topology.example.yaml). + For the parameter format, see the [TiUP parameter template](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/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 c7c04c988a22a..031f6ce89d902 100644 --- a/production-deployment-using-tiup.md +++ b/production-deployment-using-tiup.md @@ -113,8 +113,13 @@ 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. +<<<<<<< HEAD > - 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/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), and [TiFlash configuration](/tiflash/tiflash-configuration.md). +======= +> - 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/examples/cluster/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). +>>>>>>> 21a8ec26d (tiup: fix dead links (#6153)) ## Step 4: Execute the deployment command @@ -144,7 +149,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/embed/templates/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/examples/cluster/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/tiup/tiup-cluster-topology-reference.md b/tiup/tiup-cluster-topology-reference.md index 70a3fbcd727a1..683c5f6d96a69 100644 --- a/tiup/tiup-cluster-topology-reference.md +++ b/tiup/tiup-cluster-topology-reference.md @@ -4,7 +4,7 @@ title: Topology Configuration File for TiDB Deployment Using TiUP # Topology Configuration File for TiDB Deployment Using TiUP -To deploy or scale TiDB using TiUP, you need to provide a topology file ([sample](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/topology.example.yaml)) to describe the cluster topology. +To deploy or scale TiDB using TiUP, you need to provide a topology file ([sample](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml)) to describe the cluster topology. Similarly, to modify the cluster topology, you need to modify the topology file. The difference is that, after the cluster is deployed, you can only modify a part of the fields in the topology file. This document introduces each section of the topology file and each field in each section. diff --git a/tiup/tiup-cluster.md b/tiup/tiup-cluster.md index e70f93d16e24d..c77b547253337 100644 --- a/tiup/tiup-cluster.md +++ b/tiup/tiup-cluster.md @@ -63,7 +63,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/embed/templates/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/examples/cluster/topology.example.yaml). The following file is an example of the simplest topology: > **Note:** > diff --git a/tiup/tiup-dm-topology-reference.md b/tiup/tiup-dm-topology-reference.md index a135e4583acd7..b87d23b04d24d 100644 --- a/tiup/tiup-dm-topology-reference.md +++ b/tiup/tiup-dm-topology-reference.md @@ -4,7 +4,7 @@ title: Topology Configuration File for DM Cluster Deployment Using TiUP # Topology Configuration File for DM Cluster Deployment Using TiUP -To deploy or scale a TiDB Data Migration (DM) cluster, you need to provide a topology file ([sample](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/dm/topology.example.yaml)) to describe the cluster topology. +To deploy or scale a TiDB Data Migration (DM) cluster, you need to provide a topology file ([sample](https://github.com/pingcap/tiup/blob/master/embed/examples/dm/topology.example.yaml)) to describe the cluster topology. Similarly, to modify the cluster topology, you need to modify the topology file. The difference is that, after the cluster is deployed, you can only modify a part of the fields in the topology file. This document introduces each section of the topology file and each field in each section. diff --git a/upgrade-tidb-using-tiup.md b/upgrade-tidb-using-tiup.md index bc5d018b1811f..733b15ae4c0a1 100644 --- a/upgrade-tidb-using-tiup.md +++ b/upgrade-tidb-using-tiup.md @@ -118,7 +118,11 @@ tiup update cluster + If an error occurs when parsing the `Inventory` information, the import process is stopped, which does not have any impact on the original Ansible deployment method. Then you need to adjust and retry the process according to the error prompt. +<<<<<<< HEAD + If the original cluster name in Ansible is the same with any existing cluster name in TiUP, a warning message is returned with a new cluster name. Therefore, **do not repeatedly import the same cluster**, which results in multiple names for the same cluster in TiUP. +======= +2. Refer to the format of [topology](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml) configuration template and fill the parameters you want to modify in the `server_configs` section of the topology file. +>>>>>>> 21a8ec26d (tiup: fix dead links (#6153)) After the import is complete, you can check the current cluster status by executing the `tiup cluster display ` command to verify the import result. Because the `display` command is used to query the real-time status of each node, it might take a little time to execute the command. From e22e6988d7db5c4376ef7e1a90bca6f6a4b3ab32 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Thu, 12 Aug 2021 20:21:57 +0800 Subject: [PATCH 2/2] Apply suggestions from code review --- production-deployment-using-tiup.md | 7 +------ upgrade-tidb-using-tiup.md | 4 ---- 2 files changed, 1 insertion(+), 10 deletions(-) diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md index 031f6ce89d902..f21c07657dbc8 100644 --- a/production-deployment-using-tiup.md +++ b/production-deployment-using-tiup.md @@ -113,13 +113,8 @@ 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. -<<<<<<< HEAD -> - 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/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), and [TiFlash configuration](/tiflash/tiflash-configuration.md). -======= > - 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/examples/cluster/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). ->>>>>>> 21a8ec26d (tiup: fix dead links (#6153)) +> - For more parameter description, see [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), and [TiFlash configuration](/tiflash/tiflash-configuration.md). ## Step 4: Execute the deployment command diff --git a/upgrade-tidb-using-tiup.md b/upgrade-tidb-using-tiup.md index 733b15ae4c0a1..bc5d018b1811f 100644 --- a/upgrade-tidb-using-tiup.md +++ b/upgrade-tidb-using-tiup.md @@ -118,11 +118,7 @@ tiup update cluster + If an error occurs when parsing the `Inventory` information, the import process is stopped, which does not have any impact on the original Ansible deployment method. Then you need to adjust and retry the process according to the error prompt. -<<<<<<< HEAD + If the original cluster name in Ansible is the same with any existing cluster name in TiUP, a warning message is returned with a new cluster name. Therefore, **do not repeatedly import the same cluster**, which results in multiple names for the same cluster in TiUP. -======= -2. Refer to the format of [topology](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml) configuration template and fill the parameters you want to modify in the `server_configs` section of the topology file. ->>>>>>> 21a8ec26d (tiup: fix dead links (#6153)) After the import is complete, you can check the current cluster status by executing the `tiup cluster display ` command to verify the import result. Because the `display` command is used to query the real-time status of each node, it might take a little time to execute the command.