From 359f87fff2069fb1779d4c64db0a6e855c8a3d6b Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Tue, 13 Apr 2021 16:29:43 +0800 Subject: [PATCH 01/10] add 4 docs --- tiup/tiup-component-dm-prune.md | 25 +++++++++++++ tiup/tiup-component-dm-reload.md | 61 ++++++++++++++++++++++++++++++++ tiup/tiup-component-dm-start.md | 47 ++++++++++++++++++++++++ tiup/tiup-component-dm-stop.md | 51 ++++++++++++++++++++++++++ 4 files changed, 184 insertions(+) create mode 100644 tiup/tiup-component-dm-prune.md create mode 100644 tiup/tiup-component-dm-reload.md create mode 100644 tiup/tiup-component-dm-start.md create mode 100644 tiup/tiup-component-dm-stop.md diff --git a/tiup/tiup-component-dm-prune.md b/tiup/tiup-component-dm-prune.md new file mode 100644 index 0000000000000..21f26b4e1adc6 --- /dev/null +++ b/tiup/tiup-component-dm-prune.md @@ -0,0 +1,25 @@ +--- +title: tiup dm prune +--- + +# tiup dm prune + +When [scaling in the cluster](/tiup/tiup-component-dm-scale-in.md), a small amount of meta-information in etcd is not cleaned up, and usually causes no problem. If you really need to clean the meta-information up, you can manually execute the `tiup cluster prune` command. + +## Syntax + +```shell +tiup dm prune [flags] +``` + +## Option + +### -h, --help + +- Prints the help information. +- Data type: `BOOLEAN` +- Default: false + +## Output + +The log of the cleanup process. diff --git a/tiup/tiup-component-dm-reload.md b/tiup/tiup-component-dm-reload.md new file mode 100644 index 0000000000000..2e4f036db1f77 --- /dev/null +++ b/tiup/tiup-component-dm-reload.md @@ -0,0 +1,61 @@ +--- +title: tiup dm reload +--- + +# tiup dm reload + +After [modifying the cluster configuration](/tiup/tiup-component-dm-edit-config.md), the cluster needs to be reloaded using the `tiup dm 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 restarts the service in order according to the upgrade process. The cluster remains available during the restart process. + +## Syntax + +```shell +tiup dm reload [flags] +``` + +``: the name of the cluster to operate on. + +## Options + +### -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-dm-display.md) table. +- Data type: `strings` +- Default: `[]`, which means all nodes are 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 + +- 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-dm-display.md) table. +- Data type: `strings` +- Default: `[]`, which means all roles are selected. + +> **Note:** +> +> + If the `-N, --node` option is specified at the same time, the services in their intersection is restarted. +> + If the `--skip-restart` option is specified, the `-R, --role` option is invalid. + +### --skip-restart + +The `tiup dm 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 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 + +### -h, --help + +- Prints the help information. +- Data type: `BOOLEAN` +- Default: false + +## 输出 + +The execution log of the tiup-dm. \ No newline at end of file diff --git a/tiup/tiup-component-dm-start.md b/tiup/tiup-component-dm-start.md new file mode 100644 index 0000000000000..f1bd741c06d3a --- /dev/null +++ b/tiup/tiup-component-dm-start.md @@ -0,0 +1,47 @@ +--- +title: tiup dm start +--- + +# tiup dm start + +The `tiup dm start` command is used to start all or part of the services of the specified cluster. + +## Syntax + +```shell +tiup dm start [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. + +## Options + +### -N, --node + +- Specifies the nodes to be started. If not specified, all nodes are started. 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-dm-display.md) table. +- Data type: `strings` +- Default: `[]`, which means all nodes are selected. + +> **Note:** +> +> If the `-R, --role` option is specified at the same time, then the service status in their intersection is started. + +### -R, --role + +- Specifies the roles to be started. If not specified, all roles are started. 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-dm-display.md) table. +- Data type: `strings` +- Default: `[]`, which means all roles are selected. + +> **Note:** +> +> If the `-N, --node` option is specified at the same time, the services in their intersection is started. + +### -h, --help + +- Prints the help information. +- Data type: `BOOLEAN` +- Default: false + +## Output + +The log of startup. \ No newline at end of file diff --git a/tiup/tiup-component-dm-stop.md b/tiup/tiup-component-dm-stop.md new file mode 100644 index 0000000000000..9bfb529d8de8f --- /dev/null +++ b/tiup/tiup-component-dm-stop.md @@ -0,0 +1,51 @@ +--- +title: tiup dm stop +--- + +# tiup dm stop + +The `tiup dm stop` command is used to stop all or part of the services of the specified cluster. + +> **Note:** +> +> The cluster cannot provide services after the core service is stopped. + +## Syntax + +```shell +tiup dm stop [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. + +## Options + +### -N, --node + +- Specifies the nodes to be stopped. If not specified, all nodes are stopped. 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-dm-display.md) table. +- Data type: `strings` +- Default: `[]`, which means all nodes are selected. + +> **Note:** +> +> If the `-R, --role` option is specified at the same time, then the service status in their intersection is stopped. + +### -R, --role + +- Specifies the roles to be stopped. If not specified, all roles are stopped. 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-dm-display.md) table. +- Data type: `strings` +- Default: `[]`, which means all roles are selected. + +> **Note:** +> +> If the `-N, --node` option is specified at the same time, the services in their intersection is stopped. + +### -h, --help + +- Prints the help information. +- Data type: `BOOLEAN` +- Default: false + +## Output + +The log of stopping the service. \ No newline at end of file From 8d9e124fabb703cadce823b0a2b58c190396cd31 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Tue, 13 Apr 2021 16:48:33 +0800 Subject: [PATCH 02/10] refine the docs --- tiup/tiup-component-dm-prune.md | 2 +- tiup/tiup-component-dm-reload.md | 2 +- tiup/tiup-component-dm-start.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/tiup/tiup-component-dm-prune.md b/tiup/tiup-component-dm-prune.md index 21f26b4e1adc6..d82a03626bed6 100644 --- a/tiup/tiup-component-dm-prune.md +++ b/tiup/tiup-component-dm-prune.md @@ -4,7 +4,7 @@ title: tiup dm prune # tiup dm prune -When [scaling in the cluster](/tiup/tiup-component-dm-scale-in.md), a small amount of meta-information in etcd is not cleaned up, and usually causes no problem. If you really need to clean the meta-information up, you can manually execute the `tiup cluster prune` command. +When [scaling in the cluster](/tiup/tiup-component-dm-scale-in.md), a small amount of meta-information in etcd is not cleaned up, which usually causes no problem. If you need to clean the meta-information up, you can manually execute the `tiup cluster prune` command. ## Syntax diff --git a/tiup/tiup-component-dm-reload.md b/tiup/tiup-component-dm-reload.md index 2e4f036db1f77..ede64aeecde90 100644 --- a/tiup/tiup-component-dm-reload.md +++ b/tiup/tiup-component-dm-reload.md @@ -56,6 +56,6 @@ After you specify the `--skip-restart` option, it only refreshes the configurati - Data type: `BOOLEAN` - Default: false -## 输出 +## Output The execution log of the tiup-dm. \ No newline at end of file diff --git a/tiup/tiup-component-dm-start.md b/tiup/tiup-component-dm-start.md index f1bd741c06d3a..1b3a34dbb32ca 100644 --- a/tiup/tiup-component-dm-start.md +++ b/tiup/tiup-component-dm-start.md @@ -44,4 +44,4 @@ tiup dm start [flags] ## Output -The log of startup. \ No newline at end of file +The log of starting the service. \ No newline at end of file From 06ddb48e0e86ecd1f1ca214f002374e5c21184a6 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Thu, 15 Apr 2021 11:25:27 +0800 Subject: [PATCH 03/10] Update tiup-component-dm-start.md --- tiup/tiup-component-dm-start.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tiup/tiup-component-dm-start.md b/tiup/tiup-component-dm-start.md index 1b3a34dbb32ca..1c6349d2f3af0 100644 --- a/tiup/tiup-component-dm-start.md +++ b/tiup/tiup-component-dm-start.md @@ -24,7 +24,7 @@ tiup dm start [flags] > **Note:** > -> If the `-R, --role` option is specified at the same time, then the service status in their intersection is started. +> If the `-R, --role` option is specified at the same time, then the services in their intersection are started. ### -R, --role @@ -34,7 +34,7 @@ tiup dm start [flags] > **Note:** > -> If the `-N, --node` option is specified at the same time, the services in their intersection is started. +> If the `-N, --node` option is specified at the same time, the services in their intersection are started. ### -h, --help From 2e332889f2a5072dd0e48d58a45c52b07a486007 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Thu, 15 Apr 2021 14:35:00 +0800 Subject: [PATCH 04/10] hide the links --- tiup/tiup-component-dm-prune.md | 2 +- tiup/tiup-component-dm-reload.md | 4 ++-- tiup/tiup-component-dm-start.md | 6 +++--- tiup/tiup-component-dm-stop.md | 6 +++--- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/tiup/tiup-component-dm-prune.md b/tiup/tiup-component-dm-prune.md index d82a03626bed6..320f074ab6e79 100644 --- a/tiup/tiup-component-dm-prune.md +++ b/tiup/tiup-component-dm-prune.md @@ -4,7 +4,7 @@ title: tiup dm prune # tiup dm prune -When [scaling in the cluster](/tiup/tiup-component-dm-scale-in.md), a small amount of meta-information in etcd is not cleaned up, which usually causes no problem. If you need to clean the meta-information up, you can manually execute the `tiup cluster prune` command. +When [scaling in the cluster], a small amount of meta-information in etcd is not cleaned up, which usually causes no problem. If you need to clean the meta-information up, you can manually execute the `tiup cluster prune` command. ## Syntax diff --git a/tiup/tiup-component-dm-reload.md b/tiup/tiup-component-dm-reload.md index ede64aeecde90..a27f3a8080c84 100644 --- a/tiup/tiup-component-dm-reload.md +++ b/tiup/tiup-component-dm-reload.md @@ -4,7 +4,7 @@ title: tiup dm reload # tiup dm reload -After [modifying the cluster configuration](/tiup/tiup-component-dm-edit-config.md), the cluster needs to be reloaded using the `tiup dm 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 restarts the service in order according to the upgrade process. The cluster remains available during the restart process. +After [modifying the cluster configuration], the cluster needs to be reloaded using the `tiup dm 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 restarts the service in order according to the upgrade process. The cluster remains available during the restart process. ## Syntax @@ -18,7 +18,7 @@ tiup dm reload [flags] ### -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-dm-display.md) table. +- 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]table. - Data type: `strings` - Default: `[]`, which means all nodes are selected. diff --git a/tiup/tiup-component-dm-start.md b/tiup/tiup-component-dm-start.md index 1c6349d2f3af0..4cf056e153f09 100644 --- a/tiup/tiup-component-dm-start.md +++ b/tiup/tiup-component-dm-start.md @@ -20,7 +20,7 @@ tiup dm start [flags] - Specifies the nodes to be started. If not specified, all nodes are started. 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-dm-display.md) table. - Data type: `strings` -- Default: `[]`, which means all nodes are selected. +- Default: `[]`. If this option is not specified in the command, all nodes are started. > **Note:** > @@ -28,9 +28,9 @@ tiup dm start [flags] ### -R, --role -- Specifies the roles to be started. If not specified, all roles are started. 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-dm-display.md) table. +- Specifies the roles to be started. If not specified, all roles are started. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status] table. - Data type: `strings` -- Default: `[]`, which means all roles are selected. +- Default: `[]`. If this option is not specified in the command, all roles are started. > **Note:** > diff --git a/tiup/tiup-component-dm-stop.md b/tiup/tiup-component-dm-stop.md index 9bfb529d8de8f..c8a73a788301f 100644 --- a/tiup/tiup-component-dm-stop.md +++ b/tiup/tiup-component-dm-stop.md @@ -16,13 +16,13 @@ The `tiup dm stop` command is used to stop all or part of the services of the sp tiup dm stop [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 name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list]command. ## Options ### -N, --node -- Specifies the nodes to be stopped. If not specified, all nodes are stopped. 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-dm-display.md) table. +- Specifies the nodes to be stopped. If not specified, all nodes are stopped. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status] table. - Data type: `strings` - Default: `[]`, which means all nodes are selected. @@ -32,7 +32,7 @@ tiup dm stop [flags] ### -R, --role -- Specifies the roles to be stopped. If not specified, all roles are stopped. 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-dm-display.md) table. +- Specifies the roles to be stopped. If not specified, all roles are stopped. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status] table. - Data type: `strings` - Default: `[]`, which means all roles are selected. From e9e524e53d4e8c5f408c878457ccf20b9d093325 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Thu, 15 Apr 2021 14:39:45 +0800 Subject: [PATCH 05/10] hide the links --- tiup/tiup-component-dm-reload.md | 2 +- tiup/tiup-component-dm-start.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/tiup/tiup-component-dm-reload.md b/tiup/tiup-component-dm-reload.md index a27f3a8080c84..f0a24d8520ee6 100644 --- a/tiup/tiup-component-dm-reload.md +++ b/tiup/tiup-component-dm-reload.md @@ -29,7 +29,7 @@ tiup dm reload [flags] ### -R, --role -- 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-dm-display.md) table. +- 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]table. - Data type: `strings` - Default: `[]`, which means all roles are selected. diff --git a/tiup/tiup-component-dm-start.md b/tiup/tiup-component-dm-start.md index 4cf056e153f09..551f61777a66d 100644 --- a/tiup/tiup-component-dm-start.md +++ b/tiup/tiup-component-dm-start.md @@ -12,13 +12,13 @@ The `tiup dm start` command is used to start all or part of the services of the tiup dm start [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 name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list] command. ## Options ### -N, --node -- Specifies the nodes to be started. If not specified, all nodes are started. 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-dm-display.md) table. +- Specifies the nodes to be started. If not specified, all nodes are started. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status]table. - Data type: `strings` - Default: `[]`. If this option is not specified in the command, all nodes are started. From 67e25e75f186b92fa0063cc01e5af7ba7c87a1e6 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Thu, 15 Apr 2021 14:41:24 +0800 Subject: [PATCH 06/10] meta --- tiup/tiup-component-dm-prune.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-component-dm-prune.md b/tiup/tiup-component-dm-prune.md index 320f074ab6e79..67faf960ce9c1 100644 --- a/tiup/tiup-component-dm-prune.md +++ b/tiup/tiup-component-dm-prune.md @@ -4,7 +4,7 @@ title: tiup dm prune # tiup dm prune -When [scaling in the cluster], a small amount of meta-information in etcd is not cleaned up, which usually causes no problem. If you need to clean the meta-information up, you can manually execute the `tiup cluster prune` command. +When [scaling in the cluster], a small amount of metadata in etcd is not cleaned up, which usually causes no problem. If you need to clean up the metadata, you can manually execute the `tiup cluster prune` command. ## Syntax From 76b594ca2d9b315bb548b92ffaef61f5d6b0ac12 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Thu, 15 Apr 2021 15:38:34 +0800 Subject: [PATCH 07/10] Update tiup-component-dm-prune.md --- tiup/tiup-component-dm-prune.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-component-dm-prune.md b/tiup/tiup-component-dm-prune.md index 67faf960ce9c1..64a82c93b7fdf 100644 --- a/tiup/tiup-component-dm-prune.md +++ b/tiup/tiup-component-dm-prune.md @@ -4,7 +4,7 @@ title: tiup dm prune # tiup dm prune -When [scaling in the cluster], a small amount of metadata in etcd is not cleaned up, which usually causes no problem. If you need to clean up the metadata, you can manually execute the `tiup cluster prune` command. +When [scaling in the cluster], a small amount of metadata in etcd is not cleaned up, which usually causes no problem. If you need to clean up the metadata, you can manually execute the `tiup dm prune` command. ## Syntax From 05dc83e58ca69fad961a51630f86340d7fa73754 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Thu, 15 Apr 2021 16:14:02 +0800 Subject: [PATCH 08/10] Update tiup-component-dm-prune.md --- tiup/tiup-component-dm-prune.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-component-dm-prune.md b/tiup/tiup-component-dm-prune.md index 64a82c93b7fdf..a35920692a47b 100644 --- a/tiup/tiup-component-dm-prune.md +++ b/tiup/tiup-component-dm-prune.md @@ -4,7 +4,7 @@ title: tiup dm prune # tiup dm prune -When [scaling in the cluster], a small amount of metadata in etcd is not cleaned up, which usually causes no problem. If you need to clean up the metadata, you can manually execute the `tiup dm prune` command. +When scaling in the cluster, a small amount of metadata in etcd is not cleaned up, which usually causes no problem. If you need to clean up the metadata, you can manually execute the `tiup dm prune` command. ## Syntax From 8c0c0e3bfc8e2d618d98a2a2d50b098f6da4821e Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Thu, 15 Apr 2021 17:03:04 +0800 Subject: [PATCH 09/10] Update tiup-component-dm-prune.md --- tiup/tiup-component-dm-prune.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-component-dm-prune.md b/tiup/tiup-component-dm-prune.md index a35920692a47b..bdfb1f3f4fb73 100644 --- a/tiup/tiup-component-dm-prune.md +++ b/tiup/tiup-component-dm-prune.md @@ -4,7 +4,7 @@ title: tiup dm prune # tiup dm prune -When scaling in the cluster, a small amount of metadata in etcd is not cleaned up, which usually causes no problem. If you need to clean up the metadata, you can manually execute the `tiup dm prune` command. +When scaling in the cluster(/tiup/tiup-component-dm-scale-in.md), a small amount of metadata in etcd is not cleaned up, which usually causes no problem. If you need to clean up the metadata, you can manually execute the `tiup dm prune` command. ## Syntax From 405e442ed941a83c53db5730318a9e6fbfbcf357 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Thu, 15 Apr 2021 17:36:02 +0800 Subject: [PATCH 10/10] Update tiup-component-dm-prune.md --- tiup/tiup-component-dm-prune.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-component-dm-prune.md b/tiup/tiup-component-dm-prune.md index bdfb1f3f4fb73..12097c4a0079c 100644 --- a/tiup/tiup-component-dm-prune.md +++ b/tiup/tiup-component-dm-prune.md @@ -4,7 +4,7 @@ title: tiup dm prune # tiup dm prune -When scaling in the cluster(/tiup/tiup-component-dm-scale-in.md), a small amount of metadata in etcd is not cleaned up, which usually causes no problem. If you need to clean up the metadata, you can manually execute the `tiup dm prune` command. +When you scale in the cluster(/tiup/tiup-component-dm-scale-in.md), a small amount of metadata in etcd is not cleaned up, which usually causes no problem. If you need to clean up the metadata, you can manually execute the `tiup dm prune` command. ## Syntax