From ba8657f403c7094892905611133f722212040ba4 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Mon, 10 May 2021 11:13:50 +0800 Subject: [PATCH 1/4] add links --- tiup/tiup-command-mirror-clone.md | 2 ++ tiup/tiup-command-mirror-genkey.md | 2 ++ tiup/tiup-command-mirror-grant.md | 2 ++ tiup/tiup-command-mirror-init.md | 2 ++ tiup/tiup-command-mirror-merge.md | 2 ++ tiup/tiup-command-mirror-modify.md | 2 ++ tiup/tiup-command-mirror-publish.md | 2 ++ tiup/tiup-command-mirror-rotate.md | 2 ++ tiup/tiup-command-mirror-set.md | 2 ++ tiup/tiup-command-mirror-sign.md | 2 ++ tiup/tiup-component-cluster-audit.md | 2 ++ tiup/tiup-component-cluster-check.md | 2 ++ tiup/tiup-component-cluster-clean.md | 2 ++ tiup/tiup-component-cluster-deploy.md | 2 ++ tiup/tiup-component-cluster-destroy.md | 2 ++ tiup/tiup-component-cluster-disable.md | 2 ++ tiup/tiup-component-cluster-display.md | 2 ++ tiup/tiup-component-cluster-edit-config.md | 2 ++ tiup/tiup-component-cluster-enable.md | 2 ++ tiup/tiup-component-cluster-help.md | 2 ++ tiup/tiup-component-cluster-import.md | 2 ++ tiup/tiup-component-cluster-list.md | 2 ++ tiup/tiup-component-cluster-patch.md | 2 ++ tiup/tiup-component-cluster-prune.md | 2 ++ tiup/tiup-component-cluster-reload.md | 2 ++ tiup/tiup-component-cluster-rename.md | 2 ++ tiup/tiup-component-cluster-replay.md | 2 ++ tiup/tiup-component-cluster-restart.md | 2 ++ tiup/tiup-component-cluster-scale-in.md | 2 ++ tiup/tiup-component-cluster-scale-out.md | 2 ++ tiup/tiup-component-cluster-start.md | 2 ++ tiup/tiup-component-cluster-stop.md | 2 ++ tiup/tiup-component-cluster-template.md | 2 ++ tiup/tiup-component-cluster-upgrade.md | 2 ++ tiup/tiup-component-dm-audit.md | 2 ++ tiup/tiup-component-dm-deploy.md | 2 ++ tiup/tiup-component-dm-destroy.md | 2 ++ tiup/tiup-component-dm-disable.md | 2 ++ tiup/tiup-component-dm-display.md | 2 ++ tiup/tiup-component-dm-edit-config.md | 2 ++ tiup/tiup-component-dm-enable.md | 2 ++ tiup/tiup-component-dm-help.md | 2 ++ tiup/tiup-component-dm-import.md | 2 ++ tiup/tiup-component-dm-list.md | 2 ++ tiup/tiup-component-dm-patch.md | 2 ++ tiup/tiup-component-dm-prune.md | 2 ++ tiup/tiup-component-dm-reload.md | 2 ++ tiup/tiup-component-dm-replay.md | 2 ++ tiup/tiup-component-dm-restart.md | 2 ++ tiup/tiup-component-dm-scale-in.md | 2 ++ tiup/tiup-component-dm-scale-out.md | 2 ++ tiup/tiup-component-dm-start.md | 2 ++ tiup/tiup-component-dm-stop.md | 2 ++ tiup/tiup-component-dm-template.md | 2 ++ tiup/tiup-component-dm-upgrade.md | 4 +++- tiup/tiup-component-dm.md | 12 +++++++----- 56 files changed, 118 insertions(+), 6 deletions(-) diff --git a/tiup/tiup-command-mirror-clone.md b/tiup/tiup-command-mirror-clone.md index 466c3eed7ccb2..8de470549730c 100644 --- a/tiup/tiup-command-mirror-clone.md +++ b/tiup/tiup-command-mirror-clone.md @@ -4,6 +4,8 @@ title: tiup mirror clone # tiup mirror clone +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) + The command `tiup mirror clone` is used to clone an existing mirror or clone some of its components to create a new mirror. The new mirror has the same components as the old one, but uses a different signature key. ## Syntax diff --git a/tiup/tiup-command-mirror-genkey.md b/tiup/tiup-command-mirror-genkey.md index fe4076b8b1346..f9c8d2321b78a 100644 --- a/tiup/tiup-command-mirror-genkey.md +++ b/tiup/tiup-command-mirror-genkey.md @@ -4,6 +4,8 @@ title: tiup mirror genkey # tiup mirror genkey +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) + TiUP [mirror](/tiup/tiup-mirror-reference.md), according its definition, has three roles of users: - Mirror administrators: They have the permission to modify `root.json`, `index.json`, `snapshot.json`, and `timestamp.json`. diff --git a/tiup/tiup-command-mirror-grant.md b/tiup/tiup-command-mirror-grant.md index a759f699734e5..ba0fb76ed4770 100644 --- a/tiup/tiup-command-mirror-grant.md +++ b/tiup/tiup-command-mirror-grant.md @@ -4,6 +4,8 @@ title: tiup mirror grant # tiup mirror grant +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) + The `tiup mirror grant` command is used to introduce a component owner to the current mirror. Component owners can use their keys to publish new components or to modify components they previously published. Before adding a new component owner, the component owner to be added needs to send his or her own public key to the mirror administrator. diff --git a/tiup/tiup-command-mirror-init.md b/tiup/tiup-command-mirror-init.md index a549e13ffabdc..2ef84a9428116 100644 --- a/tiup/tiup-command-mirror-init.md +++ b/tiup/tiup-command-mirror-init.md @@ -4,6 +4,8 @@ title: tiup mirror init # tiup mirror init +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) + The command `tiup mirror init` is used to initialize an empty mirror. The initialized mirror does not contain any components or component owners. The command only generates the following files for the initialized mirror: ``` diff --git a/tiup/tiup-command-mirror-merge.md b/tiup/tiup-command-mirror-merge.md index 6e93d3a2330b5..5cd62f4767caa 100644 --- a/tiup/tiup-command-mirror-merge.md +++ b/tiup/tiup-command-mirror-merge.md @@ -4,6 +4,8 @@ title: tiup mirror merge # tiup mirror merge +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) + The `tiup mirror merge` command is used to merge one or more mirrors to the current mirror. To execute this command, the following conditions must be met: diff --git a/tiup/tiup-command-mirror-modify.md b/tiup/tiup-command-mirror-modify.md index 9e5fe1e9b5da3..e93d4b7140b39 100644 --- a/tiup/tiup-command-mirror-modify.md +++ b/tiup/tiup-command-mirror-modify.md @@ -4,6 +4,8 @@ title: tiup mirror modify # tiup mirror modify +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) + The `tiup mirror modify` command is used to modify published components. Only valid component owners can modify the components that they have published on their own. For the method to publish a component, refer to the [`publish` command](/tiup/tiup-command-mirror-publish.md). ## Syntax diff --git a/tiup/tiup-command-mirror-publish.md b/tiup/tiup-command-mirror-publish.md index 5cdbc7d20c429..cb4052cf4f508 100644 --- a/tiup/tiup-command-mirror-publish.md +++ b/tiup/tiup-command-mirror-publish.md @@ -4,6 +4,8 @@ title: tiup mirror publish # tiup mirror publish +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) + The command `tiup mirror publish` is used to publish a new component or a new version of an existing component. Only component owner that has the access to the target component can publish it. To add a new component owner, see the usage of the [`grant` command](/tiup/tiup-command-mirror-grant.md). ## Syntax diff --git a/tiup/tiup-command-mirror-rotate.md b/tiup/tiup-command-mirror-rotate.md index 4441cf7600d68..f81bd543bf508 100644 --- a/tiup/tiup-command-mirror-rotate.md +++ b/tiup/tiup-command-mirror-rotate.md @@ -4,6 +4,8 @@ title: tiup mirror rotate # tiup mirror rotate +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) + `root.json` is an important file in a TiUP mirror. It stores the public keys needed for the entire system and is the basis of the chain of trust in TiUP. It mainly contains the following parts: - Signatures of mirror administrators. For the official mirror, there are five signatures. For an initialized mirror, there are three signatures by default. diff --git a/tiup/tiup-command-mirror-set.md b/tiup/tiup-command-mirror-set.md index 241fb4db86e18..441d426148cdb 100644 --- a/tiup/tiup-command-mirror-set.md +++ b/tiup/tiup-command-mirror-set.md @@ -4,6 +4,8 @@ title: tiup mirror set # tiup mirror set +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) + The `tiup mirror set` command is used to switch the current mirror and supports two forms of mirrors: local file system and remote network address. The address of the official mirror is `https://tiup-mirrors.pingcap.com`. diff --git a/tiup/tiup-command-mirror-sign.md b/tiup/tiup-command-mirror-sign.md index 397d07cefe660..f2c9a2c4935bf 100644 --- a/tiup/tiup-command-mirror-sign.md +++ b/tiup/tiup-command-mirror-sign.md @@ -4,6 +4,8 @@ title: tiup mirror sign # tiup mirror sign +[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) + The `tiup mirror sign` command is used to sign the metadata files (*.json）defined in TiUP [mirror](/tiup/tiup-mirror-reference.md). These metadata files might be stored on the local file system or remotely stored using the HTTP protocol to provide a signature entry. ## Syntax diff --git a/tiup/tiup-component-cluster-audit.md b/tiup/tiup-component-cluster-audit.md index aeb0c7262b9d3..b7ea99227c100 100644 --- a/tiup/tiup-component-cluster-audit.md +++ b/tiup/tiup-component-cluster-audit.md @@ -4,6 +4,8 @@ title: tiup cluster audit # tiup cluster audit +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + The `tiup cluster audit` command is used to view commands executed on all clusters in the history and the execution log of each command. ## Syntax diff --git a/tiup/tiup-component-cluster-check.md b/tiup/tiup-component-cluster-check.md index 044c207e4f648..ad98463eccc8c 100644 --- a/tiup/tiup-component-cluster-check.md +++ b/tiup/tiup-component-cluster-check.md @@ -4,6 +4,8 @@ title: tiup cluster check # tiup cluster check +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + For a formal production environment, before the environment goes live, you need to perform a series of checks to ensure the clusters are in their best performance. To simplify the manual check steps, TiUP Cluster provides the `check` command to check whether the hardware and software environments of the target machines of a specified cluster meet the requirements to work normally. ## List of check items diff --git a/tiup/tiup-component-cluster-clean.md b/tiup/tiup-component-cluster-clean.md index 8f5266cb1d063..56146640d8cb8 100644 --- a/tiup/tiup-component-cluster-clean.md +++ b/tiup/tiup-component-cluster-clean.md @@ -4,6 +4,8 @@ title: tiup cluster clean # tiup cluster clean +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + In the test environment, sometimes you might need to reset the cluster back to the state as it has been just deployed, which means deleting all data. You can do that easily using the `tiup cluster clean` command. After running it, the cluster is stopped and then cluster data is deleted. After restarting the cluster manually, you will get a clean cluster. > **Warning:** diff --git a/tiup/tiup-component-cluster-deploy.md b/tiup/tiup-component-cluster-deploy.md index 5d71e44304e15..ffd2e637c4ec8 100644 --- a/tiup/tiup-component-cluster-deploy.md +++ b/tiup/tiup-component-cluster-deploy.md @@ -4,6 +4,8 @@ title: tiup cluster deploy # tiup cluster deploy +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + The `tiup cluster deploy` command is used to deploy a new cluster. ## Syntax diff --git a/tiup/tiup-component-cluster-destroy.md b/tiup/tiup-component-cluster-destroy.md index d09004f81a489..6fedb8d7fc81b 100644 --- a/tiup/tiup-component-cluster-destroy.md +++ b/tiup/tiup-component-cluster-destroy.md @@ -4,6 +4,8 @@ title: tiup cluster destroy # tiup cluster destroy +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + After an application goes offline, if you want to release the machines occupied by the cluster for use by other applications, you need to clean up the data on the cluster and the deployed binary files. To destroy the cluster, the `tiup cluster destroy` command performs the following operations: - Stops the cluster. diff --git a/tiup/tiup-component-cluster-disable.md b/tiup/tiup-component-cluster-disable.md index a75d0c761b7b8..06e7c42225ced 100644 --- a/tiup/tiup-component-cluster-disable.md +++ b/tiup/tiup-component-cluster-disable.md @@ -4,6 +4,8 @@ title: tiup cluster disable # tiup cluster disable +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + After restarting the machine on which the cluster service is located, the cluster service will be automatically enabled. To disable the auto-enabling of cluster service, you can use the `tiup cluster disable` command. This command executes `systemctl disable ` on the specified node to disable the auto-enabling of the service. ## Syntax diff --git a/tiup/tiup-component-cluster-display.md b/tiup/tiup-component-cluster-display.md index 0ab1d0fc0f919..330beb316db31 100644 --- a/tiup/tiup-component-cluster-display.md +++ b/tiup/tiup-component-cluster-display.md @@ -4,6 +4,8 @@ title: tiup cluster display # tiup cluster display +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + If you want to see the operation status of each component in the cluster, it is obviously inefficient to log in to each machine one by one. Therefore, tiup-cluster provides the `tiup cluster display` command to efficiently complete this task. ## Syntax diff --git a/tiup/tiup-component-cluster-edit-config.md b/tiup/tiup-component-cluster-edit-config.md index b222327e8ee27..9bf45a6eea18d 100644 --- a/tiup/tiup-component-cluster-edit-config.md +++ b/tiup/tiup-component-cluster-edit-config.md @@ -4,6 +4,8 @@ title: tiup cluster edit-config # tiup cluster edit-config +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + If you need to modify the cluster configuration after the cluster is deployed, you can use the `tiup cluster edit-config` command that starts an editor for you to modify the [topology file](/tiup/tiup-cluster-topology-reference.md) of a cluster. This editor is specified in the `$EDITOR` environment variable by default. If the `$EDITOR` environment variable does not exist, the `vi` editor is used. > **Note:** diff --git a/tiup/tiup-component-cluster-enable.md b/tiup/tiup-component-cluster-enable.md index 1a0eeb98a8153..0c8177536ba29 100644 --- a/tiup/tiup-component-cluster-enable.md +++ b/tiup/tiup-component-cluster-enable.md @@ -4,6 +4,8 @@ title: tiup cluster enable # tiup cluster enable +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + The `tiup cluster enable` command is used to set the auto-enabling of the cluster service after a machine is restarted. This command enables the auto-enabling of the service by executing `systemctl enable ` at the specified node. > **Note:** diff --git a/tiup/tiup-component-cluster-help.md b/tiup/tiup-component-cluster-help.md index 1b11b35b01b47..cc9ee2879868d 100644 --- a/tiup/tiup-component-cluster-help.md +++ b/tiup/tiup-component-cluster-help.md @@ -4,6 +4,8 @@ title: tiup cluster help # tiup cluster help +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + tiup-cluster provides a wealth of help information for users in the command line interface. You can obtain it via the `help` command or the `--help` option. `tiup cluster help ` is basically equivalent to `tiup cluster --help`. ## Syntax diff --git a/tiup/tiup-component-cluster-import.md b/tiup/tiup-component-cluster-import.md index e49c318cb0a46..415e324f8770f 100644 --- a/tiup/tiup-component-cluster-import.md +++ b/tiup/tiup-component-cluster-import.md @@ -4,6 +4,8 @@ title: tiup cluster import # tiup cluster import +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + Before TiDB v4.0, TiDB clusters were mainly deployed using TiDB Ansible. For TiDB v4.0 and later releases, TiUP Cluster provides the `import` command to transfer the clusters to the tiup-cluster component for management. > **Note:** diff --git a/tiup/tiup-component-cluster-list.md b/tiup/tiup-component-cluster-list.md index c9510f89cd5e0..0131be064dee1 100644 --- a/tiup/tiup-component-cluster-list.md +++ b/tiup/tiup-component-cluster-list.md @@ -4,6 +4,8 @@ title: tiup cluster list # tiup cluster list +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + tiup-cluster supports deploying multiple clusters using the same control machine. The `tiup cluster list` command outputs all clusters deployed by the currently logged-in user using this control machine. > **Note:** diff --git a/tiup/tiup-component-cluster-patch.md b/tiup/tiup-component-cluster-patch.md index d68e1bc4a3e5c..27e1a346a4894 100644 --- a/tiup/tiup-component-cluster-patch.md +++ b/tiup/tiup-component-cluster-patch.md @@ -4,6 +4,8 @@ title: tiup cluster patch # tiup cluster patch +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + If you need to dynamically replace the binaries of a service while the cluster is running (namely, keep the cluster available during the replacement process), you can use the `tiup cluster patch` command. After the command is executed, TiUP does the following things: - Uploads the binary package for replacement to the target machine. diff --git a/tiup/tiup-component-cluster-prune.md b/tiup/tiup-component-cluster-prune.md index de2b81008becb..fba6a224d4c20 100644 --- a/tiup/tiup-component-cluster-prune.md +++ b/tiup/tiup-component-cluster-prune.md @@ -4,6 +4,8 @@ title: tiup cluster prune # tiup cluster prune +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + When [scaling in the cluster](/tiup/tiup-component-cluster-scale-in.md), for some components, TiUP does not immediately stop their services or delete their data. You need to wait for the data scheduling to complete and then manually execute the `tiup cluster prune` command to clean up. ## Syntax diff --git a/tiup/tiup-component-cluster-reload.md b/tiup/tiup-component-cluster-reload.md index 8986e26dbb041..f156dbb23f0fe 100644 --- a/tiup/tiup-component-cluster-reload.md +++ b/tiup/tiup-component-cluster-reload.md @@ -4,6 +4,8 @@ title: tiup cluster reload # tiup cluster reload +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + 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 diff --git a/tiup/tiup-component-cluster-rename.md b/tiup/tiup-component-cluster-rename.md index 6042bbced0c00..d3a5fb8ba223a 100644 --- a/tiup/tiup-component-cluster-rename.md +++ b/tiup/tiup-component-cluster-rename.md @@ -4,6 +4,8 @@ title: tiup cluster rename # tiup cluster rename +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + The cluster name is specified when [the cluster is deployed](/tiup/tiup-component-cluster-deploy.md). If you want to change the cluster name after the cluster is deployed, you can use the command `tiup cluster rename`. > **Note:** diff --git a/tiup/tiup-component-cluster-replay.md b/tiup/tiup-component-cluster-replay.md index f5a375bcf4505..340807493fbda 100644 --- a/tiup/tiup-component-cluster-replay.md +++ b/tiup/tiup-component-cluster-replay.md @@ -4,6 +4,8 @@ title: tiup cluster replay # tiup cluster replay +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + When you perform a cluster operation such as upgrade or restart, the operation might fail due to cluster environment issues. If you re-perform the operation, you need to perform all the steps from the very beginning. If the cluster is large, re-performing these steps will take a long time. In this case, you can use the `tiup cluster replay` command to retry the failed commands and skip the successfully performed steps. ## Syntax diff --git a/tiup/tiup-component-cluster-restart.md b/tiup/tiup-component-cluster-restart.md index 0da657da69415..e857183fe4454 100644 --- a/tiup/tiup-component-cluster-restart.md +++ b/tiup/tiup-component-cluster-restart.md @@ -4,6 +4,8 @@ title: tiup cluster restart # tiup cluster restart +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + The command `tiup cluster restart` is used to restart all or some of the services of the specified cluster. > **Note:** diff --git a/tiup/tiup-component-cluster-scale-in.md b/tiup/tiup-component-cluster-scale-in.md index aaa96dfa1934a..b246a6c07404f 100644 --- a/tiup/tiup-component-cluster-scale-in.md +++ b/tiup/tiup-component-cluster-scale-in.md @@ -4,6 +4,8 @@ title: tiup cluster scale-in # tiup cluster scale-in +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + The `tiup cluster scale-in` command is used to scale in the cluster, which takes the services of the specified nodes offline, removes the specified nodes from the cluster, and deletes the remaining files from those nodes. Because the TiKV, TiFlash, and TiDB Binlog components are taken offline asynchronously (which requires TiUP to remove the node through API first) and the stopping process takes a long time (which requires TiUP to continuously check whether the node is successfully taken offline), the TiKV, TiFlash, and TiDB Binlog components are handled particularly as follows: diff --git a/tiup/tiup-component-cluster-scale-out.md b/tiup/tiup-component-cluster-scale-out.md index 478eaab8d4413..5689a8a6dd562 100644 --- a/tiup/tiup-component-cluster-scale-out.md +++ b/tiup/tiup-component-cluster-scale-out.md @@ -4,6 +4,8 @@ title: tiup cluster scale-out # tiup cluster scale-out +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + 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. diff --git a/tiup/tiup-component-cluster-start.md b/tiup/tiup-component-cluster-start.md index 6f7085c557005..f5252dd32a891 100644 --- a/tiup/tiup-component-cluster-start.md +++ b/tiup/tiup-component-cluster-start.md @@ -4,6 +4,8 @@ title: tiup cluster start # tiup cluster start +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + The `tiup cluster start` command is used to start all services or some services of the specified cluster. ## Syntax diff --git a/tiup/tiup-component-cluster-stop.md b/tiup/tiup-component-cluster-stop.md index 6c2b4d9cdc872..a7da6d8664eac 100644 --- a/tiup/tiup-component-cluster-stop.md +++ b/tiup/tiup-component-cluster-stop.md @@ -4,6 +4,8 @@ title: tiup cluster stop # tiup cluster stop +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + The `tiup cluster stop` command is used to stop all services or some services of the specified cluster. > **Note:** diff --git a/tiup/tiup-component-cluster-template.md b/tiup/tiup-component-cluster-template.md index 1b6a47aa2e54a..6dd21372c9def 100644 --- a/tiup/tiup-component-cluster-template.md +++ b/tiup/tiup-component-cluster-template.md @@ -4,6 +4,8 @@ title: tiup cluster template # tiup cluster template +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + Before deploying the cluster, you need to prepare a [topology file](/tiup/tiup-cluster-topology-reference.md) of the cluster. TiUP has a built-in topology file template, and you can modify this template to create the final topology file. To output the built-in template content, you can use the `tiup cluster template` command. ## Syntax diff --git a/tiup/tiup-component-cluster-upgrade.md b/tiup/tiup-component-cluster-upgrade.md index ea3189d29d824..50aedba5fdb23 100644 --- a/tiup/tiup-component-cluster-upgrade.md +++ b/tiup/tiup-component-cluster-upgrade.md @@ -4,6 +4,8 @@ title: tiup cluster upgrade # tiup cluster upgrade +[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) + The `tiup cluster upgrade` command is used to upgrade the specified cluster to a specific version. ## Syntax diff --git a/tiup/tiup-component-dm-audit.md b/tiup/tiup-component-dm-audit.md index 43d8badea3179..63d35df647243 100644 --- a/tiup/tiup-component-dm-audit.md +++ b/tiup/tiup-component-dm-audit.md @@ -4,6 +4,8 @@ title: tiup dm audit # tiup dm audit +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + The `tiup dm audit` command is used to view historical commands executed on all clusters and the execution log of each command. ## Syntax diff --git a/tiup/tiup-component-dm-deploy.md b/tiup/tiup-component-dm-deploy.md index bd612752b90b3..f1bb482c2019a 100644 --- a/tiup/tiup-component-dm-deploy.md +++ b/tiup/tiup-component-dm-deploy.md @@ -4,6 +4,8 @@ title: tiup dm deploy # tiup dm deploy +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + The `tiup dm deploy` command is used to deploy a new cluster. ## Syntax diff --git a/tiup/tiup-component-dm-destroy.md b/tiup/tiup-component-dm-destroy.md index 3cbfd1645a2e0..7c75a7deba46d 100644 --- a/tiup/tiup-component-dm-destroy.md +++ b/tiup/tiup-component-dm-destroy.md @@ -4,6 +4,8 @@ title: tiup dm destroy # tiup dm destroy +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + After an application goes offline, if you want to release the machines occupied by the cluster for use by other applications, you need to clean up the data on the cluster and the deployed binary files. To destroy the cluster, the `tiup dm destroy` command performs the following operations: - Stops the cluster. diff --git a/tiup/tiup-component-dm-disable.md b/tiup/tiup-component-dm-disable.md index d9abff9a6a75a..72199f85f93f2 100644 --- a/tiup/tiup-component-dm-disable.md +++ b/tiup/tiup-component-dm-disable.md @@ -4,6 +4,8 @@ title: tiup dm disable # tiup dm disable +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + After restarting the machine on which the cluster service is located, the cluster service will be automatically enabled. To disable the auto-enabling of cluster service, you can use the `tiup dm disable` command. This command executes `systemctl disable ` on the specified node to disable the auto-enabling of the service. ## Syntax diff --git a/tiup/tiup-component-dm-display.md b/tiup/tiup-component-dm-display.md index dbc6e403a2595..f33f97d163ae4 100644 --- a/tiup/tiup-component-dm-display.md +++ b/tiup/tiup-component-dm-display.md @@ -4,6 +4,8 @@ title: tiup dm display # tiup dm display +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + If you want to check the operational status of each component in a DM cluster, it is inefficient to log in to each machine one by one. Therefore, tiup-dm provides the `tiup dm display` command to do this job efficiently. ## Syntax diff --git a/tiup/tiup-component-dm-edit-config.md b/tiup/tiup-component-dm-edit-config.md index 7b2ba042b3d81..4921ddc64c30a 100644 --- a/tiup/tiup-component-dm-edit-config.md +++ b/tiup/tiup-component-dm-edit-config.md @@ -4,6 +4,8 @@ title: tiup dm edit-config # tiup dm edit-config +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + If you need to modify the cluster service configuration after the cluster is deployed, you can use the `tiup dm edit-config` command that starts an editor for you to modify the [topology file](/tiup/tiup-dm-topology-reference.md). of the specified cluster. This editor is specified in the `$EDITOR` environment variable by default. If the `$EDITOR` environment variable does not exist, the `vi` editor is used. > **Note:** diff --git a/tiup/tiup-component-dm-enable.md b/tiup/tiup-component-dm-enable.md index 8ed4d840bbb6c..33576644a433f 100644 --- a/tiup/tiup-component-dm-enable.md +++ b/tiup/tiup-component-dm-enable.md @@ -4,6 +4,8 @@ title: tiup dm enable # tiup dm enable +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + The `tiup dm enable` command is used to set the auto-enabling of the cluster service after a machine is restarted. This command enables the auto-enabling of the service by executing `systemctl enable ` at the specified node. ## Syntax diff --git a/tiup/tiup-component-dm-help.md b/tiup/tiup-component-dm-help.md index da4867e0a40df..6887cf670d139 100644 --- a/tiup/tiup-component-dm-help.md +++ b/tiup/tiup-component-dm-help.md @@ -4,6 +4,8 @@ title: tiup dm help # tiup dm help +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + tiup-dm command-line interface provides users with a wealth of help information. You can view it via the `help` command or the `--help` option. Basically, `tiup dm help ` is equivalent to `tiup dm --help`. ## Syntax diff --git a/tiup/tiup-component-dm-import.md b/tiup/tiup-component-dm-import.md index fd5f023e10bf2..a4791be0ca02e 100644 --- a/tiup/tiup-component-dm-import.md +++ b/tiup/tiup-component-dm-import.md @@ -4,6 +4,8 @@ title: tiup dm import # tiup dm import +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + In DM v1.0, the cluster is basically deployed using TiDB Ansible. TiUP DM provides the `import` command to import v1.0 clusters and redeploy the clusters in DM v2.0. > **Note:** diff --git a/tiup/tiup-component-dm-list.md b/tiup/tiup-component-dm-list.md index 7339da8ef2927..5849bd73196bb 100644 --- a/tiup/tiup-component-dm-list.md +++ b/tiup/tiup-component-dm-list.md @@ -4,6 +4,8 @@ title: tiup dm list # tiup dm list +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + `tiup-dm` supports deploying multiple clusters using the same control machine. You can use the `tiup dm list` command to check which clusters are deployed using the control machine by the currently logged-in user. > **Note:** diff --git a/tiup/tiup-component-dm-patch.md b/tiup/tiup-component-dm-patch.md index 45bca99d35dd0..d229a85dcfb38 100644 --- a/tiup/tiup-component-dm-patch.md +++ b/tiup/tiup-component-dm-patch.md @@ -4,6 +4,8 @@ title: tiup dm patch # tiup dm patch +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + If you need to dynamically replace the binaries of a service while the cluster is running (that is, to keep the cluster available during the replacement), you can use the `tiup dm patch` command. The command does the following: - Uploads the binary package for replacement to the target machine. diff --git a/tiup/tiup-component-dm-prune.md b/tiup/tiup-component-dm-prune.md index 12097c4a0079c..814c45ddd3a68 100644 --- a/tiup/tiup-component-dm-prune.md +++ b/tiup/tiup-component-dm-prune.md @@ -4,6 +4,8 @@ title: tiup dm prune # tiup dm prune +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + 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 diff --git a/tiup/tiup-component-dm-reload.md b/tiup/tiup-component-dm-reload.md index 713915d4660bc..fc6aaab81ea89 100644 --- a/tiup/tiup-component-dm-reload.md +++ b/tiup/tiup-component-dm-reload.md @@ -4,6 +4,8 @@ title: tiup dm reload # tiup dm reload +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + 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 diff --git a/tiup/tiup-component-dm-replay.md b/tiup/tiup-component-dm-replay.md index 64719e26c01e2..bb2a74d52936e 100644 --- a/tiup/tiup-component-dm-replay.md +++ b/tiup/tiup-component-dm-replay.md @@ -4,6 +4,8 @@ title: tiup dm replay # tiup dm replay +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + When you perform a cluster operation such as upgrade or restart, the operation might fail due to cluster environment issues. If you re-perform the operation, you need to perform all the steps from the very beginning. If the cluster is large, re-performing these steps will take a long time. In this case, you can use the `tiup dm replay` command to retry the failed commands and skip the successfully performed steps. ## Syntax diff --git a/tiup/tiup-component-dm-restart.md b/tiup/tiup-component-dm-restart.md index 278dab2aef4e1..720c685cf5dd5 100644 --- a/tiup/tiup-component-dm-restart.md +++ b/tiup/tiup-component-dm-restart.md @@ -4,6 +4,8 @@ title: tiup dm restart # tiup dm restart +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + The command `tiup dm restart` is used to restart all or some of the services of the specified cluster. > **Note:** diff --git a/tiup/tiup-component-dm-scale-in.md b/tiup/tiup-component-dm-scale-in.md index 581e98ddad170..7737565eb74fa 100644 --- a/tiup/tiup-component-dm-scale-in.md +++ b/tiup/tiup-component-dm-scale-in.md @@ -4,6 +4,8 @@ title: tiup dm scale-in # tiup dm scale-in +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + The `tiup dm scale-in` command is used to scale in the cluster. Scaling in the cluster means taking the service offline, which eventually removes the specified node from the cluster and deletes the remaining related files. ## Syntax diff --git a/tiup/tiup-component-dm-scale-out.md b/tiup/tiup-component-dm-scale-out.md index b103b6b18d54d..de2c825c5354c 100644 --- a/tiup/tiup-component-dm-scale-out.md +++ b/tiup/tiup-component-dm-scale-out.md @@ -4,6 +4,8 @@ title: tiup dm scale-out # tiup dm scale-out +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + The `tiup dm 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-dm` components first establish an SSH connection to the new node, create the necessary directories on the target node, then perform the deployment and start the service. ## Syntax diff --git a/tiup/tiup-component-dm-start.md b/tiup/tiup-component-dm-start.md index 6532a7377567f..22a56835a6f10 100644 --- a/tiup/tiup-component-dm-start.md +++ b/tiup/tiup-component-dm-start.md @@ -4,6 +4,8 @@ title: tiup dm start # tiup dm start +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + The `tiup dm start` command is used to start all or part of the services of the specified cluster. ## Syntax diff --git a/tiup/tiup-component-dm-stop.md b/tiup/tiup-component-dm-stop.md index 8a46ee87cae7d..98f43b14dfe69 100644 --- a/tiup/tiup-component-dm-stop.md +++ b/tiup/tiup-component-dm-stop.md @@ -4,6 +4,8 @@ title: tiup dm stop # tiup dm stop +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + The `tiup dm stop` command is used to stop all or part of the services of the specified cluster. > **Note:** diff --git a/tiup/tiup-component-dm-template.md b/tiup/tiup-component-dm-template.md index 939474225248a..5ba3ac3788caf 100644 --- a/tiup/tiup-component-dm-template.md +++ b/tiup/tiup-component-dm-template.md @@ -4,6 +4,8 @@ title: tiup dm template # tiup dm template +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + Before deploying the cluster, you need to prepare a [topology file](/tiup/tiup-dm-topology-reference.md) of the cluster. TiUP has a built-in topology file template, and you can modify this template to create the final topology file. To output the built-in template content, you can use the `tiup dm template` command. ## Syntax diff --git a/tiup/tiup-component-dm-upgrade.md b/tiup/tiup-component-dm-upgrade.md index aa3cc8b96a8fb..91a0fefa073c8 100644 --- a/tiup/tiup-component-dm-upgrade.md +++ b/tiup/tiup-component-dm-upgrade.md @@ -4,9 +4,11 @@ title: tiup dm upgrade # tiup dm upgrade +[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) + The `tiup dm upgrade` command is used to upgrade a specified cluster to a specific version. -## Syntax +## Syntax ```shell tiup dm upgrade [flags] diff --git a/tiup/tiup-component-dm.md b/tiup/tiup-component-dm.md index 4e3194f5a8073..2315f077aad0c 100644 --- a/tiup/tiup-component-dm.md +++ b/tiup/tiup-component-dm.md @@ -4,6 +4,8 @@ title: TiUP DM # TiUP DM +[<< Back to the previous page - TiUP Reference component list](/tiup/tiup-reference.md#component-list) + Similar to [TiUP Cluster](/tiup/tiup-component-cluster.md) which is used to manage TiDB clusters, TiUP DM is used to manage DM clusters. You can use the TiUP DM component to perform daily operations and maintenance tasks of DM clusters, including deploying, starting, stopping, destroying, elastic scaling, upgrading DM clusters, and managing the configuration parameters of DM clusters. ## Syntax @@ -12,14 +14,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 +39,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 +60,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. From 21ad323a21101ff0f615d81c250f5dc0ff0cfc2e Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Mon, 10 May 2021 11:14:03 +0800 Subject: [PATCH 2/4] add links --- tiup/tiup-command-clean.md | 2 ++ tiup/tiup-command-completion.md | 2 ++ tiup/tiup-command-env.md | 2 ++ tiup/tiup-command-help.md | 2 ++ tiup/tiup-command-install.md | 2 ++ tiup/tiup-command-list.md | 2 ++ tiup/tiup-command-mirror.md | 2 ++ tiup/tiup-command-status.md | 2 ++ tiup/tiup-command-telemetry.md | 2 ++ tiup/tiup-command-uninstall.md | 2 ++ tiup/tiup-command-update.md | 4 +++- tiup/tiup-component-cluster.md | 2 ++ 12 files changed, 25 insertions(+), 1 deletion(-) diff --git a/tiup/tiup-command-clean.md b/tiup/tiup-command-clean.md index fd61ec22b021f..779acea086436 100644 --- a/tiup/tiup-command-clean.md +++ b/tiup/tiup-command-clean.md @@ -4,6 +4,8 @@ title: tiup clean # tiup clean +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) + The `tiup clean` command is used to clear the data generated during component operation. ## Syntax diff --git a/tiup/tiup-command-completion.md b/tiup/tiup-command-completion.md index 2157fabc1580a..d76741f44b359 100644 --- a/tiup/tiup-command-completion.md +++ b/tiup/tiup-command-completion.md @@ -4,6 +4,8 @@ title: tiup completion # tiup completion +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) + To reduce user costs, TiUP provides the `tiup completion` command to generate a configuration file for automatic command-line completion. Currently, TiUP supports completing `bash` and `zsh` commands. If you want to complete `bash` commands, you need to install `bash-completion` first. See the following instructions: diff --git a/tiup/tiup-command-env.md b/tiup/tiup-command-env.md index 6810f4ebac679..97c0ee7a3381b 100644 --- a/tiup/tiup-command-env.md +++ b/tiup/tiup-command-env.md @@ -4,6 +4,8 @@ title: tiup env # tiup env +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) + TiUP provides users with flexible and customized interfaces, some of which are implemented using environment variables. The `tiup env` command is used to query the user-defined environment variables that TiUP supports and their values. ## Syntax diff --git a/tiup/tiup-command-help.md b/tiup/tiup-command-help.md index ea59b6bdd4733..9d23f3db64cc1 100644 --- a/tiup/tiup-command-help.md +++ b/tiup/tiup-command-help.md @@ -4,6 +4,8 @@ title: tiup help # tiup help +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) + The TiUP command-line interface provides users with a wealth of help information. You can view it via the `help` command or the `--help` option. ## Syntax diff --git a/tiup/tiup-command-install.md b/tiup/tiup-command-install.md index 7d4fc71e060d0..0f88c46734e81 100644 --- a/tiup/tiup-command-install.md +++ b/tiup/tiup-command-install.md @@ -4,6 +4,8 @@ title: tiup install # tiup install +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) + The `tiup install` command is used for component installation. It downloads the component package of a specified version from the mirror repository and decompresses it in the local TiUP data directory for later use. In addition, when TiUP needs to run a component that does not exist in the mirror repository, it tries to download the component first and then runs it automatically. If the component does not exist in the repository, an error is reported. ## Syntax diff --git a/tiup/tiup-command-list.md b/tiup/tiup-command-list.md index 6d95280b8ab68..2e8df65f5c54a 100644 --- a/tiup/tiup-command-list.md +++ b/tiup/tiup-command-list.md @@ -4,6 +4,8 @@ title: tiup list # tiup list +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) + The command `tiup list` is used to get the list of available components of a mirror. ## Syntax diff --git a/tiup/tiup-command-mirror.md b/tiup/tiup-command-mirror.md index 22277aafe1ab3..82b443e079b31 100644 --- a/tiup/tiup-command-mirror.md +++ b/tiup/tiup-command-mirror.md @@ -4,6 +4,8 @@ title: tiup mirror # tiup mirror +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) + In TiUP, [mirror](/tiup/tiup-mirror-reference.md) is an important concept. TiUP currently supports two forms of mirroring: - Local mirror: the TiUP client and the mirror are on the same machine, and the client accesses the mirror through the file system. diff --git a/tiup/tiup-command-status.md b/tiup/tiup-command-status.md index 3529692ab3a6b..33e239fc99d8f 100644 --- a/tiup/tiup-command-status.md +++ b/tiup/tiup-command-status.md @@ -4,6 +4,8 @@ title: tiup status # tiup status +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) + The `tiup status` command is used to view the operation information of the components after you run the components using the `tiup [flags] [args...]` command. > **Note:** diff --git a/tiup/tiup-command-telemetry.md b/tiup/tiup-command-telemetry.md index 179d25fec5145..d97ef35ce25d9 100644 --- a/tiup/tiup-command-telemetry.md +++ b/tiup/tiup-command-telemetry.md @@ -4,6 +4,8 @@ title: tiup telemetry # tiup telemetry +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) + TiDB, TiUP, and TiDB Dashboard collect usage information by default and share the information with PingCAP to improve the product. For example, through this usage information, PingCAP learns about common TiDB cluster operations and thereby determines the priority of new features. When TiUP telemetry is enabled, usage information is shared with PingCAP when TiUP commands are executed, including (but not limited to): diff --git a/tiup/tiup-command-uninstall.md b/tiup/tiup-command-uninstall.md index abd0143212fbd..5378772d80224 100644 --- a/tiup/tiup-command-uninstall.md +++ b/tiup/tiup-command-uninstall.md @@ -4,6 +4,8 @@ title: tiup uninstall # tiup uninstall +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) + The `tiup uninstall` command is used to uninstall the installed components. ## Syntax diff --git a/tiup/tiup-command-update.md b/tiup/tiup-command-update.md index 2b9c00c0d0b96..38caca3b2fbf4 100644 --- a/tiup/tiup-command-update.md +++ b/tiup/tiup-command-update.md @@ -4,11 +4,13 @@ title: tiup update # tiup update +[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) + The `tiup update` command is used to update the installed components or TiUP itself. ## Syntax -```sh +```shell tiup update [component1][:version] [component2..N] [flags] ``` diff --git a/tiup/tiup-component-cluster.md b/tiup/tiup-component-cluster.md index 754b138fd040d..f736cfda365c2 100644 --- a/tiup/tiup-component-cluster.md +++ b/tiup/tiup-component-cluster.md @@ -4,6 +4,8 @@ title: TiUP Cluster # TiUP Cluster +[<< Back to the previous page - TiUP Reference component list](/tiup/tiup-reference.md#component-list) + TiUP Cluster is a cluster management component of TiUP written in Golang. You can use the TiUP Cluster component to perform daily operations and maintenance, including deploying, starting, shutting down, destroying, elastic scaling, upgrading TiDB clusters, and managing TiDB cluster parameters. ## Syntax From f32e2cf9118667bb8176029cf83fdebb6cb189a4 Mon Sep 17 00:00:00 2001 From: Joyinqin Date: Mon, 10 May 2021 11:50:22 +0800 Subject: [PATCH 3/4] `sh`-`shell` --- tiup/tiup-cluster.md | 2 +- tiup/tiup-command-uninstall.md | 2 +- tiup/tiup-component-cluster-audit.md | 2 +- tiup/tiup-component-cluster-clean.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/tiup/tiup-cluster.md b/tiup/tiup-cluster.md index c7447b1efcf5f..e5c685d32d246 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-uninstall.md b/tiup/tiup-command-uninstall.md index 5378772d80224..9dda4509cc7a6 100644 --- a/tiup/tiup-command-uninstall.md +++ b/tiup/tiup-command-uninstall.md @@ -10,7 +10,7 @@ The `tiup uninstall` command is used to uninstall the installed components. ## Syntax -```sh +```shell tiup uninstall : [component2...N] [flags] ``` diff --git a/tiup/tiup-component-cluster-audit.md b/tiup/tiup-component-cluster-audit.md index b7ea99227c100..8c30ee0403b37 100644 --- a/tiup/tiup-component-cluster-audit.md +++ b/tiup/tiup-component-cluster-audit.md @@ -10,7 +10,7 @@ The `tiup cluster audit` command is used to view commands executed on all cluste ## Syntax -```sh +```shell tiup cluster audit [audit-id] [flags] ``` diff --git a/tiup/tiup-component-cluster-clean.md b/tiup/tiup-component-cluster-clean.md index 56146640d8cb8..0fe94a7f67661 100644 --- a/tiup/tiup-component-cluster-clean.md +++ b/tiup/tiup-component-cluster-clean.md @@ -14,7 +14,7 @@ In the test environment, sometimes you might need to reset the cluster back to t ## Syntax -```sh +```shell tiup cluster clean [flags] ``` From 0526b4da84f89d937edbd1516135a76ad3f5d6c5 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Tue, 11 May 2021 17:06:21 +0800 Subject: [PATCH 4/4] move to the last lines --- tiup/tiup-command-clean.md | 4 ++-- tiup/tiup-command-completion.md | 4 ++-- tiup/tiup-command-env.md | 4 ++-- tiup/tiup-command-help.md | 4 ++-- tiup/tiup-command-install.md | 4 ++-- tiup/tiup-command-list.md | 4 ++-- tiup/tiup-command-mirror-clone.md | 4 ++-- tiup/tiup-command-mirror-genkey.md | 4 ++-- tiup/tiup-command-mirror-grant.md | 4 ++-- tiup/tiup-command-mirror-init.md | 4 ++-- tiup/tiup-command-mirror-merge.md | 4 ++-- tiup/tiup-command-mirror-modify.md | 4 ++-- tiup/tiup-command-mirror-publish.md | 4 ++-- tiup/tiup-command-mirror-rotate.md | 4 ++-- tiup/tiup-command-mirror-set.md | 4 ++-- tiup/tiup-command-mirror-sign.md | 4 ++-- tiup/tiup-command-mirror.md | 4 ++-- tiup/tiup-command-status.md | 4 ++-- tiup/tiup-command-telemetry.md | 4 ++-- tiup/tiup-command-uninstall.md | 4 ++-- tiup/tiup-command-update.md | 4 ++-- tiup/tiup-component-cluster-audit.md | 4 ++-- tiup/tiup-component-cluster-check.md | 4 ++-- tiup/tiup-component-cluster-clean.md | 4 ++-- tiup/tiup-component-cluster-deploy.md | 4 ++-- tiup/tiup-component-cluster-destroy.md | 4 ++-- tiup/tiup-component-cluster-disable.md | 4 ++-- tiup/tiup-component-cluster-display.md | 4 ++-- tiup/tiup-component-cluster-edit-config.md | 4 ++-- tiup/tiup-component-cluster-enable.md | 4 ++-- tiup/tiup-component-cluster-help.md | 6 +++--- tiup/tiup-component-cluster-import.md | 4 ++-- tiup/tiup-component-cluster-list.md | 4 ++-- tiup/tiup-component-cluster-patch.md | 4 ++-- tiup/tiup-component-cluster-prune.md | 4 ++-- tiup/tiup-component-cluster-reload.md | 4 ++-- tiup/tiup-component-cluster-rename.md | 4 ++-- tiup/tiup-component-cluster-replay.md | 4 ++-- tiup/tiup-component-cluster-restart.md | 4 ++-- tiup/tiup-component-cluster-scale-in.md | 4 ++-- tiup/tiup-component-cluster-scale-out.md | 4 ++-- tiup/tiup-component-cluster-start.md | 4 ++-- tiup/tiup-component-cluster-stop.md | 10 +++++----- tiup/tiup-component-cluster-template.md | 4 ++-- tiup/tiup-component-cluster-upgrade.md | 4 ++-- tiup/tiup-component-cluster.md | 6 +++--- tiup/tiup-component-dm-audit.md | 6 +++--- tiup/tiup-component-dm-deploy.md | 4 ++-- tiup/tiup-component-dm-destroy.md | 4 ++-- tiup/tiup-component-dm-disable.md | 4 ++-- tiup/tiup-component-dm-display.md | 4 ++-- tiup/tiup-component-dm-edit-config.md | 4 ++-- tiup/tiup-component-dm-enable.md | 4 ++-- tiup/tiup-component-dm-help.md | 6 +++--- tiup/tiup-component-dm-import.md | 4 ++-- tiup/tiup-component-dm-list.md | 4 ++-- tiup/tiup-component-dm-patch.md | 4 ++-- tiup/tiup-component-dm-prune.md | 4 ++-- tiup/tiup-component-dm-reload.md | 4 ++-- tiup/tiup-component-dm-replay.md | 4 ++-- tiup/tiup-component-dm-restart.md | 4 ++-- tiup/tiup-component-dm-scale-in.md | 6 +++--- tiup/tiup-component-dm-scale-out.md | 4 ++-- tiup/tiup-component-dm-start.md | 4 ++-- tiup/tiup-component-dm-stop.md | 4 ++-- tiup/tiup-component-dm-template.md | 4 ++-- tiup/tiup-component-dm-upgrade.md | 4 ++-- tiup/tiup-component-dm.md | 4 ++-- tiup/tiup-dm-topology-reference.md | 2 +- 69 files changed, 145 insertions(+), 145 deletions(-) diff --git a/tiup/tiup-command-clean.md b/tiup/tiup-command-clean.md index 779acea086436..c1495e26fa7b0 100644 --- a/tiup/tiup-command-clean.md +++ b/tiup/tiup-command-clean.md @@ -4,8 +4,6 @@ title: tiup clean # tiup clean -[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) - The `tiup clean` command is used to clear the data generated during component operation. ## Syntax @@ -29,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 d76741f44b359..ba14ca86faef6 100644 --- a/tiup/tiup-command-completion.md +++ b/tiup/tiup-command-completion.md @@ -4,8 +4,6 @@ title: tiup completion # tiup completion -[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) - To reduce user costs, TiUP provides the `tiup completion` command to generate a configuration file for automatic command-line completion. Currently, TiUP supports completing `bash` and `zsh` commands. If you want to complete `bash` commands, you need to install `bash-completion` first. See the following instructions: @@ -43,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 97c0ee7a3381b..0219eb878f0c2 100644 --- a/tiup/tiup-command-env.md +++ b/tiup/tiup-command-env.md @@ -4,8 +4,6 @@ title: tiup env # tiup env -[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) - TiUP provides users with flexible and customized interfaces, some of which are implemented using environment variables. The `tiup env` command is used to query the user-defined environment variables that TiUP supports and their values. ## Syntax @@ -26,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 9d23f3db64cc1..f398f9e120ddb 100644 --- a/tiup/tiup-command-help.md +++ b/tiup/tiup-command-help.md @@ -4,8 +4,6 @@ title: tiup help # tiup help -[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) - The TiUP command-line interface provides users with a wealth of help information. You can view it via the `help` command or the `--help` option. ## Syntax @@ -23,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 0f88c46734e81..5244441c5451e 100644 --- a/tiup/tiup-command-install.md +++ b/tiup/tiup-command-install.md @@ -4,8 +4,6 @@ title: tiup install # tiup install -[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) - The `tiup install` command is used for component installation. It downloads the component package of a specified version from the mirror repository and decompresses it in the local TiUP data directory for later use. In addition, when TiUP needs to run a component that does not exist in the mirror repository, it tries to download the component first and then runs it automatically. If the component does not exist in the repository, an error is reported. ## Syntax @@ -25,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 2e8df65f5c54a..9f9a0b54ed8dc 100644 --- a/tiup/tiup-command-list.md +++ b/tiup/tiup-command-list.md @@ -4,8 +4,6 @@ title: tiup list # tiup list -[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) - The command `tiup list` is used to get the list of available components of a mirror. ## Syntax @@ -44,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 8de470549730c..1ba0725aafd26 100644 --- a/tiup/tiup-command-mirror-clone.md +++ b/tiup/tiup-command-mirror-clone.md @@ -4,8 +4,6 @@ title: tiup mirror clone # tiup mirror clone -[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) - The command `tiup mirror clone` is used to clone an existing mirror or clone some of its components to create a new mirror. The new mirror has the same components as the old one, but uses a different signature key. ## Syntax @@ -48,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 f9c8d2321b78a..18739fbe308f0 100644 --- a/tiup/tiup-command-mirror-genkey.md +++ b/tiup/tiup-command-mirror-genkey.md @@ -4,8 +4,6 @@ title: tiup mirror genkey # tiup mirror genkey -[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) - TiUP [mirror](/tiup/tiup-mirror-reference.md), according its definition, has three roles of users: - Mirror administrators: They have the permission to modify `root.json`, `index.json`, `snapshot.json`, and `timestamp.json`. @@ -53,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 ba0fb76ed4770..8f3ad9a959310 100644 --- a/tiup/tiup-command-mirror-grant.md +++ b/tiup/tiup-command-mirror-grant.md @@ -4,8 +4,6 @@ title: tiup mirror grant # tiup mirror grant -[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) - The `tiup mirror grant` command is used to introduce a component owner to the current mirror. Component owners can use their keys to publish new components or to modify components they previously published. Before adding a new component owner, the component owner to be added needs to send his or her own public key to the mirror administrator. @@ -42,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 2ef84a9428116..7d5f48088a577 100644 --- a/tiup/tiup-command-mirror-init.md +++ b/tiup/tiup-command-mirror-init.md @@ -4,8 +4,6 @@ title: tiup mirror init # tiup mirror init -[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) - The command `tiup mirror init` is used to initialize an empty mirror. The initialized mirror does not contain any components or component owners. The command only generates the following files for the initialized mirror: ``` @@ -44,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 5cd62f4767caa..ca16e2225c57f 100644 --- a/tiup/tiup-command-mirror-merge.md +++ b/tiup/tiup-command-mirror-merge.md @@ -4,8 +4,6 @@ title: tiup mirror merge # tiup mirror merge -[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) - The `tiup mirror merge` command is used to merge one or more mirrors to the current mirror. To execute this command, the following conditions must be met: @@ -30,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 e93d4b7140b39..d9553f4398017 100644 --- a/tiup/tiup-command-mirror-modify.md +++ b/tiup/tiup-command-mirror-modify.md @@ -4,8 +4,6 @@ title: tiup mirror modify # tiup mirror modify -[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) - The `tiup mirror modify` command is used to modify published components. Only valid component owners can modify the components that they have published on their own. For the method to publish a component, refer to the [`publish` command](/tiup/tiup-command-mirror-publish.md). ## Syntax @@ -62,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 cb4052cf4f508..50312cf430ea0 100644 --- a/tiup/tiup-command-mirror-publish.md +++ b/tiup/tiup-command-mirror-publish.md @@ -4,8 +4,6 @@ title: tiup mirror publish # tiup mirror publish -[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) - The command `tiup mirror publish` is used to publish a new component or a new version of an existing component. Only component owner that has the access to the target component can publish it. To add a new component owner, see the usage of the [`grant` command](/tiup/tiup-command-mirror-grant.md). ## Syntax @@ -83,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 f81bd543bf508..962841a0c01cf 100644 --- a/tiup/tiup-command-mirror-rotate.md +++ b/tiup/tiup-command-mirror-rotate.md @@ -4,8 +4,6 @@ title: tiup mirror rotate # tiup mirror rotate -[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) - `root.json` is an important file in a TiUP mirror. It stores the public keys needed for the entire system and is the basis of the chain of trust in TiUP. It mainly contains the following parts: - Signatures of mirror administrators. For the official mirror, there are five signatures. For an initialized mirror, there are three signatures by default. @@ -60,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 441d426148cdb..2a8a9ba9a79fb 100644 --- a/tiup/tiup-command-mirror-set.md +++ b/tiup/tiup-command-mirror-set.md @@ -4,8 +4,6 @@ title: tiup mirror set # tiup mirror set -[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) - The `tiup mirror set` command is used to switch the current mirror and supports two forms of mirrors: local file system and remote network address. The address of the official mirror is `https://tiup-mirrors.pingcap.com`. @@ -47,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 f2c9a2c4935bf..7c5f45657fbb5 100644 --- a/tiup/tiup-command-mirror-sign.md +++ b/tiup/tiup-command-mirror-sign.md @@ -4,8 +4,6 @@ title: tiup mirror sign # tiup mirror sign -[<< Back to the previous page - TiUP Mirror command list](/tiup/tiup-command-mirror.md#command-list) - The `tiup mirror sign` command is used to sign the metadata files (*.json）defined in TiUP [mirror](/tiup/tiup-mirror-reference.md). These metadata files might be stored on the local file system or remotely stored using the HTTP protocol to provide a signature entry. ## Syntax @@ -47,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 82b443e079b31..a534d5bd1dbb3 100644 --- a/tiup/tiup-command-mirror.md +++ b/tiup/tiup-command-mirror.md @@ -4,8 +4,6 @@ title: tiup mirror # tiup mirror -[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) - In TiUP, [mirror](/tiup/tiup-mirror-reference.md) is an important concept. TiUP currently supports two forms of mirroring: - Local mirror: the TiUP client and the mirror are on the same machine, and the client accesses the mirror through the file system. @@ -37,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 33e239fc99d8f..a43febf01a6cb 100644 --- a/tiup/tiup-command-status.md +++ b/tiup/tiup-command-status.md @@ -4,8 +4,6 @@ title: tiup status # tiup status -[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) - The `tiup status` command is used to view the operation information of the components after you run the components using the `tiup [flags] [args...]` command. > **Note:** @@ -37,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 d97ef35ce25d9..f8412ad0bac1c 100644 --- a/tiup/tiup-command-telemetry.md +++ b/tiup/tiup-command-telemetry.md @@ -4,8 +4,6 @@ title: tiup telemetry # tiup telemetry -[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) - TiDB, TiUP, and TiDB Dashboard collect usage information by default and share the information with PingCAP to improve the product. For example, through this usage information, PingCAP learns about common TiDB cluster operations and thereby determines the priority of new features. When TiUP telemetry is enabled, usage information is shared with PingCAP when TiUP commands are executed, including (but not limited to): @@ -54,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 9dda4509cc7a6..ad71761195d75 100644 --- a/tiup/tiup-command-uninstall.md +++ b/tiup/tiup-command-uninstall.md @@ -4,8 +4,6 @@ title: tiup uninstall # tiup uninstall -[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) - The `tiup uninstall` command is used to uninstall the installed components. ## Syntax @@ -36,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 38caca3b2fbf4..9cbc2a3bfab34 100644 --- a/tiup/tiup-command-update.md +++ b/tiup/tiup-command-update.md @@ -4,8 +4,6 @@ title: tiup update # tiup update -[<< Back to the previous page - TiUP Reference command list](/tiup/tiup-reference.md#command-list) - The `tiup update` command is used to update the installed components or TiUP itself. ## Syntax @@ -50,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 8c30ee0403b37..abefeb0fbc031 100644 --- a/tiup/tiup-component-cluster-audit.md +++ b/tiup/tiup-component-cluster-audit.md @@ -4,8 +4,6 @@ title: tiup cluster audit # tiup cluster audit -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - The `tiup cluster audit` command is used to view commands executed on all clusters in the history and the execution log of each command. ## Syntax @@ -32,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 ad98463eccc8c..8088ac88c5db2 100644 --- a/tiup/tiup-component-cluster-check.md +++ b/tiup/tiup-component-cluster-check.md @@ -4,8 +4,6 @@ title: tiup cluster check # tiup cluster check -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - For a formal production environment, before the environment goes live, you need to perform a series of checks to ensure the clusters are in their best performance. To simplify the manual check steps, TiUP Cluster provides the `check` command to check whether the hardware and software environments of the target machines of a specified cluster meet the requirements to work normally. ## List of check items @@ -236,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 0fe94a7f67661..47eec3b1f3250 100644 --- a/tiup/tiup-component-cluster-clean.md +++ b/tiup/tiup-component-cluster-clean.md @@ -4,8 +4,6 @@ title: tiup cluster clean # tiup cluster clean -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - In the test environment, sometimes you might need to reset the cluster back to the state as it has been just deployed, which means deleting all data. You can do that easily using the `tiup cluster clean` command. After running it, the cluster is stopped and then cluster data is deleted. After restarting the cluster manually, you will get a clean cluster. > **Warning:** @@ -64,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 ffd2e637c4ec8..58b98d42ac150 100644 --- a/tiup/tiup-component-cluster-deploy.md +++ b/tiup/tiup-component-cluster-deploy.md @@ -4,8 +4,6 @@ title: tiup cluster deploy # tiup cluster deploy -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - The `tiup cluster deploy` command is used to deploy a new cluster. ## Syntax @@ -67,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 6fedb8d7fc81b..cb69edf8d6417 100644 --- a/tiup/tiup-component-cluster-destroy.md +++ b/tiup/tiup-component-cluster-destroy.md @@ -4,8 +4,6 @@ title: tiup cluster destroy # tiup cluster destroy -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - After an application goes offline, if you want to release the machines occupied by the cluster for use by other applications, you need to clean up the data on the cluster and the deployed binary files. To destroy the cluster, the `tiup cluster destroy` command performs the following operations: - Stops the cluster. @@ -49,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 06e7c42225ced..765fe5423a7e1 100644 --- a/tiup/tiup-component-cluster-disable.md +++ b/tiup/tiup-component-cluster-disable.md @@ -4,8 +4,6 @@ title: tiup cluster disable # tiup cluster disable -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - After restarting the machine on which the cluster service is located, the cluster service will be automatically enabled. To disable the auto-enabling of cluster service, you can use the `tiup cluster disable` command. This command executes `systemctl disable ` on the specified node to disable the auto-enabling of the service. ## Syntax @@ -47,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 330beb316db31..d8e0c81f22046 100644 --- a/tiup/tiup-component-cluster-display.md +++ b/tiup/tiup-component-cluster-display.md @@ -4,8 +4,6 @@ title: tiup cluster display # tiup cluster display -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - If you want to see the operation status of each component in the cluster, it is obviously inefficient to log in to each machine one by one. Therefore, tiup-cluster provides the `tiup cluster display` command to efficiently complete this task. ## Syntax @@ -65,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 9bf45a6eea18d..ef7b6780396a8 100644 --- a/tiup/tiup-component-cluster-edit-config.md +++ b/tiup/tiup-component-cluster-edit-config.md @@ -4,8 +4,6 @@ title: tiup cluster edit-config # tiup cluster edit-config -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - If you need to modify the cluster configuration after the cluster is deployed, you can use the `tiup cluster edit-config` command that starts an editor for you to modify the [topology file](/tiup/tiup-cluster-topology-reference.md) of a cluster. This editor is specified in the `$EDITOR` environment variable by default. If the `$EDITOR` environment variable does not exist, the `vi` editor is used. > **Note:** @@ -33,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 0c8177536ba29..094a0c5ab46c9 100644 --- a/tiup/tiup-component-cluster-enable.md +++ b/tiup/tiup-component-cluster-enable.md @@ -4,8 +4,6 @@ title: tiup cluster enable # tiup cluster enable -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - The `tiup cluster enable` command is used to set the auto-enabling of the cluster service after a machine is restarted. This command enables the auto-enabling of the service by executing `systemctl enable ` at the specified node. > **Note:** @@ -51,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 cc9ee2879868d..8c0e1f1f0edaa 100644 --- a/tiup/tiup-component-cluster-help.md +++ b/tiup/tiup-component-cluster-help.md @@ -4,8 +4,6 @@ title: tiup cluster help # tiup cluster help -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - tiup-cluster provides a wealth of help information for users in the command line interface. You can obtain it via the `help` command or the `--help` option. `tiup cluster help ` is basically equivalent to `tiup cluster --help`. ## Syntax @@ -24,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 415e324f8770f..d9cf8054aacf1 100644 --- a/tiup/tiup-component-cluster-import.md +++ b/tiup/tiup-component-cluster-import.md @@ -4,8 +4,6 @@ title: tiup cluster import # tiup cluster import -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - Before TiDB v4.0, TiDB clusters were mainly deployed using TiDB Ansible. For TiDB v4.0 and later releases, TiUP Cluster provides the `import` command to transfer the clusters to the tiup-cluster component for management. > **Note:** @@ -67,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 0131be064dee1..8e694bb08802a 100644 --- a/tiup/tiup-component-cluster-list.md +++ b/tiup/tiup-component-cluster-list.md @@ -4,8 +4,6 @@ title: tiup cluster list # tiup cluster list -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - tiup-cluster supports deploying multiple clusters using the same control machine. The `tiup cluster list` command outputs all clusters deployed by the currently logged-in user using this control machine. > **Note:** @@ -35,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 27e1a346a4894..87d3b31c1d9b6 100644 --- a/tiup/tiup-component-cluster-patch.md +++ b/tiup/tiup-component-cluster-patch.md @@ -4,8 +4,6 @@ title: tiup cluster patch # tiup cluster patch -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - If you need to dynamically replace the binaries of a service while the cluster is running (namely, keep the cluster available during the replacement process), you can use the `tiup cluster patch` command. After the command is executed, TiUP does the following things: - Uploads the binary package for replacement to the target machine. @@ -89,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 fba6a224d4c20..1940338781815 100644 --- a/tiup/tiup-component-cluster-prune.md +++ b/tiup/tiup-component-cluster-prune.md @@ -4,8 +4,6 @@ title: tiup cluster prune # tiup cluster prune -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - When [scaling in the cluster](/tiup/tiup-component-cluster-scale-in.md), for some components, TiUP does not immediately stop their services or delete their data. You need to wait for the data scheduling to complete and then manually execute the `tiup cluster prune` command to clean up. ## Syntax @@ -25,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 f156dbb23f0fe..9372e9ff36b25 100644 --- a/tiup/tiup-component-cluster-reload.md +++ b/tiup/tiup-component-cluster-reload.md @@ -4,8 +4,6 @@ title: tiup cluster reload # tiup cluster reload -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - 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 @@ -83,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 d3a5fb8ba223a..79e7e3a4c0f33 100644 --- a/tiup/tiup-component-cluster-rename.md +++ b/tiup/tiup-component-cluster-rename.md @@ -4,8 +4,6 @@ title: tiup cluster rename # tiup cluster rename -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - The cluster name is specified when [the cluster is deployed](/tiup/tiup-component-cluster-deploy.md). If you want to change the cluster name after the cluster is deployed, you can use the command `tiup cluster rename`. > **Note:** @@ -35,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 340807493fbda..cfa134c6794e3 100644 --- a/tiup/tiup-component-cluster-replay.md +++ b/tiup/tiup-component-cluster-replay.md @@ -4,8 +4,6 @@ title: tiup cluster replay # tiup cluster replay -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - When you perform a cluster operation such as upgrade or restart, the operation might fail due to cluster environment issues. If you re-perform the operation, you need to perform all the steps from the very beginning. If the cluster is large, re-performing these steps will take a long time. In this case, you can use the `tiup cluster replay` command to retry the failed commands and skip the successfully performed steps. ## Syntax @@ -25,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 e857183fe4454..5bd9a994d3202 100644 --- a/tiup/tiup-component-cluster-restart.md +++ b/tiup/tiup-component-cluster-restart.md @@ -4,8 +4,6 @@ title: tiup cluster restart # tiup cluster restart -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - The command `tiup cluster restart` is used to restart all or some of the services of the specified cluster. > **Note:** @@ -51,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 b246a6c07404f..d60ca82053293 100644 --- a/tiup/tiup-component-cluster-scale-in.md +++ b/tiup/tiup-component-cluster-scale-in.md @@ -4,8 +4,6 @@ title: tiup cluster scale-in # tiup cluster scale-in -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - The `tiup cluster scale-in` command is used to scale in the cluster, which takes the services of the specified nodes offline, removes the specified nodes from the cluster, and deletes the remaining files from those nodes. Because the TiKV, TiFlash, and TiDB Binlog components are taken offline asynchronously (which requires TiUP to remove the node through API first) and the stopping process takes a long time (which requires TiUP to continuously check whether the node is successfully taken offline), the TiKV, TiFlash, and TiDB Binlog components are handled particularly as follows: @@ -70,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 5689a8a6dd562..fba6627d53551 100644 --- a/tiup/tiup-component-cluster-scale-out.md +++ b/tiup/tiup-component-cluster-scale-out.md @@ -4,8 +4,6 @@ title: tiup cluster scale-out # tiup cluster scale-out -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - 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. @@ -63,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 f5252dd32a891..6ee0a10279f65 100644 --- a/tiup/tiup-component-cluster-start.md +++ b/tiup/tiup-component-cluster-start.md @@ -4,8 +4,6 @@ title: tiup cluster start # tiup cluster start -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - The `tiup cluster start` command is used to start all services or some services of the specified cluster. ## Syntax @@ -47,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 a7da6d8664eac..f8192e8ef02a7 100644 --- a/tiup/tiup-component-cluster-stop.md +++ b/tiup/tiup-component-cluster-stop.md @@ -4,12 +4,10 @@ title: tiup cluster stop # tiup cluster stop -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - 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 @@ -29,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 @@ -39,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 @@ -51,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 6dd21372c9def..628002ccaee56 100644 --- a/tiup/tiup-component-cluster-template.md +++ b/tiup/tiup-component-cluster-template.md @@ -4,8 +4,6 @@ title: tiup cluster template # tiup cluster template -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - Before deploying the cluster, you need to prepare a [topology file](/tiup/tiup-cluster-topology-reference.md) of the cluster. TiUP has a built-in topology file template, and you can modify this template to create the final topology file. To output the built-in template content, you can use the `tiup cluster template` command. ## Syntax @@ -42,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 50aedba5fdb23..02df5f7ea6fb7 100644 --- a/tiup/tiup-component-cluster-upgrade.md +++ b/tiup/tiup-component-cluster-upgrade.md @@ -4,8 +4,6 @@ title: tiup cluster upgrade # tiup cluster upgrade -[<< Back to the previous page - TiUP Cluster command list](/tiup/tiup-component-cluster.md#command-list) - The `tiup cluster upgrade` command is used to upgrade the specified cluster to a specific version. ## Syntax @@ -60,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 f736cfda365c2..a1ace2810dee0 100644 --- a/tiup/tiup-component-cluster.md +++ b/tiup/tiup-component-cluster.md @@ -4,8 +4,6 @@ title: TiUP Cluster # TiUP Cluster -[<< Back to the previous page - TiUP Reference component list](/tiup/tiup-reference.md#component-list) - TiUP Cluster is a cluster management component of TiUP written in Golang. You can use the TiUP Cluster component to perform daily operations and maintenance, including deploying, starting, shutting down, destroying, elastic scaling, upgrading TiDB clusters, and managing TiDB cluster parameters. ## Syntax @@ -84,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 63d35df647243..f30f7d957b478 100644 --- a/tiup/tiup-component-dm-audit.md +++ b/tiup/tiup-component-dm-audit.md @@ -4,8 +4,6 @@ title: tiup dm audit # tiup dm audit -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - The `tiup dm audit` command is used to view historical commands executed on all clusters and the execution log of each command. ## Syntax @@ -31,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 f1bb482c2019a..3ef4b0f3b5ca1 100644 --- a/tiup/tiup-component-dm-deploy.md +++ b/tiup/tiup-component-dm-deploy.md @@ -4,8 +4,6 @@ title: tiup dm deploy # tiup dm deploy -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - The `tiup dm deploy` command is used to deploy a new cluster. ## Syntax @@ -47,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 7c75a7deba46d..0c7f04d4097aa 100644 --- a/tiup/tiup-component-dm-destroy.md +++ b/tiup/tiup-component-dm-destroy.md @@ -4,8 +4,6 @@ title: tiup dm destroy # tiup dm destroy -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - After an application goes offline, if you want to release the machines occupied by the cluster for use by other applications, you need to clean up the data on the cluster and the deployed binary files. To destroy the cluster, the `tiup dm destroy` command performs the following operations: - Stops the cluster. @@ -31,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 72199f85f93f2..fca46d3ae5c42 100644 --- a/tiup/tiup-component-dm-disable.md +++ b/tiup/tiup-component-dm-disable.md @@ -4,8 +4,6 @@ title: tiup dm disable # tiup dm disable -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - After restarting the machine on which the cluster service is located, the cluster service will be automatically enabled. To disable the auto-enabling of cluster service, you can use the `tiup dm disable` command. This command executes `systemctl disable ` on the specified node to disable the auto-enabling of the service. ## Syntax @@ -45,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 f33f97d163ae4..4d20cfef25b53 100644 --- a/tiup/tiup-component-dm-display.md +++ b/tiup/tiup-component-dm-display.md @@ -4,8 +4,6 @@ title: tiup dm display # tiup dm display -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - If you want to check the operational status of each component in a DM cluster, it is inefficient to log in to each machine one by one. Therefore, tiup-dm provides the `tiup dm display` command to do this job efficiently. ## Syntax @@ -58,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 4921ddc64c30a..b2cd02bc55f46 100644 --- a/tiup/tiup-component-dm-edit-config.md +++ b/tiup/tiup-component-dm-edit-config.md @@ -4,8 +4,6 @@ title: tiup dm edit-config # tiup dm edit-config -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - If you need to modify the cluster service configuration after the cluster is deployed, you can use the `tiup dm edit-config` command that starts an editor for you to modify the [topology file](/tiup/tiup-dm-topology-reference.md). of the specified cluster. This editor is specified in the `$EDITOR` environment variable by default. If the `$EDITOR` environment variable does not exist, the `vi` editor is used. > **Note:** @@ -33,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 33576644a433f..f16000128a843 100644 --- a/tiup/tiup-component-dm-enable.md +++ b/tiup/tiup-component-dm-enable.md @@ -4,8 +4,6 @@ title: tiup dm enable # tiup dm enable -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - The `tiup dm enable` command is used to set the auto-enabling of the cluster service after a machine is restarted. This command enables the auto-enabling of the service by executing `systemctl enable ` at the specified node. ## Syntax @@ -45,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 6887cf670d139..035530c224aae 100644 --- a/tiup/tiup-component-dm-help.md +++ b/tiup/tiup-component-dm-help.md @@ -4,8 +4,6 @@ title: tiup dm help # tiup dm help -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - tiup-dm command-line interface provides users with a wealth of help information. You can view it via the `help` command or the `--help` option. Basically, `tiup dm help ` is equivalent to `tiup dm --help`. ## Syntax @@ -24,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 a4791be0ca02e..b84c1de36a198 100644 --- a/tiup/tiup-component-dm-import.md +++ b/tiup/tiup-component-dm-import.md @@ -4,8 +4,6 @@ title: tiup dm import # tiup dm import -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - In DM v1.0, the cluster is basically deployed using TiDB Ansible. TiUP DM provides the `import` command to import v1.0 clusters and redeploy the clusters in DM v2.0. > **Note:** @@ -60,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 5849bd73196bb..c7719d5999b5a 100644 --- a/tiup/tiup-component-dm-list.md +++ b/tiup/tiup-component-dm-list.md @@ -4,8 +4,6 @@ title: tiup dm list # tiup dm list -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - `tiup-dm` supports deploying multiple clusters using the same control machine. You can use the `tiup dm list` command to check which clusters are deployed using the control machine by the currently logged-in user. > **Note:** @@ -35,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 d229a85dcfb38..03acd41f5a359 100644 --- a/tiup/tiup-component-dm-patch.md +++ b/tiup/tiup-component-dm-patch.md @@ -4,8 +4,6 @@ title: tiup dm patch # tiup dm patch -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - If you need to dynamically replace the binaries of a service while the cluster is running (that is, to keep the cluster available during the replacement), you can use the `tiup dm patch` command. The command does the following: - Uploads the binary package for replacement to the target machine. @@ -77,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 814c45ddd3a68..66fef792543d7 100644 --- a/tiup/tiup-component-dm-prune.md +++ b/tiup/tiup-component-dm-prune.md @@ -4,8 +4,6 @@ title: tiup dm prune # tiup dm prune -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - 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 @@ -25,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 fc6aaab81ea89..7fda1d8186925 100644 --- a/tiup/tiup-component-dm-reload.md +++ b/tiup/tiup-component-dm-reload.md @@ -4,8 +4,6 @@ title: tiup dm reload # tiup dm reload -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - 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 @@ -61,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 bb2a74d52936e..7a15f900f413f 100644 --- a/tiup/tiup-component-dm-replay.md +++ b/tiup/tiup-component-dm-replay.md @@ -4,8 +4,6 @@ title: tiup dm replay # tiup dm replay -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - When you perform a cluster operation such as upgrade or restart, the operation might fail due to cluster environment issues. If you re-perform the operation, you need to perform all the steps from the very beginning. If the cluster is large, re-performing these steps will take a long time. In this case, you can use the `tiup dm replay` command to retry the failed commands and skip the successfully performed steps. ## Syntax @@ -25,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 720c685cf5dd5..6910fae1455ae 100644 --- a/tiup/tiup-component-dm-restart.md +++ b/tiup/tiup-component-dm-restart.md @@ -4,8 +4,6 @@ title: tiup dm restart # tiup dm restart -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - The command `tiup dm restart` is used to restart all or some of the services of the specified cluster. > **Note:** @@ -51,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 7737565eb74fa..af3b3c1a022f0 100644 --- a/tiup/tiup-component-dm-scale-in.md +++ b/tiup/tiup-component-dm-scale-in.md @@ -4,8 +4,6 @@ title: tiup dm scale-in # tiup dm scale-in -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - The `tiup dm scale-in` command is used to scale in the cluster. Scaling in the cluster means taking the service offline, which eventually removes the specified node from the cluster and deletes the remaining related files. ## Syntax @@ -38,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 de2c825c5354c..da77f96e94812 100644 --- a/tiup/tiup-component-dm-scale-out.md +++ b/tiup/tiup-component-dm-scale-out.md @@ -4,8 +4,6 @@ title: tiup dm scale-out # tiup dm scale-out -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - The `tiup dm 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-dm` components first establish an SSH connection to the new node, create the necessary directories on the target node, then perform the deployment and start the service. ## Syntax @@ -47,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 22a56835a6f10..4a5c9ff1acf2b 100644 --- a/tiup/tiup-component-dm-start.md +++ b/tiup/tiup-component-dm-start.md @@ -4,8 +4,6 @@ title: tiup dm start # tiup dm start -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - The `tiup dm start` command is used to start all or part of the services of the specified cluster. ## Syntax @@ -47,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 98f43b14dfe69..72cd009d4e733 100644 --- a/tiup/tiup-component-dm-stop.md +++ b/tiup/tiup-component-dm-stop.md @@ -4,8 +4,6 @@ title: tiup dm stop # tiup dm stop -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - The `tiup dm stop` command is used to stop all or part of the services of the specified cluster. > **Note:** @@ -51,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 5ba3ac3788caf..eedd9c492fd91 100644 --- a/tiup/tiup-component-dm-template.md +++ b/tiup/tiup-component-dm-template.md @@ -4,8 +4,6 @@ title: tiup dm template # tiup dm template -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - Before deploying the cluster, you need to prepare a [topology file](/tiup/tiup-dm-topology-reference.md) of the cluster. TiUP has a built-in topology file template, and you can modify this template to create the final topology file. To output the built-in template content, you can use the `tiup dm template` command. ## Syntax @@ -36,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 91a0fefa073c8..87b8b12be5955 100644 --- a/tiup/tiup-component-dm-upgrade.md +++ b/tiup/tiup-component-dm-upgrade.md @@ -4,8 +4,6 @@ title: tiup dm upgrade # tiup dm upgrade -[<< Back to the previous page - TiUP DM command list](/tiup/tiup-component-dm.md#command-list) - The `tiup dm upgrade` command is used to upgrade a specified cluster to a specific version. ## Syntax @@ -32,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 2315f077aad0c..f162b08c76df3 100644 --- a/tiup/tiup-component-dm.md +++ b/tiup/tiup-component-dm.md @@ -4,8 +4,6 @@ title: TiUP DM # TiUP DM -[<< Back to the previous page - TiUP Reference component list](/tiup/tiup-reference.md#component-list) - Similar to [TiUP Cluster](/tiup/tiup-component-cluster.md) which is used to manage TiDB clusters, TiUP DM is used to manage DM clusters. You can use the TiUP DM component to perform daily operations and maintenance tasks of DM clusters, including deploying, starting, stopping, destroying, elastic scaling, upgrading DM clusters, and managing the configuration parameters of DM clusters. ## Syntax @@ -83,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.