diff --git a/tiup/tiup-cluster.md b/tiup/tiup-cluster.md index 7900e88c737e6..e70f93d16e24d 100644 --- a/tiup/tiup-cluster.md +++ b/tiup/tiup-cluster.md @@ -688,7 +688,7 @@ You can add `--native-ssh` in all cluster operation commands above to use the sy To avoid adding such a flag in every command, you can use the `TIUP_NATIVE_SSH` system variable to specify whether to use the local SSH client: -```sh +```shell export TIUP_NATIVE_SSH=true # or export TIUP_NATIVE_SSH=1 diff --git a/tiup/tiup-command-clean.md b/tiup/tiup-command-clean.md index fd61ec22b021f..c1495e26fa7b0 100644 --- a/tiup/tiup-command-clean.md +++ b/tiup/tiup-command-clean.md @@ -27,3 +27,5 @@ The value of `[name]` is the `Name` field output by the [`status` command](/tiup ``` Clean instance of `%s`, directory: %s ``` + +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) diff --git a/tiup/tiup-command-completion.md b/tiup/tiup-command-completion.md index 2157fabc1580a..ba14ca86faef6 100644 --- a/tiup/tiup-command-completion.md +++ b/tiup/tiup-command-completion.md @@ -41,3 +41,5 @@ source $HOME/.bash_profile ```shell tiup completion zsh > "${fpath[1]}/_tiup" ``` + +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) diff --git a/tiup/tiup-command-env.md b/tiup/tiup-command-env.md index 6810f4ebac679..0219eb878f0c2 100644 --- a/tiup/tiup-command-env.md +++ b/tiup/tiup-command-env.md @@ -24,3 +24,5 @@ None - If `[name1...N]` is specified, the "{value}" list is output in order. In the above output, if `value` is empty, it means that the value of the environment variable is not set. In this case, TiUP uses the default value. + +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) diff --git a/tiup/tiup-command-help.md b/tiup/tiup-command-help.md index ea59b6bdd4733..f398f9e120ddb 100644 --- a/tiup/tiup-command-help.md +++ b/tiup/tiup-command-help.md @@ -21,3 +21,5 @@ None ## Output The help information of `[command]` or TiUP. + +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) diff --git a/tiup/tiup-command-install.md b/tiup/tiup-command-install.md index 7d4fc71e060d0..5244441c5451e 100644 --- a/tiup/tiup-command-install.md +++ b/tiup/tiup-command-install.md @@ -23,3 +23,5 @@ None - Normally outputs the download information of the component. - If the component does not exist, the `The component "%s" not found` error is reported. - If the version does not exist, the `version %s not supported by component %s` error is reported. + +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) diff --git a/tiup/tiup-command-list.md b/tiup/tiup-command-list.md index 6d95280b8ab68..9f9a0b54ed8dc 100644 --- a/tiup/tiup-command-list.md +++ b/tiup/tiup-command-list.md @@ -42,3 +42,5 @@ tiup list [component] [flags] - If `[component]` is set: - If the specified component exists: TiUP outputs a version information list of the specified component, consisting of `Version` (version number), `Installed` (installation status), `Release` (release date), and `Platforms` (supported platforms). - If the specified component does not exist: TiUP reports the error `failed to fetch component: unknown component`. + +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) diff --git a/tiup/tiup-command-mirror-clone.md b/tiup/tiup-command-mirror-clone.md index 466c3eed7ccb2..1ba0725aafd26 100644 --- a/tiup/tiup-command-mirror-clone.md +++ b/tiup/tiup-command-mirror-clone.md @@ -46,3 +46,5 @@ tiup mirror clone [global version] [flags] - Specifies the version list of the component to be cloned. Fill component names in `{component}`. You can run [`tiup list --all`](/tiup/tiup-command-list.md) to view available component names. - Data type: Strings - Default: Null + +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) diff --git a/tiup/tiup-command-mirror-genkey.md b/tiup/tiup-command-mirror-genkey.md index fe4076b8b1346..18739fbe308f0 100644 --- a/tiup/tiup-command-mirror-genkey.md +++ b/tiup/tiup-command-mirror-genkey.md @@ -51,3 +51,5 @@ tiup mirror genkey [flags] - If `-p/--public` is specified: - If the private key specified in `-n/--name` does not exist: TiUP reports the error `Error: open ${TIUP_HOME}/keys/{name}.json: no such file or directory`. - If the private key specified in `-n/--name` exists: TiUP outputs the content of the corresponding public key. + +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) diff --git a/tiup/tiup-command-mirror-grant.md b/tiup/tiup-command-mirror-grant.md index a759f699734e5..8f3ad9a959310 100644 --- a/tiup/tiup-command-mirror-grant.md +++ b/tiup/tiup-command-mirror-grant.md @@ -40,3 +40,5 @@ tiup mirror grant [flags] - If the command is executed successfully, there is no output. - If the component owner's ID is duplicated, TiUP reports the error `Error: owner %s exists`. - If the key is used by another component owner, TiUP reports the error `Error: key %s exists`. + +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) diff --git a/tiup/tiup-command-mirror-init.md b/tiup/tiup-command-mirror-init.md index a549e13ffabdc..7d5f48088a577 100644 --- a/tiup/tiup-command-mirror-init.md +++ b/tiup/tiup-command-mirror-init.md @@ -42,3 +42,5 @@ tiup mirror init [flags] - If the command is executed successfully, there is no output. - If the specified `` is not empty, TiUP reports the error `Error: the target path '%s' is not an empty directory`. - If the specified `` is not a directory, TiUP reports the error `Error: fdopendir: not a directory`. + +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) diff --git a/tiup/tiup-command-mirror-merge.md b/tiup/tiup-command-mirror-merge.md index 6e93d3a2330b5..ca16e2225c57f 100644 --- a/tiup/tiup-command-mirror-merge.md +++ b/tiup/tiup-command-mirror-merge.md @@ -28,3 +28,5 @@ None - If the command is executed successfully, there is no output. - If the current mirror does not have a component owner of the target mirror, or if `${TIUP_HOME}/keys` does not have the owner's private key, TiUP reports the `Error: missing owner keys for owner %s on component %s` error. + +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) diff --git a/tiup/tiup-command-mirror-modify.md b/tiup/tiup-command-mirror-modify.md index 9e5fe1e9b5da3..d9553f4398017 100644 --- a/tiup/tiup-command-mirror-modify.md +++ b/tiup/tiup-command-mirror-modify.md @@ -60,3 +60,5 @@ Marks a specified component or version as unavailable. - If the component owner is not authorized to modify the target component: - If the mirror is a remote mirror, TiUP reports the error `Error: The server refused, make sure you have access to this component`. - If the mirror is a local mirror, TiUP reports the error `Error: the signature is not correct`. + +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) diff --git a/tiup/tiup-command-mirror-publish.md b/tiup/tiup-command-mirror-publish.md index 5cdbc7d20c429..50312cf430ea0 100644 --- a/tiup/tiup-command-mirror-publish.md +++ b/tiup/tiup-command-mirror-publish.md @@ -81,3 +81,5 @@ The meaning of each parameter is as follows: - If the component owner is not authorized to modify the target component: - If the mirror is a remote mirror, TiUP reports the error `Error: The server refused, make sure you have access to this component`. - If the mirror is a local mirror, TiUP reports the error `Error: the signature is not correct`. + +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) diff --git a/tiup/tiup-command-mirror-rotate.md b/tiup/tiup-command-mirror-rotate.md index 4441cf7600d68..962841a0c01cf 100644 --- a/tiup/tiup-command-mirror-rotate.md +++ b/tiup/tiup-command-mirror-rotate.md @@ -58,3 +58,5 @@ For how mirror administrators sign files, refer to the [`sign` command](/tiup/ti ## Outputs The current signature status of each mirror administrator. + +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) diff --git a/tiup/tiup-command-mirror-set.md b/tiup/tiup-command-mirror-set.md index 241fb4db86e18..2a8a9ba9a79fb 100644 --- a/tiup/tiup-command-mirror-set.md +++ b/tiup/tiup-command-mirror-set.md @@ -45,3 +45,5 @@ In the steps above, if the mirror is attacked before the `wget` command, you can ## Output None + +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) diff --git a/tiup/tiup-command-mirror-sign.md b/tiup/tiup-command-mirror-sign.md index 397d07cefe660..7c5f45657fbb5 100644 --- a/tiup/tiup-command-mirror-sign.md +++ b/tiup/tiup-command-mirror-sign.md @@ -45,3 +45,5 @@ If it is a network address, this address must provide the following features: - If the command is executed successfully, there is no output. - If the file has been signed by the specified key, TiUP reports the error `Error: this manifest file has already been signed by specified key`. - If the file is not a valid manifest, TiUP reports the error `Error: unmarshal manifest: %s`. + +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) diff --git a/tiup/tiup-command-mirror.md b/tiup/tiup-command-mirror.md index 22277aafe1ab3..a534d5bd1dbb3 100644 --- a/tiup/tiup-command-mirror.md +++ b/tiup/tiup-command-mirror.md @@ -35,3 +35,5 @@ None - [rotate](/tiup/tiup-command-mirror-rotate.md): updates the root certificate in the current mirror - [clone](/tiup/tiup-command-mirror-clone.md): clones a new mirror from an existing one - [merge](/tiup/tiup-command-mirror-merge.md): merges mirrors + +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) diff --git a/tiup/tiup-command-status.md b/tiup/tiup-command-status.md index 3529692ab3a6b..a43febf01a6cb 100644 --- a/tiup/tiup-command-status.md +++ b/tiup/tiup-command-status.md @@ -35,3 +35,5 @@ A table consisting of the following fields: - `Directory`: The data directory of the components. - `Binary`: The binary file path of the components. - `Args`: The starting arguments of the operating components. + +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) diff --git a/tiup/tiup-command-telemetry.md b/tiup/tiup-command-telemetry.md index 179d25fec5145..f8412ad0bac1c 100644 --- a/tiup/tiup-command-telemetry.md +++ b/tiup/tiup-command-telemetry.md @@ -52,3 +52,5 @@ The `tiup telemetry enable` command is used to enable the telemetry. ### disable The `tiup telemetry disable` command is used to disable the telemetry. + +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) diff --git a/tiup/tiup-command-uninstall.md b/tiup/tiup-command-uninstall.md index abd0143212fbd..ad71761195d75 100644 --- a/tiup/tiup-command-uninstall.md +++ b/tiup/tiup-command-uninstall.md @@ -8,7 +8,7 @@ The `tiup uninstall` command is used to uninstall the installed components. ## Syntax -```sh +```shell tiup uninstall : [component2...N] [flags] ``` @@ -34,3 +34,5 @@ tiup uninstall : [component2...N] [flags] - If the command exits without any error, `Uninstalled component "%s" successfully!` is output. - If neither `` nor `--all` is specified, the `Use "tiup uninstall tidbx --all" if you want to remove all versions.` error is reported. + +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) diff --git a/tiup/tiup-command-update.md b/tiup/tiup-command-update.md index 2b9c00c0d0b96..9cbc2a3bfab34 100644 --- a/tiup/tiup-command-update.md +++ b/tiup/tiup-command-update.md @@ -8,7 +8,7 @@ The `tiup update` command is used to update the installed components or TiUP its ## Syntax -```sh +```shell tiup update [component1][:version] [component2..N] [flags] ``` @@ -48,3 +48,5 @@ The update operation does not delete the old version. You can still specify usin - If the update is successful, `Updated successfully!` is output. - If target version does not exist, the `Error: version %s not supported by component %s` error is reported. + +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) diff --git a/tiup/tiup-component-cluster-audit.md b/tiup/tiup-component-cluster-audit.md index aeb0c7262b9d3..abefeb0fbc031 100644 --- a/tiup/tiup-component-cluster-audit.md +++ b/tiup/tiup-component-cluster-audit.md @@ -8,7 +8,7 @@ The `tiup cluster audit` command is used to view commands executed on all cluste ## Syntax -```sh +```shell tiup cluster audit [audit-id] [flags] ``` @@ -30,3 +30,5 @@ tiup cluster audit [audit-id] [flags] - ID: the `audit-id` corresponding to the record - Time: the execution time of the command corresponding to the record - Command:the command corresponding to the record + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-check.md b/tiup/tiup-component-cluster-check.md index 044c207e4f648..8088ac88c5db2 100644 --- a/tiup/tiup-component-cluster-check.md +++ b/tiup/tiup-component-cluster-check.md @@ -234,3 +234,5 @@ A table containing the following fields: - `Check`: the check item - `Result`: the check result (Pass, Warn, or Fail) - `Message`: the result description + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-clean.md b/tiup/tiup-component-cluster-clean.md index 8f5266cb1d063..47eec3b1f3250 100644 --- a/tiup/tiup-component-cluster-clean.md +++ b/tiup/tiup-component-cluster-clean.md @@ -12,7 +12,7 @@ In the test environment, sometimes you might need to reset the cluster back to t ## Syntax -```sh +```shell tiup cluster clean [flags] ``` @@ -62,3 +62,5 @@ tiup cluster clean [flags] ## Output The execution logs of tiup-cluster. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-deploy.md b/tiup/tiup-component-cluster-deploy.md index 5d71e44304e15..58b98d42ac150 100644 --- a/tiup/tiup-component-cluster-deploy.md +++ b/tiup/tiup-component-cluster-deploy.md @@ -65,3 +65,5 @@ tiup cluster deploy [flags] ## Output The deployment log. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-destroy.md b/tiup/tiup-component-cluster-destroy.md index d09004f81a489..cb69edf8d6417 100644 --- a/tiup/tiup-component-cluster-destroy.md +++ b/tiup/tiup-component-cluster-destroy.md @@ -47,3 +47,5 @@ tiup cluster destroy [flags] ## Output The execution log of the tiup-cluster. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-disable.md b/tiup/tiup-component-cluster-disable.md index a75d0c761b7b8..765fe5423a7e1 100644 --- a/tiup/tiup-component-cluster-disable.md +++ b/tiup/tiup-component-cluster-disable.md @@ -45,3 +45,5 @@ tiup cluster disable [flags] ## Output The execution log of the tiup-cluster. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-display.md b/tiup/tiup-component-cluster-display.md index 0ab1d0fc0f919..d8e0c81f22046 100644 --- a/tiup/tiup-component-cluster-display.md +++ b/tiup/tiup-component-cluster-display.md @@ -63,3 +63,5 @@ tiup cluster display [flags] - Status: the current status of the node service - Data Dir: the data directory of the service. `-` means no data directory. - Deploy Dir: the deployment directory of the service + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-edit-config.md b/tiup/tiup-component-cluster-edit-config.md index b222327e8ee27..ef7b6780396a8 100644 --- a/tiup/tiup-component-cluster-edit-config.md +++ b/tiup/tiup-component-cluster-edit-config.md @@ -31,3 +31,5 @@ tiup cluster edit-config [flags] - If the command is successfully executed, there is no output. - If you have mistakenly modified the fields that cannot be modified, when you save the file, an error will be reported, reminding you to edit the file again. For the fields that cannot be modified, see the [topology file](/tiup/tiup-cluster-topology-reference.md). + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-enable.md b/tiup/tiup-component-cluster-enable.md index 1a0eeb98a8153..094a0c5ab46c9 100644 --- a/tiup/tiup-component-cluster-enable.md +++ b/tiup/tiup-component-cluster-enable.md @@ -49,3 +49,5 @@ tiup cluster enable [flags] ## Output The execution log of the tiup-cluster. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-help.md b/tiup/tiup-component-cluster-help.md index 1b11b35b01b47..8c0e1f1f0edaa 100644 --- a/tiup/tiup-component-cluster-help.md +++ b/tiup/tiup-component-cluster-help.md @@ -22,4 +22,6 @@ tiup cluster help [command] [flags] ## Output -The help information of the `[command]` or tiup-cluster. \ No newline at end of file +The help information of the `[command]` or tiup-cluster. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-import.md b/tiup/tiup-component-cluster-import.md index e49c318cb0a46..d9cf8054aacf1 100644 --- a/tiup/tiup-component-cluster-import.md +++ b/tiup/tiup-component-cluster-import.md @@ -65,3 +65,5 @@ tiup cluster import [flags] ## Output Shows the logs of the import process. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-list.md b/tiup/tiup-component-cluster-list.md index c9510f89cd5e0..8e694bb08802a 100644 --- a/tiup/tiup-component-cluster-list.md +++ b/tiup/tiup-component-cluster-list.md @@ -33,3 +33,5 @@ Outputs the table with the following fields: - Version: the cluster version - Path: the path of the cluster deployment data on the control machine - PrivateKey: the path of the private key that is used to connect the cluster + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-patch.md b/tiup/tiup-component-cluster-patch.md index d68e1bc4a3e5c..87d3b31c1d9b6 100644 --- a/tiup/tiup-component-cluster-patch.md +++ b/tiup/tiup-component-cluster-patch.md @@ -87,3 +87,5 @@ You need to pack the binary package required for this command in advance accordi ## Outputs The execution log of the tiup-cluster. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-prune.md b/tiup/tiup-component-cluster-prune.md index de2b81008becb..1940338781815 100644 --- a/tiup/tiup-component-cluster-prune.md +++ b/tiup/tiup-component-cluster-prune.md @@ -23,3 +23,5 @@ tiup cluster prune [flags] ## Output The log of the cleanup process. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-reload.md b/tiup/tiup-component-cluster-reload.md index 8986e26dbb041..9372e9ff36b25 100644 --- a/tiup/tiup-component-cluster-reload.md +++ b/tiup/tiup-component-cluster-reload.md @@ -81,3 +81,5 @@ After you specify the `--skip-restart` option, it only refreshes the configurati ## Output The execution log of the tiup-cluster. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-rename.md b/tiup/tiup-component-cluster-rename.md index 6042bbced0c00..79e7e3a4c0f33 100644 --- a/tiup/tiup-component-cluster-rename.md +++ b/tiup/tiup-component-cluster-rename.md @@ -33,3 +33,5 @@ tiup cluster rename [flags] ## Outputs The execution log of the tiup-cluster. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-replay.md b/tiup/tiup-component-cluster-replay.md index f5a375bcf4505..cfa134c6794e3 100644 --- a/tiup/tiup-component-cluster-replay.md +++ b/tiup/tiup-component-cluster-replay.md @@ -23,3 +23,5 @@ Prints the help information. ## Output The output of the command corresponding to ``. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-restart.md b/tiup/tiup-component-cluster-restart.md index 0da657da69415..5bd9a994d3202 100644 --- a/tiup/tiup-component-cluster-restart.md +++ b/tiup/tiup-component-cluster-restart.md @@ -49,3 +49,5 @@ tiup cluster restart [flags] ## Outputs The log of the service restart process. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-scale-in.md b/tiup/tiup-component-cluster-scale-in.md index aaa96dfa1934a..d60ca82053293 100644 --- a/tiup/tiup-component-cluster-scale-in.md +++ b/tiup/tiup-component-cluster-scale-in.md @@ -68,3 +68,5 @@ tiup cluster scale-in [flags] ## Output Shows the logs of the scaling-in process. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-scale-out.md b/tiup/tiup-component-cluster-scale-out.md index 478eaab8d4413..fba6627d53551 100644 --- a/tiup/tiup-component-cluster-scale-out.md +++ b/tiup/tiup-component-cluster-scale-out.md @@ -61,3 +61,5 @@ tiup cluster scale-out [flags] ## Output The log of scaling out. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-start.md b/tiup/tiup-component-cluster-start.md index 6f7085c557005..6ee0a10279f65 100644 --- a/tiup/tiup-component-cluster-start.md +++ b/tiup/tiup-component-cluster-start.md @@ -45,3 +45,5 @@ tiup cluster start [flags] ## Output The log of starting the service. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-stop.md b/tiup/tiup-component-cluster-stop.md index 6c2b4d9cdc872..f8192e8ef02a7 100644 --- a/tiup/tiup-component-cluster-stop.md +++ b/tiup/tiup-component-cluster-stop.md @@ -7,7 +7,7 @@ title: tiup cluster stop The `tiup cluster stop` command is used to stop all services or some services of the specified cluster. > **Note:** -> +> > If the core services of a cluster are stopped, the cluster cannot provide services anymore. ## Syntax @@ -27,7 +27,7 @@ tiup cluster stop [flags] - If this option is not specified in the command, the command stops all the nodes by default. > **Note:** -> +> > If the `-R, --role` option is specified at the same time, only the service nodes that match both the specifications of `-N, --node` and `-R, --role` are stopped. ### -R, --role @@ -37,7 +37,7 @@ tiup cluster stop [flags] - If this option is not specified in the command, the command stops all the roles by default. > **Note:** -> +> > If the `-N, --node` option is specified at the same time, only the service nodes that match both the specifications of `-N, --node` and `-R, --role` are stopped. ### -h, --help @@ -49,3 +49,5 @@ tiup cluster stop [flags] ## Output The log of stopping the service. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-template.md b/tiup/tiup-component-cluster-template.md index 1b6a47aa2e54a..628002ccaee56 100644 --- a/tiup/tiup-component-cluster-template.md +++ b/tiup/tiup-component-cluster-template.md @@ -40,3 +40,5 @@ Prints the help information. ## Output Outputs the topology template according to the specified options, which can be redirected to the topology file for deployment. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster-upgrade.md b/tiup/tiup-component-cluster-upgrade.md index ea3189d29d824..02df5f7ea6fb7 100644 --- a/tiup/tiup-component-cluster-upgrade.md +++ b/tiup/tiup-component-cluster-upgrade.md @@ -58,3 +58,5 @@ tiup cluster upgrade [flags] ## Output The log of the upgrading progress. + +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) diff --git a/tiup/tiup-component-cluster.md b/tiup/tiup-component-cluster.md index 754b138fd040d..a1ace2810dee0 100644 --- a/tiup/tiup-component-cluster.md +++ b/tiup/tiup-component-cluster.md @@ -82,4 +82,6 @@ tiup cluster [command] [flags] - [replay](/tiup/tiup-component-cluster-replay.md): retries the specified command - [enable](/tiup/tiup-component-cluster-enable.md): enables the auto-enabling of the cluster service after a machine is restarted. - [disable](/tiup/tiup-component-cluster-disable.md): disables the auto-enabling of the cluster service after a machine is restarted. -- [help](/tiup/tiup-component-cluster-help.md): prints the help information \ No newline at end of file +- [help](/tiup/tiup-component-cluster-help.md): prints the help information + +[<< Back to the previous page - TiUP Reference component list](/tiup/tiup-reference.md#component-list) diff --git a/tiup/tiup-component-dm-audit.md b/tiup/tiup-component-dm-audit.md index 43d8badea3179..f30f7d957b478 100644 --- a/tiup/tiup-component-dm-audit.md +++ b/tiup/tiup-component-dm-audit.md @@ -29,4 +29,6 @@ tiup dm audit [audit-id] [flags] - If `[audit-id]` is not specified, a table with the following fields is output: - ID: the `audit-id` corresponding to this record - Time: the execution time of the command corresponding to the record - - Command: the command corresponding to the record \ No newline at end of file + - Command: the command corresponding to the record + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-deploy.md b/tiup/tiup-component-dm-deploy.md index bd612752b90b3..3ef4b0f3b5ca1 100644 --- a/tiup/tiup-component-dm-deploy.md +++ b/tiup/tiup-component-dm-deploy.md @@ -45,3 +45,5 @@ tiup dm deploy [flags] ## Output The deployment log. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-destroy.md b/tiup/tiup-component-dm-destroy.md index 3cbfd1645a2e0..0c7f04d4097aa 100644 --- a/tiup/tiup-component-dm-destroy.md +++ b/tiup/tiup-component-dm-destroy.md @@ -29,3 +29,5 @@ tiup dm destroy [flags] ## Output The execution log of the tiup-dm. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-disable.md b/tiup/tiup-component-dm-disable.md index d9abff9a6a75a..fca46d3ae5c42 100644 --- a/tiup/tiup-component-dm-disable.md +++ b/tiup/tiup-component-dm-disable.md @@ -43,3 +43,5 @@ Prints the help information. ## Output The execution log of the tiup-dm. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-display.md b/tiup/tiup-component-dm-display.md index dbc6e403a2595..4d20cfef25b53 100644 --- a/tiup/tiup-component-dm-display.md +++ b/tiup/tiup-component-dm-display.md @@ -56,3 +56,5 @@ tiup dm display [flags] - `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. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-edit-config.md b/tiup/tiup-component-dm-edit-config.md index 7b2ba042b3d81..b2cd02bc55f46 100644 --- a/tiup/tiup-component-dm-edit-config.md +++ b/tiup/tiup-component-dm-edit-config.md @@ -31,3 +31,5 @@ tiup dm edit-config [flags] - Normally, no output. - If you have mistakenly modified the fields that cannot be modified, when you save the file, an error is reported, reminding you to edit the file again. For the fields that cannot be modified, see [the topology file](/tiup/tiup-dm-topology-reference.md). + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-enable.md b/tiup/tiup-component-dm-enable.md index 8ed4d840bbb6c..f16000128a843 100644 --- a/tiup/tiup-component-dm-enable.md +++ b/tiup/tiup-component-dm-enable.md @@ -43,3 +43,5 @@ Prints the help information. ## Output the execution log of tiup-dm. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-help.md b/tiup/tiup-component-dm-help.md index da4867e0a40df..035530c224aae 100644 --- a/tiup/tiup-component-dm-help.md +++ b/tiup/tiup-component-dm-help.md @@ -22,4 +22,6 @@ tiup dm help [command] [flags] ## Output -The help information of `[command]` or `tiup-dm`. \ No newline at end of file +The help information of `[command]` or `tiup-dm`. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-import.md b/tiup/tiup-component-dm-import.md index fd5f023e10bf2..b84c1de36a198 100644 --- a/tiup/tiup-component-dm-import.md +++ b/tiup/tiup-component-dm-import.md @@ -58,3 +58,5 @@ tiup dm import [flags] ## Outputs The log of the importing process. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-list.md b/tiup/tiup-component-dm-list.md index 7339da8ef2927..c7719d5999b5a 100644 --- a/tiup/tiup-component-dm-list.md +++ b/tiup/tiup-component-dm-list.md @@ -33,3 +33,5 @@ A table consisting of the following fields: - `Version`: the cluster version. - `Path`: the path of the cluster deployment data on the control machine. - `PrivateKey`: the path of the private key to the cluster. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-patch.md b/tiup/tiup-component-dm-patch.md index 45bca99d35dd0..03acd41f5a359 100644 --- a/tiup/tiup-component-dm-patch.md +++ b/tiup/tiup-component-dm-patch.md @@ -75,3 +75,5 @@ You need to pack the binary package required for this command in advance accordi ## Outputs The execution log of tiup-dm. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-prune.md b/tiup/tiup-component-dm-prune.md index 12097c4a0079c..66fef792543d7 100644 --- a/tiup/tiup-component-dm-prune.md +++ b/tiup/tiup-component-dm-prune.md @@ -23,3 +23,5 @@ tiup dm prune [flags] ## Output The log of the cleanup process. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-reload.md b/tiup/tiup-component-dm-reload.md index 713915d4660bc..7fda1d8186925 100644 --- a/tiup/tiup-component-dm-reload.md +++ b/tiup/tiup-component-dm-reload.md @@ -59,3 +59,5 @@ After you specify the `--skip-restart` option, it only refreshes the configurati ## Output The execution log of the tiup-dm. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-replay.md b/tiup/tiup-component-dm-replay.md index 64719e26c01e2..7a15f900f413f 100644 --- a/tiup/tiup-component-dm-replay.md +++ b/tiup/tiup-component-dm-replay.md @@ -23,3 +23,5 @@ Prints the help information. ## Output The output of the command corresponding to ``. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-restart.md b/tiup/tiup-component-dm-restart.md index 278dab2aef4e1..6910fae1455ae 100644 --- a/tiup/tiup-component-dm-restart.md +++ b/tiup/tiup-component-dm-restart.md @@ -49,3 +49,5 @@ tiup dm restart [flags] ## Outputs The log of the service restart process. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-scale-in.md b/tiup/tiup-component-dm-scale-in.md index 581e98ddad170..af3b3c1a022f0 100644 --- a/tiup/tiup-component-dm-scale-in.md +++ b/tiup/tiup-component-dm-scale-in.md @@ -36,4 +36,6 @@ tiup dm scale-in [flags] ## Output -The log of scaling in. \ No newline at end of file +The log of scaling in. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-scale-out.md b/tiup/tiup-component-dm-scale-out.md index b103b6b18d54d..da77f96e94812 100644 --- a/tiup/tiup-component-dm-scale-out.md +++ b/tiup/tiup-component-dm-scale-out.md @@ -45,3 +45,5 @@ tiup dm scale-out [flags] ## Output The log of scaling out. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-start.md b/tiup/tiup-component-dm-start.md index 6532a7377567f..4a5c9ff1acf2b 100644 --- a/tiup/tiup-component-dm-start.md +++ b/tiup/tiup-component-dm-start.md @@ -45,3 +45,5 @@ tiup dm start [flags] ## Output The log of starting the service. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-stop.md b/tiup/tiup-component-dm-stop.md index 8a46ee87cae7d..72cd009d4e733 100644 --- a/tiup/tiup-component-dm-stop.md +++ b/tiup/tiup-component-dm-stop.md @@ -49,3 +49,5 @@ tiup dm stop [flags] ## Output The log of stopping the service. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-template.md b/tiup/tiup-component-dm-template.md index 939474225248a..eedd9c492fd91 100644 --- a/tiup/tiup-component-dm-template.md +++ b/tiup/tiup-component-dm-template.md @@ -34,3 +34,5 @@ Prints the help information. ## Output Outputs the topology template according to the specified options, which can be redirected to the topology file for deployment. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm-upgrade.md b/tiup/tiup-component-dm-upgrade.md index aa3cc8b96a8fb..87b8b12be5955 100644 --- a/tiup/tiup-component-dm-upgrade.md +++ b/tiup/tiup-component-dm-upgrade.md @@ -6,7 +6,7 @@ title: tiup dm upgrade The `tiup dm upgrade` command is used to upgrade a specified cluster to a specific version. -## Syntax +## Syntax ```shell tiup dm upgrade [flags] @@ -30,3 +30,5 @@ tiup dm upgrade [flags] ## Output Log of the service upgrade process. + +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) diff --git a/tiup/tiup-component-dm.md b/tiup/tiup-component-dm.md index 4e3194f5a8073..f162b08c76df3 100644 --- a/tiup/tiup-component-dm.md +++ b/tiup/tiup-component-dm.md @@ -12,14 +12,14 @@ Similar to [TiUP Cluster](/tiup/tiup-component-cluster.md) which is used to mana tiup dm [command] [flags] ``` -`[command]` is used to pass the name of the command. See the [command list](#list-of-commands) for supported commands. +`[command]` is used to pass the name of the command. See the [Command list](#command-list) for supported commands. ## Options ### --ssh - Specifies the SSH client to connect to the remote end (the machine where the TiDB service is deployed) for the command execution. -- Data type:`STRING` +- Data type: `STRING` - Support values: - `builtin`: Uses the built-in easyssh client of tiup-cluster as the SSH client. @@ -37,13 +37,13 @@ tiup dm [command] [flags] ### --wait-timeout - Specifies the maximum waiting time (in seconds) for each step in the operation process. The operation process consists of many steps, such as specifying systemctl to start or stop services, and waiting for ports to be online or offline. Each step may take several seconds. If the execution time of a step exceeds the specified timeout, the step exits with an error. -- Data type:`UINT` +- Data type: `UINT` - If this option is not specified in the command, the maximum waiting time for each steps is `120` seconds. ### -y, --yes - Skips the secondary confirmation of all risky operations. It is not recommended to use this option unless you use a script to call TiUP. -- Data type:`BOOLEAN` +- 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. ### -v, --version @@ -58,7 +58,7 @@ tiup dm [command] [flags] - 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. -## List of commands +## Command list - [import](/tiup/tiup-component-dm-import.md): Imports a DM v1.0 cluster deployed by DM-Ansible. - [template](/tiup/tiup-component-dm-template.md): Outputs the topology template. @@ -81,3 +81,5 @@ tiup dm [command] [flags] - [enable](/tiup/tiup-component-dm-enable.md): Enables the auto-enabling of the cluster service after a machine is restarted. - [disable](/tiup/tiup-component-dm-disable.md): Disables the auto-enabling of the cluster service after a machine is restarted. - [help](/tiup/tiup-component-dm-help.md): Prints help information. + +[<< Back to the previous page - TiUP Reference component list](/tiup/tiup-reference.md#component-list) diff --git a/tiup/tiup-dm-topology-reference.md b/tiup/tiup-dm-topology-reference.md index b7b83d255e1f9..a135e4583acd7 100644 --- a/tiup/tiup-dm-topology-reference.md +++ b/tiup/tiup-dm-topology-reference.md @@ -4,7 +4,7 @@ title: Topology Configuration File for DM Cluster Deployment Using TiUP # Topology Configuration File for DM Cluster Deployment Using TiUP -To deploy or scale a TiDB Data Migration (DM) cluster, you need to provide a topology file ([sample](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/dm/topology.example.yaml)) to describe the cluster topology. +To deploy or scale a TiDB Data Migration (DM) cluster, you need to provide a topology file ([sample](https://github.com/pingcap/tiup/blob/master/embed/templates/examples/dm/topology.example.yaml)) to describe the cluster topology. Similarly, to modify the cluster topology, you need to modify the topology file. The difference is that, after the cluster is deployed, you can only modify a part of the fields in the topology file. This document introduces each section of the topology file and each field in each section.