From 304b0f6f854f8ed55a03286a1eb5bc594271c0ec Mon Sep 17 00:00:00 2001 From: qiancai Date: Mon, 12 Apr 2021 19:07:56 +0800 Subject: [PATCH 01/14] TiUP: Add two docs about tiup dm display and upgrade --- tiup/tiup-component-dm-display.md | 58 +++++++++++++++++++++++++++++++ tiup/tiup-component-dm-upgrade.md | 29 ++++++++++++++++ 2 files changed, 87 insertions(+) create mode 100644 tiup/tiup-component-dm-display.md create mode 100644 tiup/tiup-component-dm-upgrade.md diff --git a/tiup/tiup-component-dm-display.md b/tiup/tiup-component-dm-display.md new file mode 100644 index 000000000000..5111f690766d --- /dev/null +++ b/tiup/tiup-component-dm-display.md @@ -0,0 +1,58 @@ +--- +title: tiup dm display +--- + +# tiup dm display + +If you want to check the operational status of each component in a cluster, it is inefficient to log in to each machine one by one. Therefore, tiup-dm provides the `tiup dm display` command to do this job efficiently. + +## Syntax + +```shell +tiup dm display [flags] +``` + +`` is the name of the cluster to operate on. If you forget the cluster name, check it in [tiup cluster list](/tiup/tiup-component-cluster-list.md). + +## Options + +### -N, --node + +Specifies the IDs of the nodes to query, splitting by commas for multiple nodes. The node IDs are in the first column of the [tiup cluster display](/tiup/tiup-component-cluster-display.md) table. +Data type: `STRING` +Default: []. If this option is not specified in the command, the command queries all the nodes. + +> **Note:** +> +> If `-R, --role` is also specified, only the services in the intersection of the specified nodes and roles will be queried. + +### -R, --role strings + +Specifies the roles to be queried, splitting by commas for multiple roles. The roles are in the second column of the [tiup cluster display](/tiup/tiup-component-cluster-display.md) table. +Data type: `STRING` +Default: []. If this option is not specified in the command, the command queries all the roles. + +> **Note:** +> +> If `-N, --node` is also specified, only the services in the intersection of the specified nodes and roles will be queried. + +### -h, --help + +- Prints the help information. +- Data type: `BOOLEAN` +- This option is disabled by default with the `false` value. To enable this option, add this option to the command, and either pass the `true` value or do not pass any value. + +## Output + +- Cluster name +- Cluster version +- SSH client type +- A table containing the following fields: + - `ID`: Node ID, consisting of IP:PORT. + - `Role`: the service role deployed on the node (for example, TiDB or TiKV). + - `Host`: IP address of the machine corresponding to the node. + - `Ports`: the port number used by the service. + - `OS/Arch`: the operating system and machine architecture of the node. + - `Status`: the current status of the services on the node. + - `Data Dir`: the data directory of the service. `-` means that there is no data directory. + - `Deploy Dir`: the deployment directory of the service. diff --git a/tiup/tiup-component-dm-upgrade.md b/tiup/tiup-component-dm-upgrade.md new file mode 100644 index 000000000000..252e35f14bbf --- /dev/null +++ b/tiup/tiup-component-dm-upgrade.md @@ -0,0 +1,29 @@ +-- +title: tiup dm upgrade +-- + +# tiup dm upgrade + +The `tiup dm upgrade` command is used to upgrade a specified cluster to a specific version. + +## Syntax + +```shell +tiup dm upgrade [flags] +``` + +- `` is the name of the cluster to operate on. If you forget the cluster name, check it in [tiup cluster list](/tiup/tiup-component-cluster-list.md). +- `` is the target version to upgrade to. Currently, only upgrading to a later version is allowed, and upgrading to an earlier version is not allowed, which means the downgrade is not allowed. Upgrading to a nightly version is not allowed either. + +## Options + +### -h, --help + +- Prints the help information. +- Data type: `BOOLEAN` +- This option is disabled by default with the `false` value. To enable this option, add this option to the command, and either pass the `true` value or do not pass any value. + +## Output + +Log of the upgraded service. + From b38e1c9bad47f6728709a9daee0edf5a7718e31f Mon Sep 17 00:00:00 2001 From: qiancai Date: Tue, 13 Apr 2021 11:18:02 +0800 Subject: [PATCH 02/14] Create tiup-component-cluster-check.md --- tiup/tiup-component-cluster-check.md | 216 +++++++++++++++++++++++++++ 1 file changed, 216 insertions(+) create mode 100644 tiup/tiup-component-cluster-check.md diff --git a/tiup/tiup-component-cluster-check.md b/tiup/tiup-component-cluster-check.md new file mode 100644 index 000000000000..d44145282f2b --- /dev/null +++ b/tiup/tiup-component-cluster-check.md @@ -0,0 +1,216 @@ +--- +title: tiup cluster check +--- + +# tiup cluster check + +For the formal production environments, before the environment goes live, you need to perform a series of checks to ensure the clusters are in their best performance. To simplify the manual check steps, TiUP Cluster provides the `check` command to check whether the hardware and software environments of the target machines of a specified cluster meet the requirements to work normally. + +## List of check items + +### Operating system version + +Check the operating system distribution and version of the deployed machines. Currently, only CentOS 7 is supported for deployment. More system versions may be supported in later releases for compatibility improvement. + +### CPU EPOLLEXCLUSIVE + +Check whether the CPU of the target machine supports EPOLLEXCLUSIVE. + +### numactl + +Check whether numactl is installed on the target machine. If tied cores are configured on the target machine, you must install numactl. + +### system time + +Check whether the system time of the target machine is synchronized: compare the system time of the target machine with that of the central control machine, and report an error if the deviation exceeds a certain threshold (500ms). + +### Time synchronization service + +Check whether the time synchronization service is configured on the target machine: check whether ntpd is running. + +### Swap partitioning + +Check whether swap partitioning is enabled on the target machine. It is recommended to disable swap partitioning. + +### Kernel parameters + +Check the values of the kernel parameters. + +- net.ipv4.tcp_tw_recycle: 0 +- net.ipv4.tcp_syncookies: 0 +- net.core.somaxconn: 32768 +- vm.swappiness: 0 +- vm.overcommit_memory: 0 or 1 +- fs.file-max: 1000000 + +### Transparent Huge Pages (THP) + +Check whether THP is enabled on the target machine. It is recommended to disable THP. + +### System limits + +Check the limit values in the `/etc/security/limits.conf` file: + +``` + soft nofile 1000000 + hard nofile 1000000 + soft stack 10240 +``` + +where `` is the user who deploys and runs the TiDB cluster, and the last column is the minimum value required for the system. + +### SELinux + +Check whether SELinux is enabled. It is recommended to disable SELinux. + +### Firewall + +Check whether the FirewallD service is enabled. It is recommended to either disable the FirewallD service or add permission rules for each service in the TiDB cluster. + +### irqbalance + +Check whether the irqbalance service is enabled. It is recommended to enable the irqbalance service. + +### Disk mount options + +Check the mount options for ext4 partitions. Make sure the mount options include the nodelalloc option and the noatime option. + +### Port usage + +Check if the ports defined in the topology (including the auto-completion default ports) are already used by the processes on the target machine. + +> **Note:** +> +> The port usage check assumes that a cluster is not started yet. If a cluster is already deployed and started, the port usage check on the cluster fails because the ports must be in use in this case. + +### CPU core number + +Check the CPU information of the target machine. For the production cluster, it is recommended that CPU logical core number >= 16. + +> **Note:** +> +> CPU core number is not checked by default. To enable the check, you need to add the `-enable-cpu` option. + +### Memory size + +Check the memory size of the target machine. For the production cluster, it is recommended that the total memory capacity >= 32GB. + +> **Note:** +> +> Memory size is not checked by default. To enable the check, you need to add the `-enable-mem` option. + +### Fio disk performance test + +Use flexible I/O tester (fio) to test the performance of the disk where `data_dir` is located, including the following three test items: + +- fio_randread_write_latency +- fio_randread_write +- fio_randread + +> **Note:** +> +> The fio disk performance test is not performed by default. To perform the test, you need to add the `-enable-disk` option. + +## Syntax + +```shell +tiup cluster check [flags] +``` + +- If a cluster is not deployed yet, you need to pass the [topology.yml](/tiup/tiup-cluster-topology-reference.md) file that will be used to deploy the cluster. According to the content in this file, tiup-cluster will connect to the corresponding machine to do the check. +- If a cluster is already deployed, you can use the `` as the check object. + +> **Note:** +> +> If `` is used for the check, you need to add the `--cluster` option in the command. + +## Options + +### --apply + +- Attempts to automatically repair the failed check items. Currently, tiup-cluster only attempts to repair the following: + - SELinux + - firewall + - irqbalance + - kernel parameters + - System limits + - THP (Transparent Huge Pages) +- Data type: `BOOLEAN` +- This option is disabled by default with the `false` value. To enable this option, add this option to the command, and either pass the `true` value or do not pass any value. + +### --cluster + +- Indicates that the check is for the deployed clusters. +- Data type: `BOOLEAN` +- This option is disabled by default with the `false` value. To enable this option, add this option to the command, and either pass the `true` value or do not pass any value. + +> **Note:** +> +> tiup-cluster supports checking both un-deployed clusters and deployed clusters with the following command format: + +```shell +tiup cluster check [flags] +``` + +If the `tiup cluster check ` command is used, you must add the `--cluster` option: `tiup cluster check --cluster`. + +### --enable-cpu + +- Enables the check of CPU core number. +- Data type: `BOOLEAN` +- This option is disabled by default with the `false` value. To enable this option, add this option to the command, and either pass the `true` value or do not pass any value. + +### --enable-disk + +- Enables the fio disk performance test. +- Data type: `BOOLEAN` +- This option is disabled by default with the `false` value. To enable this option, add this option to the command, and either pass the `true` value or do not pass any value. + +### --enable-mem + +- Enables the memory size check. +- Data type: `BOOLEAN` +- This option is disabled by default with the `false` value. To enable this option, add this option to the command, and either pass the `true` value or do not pass any value. + +### --u, --user + +- Specifies the user name to connect to the target machine. The specified user needs to have the password-free sudo root privileges on the target machine. +- Data type: `STRING` +- The option is enabled by default with the user currently executing the command (the default value) passed in. + +> **Note:** +> +> This option is valid only if the `-cluster` option is false. Otherwise, the value of this option is fixed to the username specified in the topology file for the cluster deployment. + +### -i, --identity_file + +- Specifies the key file to connect to the target machine. +- Data type: `STRING` +- The option is enabled by default with `~/.ssh/id_rsa` (the default value) passed in. + +> **Note:** +> +> This option is valid only if the `--cluster` option is false. Otherwise the value of this option is fixed to `${TIUP_HOME}/storage/cluster/clusters//ssh/id_rsa`. + +### -p, --password + +- Logs in with a password when connecting to the target machine. + - If the `--cluster` option is added for a cluster, the password is the password of the user specified in the topology file when the cluster was deployed. + - If the `--cluster` option is not added for a cluster, the password is the password of the user specified in the `-u/--user` option. +- Data type: `BOOLEAN` +- This option is disabled by default with the `false` value. To enable this option, add this option to the command, and either pass the `true` value or do not pass any value. + +### -h, --help + +- Prints the help information of the related commands. +- Data type: `BOOLEAN` +- This option is disabled by default with the `false` value. To enable this option, add this option to the command, and either pass the `true` value or do not pass any value. + +## Output + +A table containing the following fields: + +- `Node`: the target node +- `Check`: the check item +- `Result`: the check result (Pass, Warn, or Fail) +- `Message`: the result description From 1aa02b084adc711426333e8c8c7b7ab7fd122a55 Mon Sep 17 00:00:00 2001 From: qiancai Date: Tue, 13 Apr 2021 11:22:15 +0800 Subject: [PATCH 03/14] Update tiup-component-cluster-check.md --- tiup/tiup-component-cluster-check.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-component-cluster-check.md b/tiup/tiup-component-cluster-check.md index d44145282f2b..af54cd314271 100644 --- a/tiup/tiup-component-cluster-check.md +++ b/tiup/tiup-component-cluster-check.md @@ -4,7 +4,7 @@ title: tiup cluster check # tiup cluster check -For the formal production environments, before the environment goes live, you need to perform a series of checks to ensure the clusters are in their best performance. To simplify the manual check steps, TiUP Cluster provides the `check` command to check whether the hardware and software environments of the target machines of a specified cluster meet the requirements to work normally. +For a formal production environment, before the environment goes live, you need to perform a series of checks to ensure the clusters are in their best performance. To simplify the manual check steps, TiUP Cluster provides the `check` command to check whether the hardware and software environments of the target machines of a specified cluster meet the requirements to work normally. ## List of check items From 1f8c81070b4c55351c254dba9c499cda7e021a03 Mon Sep 17 00:00:00 2001 From: qiancai Date: Wed, 14 Apr 2021 13:38:25 +0800 Subject: [PATCH 04/14] Update tiup-component-dm-display.md --- tiup/tiup-component-dm-display.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/tiup/tiup-component-dm-display.md b/tiup/tiup-component-dm-display.md index 5111f690766d..8a442e401121 100644 --- a/tiup/tiup-component-dm-display.md +++ b/tiup/tiup-component-dm-display.md @@ -18,23 +18,23 @@ tiup dm display [flags] ### -N, --node -Specifies the IDs of the nodes to query, splitting by commas for multiple nodes. The node IDs are in the first column of the [tiup cluster display](/tiup/tiup-component-cluster-display.md) table. +Specifies the IDs of the nodes to query, splitting by commas for multiple nodes. If you are not sure about the ID of a node, you can skip this option in the command to show the IDs and status of all nodes in the output. Data type: `STRING` -Default: []. If this option is not specified in the command, the command queries all the nodes. +This option is enabled by default with `[]` (which means all nodes) passed in. > **Note:** > -> If `-R, --role` is also specified, only the services in the intersection of the specified nodes and roles will be queried. +> If `-R, --role` is also specified, only the services in the intersection of the specified nodes and roles is queried. ### -R, --role strings -Specifies the roles to be queried, splitting by commas for multiple roles. The roles are in the second column of the [tiup cluster display](/tiup/tiup-component-cluster-display.md) table. +Specifies the roles to query, splitting by commas for multiple roles. If you are not sure about the role deployed on a node, you can skip this option in the command to show the roles and status of all nodes in the output. Data type: `STRING` -Default: []. If this option is not specified in the command, the command queries all the roles. +This option is enabled by default with `[]` (which means all roles) passed in. > **Note:** > -> If `-N, --node` is also specified, only the services in the intersection of the specified nodes and roles will be queried. +> If `-N, --node` is also specified, only the services in the intersection of the specified nodes and roles is queried. ### -h, --help @@ -48,9 +48,9 @@ Default: []. If this option is not specified in the command, the command queries - Cluster version - SSH client type - A table containing the following fields: - - `ID`: Node ID, consisting of IP:PORT. + - `ID`: the Node ID, consisting of IP:PORT. - `Role`: the service role deployed on the node (for example, TiDB or TiKV). - - `Host`: IP address of the machine corresponding to the node. + - `Host`: the IP address of the machine corresponding to the node. - `Ports`: the port number used by the service. - `OS/Arch`: the operating system and machine architecture of the node. - `Status`: the current status of the services on the node. From 4ac119b6013eac4e23c2b4f22f5d5f8bbd828d47 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Fri, 16 Apr 2021 10:24:26 +0800 Subject: [PATCH 05/14] Update tiup/tiup-component-cluster-check.md Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com> --- tiup/tiup-component-cluster-check.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-component-cluster-check.md b/tiup/tiup-component-cluster-check.md index af54cd314271..eb459933187e 100644 --- a/tiup/tiup-component-cluster-check.md +++ b/tiup/tiup-component-cluster-check.md @@ -20,7 +20,7 @@ Check whether the CPU of the target machine supports EPOLLEXCLUSIVE. Check whether numactl is installed on the target machine. If tied cores are configured on the target machine, you must install numactl. -### system time +### System time Check whether the system time of the target machine is synchronized: compare the system time of the target machine with that of the central control machine, and report an error if the deviation exceeds a certain threshold (500ms). From a7efbc0fc080d851383e54c474b33785e646c64e Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Fri, 16 Apr 2021 10:24:49 +0800 Subject: [PATCH 06/14] Update tiup/tiup-component-cluster-check.md Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com> --- tiup/tiup-component-cluster-check.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-component-cluster-check.md b/tiup/tiup-component-cluster-check.md index eb459933187e..a96256f1a1cd 100644 --- a/tiup/tiup-component-cluster-check.md +++ b/tiup/tiup-component-cluster-check.md @@ -22,7 +22,7 @@ Check whether numactl is installed on the target machine. If tied cores are conf ### System time -Check whether the system time of the target machine is synchronized: compare the system time of the target machine with that of the central control machine, and report an error if the deviation exceeds a certain threshold (500ms). +Check whether the system time of the target machine is synchronized. Compare the system time of the target machine with that of the central control machine, and report an error if the deviation exceeds a certain threshold (500ms). ### Time synchronization service From d1199c6130139d3c917c9f6f9a88a3c2f27fa66c Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Fri, 16 Apr 2021 10:34:19 +0800 Subject: [PATCH 07/14] Apply suggestions from code review Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com> --- tiup/tiup-component-cluster-check.md | 36 ++++++++++++++-------------- tiup/tiup-component-dm-display.md | 6 ++--- tiup/tiup-component-dm-upgrade.md | 5 ++-- 3 files changed, 23 insertions(+), 24 deletions(-) diff --git a/tiup/tiup-component-cluster-check.md b/tiup/tiup-component-cluster-check.md index a96256f1a1cd..73fc9c25cee3 100644 --- a/tiup/tiup-component-cluster-check.md +++ b/tiup/tiup-component-cluster-check.md @@ -26,7 +26,7 @@ Check whether the system time of the target machine is synchronized. Compare the ### Time synchronization service -Check whether the time synchronization service is configured on the target machine: check whether ntpd is running. +Check whether the time synchronization service is configured on the target machine. Namely, check whether ntpd is running. ### Swap partitioning @@ -34,14 +34,14 @@ Check whether swap partitioning is enabled on the target machine. It is recommen ### Kernel parameters -Check the values of the kernel parameters. +Check the values of the following kernel parameters: -- net.ipv4.tcp_tw_recycle: 0 -- net.ipv4.tcp_syncookies: 0 -- net.core.somaxconn: 32768 -- vm.swappiness: 0 -- vm.overcommit_memory: 0 or 1 -- fs.file-max: 1000000 +- `net.ipv4.tcp_tw_recycle`: 0 +- `net.ipv4.tcp_syncookies`: 0 +- `net.core.somaxconn`: 32768 +- `vm.swappiness`: 0 +- `vm.overcommit_memory`: 0 or 1 +- `fs.file-max`: 1000000 ### Transparent Huge Pages (THP) @@ -57,7 +57,7 @@ Check the limit values in the `/etc/security/limits.conf` file: soft stack 10240 ``` -where `` is the user who deploys and runs the TiDB cluster, and the last column is the minimum value required for the system. +`` is the user who deploys and runs the TiDB cluster, and the last column is the minimum value required for the system. ### SELinux @@ -85,19 +85,19 @@ Check if the ports defined in the topology (including the auto-completion defaul ### CPU core number -Check the CPU information of the target machine. For the production cluster, it is recommended that CPU logical core number >= 16. +Check the CPU information of the target machine. For a production cluster, it is recommended that the number of the CPU logical core is greater than or equal to 16. > **Note:** > -> CPU core number is not checked by default. To enable the check, you need to add the `-enable-cpu` option. +> CPU core number is not checked by default. To enable the check, you need to add the `-enable-cpu` option to the command. ### Memory size -Check the memory size of the target machine. For the production cluster, it is recommended that the total memory capacity >= 32GB. +Check the memory size of the target machine. For a production cluster, it is recommended that the total memory capacity is greater than or equal to 32GB. > **Note:** > -> Memory size is not checked by default. To enable the check, you need to add the `-enable-mem` option. +> Memory size is not checked by default. To enable the check, you need to add the `-enable-mem` option to the command. ### Fio disk performance test @@ -109,7 +109,7 @@ Use flexible I/O tester (fio) to test the performance of the disk where `data_di > **Note:** > -> The fio disk performance test is not performed by default. To perform the test, you need to add the `-enable-disk` option. +> The fio disk performance test is not performed by default. To perform the test, you need to add the `-enable-disk` option to the command. ## Syntax @@ -117,7 +117,7 @@ Use flexible I/O tester (fio) to test the performance of the disk where `data_di tiup cluster check [flags] ``` -- If a cluster is not deployed yet, you need to pass the [topology.yml](/tiup/tiup-cluster-topology-reference.md) file that will be used to deploy the cluster. According to the content in this file, tiup-cluster will connect to the corresponding machine to do the check. +- If a cluster is not deployed yet, you need to pass the [topology.yml](/tiup/tiup-cluster-topology-reference.md) file that is used to deploy the cluster. According to the content in this file, tiup-cluster connects to the corresponding machine to perform the check. - If a cluster is already deployed, you can use the `` as the check object. > **Note:** @@ -128,7 +128,7 @@ tiup cluster check [flags] ### --apply -- Attempts to automatically repair the failed check items. Currently, tiup-cluster only attempts to repair the following: +- Attempts to automatically repair the failed check items. Currently, tiup-cluster only attempts to repair the following check items: - SELinux - firewall - irqbalance @@ -176,7 +176,7 @@ If the `tiup cluster check ` command is used, you must add the `-- - Specifies the user name to connect to the target machine. The specified user needs to have the password-free sudo root privileges on the target machine. - Data type: `STRING` -- The option is enabled by default with the user currently executing the command (the default value) passed in. +- If this option is not specified in the command, user who executes the command is used as the default value. > **Note:** > @@ -190,7 +190,7 @@ If the `tiup cluster check ` command is used, you must add the `-- > **Note:** > -> This option is valid only if the `--cluster` option is false. Otherwise the value of this option is fixed to `${TIUP_HOME}/storage/cluster/clusters//ssh/id_rsa`. +> This option is valid only if the `--cluster` option is false. Otherwise, the value of this option is fixed to `${TIUP_HOME}/storage/cluster/clusters//ssh/id_rsa`. ### -p, --password diff --git a/tiup/tiup-component-dm-display.md b/tiup/tiup-component-dm-display.md index 8a442e401121..981897a9dd48 100644 --- a/tiup/tiup-component-dm-display.md +++ b/tiup/tiup-component-dm-display.md @@ -4,7 +4,7 @@ title: tiup dm display # tiup dm display -If you want to check the operational status of each component in a cluster, it is inefficient to log in to each machine one by one. Therefore, tiup-dm provides the `tiup dm display` command to do this job efficiently. +If you want to check the operational status of each component in a DM cluster, it is inefficient to log in to each machine one by one. Therefore, tiup-dm provides the `tiup dm display` command to do this job efficiently. ## Syntax @@ -26,7 +26,7 @@ This option is enabled by default with `[]` (which means all nodes) passed in. > > If `-R, --role` is also specified, only the services in the intersection of the specified nodes and roles is queried. -### -R, --role strings +### -R, --role Specifies the roles to query, splitting by commas for multiple roles. If you are not sure about the role deployed on a node, you can skip this option in the command to show the roles and status of all nodes in the output. Data type: `STRING` @@ -48,7 +48,7 @@ This option is enabled by default with `[]` (which means all roles) passed in. - Cluster version - SSH client type - A table containing the following fields: - - `ID`: the Node ID, consisting of IP:PORT. + - `ID`: the node ID, consisting of IP:PORT. - `Role`: the service role deployed on the node (for example, TiDB or TiKV). - `Host`: the IP address of the machine corresponding to the node. - `Ports`: the port number used by the service. diff --git a/tiup/tiup-component-dm-upgrade.md b/tiup/tiup-component-dm-upgrade.md index 252e35f14bbf..fc1cd4f21fc1 100644 --- a/tiup/tiup-component-dm-upgrade.md +++ b/tiup/tiup-component-dm-upgrade.md @@ -13,7 +13,7 @@ tiup dm upgrade [flags] ``` - `` is the name of the cluster to operate on. If you forget the cluster name, check it in [tiup cluster list](/tiup/tiup-component-cluster-list.md). -- `` is the target version to upgrade to. Currently, only upgrading to a later version is allowed, and upgrading to an earlier version is not allowed, which means the downgrade is not allowed. Upgrading to a nightly version is not allowed either. +- `` is the target version to be upgraded to. Currently, only upgrading to a later version is allowed, and upgrading to an earlier version is not allowed, which means the downgrade is not allowed. Upgrading to a nightly version is not allowed either. ## Options @@ -25,5 +25,4 @@ tiup dm upgrade [flags] ## Output -Log of the upgraded service. - +Log of the service upgrade process. From f841f70d8474cf201ea011648b029e916cd27b9a Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Fri, 16 Apr 2021 10:45:13 +0800 Subject: [PATCH 08/14] Update tiup/tiup-component-cluster-check.md --- tiup/tiup-component-cluster-check.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-component-cluster-check.md b/tiup/tiup-component-cluster-check.md index 73fc9c25cee3..c39c4e3809ba 100644 --- a/tiup/tiup-component-cluster-check.md +++ b/tiup/tiup-component-cluster-check.md @@ -176,7 +176,7 @@ If the `tiup cluster check ` command is used, you must add the `-- - Specifies the user name to connect to the target machine. The specified user needs to have the password-free sudo root privileges on the target machine. - Data type: `STRING` -- If this option is not specified in the command, user who executes the command is used as the default value. +- If this option is not specified in the command, the user who executes the command is used as the default value. > **Note:** > From 7cba39138e118aaf961eb66d00383f9062115775 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Fri, 16 Apr 2021 10:48:40 +0800 Subject: [PATCH 09/14] Update tiup/tiup-component-cluster-check.md Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com> --- tiup/tiup-component-cluster-check.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/tiup/tiup-component-cluster-check.md b/tiup/tiup-component-cluster-check.md index c39c4e3809ba..e30e530b7c25 100644 --- a/tiup/tiup-component-cluster-check.md +++ b/tiup/tiup-component-cluster-check.md @@ -147,12 +147,12 @@ tiup cluster check [flags] > **Note:** > > tiup-cluster supports checking both un-deployed clusters and deployed clusters with the following command format: - -```shell -tiup cluster check [flags] -``` - -If the `tiup cluster check ` command is used, you must add the `--cluster` option: `tiup cluster check --cluster`. +> +> ```shell +> tiup cluster check [flags] +> ``` +> +> If the `tiup cluster check ` command is used, you must add the `--cluster` option: `tiup cluster check --cluster`. ### --enable-cpu From 98a4a310bb5611321a3dfc71f4008c9c26d567e5 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Fri, 16 Apr 2021 10:54:40 +0800 Subject: [PATCH 10/14] Apply suggestions from code review Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com> --- tiup/tiup-component-dm-display.md | 2 +- tiup/tiup-component-dm-upgrade.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/tiup/tiup-component-dm-display.md b/tiup/tiup-component-dm-display.md index 981897a9dd48..0a1274c1920d 100644 --- a/tiup/tiup-component-dm-display.md +++ b/tiup/tiup-component-dm-display.md @@ -12,7 +12,7 @@ If you want to check the operational status of each component in a DM cluster, i tiup dm display [flags] ``` -`` is the name of the cluster to operate on. If you forget the cluster name, check it in [tiup cluster list](/tiup/tiup-component-cluster-list.md). +`` is the name of the cluster to be operated. If you forget the cluster name, check it in the [tiup dm cluster list](/tiup/tiup-component-dm-list.md). ## Options diff --git a/tiup/tiup-component-dm-upgrade.md b/tiup/tiup-component-dm-upgrade.md index fc1cd4f21fc1..0d9134021c5c 100644 --- a/tiup/tiup-component-dm-upgrade.md +++ b/tiup/tiup-component-dm-upgrade.md @@ -12,7 +12,7 @@ The `tiup dm upgrade` command is used to upgrade a specified cluster to a specif tiup dm upgrade [flags] ``` -- `` is the name of the cluster to operate on. If you forget the cluster name, check it in [tiup cluster list](/tiup/tiup-component-cluster-list.md). +- `` is the name of the cluster to be operated on. If you forget the cluster name, check it in [tiup DM cluster list](/tiup/tiup-component-dm-list.md). - `` is the target version to be upgraded to. Currently, only upgrading to a later version is allowed, and upgrading to an earlier version is not allowed, which means the downgrade is not allowed. Upgrading to a nightly version is not allowed either. ## Options From ec72a0556ff0905a383b934340d2f2d6750b8b28 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Fri, 16 Apr 2021 11:10:32 +0800 Subject: [PATCH 11/14] Apply suggestions from code review Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com> --- tiup/tiup-component-dm-display.md | 2 +- tiup/tiup-component-dm-upgrade.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/tiup/tiup-component-dm-display.md b/tiup/tiup-component-dm-display.md index 0a1274c1920d..958832e54190 100644 --- a/tiup/tiup-component-dm-display.md +++ b/tiup/tiup-component-dm-display.md @@ -12,7 +12,7 @@ If you want to check the operational status of each component in a DM cluster, i tiup dm display [flags] ``` -`` is the name of the cluster to be operated. If you forget the cluster name, check it in the [tiup dm cluster list](/tiup/tiup-component-dm-list.md). +`` is the name of the cluster to be operated. If you forget the cluster name, you can use the `[tiup dm list](/tiup/tiup-component-dm-list.md)` command to check it. ## Options diff --git a/tiup/tiup-component-dm-upgrade.md b/tiup/tiup-component-dm-upgrade.md index 0d9134021c5c..31bcb8aa2e90 100644 --- a/tiup/tiup-component-dm-upgrade.md +++ b/tiup/tiup-component-dm-upgrade.md @@ -1,6 +1,6 @@ --- +--- title: tiup dm upgrade --- +--- # tiup dm upgrade @@ -12,7 +12,7 @@ The `tiup dm upgrade` command is used to upgrade a specified cluster to a specif tiup dm upgrade [flags] ``` -- `` is the name of the cluster to be operated on. If you forget the cluster name, check it in [tiup DM cluster list](/tiup/tiup-component-dm-list.md). +- `` is the name of the cluster to be operated on. If you forget the cluster name, you can use the `[tiup dm list](/tiup/tiup-component-dm-list.md)` command to check it. - `` is the target version to be upgraded to. Currently, only upgrading to a later version is allowed, and upgrading to an earlier version is not allowed, which means the downgrade is not allowed. Upgrading to a nightly version is not allowed either. ## Options From 716d9e3ad59a7ee6eb86d8a435de67e889450436 Mon Sep 17 00:00:00 2001 From: qiancai Date: Fri, 16 Apr 2021 13:27:20 +0800 Subject: [PATCH 12/14] Comment out the dead link temporarily --- tiup/tiup-component-cluster-check.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-component-cluster-check.md b/tiup/tiup-component-cluster-check.md index e30e530b7c25..cd3a78f88fb8 100644 --- a/tiup/tiup-component-cluster-check.md +++ b/tiup/tiup-component-cluster-check.md @@ -117,7 +117,7 @@ Use flexible I/O tester (fio) to test the performance of the disk where `data_di tiup cluster check [flags] ``` -- If a cluster is not deployed yet, you need to pass the [topology.yml](/tiup/tiup-cluster-topology-reference.md) file that is used to deploy the cluster. According to the content in this file, tiup-cluster connects to the corresponding machine to perform the check. +- If a cluster is not deployed yet, you need to pass the topology.yml file that is used to deploy the cluster. According to the content in this file, tiup-cluster connects to the corresponding machine to perform the check. - If a cluster is already deployed, you can use the `` as the check object. > **Note:** From 1e037c2c6531aeb2c4c3c95965450e393d96301c Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Fri, 16 Apr 2021 16:46:58 +0800 Subject: [PATCH 13/14] Apply suggestions from code review Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com> --- tiup/tiup-component-dm-display.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/tiup/tiup-component-dm-display.md b/tiup/tiup-component-dm-display.md index 958832e54190..97809748a425 100644 --- a/tiup/tiup-component-dm-display.md +++ b/tiup/tiup-component-dm-display.md @@ -18,9 +18,9 @@ tiup dm display [flags] ### -N, --node -Specifies the IDs of the nodes to query, splitting by commas for multiple nodes. If you are not sure about the ID of a node, you can skip this option in the command to show the IDs and status of all nodes in the output. -Data type: `STRING` -This option is enabled by default with `[]` (which means all nodes) passed in. + - Specifies the IDs of the nodes to query, splitting by commas for multiple nodes. If you are not sure about the ID of a node, you can skip this option in the command to show the IDs and status of all nodes in the output. +- Data type: `STRING` +- This option is enabled by default with `[]` (which means all nodes) passed in. > **Note:** > @@ -28,9 +28,9 @@ This option is enabled by default with `[]` (which means all nodes) passed in. ### -R, --role -Specifies the roles to query, splitting by commas for multiple roles. If you are not sure about the role deployed on a node, you can skip this option in the command to show the roles and status of all nodes in the output. -Data type: `STRING` -This option is enabled by default with `[]` (which means all roles) passed in. +- Specifies the roles to query, splitting by commas for multiple roles. If you are not sure about the role deployed on a node, you can skip this option in the command to show the roles and status of all nodes in the output. +- Data type: `STRING` +- This option is enabled by default with `[]` (which means all roles) passed in. > **Note:** > From 39a90969dc4514710f7180b498f3fc65ac5ab81a Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Fri, 16 Apr 2021 16:57:31 +0800 Subject: [PATCH 14/14] Update tiup/tiup-component-dm-display.md Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com> --- tiup/tiup-component-dm-display.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-component-dm-display.md b/tiup/tiup-component-dm-display.md index 97809748a425..1945ae76a847 100644 --- a/tiup/tiup-component-dm-display.md +++ b/tiup/tiup-component-dm-display.md @@ -18,7 +18,7 @@ tiup dm display [flags] ### -N, --node - - Specifies the IDs of the nodes to query, splitting by commas for multiple nodes. If you are not sure about the ID of a node, you can skip this option in the command to show the IDs and status of all nodes in the output. +- Specifies the IDs of the nodes to query, splitting by commas for multiple nodes. If you are not sure about the ID of a node, you can skip this option in the command to show the IDs and status of all nodes in the output. - Data type: `STRING` - This option is enabled by default with `[]` (which means all nodes) passed in.