From bfc85304dc455507cb1a3b4c09ad5e3162b136fc Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Mon, 12 Apr 2021 17:56:15 +0800 Subject: [PATCH 01/11] add 3 docs --- tiup/tiup-component-cluster-deploy.md | 2 +- tiup/tiup-component-cluster-disable.md | 8 +-- tiup/tiup-component-cluster-display.md | 4 +- tiup/tiup-component-cluster-enable.md | 51 +++++++++++++++ tiup/tiup-component-cluster-reload.md | 81 ++++++++++++++++++++++++ tiup/tiup-component-cluster-scale-out.md | 60 ++++++++++++++++++ 6 files changed, 199 insertions(+), 7 deletions(-) create mode 100644 tiup/tiup-component-cluster-enable.md create mode 100644 tiup/tiup-component-cluster-reload.md create mode 100644 tiup/tiup-component-cluster-scale-out.md diff --git a/tiup/tiup-component-cluster-deploy.md b/tiup/tiup-component-cluster-deploy.md index 9b2ee76bc8c71..c9324f63b905e 100644 --- a/tiup/tiup-component-cluster-deploy.md +++ b/tiup/tiup-component-cluster-deploy.md @@ -50,7 +50,7 @@ tiup cluster deploy [flags] - Data type: `BOOLEAN` - Default: false -### --skip-create-user（boolean，false） +### --skip-create-user - During the cluster deployment, tiup-cluster checks whether the specified user name in the topology file exists or not. If not, it creates one. To skip this check, you can use the `--skip-create-user` option. - Data type: `BOOLEAN` diff --git a/tiup/tiup-component-cluster-disable.md b/tiup/tiup-component-cluster-disable.md index 3e8a9426c6862..4e21a436baf9b 100644 --- a/tiup/tiup-component-cluster-disable.md +++ b/tiup/tiup-component-cluster-disable.md @@ -4,7 +4,7 @@ title: tiup cluster disable # tiup cluster disable -The `tiup cluster disable` command is used to disable the auto-enabling after restarting the machine where the cluster service is located. This command executes the `systemctl disable ` on the specified node to disable the auto-enabling of the service. +The `tiup cluster disable` command is used to disable the auto-enabling after rebooting the machine where the cluster service is located. This command executes the `systemctl disable ` on the specified node to disable the auto-enabling of the service. ## Syntax @@ -18,15 +18,15 @@ tiup cluster disable [flags] ### -N, --node +- Specifies the nodes whose auto-enabling service is to be disabled. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. - Data type: `strings` - Default: `[]`, which means no node is selected. -- Specifies the nodes whose auto-enabling service is to be disabled. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. > **Note:** > > If the `-R, --role` option is specified at the same time, the auto-enabling of services in their intersection is disabled. -### -R, --role strings +### -R, --role - Data type: `strings` - Default: `[]`, which means no role is selected. @@ -38,7 +38,7 @@ tiup cluster disable [flags] ### -h, --help -- Outputs the help information. +- Prints the help information. - Data type: `BOOLEAN` - Default: false diff --git a/tiup/tiup-component-cluster-display.md b/tiup/tiup-component-cluster-display.md index 824627ae9459b..22bdd973aeda0 100644 --- a/tiup/tiup-component-cluster-display.md +++ b/tiup/tiup-component-cluster-display.md @@ -24,9 +24,9 @@ tiup cluster display [flags] ### -N, --node +- Specifies the node to query. If not specified, all nodes are queried. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. - Data type: `strings` - Default: `[]`, which means all nodes. -- Specifies the node to query. If not specified, all nodes are queried. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. > **Note:** > @@ -34,9 +34,9 @@ tiup cluster display [flags] ### -R, --role strings +- Specifies the role to query. If not specified, all roles are queried. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. - Data type: `strings` - Default: `[]`, which means all roles. -- Specifies the role to query. If not specified, all roles are queried. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. > **Note:** > diff --git a/tiup/tiup-component-cluster-enable.md b/tiup/tiup-component-cluster-enable.md new file mode 100644 index 0000000000000..6294d9b868f36 --- /dev/null +++ b/tiup/tiup-component-cluster-enable.md @@ -0,0 +1,51 @@ +--- +title: tiup cluster enable +--- + +# tiup cluster enable + +The `tiup cluster enable` command is used to set the self-enabling of the cluster service after a machine reboots. To enable the self-enabling of the service, this command executes `systemctl enable ` at the specified node. + +> **Note:** +> +> When all clusters are shut down and restarted, the order of service startup is determined by the node's operating system startup order. When the restart order is incorrect, in some cases, the restarted cluster still cannot provide services (For example, if TiKV is started first but PD is not started, system gives up if TiKV is restarted multiple times but PD is not found). + +## Syntax + +```shell +tiup cluster enable [flags] +``` + +``: the cluster whose auto-enabling service is to be enabled. + +## Options + +### -N, --node + +- Specifies the nodes whose auto-enabling service is to be enabled. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. +- Data type: `strings` +- Default: `[]`, which means no node is selected. + +> **Note:** +> +> If the `-R, --role` option is specified at the same time, the auto-enabling of services in their intersection is enabled. + +### -R, --role + +- Specifies the roles whose auto-enabling service is to be disabled. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. +- Data type: `strings` +- Default: `[]`, which means no role is selected. + +> **Note:** +> +> If the `-N, --node` option is specified at the same time, the auto-enabling of services in their intersection is enabled. + +### -h, --help + +- Prints the help information. +- Data type: `BOOLEAN` +- Default: false + +## Output + +The execution log of the tiup-cluster. \ No newline at end of file diff --git a/tiup/tiup-component-cluster-reload.md b/tiup/tiup-component-cluster-reload.md new file mode 100644 index 0000000000000..e6ab6f55bc1a1 --- /dev/null +++ b/tiup/tiup-component-cluster-reload.md @@ -0,0 +1,81 @@ +--- +title: tiup cluster reload +--- + +# tiup cluster reload + +After [modifying the cluster configuration](/tiup/tiup-component-cluster-edit-config.md), the cluster needs to be reloaded using the `tiup cluster reload` command for the configuration to take effect. This command publishes the configuration of the control machine to the remote machine where the service is running, and follow the upgrade process to restart the services in order according to the upgrade process, and the cluster is still available during the restart process. + +## Syntax + +```shell +tiup cluster reload [flags] +``` + +``: the cluster name to operate on. + +## Options + +### --force + +- Ignores errors in the reloading process and forces reload. +- Data type: `BOOLEAN` +- Default: false + +### --transfer-timeout + +- When restarting PD or TiKV, the leader of the restarted node is migrated to other nodes first, and the migration process takes some time. You can set the maximum wait time (in seconds) by setting `-transfer-timeout`. After the timeout, the service can be restarted directly without waiting. +- Data type: `uint` +- Default: 300 + +> **Note:** +> +> In the case of skipping the waiting and restarting directly, the service performance might jitter. + +### --ignore-config-check + +- After the binary files of components are deployed, the configurations of TiDB, TiKV, and PD components are checked using ` --config-check `. `` is the path of the deployed binary file. `` is the configuration file generated based on the user configuration. If you want to skip this check, you can use this option. +- Data type: `BOOLEAN` +- Default: false + +### -N, --node + +- Specifies the nodes to be restarted. If not specified, all nodes are restarted. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. +- Data type: `strings` +- Default: `[]`, which means no node is selected. + +> **Note:** +> +> + If the `-R, --role` option is specified at the same time, then the service status in their intersection is restarted. +> + If the `--skip-restart` option is specified, the `-N, --node` option is invalid. + +### -R, --role + +- Data type: `strings` +- Default: `[]`, which means no role is selected. +- Specifies the roles whose auto-enabling service is to be disabled. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. + +> **Note:** +> +> 1. If the `-N, --node` option is specified at the same time, the services in their intersection is restarted. +> 2. If the `--skip-restart` option is specified, the `-R, --role` option is invalid. + +### --skip-restart + +The `tiup cluster reload` command performs two operations: + +- Refreshes all node configurations +- Restarts the specified node + +- After you specify this option, it only refreshes the configuration and does not restart any nodes, so that the refreshed configuration is not applied and does not take effect until the next restart of the corresponding service. +- Data type: `BOOLEAN` + +### -h, --help + +- Prints the help information. +- Data type: `BOOLEAN` +- Default: false + +## Output + +The execution log of the tiup-cluster. \ No newline at end of file diff --git a/tiup/tiup-component-cluster-scale-out.md b/tiup/tiup-component-cluster-scale-out.md new file mode 100644 index 0000000000000..8e37ce3caa130 --- /dev/null +++ b/tiup/tiup-component-cluster-scale-out.md @@ -0,0 +1,60 @@ +--- +title: tiup cluster scale-out +--- + +# tiup cluster scale-out + +The `tiup cluster scale-out` command is used for scaling out the cluster. The internal logic of scaling out the cluster is similar to the cluster deployment. The tiup-cluster component first establishes an SSH connection to the new node, creates the necessary directories on the target node, then performs the deployment and starts the service. The scaling out of the PD node is added to the cluster by the join operation, and the configuration of the services associated with the PD is updated; other services are directly started and added to the cluster. + +## Syntax + +```shell +tiup cluster scale-out [flags] +``` + +``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list](/tiup/tiup-component-dm-list.md) command. +``: the prepared [topology file](/tiup/tiup-dm-topology-reference.md). This topology file should only contain the new nodes that are to be added to the current cluster. + +## Options + +### -u, --user + +- Specifies the user name used to connect to the target machine. This user must have the secret-free sudo root permission on the target machine. +- Data type: `STRING` +- Default: the current user who executes the command. + +### -i, --identity_file + +- Specifies the key file used to connect to the target machine. +- Data type: `STRING` +- If this option is not specified in the command, the `~/.ssh/id_rsa` file is used to connect to the target machine by default. + +### -p, --password + +- Specifies the password used to connect to the target machine. Do not use this option and `-i/--identity_file` at the same time. +- Data type: `BOOLEAN` +- Default: false + +### --no-labels + +- This option is used to skip the label check. +- When two or more TiKV nodes are deployed on the same physical machine, a risk exists: PD cannot learn the cluster topology, so PD might schedule multiple replicas of a Region to different TiKV nodes on one physical machine, which makes this physical machine a single point. To avoid this risk, you can use labels to tell PD not to schedule the same Region to the same machine. See [Schedule Replicas by Topology Labels](/schedule-replicas-by-topology-labels.md) for label configuration. +- For the test environment, this risk might matter and you can use `--no-labels` to skip the check. +- Data type: `BOOLEAN` +- Default: false + +### --skip-create-user + +- During the cluster deployment, tiup-cluster checks whether the specified user name in the topology file exists or not. If not, it creates one. To skip this check, you can use the `--skip-create-user` option. +- Data type: `BOOLEAN` +- Default: false + +### -h, --help + +- Prints the help information. +- Data type: `BOOLEAN` +- Default: false + +## Output + +The log of scaling out. \ No newline at end of file From 80a6a9f718f366970a0673a3f399428c6341377f Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Mon, 12 Apr 2021 18:22:57 +0800 Subject: [PATCH 02/11] Update tiup-component-cluster-enable.md --- tiup/tiup-component-cluster-enable.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-component-cluster-enable.md b/tiup/tiup-component-cluster-enable.md index 6294d9b868f36..86fc56fa3e9ca 100644 --- a/tiup/tiup-component-cluster-enable.md +++ b/tiup/tiup-component-cluster-enable.md @@ -32,7 +32,7 @@ tiup cluster enable [flags] ### -R, --role -- Specifies the roles whose auto-enabling service is to be disabled. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. +- Specifies the roles whose auto-enabling service is to be enabled. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. - Data type: `strings` - Default: `[]`, which means no role is selected. From aca4eaba479fd533c118bba800441c4373d11619 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Tue, 13 Apr 2021 10:42:50 +0800 Subject: [PATCH 03/11] Update tiup-component-cluster-reload.md --- tiup/tiup-component-cluster-reload.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/tiup/tiup-component-cluster-reload.md b/tiup/tiup-component-cluster-reload.md index e6ab6f55bc1a1..e95288bdd6896 100644 --- a/tiup/tiup-component-cluster-reload.md +++ b/tiup/tiup-component-cluster-reload.md @@ -4,7 +4,7 @@ title: tiup cluster reload # tiup cluster reload -After [modifying the cluster configuration](/tiup/tiup-component-cluster-edit-config.md), the cluster needs to be reloaded using the `tiup cluster reload` command for the configuration to take effect. This command publishes the configuration of the control machine to the remote machine where the service is running, and follow the upgrade process to restart the services in order according to the upgrade process, and the cluster is still available during the restart process. +After [modifying the cluster configuration](/tiup/tiup-component-cluster-edit-config.md), the cluster needs to be reloaded using the `tiup cluster reload` command for the configuration to take effect. This command publishes the configuration of the control machine to the remote machine where the service is running, and follows the upgrade process to restart the services in order according to the upgrade process, and the cluster is still available during the restart process. ## Syntax @@ -67,8 +67,9 @@ The `tiup cluster reload` command performs two operations: - Refreshes all node configurations - Restarts the specified node -- After you specify this option, it only refreshes the configuration and does not restart any nodes, so that the refreshed configuration is not applied and does not take effect until the next restart of the corresponding service. +- After you specify the `--skip-restart` option, it only refreshes the configuration and does not restart any nodes, so that the refreshed configuration is not applied and does not take effect until the next restart of the corresponding service. - Data type: `BOOLEAN` +- Default: false ### -h, --help From d995d0ad1033a8fabbd1970e75710a362271cb30 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Tue, 13 Apr 2021 11:12:32 +0800 Subject: [PATCH 04/11] Update tiup-component-cluster-reload.md --- tiup/tiup-component-cluster-reload.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tiup/tiup-component-cluster-reload.md b/tiup/tiup-component-cluster-reload.md index e95288bdd6896..d843a49cba4da 100644 --- a/tiup/tiup-component-cluster-reload.md +++ b/tiup/tiup-component-cluster-reload.md @@ -52,8 +52,8 @@ tiup cluster reload [flags] ### -R, --role - Data type: `strings` -- Default: `[]`, which means no role is selected. -- Specifies the roles whose auto-enabling service is to be disabled. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. +- Default: `[]`, which means no role is selected.S +- Specifies the roles to be restarted. If not specified, all roles are restarted. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. > **Note:** > From 744fe21f67fdf15cdf4bc87ffecfcf62e8cb9c50 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Tue, 13 Apr 2021 11:25:52 +0800 Subject: [PATCH 05/11] Update tiup-component-cluster-reload.md --- tiup/tiup-component-cluster-reload.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tiup/tiup-component-cluster-reload.md b/tiup/tiup-component-cluster-reload.md index d843a49cba4da..27ee5a43fe282 100644 --- a/tiup/tiup-component-cluster-reload.md +++ b/tiup/tiup-component-cluster-reload.md @@ -42,7 +42,7 @@ tiup cluster reload [flags] - Specifies the nodes to be restarted. If not specified, all nodes are restarted. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. - Data type: `strings` -- Default: `[]`, which means no node is selected. +- Default: `[]`, which means all nodes are selected. > **Note:** > @@ -51,9 +51,9 @@ tiup cluster reload [flags] ### -R, --role -- Data type: `strings` -- Default: `[]`, which means no role is selected.S - Specifies the roles to be restarted. If not specified, all roles are restarted. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. +- Data type: `strings` +- Default: `[]`, which means all roles are selected. > **Note:** > From ad3a913d0df8fffa667ef8a47b30706165d3d7e7 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Tue, 13 Apr 2021 14:49:39 +0800 Subject: [PATCH 06/11] restart --- tiup/tiup-component-cluster-disable.md | 2 +- tiup/tiup-component-cluster-enable.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/tiup/tiup-component-cluster-disable.md b/tiup/tiup-component-cluster-disable.md index 4e21a436baf9b..b302260bc8968 100644 --- a/tiup/tiup-component-cluster-disable.md +++ b/tiup/tiup-component-cluster-disable.md @@ -4,7 +4,7 @@ title: tiup cluster disable # tiup cluster disable -The `tiup cluster disable` command is used to disable the auto-enabling after rebooting the machine where the cluster service is located. This command executes the `systemctl disable ` on the specified node to disable the auto-enabling of the service. +The `tiup cluster disable` command is used to disable the auto-enabling after restarting the machine where the cluster service is located. This command executes the `systemctl disable ` on the specified node to disable the auto-enabling of the service. ## Syntax diff --git a/tiup/tiup-component-cluster-enable.md b/tiup/tiup-component-cluster-enable.md index 86fc56fa3e9ca..b96c258ac8ce6 100644 --- a/tiup/tiup-component-cluster-enable.md +++ b/tiup/tiup-component-cluster-enable.md @@ -4,7 +4,7 @@ title: tiup cluster enable # tiup cluster enable -The `tiup cluster enable` command is used to set the self-enabling of the cluster service after a machine reboots. To enable the self-enabling of the service, this command executes `systemctl enable ` at the specified node. +The `tiup cluster enable` command is used to set the self-enabling of the cluster service after a machine restarts. To enable the self-enabling of the service, this command executes `systemctl enable ` at the specified node. > **Note:** > From 4775e30c7c96d656e49a2e8570c2a25d7d5a42a0 Mon Sep 17 00:00:00 2001 From: JoyinQ <56883733+Joyinqin@users.noreply.github.com> Date: Tue, 13 Apr 2021 15:00:19 +0800 Subject: [PATCH 07/11] Apply suggestions from code review Co-authored-by: Ran --- tiup/tiup-component-cluster-enable.md | 4 ++-- tiup/tiup-component-cluster-reload.md | 4 ++-- tiup/tiup-component-cluster-scale-out.md | 10 ++++++---- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/tiup/tiup-component-cluster-enable.md b/tiup/tiup-component-cluster-enable.md index b96c258ac8ce6..7431182c4a440 100644 --- a/tiup/tiup-component-cluster-enable.md +++ b/tiup/tiup-component-cluster-enable.md @@ -8,7 +8,7 @@ The `tiup cluster enable` command is used to set the self-enabling of the cluste > **Note:** > -> When all clusters are shut down and restarted, the order of service startup is determined by the node's operating system startup order. When the restart order is incorrect, in some cases, the restarted cluster still cannot provide services (For example, if TiKV is started first but PD is not started, system gives up if TiKV is restarted multiple times but PD is not found). +> When all clusters are shut down and restarted, the order of service startup is determined by the node's operating system startup order. When the restart order is incorrect, in some cases, the restarted cluster still cannot provide services. For example, if TiKV is started first but PD is not started, systemd gives up if TiKV is restarted multiple times while PD is not found). ## Syntax @@ -48,4 +48,4 @@ tiup cluster enable [flags] ## Output -The execution log of the tiup-cluster. \ No newline at end of file +The execution log of the tiup-cluster. diff --git a/tiup/tiup-component-cluster-reload.md b/tiup/tiup-component-cluster-reload.md index 27ee5a43fe282..acef08fa9430c 100644 --- a/tiup/tiup-component-cluster-reload.md +++ b/tiup/tiup-component-cluster-reload.md @@ -4,7 +4,7 @@ title: tiup cluster reload # tiup cluster reload -After [modifying the cluster configuration](/tiup/tiup-component-cluster-edit-config.md), the cluster needs to be reloaded using the `tiup cluster reload` command for the configuration to take effect. This command publishes the configuration of the control machine to the remote machine where the service is running, and follows the upgrade process to restart the services in order according to the upgrade process, and the cluster is still available during the restart process. +After [modifying the cluster configuration](/tiup/tiup-component-cluster-edit-config.md), the cluster needs to be reloaded using the `tiup cluster reload` command for the configuration to take effect. This command publishes the configuration of the control machine to the remote machine where the service is running, and follows the upgrade process to restart the services in order according to the upgrade process. The cluster is still available during the restart process. ## Syntax @@ -79,4 +79,4 @@ The `tiup cluster reload` command performs two operations: ## Output -The execution log of the tiup-cluster. \ No newline at end of file +The execution log of the tiup-cluster. diff --git a/tiup/tiup-component-cluster-scale-out.md b/tiup/tiup-component-cluster-scale-out.md index 8e37ce3caa130..c6a4f67218f2d 100644 --- a/tiup/tiup-component-cluster-scale-out.md +++ b/tiup/tiup-component-cluster-scale-out.md @@ -4,7 +4,9 @@ title: tiup cluster scale-out # tiup cluster scale-out -The `tiup cluster scale-out` command is used for scaling out the cluster. The internal logic of scaling out the cluster is similar to the cluster deployment. The tiup-cluster component first establishes an SSH connection to the new node, creates the necessary directories on the target node, then performs the deployment and starts the service. The scaling out of the PD node is added to the cluster by the join operation, and the configuration of the services associated with the PD is updated; other services are directly started and added to the cluster. +The `tiup cluster scale-out` command is used for scaling out the cluster. The internal logic of scaling out the cluster is similar to the cluster deployment. The tiup-cluster component first establishes an SSH connection to the new node, creates the necessary directories on the target node, then performs the deployment and starts the service. + +When PD is scaled out, new PD nodes are added to the cluster by the join operation, and the configuration of the services associated with PD is updated; other services are directly started and added to the cluster. ## Syntax @@ -38,8 +40,8 @@ tiup cluster scale-out [flags] ### --no-labels - This option is used to skip the label check. -- When two or more TiKV nodes are deployed on the same physical machine, a risk exists: PD cannot learn the cluster topology, so PD might schedule multiple replicas of a Region to different TiKV nodes on one physical machine, which makes this physical machine a single point. To avoid this risk, you can use labels to tell PD not to schedule the same Region to the same machine. See [Schedule Replicas by Topology Labels](/schedule-replicas-by-topology-labels.md) for label configuration. -- For the test environment, this risk might matter and you can use `--no-labels` to skip the check. +- When two or more TiKV nodes are deployed on the same physical machine, a risk exists: PD does not know the cluster topology, so it might schedule multiple replicas of a Region to different TiKV nodes on one physical machine, which makes this physical machine a single point of failure. To avoid this risk, you can use labels to tell PD not to schedule the same Region to the same machine. See [Schedule Replicas by Topology Labels](/schedule-replicas-by-topology-labels.md) for label configuration. +- For the test environment, this risk might not matter, and you can use `--no-labels` to skip the check. - Data type: `BOOLEAN` - Default: false @@ -57,4 +59,4 @@ tiup cluster scale-out [flags] ## Output -The log of scaling out. \ No newline at end of file +The log of scaling out. From 02c7b8fa0210bef06b4185518ba153c4579e94a4 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Tue, 13 Apr 2021 16:12:31 +0800 Subject: [PATCH 08/11] adjust the list --- tiup/tiup-component-cluster-reload.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tiup/tiup-component-cluster-reload.md b/tiup/tiup-component-cluster-reload.md index acef08fa9430c..5cacc37185565 100644 --- a/tiup/tiup-component-cluster-reload.md +++ b/tiup/tiup-component-cluster-reload.md @@ -67,7 +67,8 @@ The `tiup cluster reload` command performs two operations: - Refreshes all node configurations - Restarts the specified node -- After you specify the `--skip-restart` option, it only refreshes the configuration and does not restart any nodes, so that the refreshed configuration is not applied and does not take effect until the next restart of the corresponding service. +After you specify the `--skip-restart` option, it only refreshes the configuration without restarting any nodes, so that the refreshed configuration is not applied and does not take effect until the next restart of the corresponding service. + - Data type: `BOOLEAN` - Default: false From e49ac9e4b3ed6c952f42c644aeff0ba566085cd9 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Thu, 15 Apr 2021 14:38:03 +0800 Subject: [PATCH 09/11] Update tiup-component-cluster-scale-out.md --- tiup/tiup-component-cluster-scale-out.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tiup/tiup-component-cluster-scale-out.md b/tiup/tiup-component-cluster-scale-out.md index c6a4f67218f2d..5f98a73154497 100644 --- a/tiup/tiup-component-cluster-scale-out.md +++ b/tiup/tiup-component-cluster-scale-out.md @@ -14,8 +14,8 @@ When PD is scaled out, new PD nodes are added to the cluster by the join operati tiup cluster scale-out [flags] ``` -``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list](/tiup/tiup-component-dm-list.md) command. -``: the prepared [topology file](/tiup/tiup-dm-topology-reference.md). This topology file should only contain the new nodes that are to be added to the current cluster. +``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list]command. +``: the prepared [topology file]. This topology file should only contain the new nodes that are to be added to the current cluster. ## Options From fc825092de9064cc2126b16cbae74e4a85cc360f Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Thu, 15 Apr 2021 16:21:36 +0800 Subject: [PATCH 10/11] Update tiup-component-cluster-scale-out.md --- tiup/tiup-component-cluster-scale-out.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tiup/tiup-component-cluster-scale-out.md b/tiup/tiup-component-cluster-scale-out.md index 5f98a73154497..9acdf2b7c3ae9 100644 --- a/tiup/tiup-component-cluster-scale-out.md +++ b/tiup/tiup-component-cluster-scale-out.md @@ -14,8 +14,8 @@ When PD is scaled out, new PD nodes are added to the cluster by the join operati tiup cluster scale-out [flags] ``` -``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list]command. -``: the prepared [topology file]. This topology file should only contain the new nodes that are to be added to the current cluster. +``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the `cluster list`command. +``: the prepared topology file. This topology file should only contain the new nodes that are to be added to the current cluster. ## Options From d7ea7f5b34b73460a9b5b72f404ad2d0b5f3aff3 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Thu, 15 Apr 2021 16:37:03 +0800 Subject: [PATCH 11/11] Update tiup-component-cluster-scale-out.md --- tiup/tiup-component-cluster-scale-out.md | 1 + 1 file changed, 1 insertion(+) diff --git a/tiup/tiup-component-cluster-scale-out.md b/tiup/tiup-component-cluster-scale-out.md index 9acdf2b7c3ae9..e297b75ad4395 100644 --- a/tiup/tiup-component-cluster-scale-out.md +++ b/tiup/tiup-component-cluster-scale-out.md @@ -15,6 +15,7 @@ tiup cluster scale-out [flags] ``` ``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the `cluster list`command. + ``: the prepared topology file. This topology file should only contain the new nodes that are to be added to the current cluster. ## Options