From 0612398453ee9f34a7038ea3c88f435e4b3acf9c Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 16 Apr 2021 19:42:21 +0800 Subject: [PATCH] tiup: uncomment links --- tiup/tiup-command-mirror-rotate.md | 4 ++-- tiup/tiup-command-mirror.md | 4 ++-- tiup/tiup-component-cluster-check.md | 2 +- tiup/tiup-component-cluster-deploy.md | 2 +- tiup/tiup-component-cluster-edit-config.md | 6 +++--- tiup/tiup-component-cluster-patch.md | 4 ++-- tiup/tiup-component-cluster-prune.md | 2 +- tiup/tiup-component-cluster-scale-out.md | 4 ++-- tiup/tiup-component-cluster.md | 14 +++++--------- tiup/tiup-component-dm-deploy.md | 2 +- tiup/tiup-component-dm-edit-config.md | 4 ++-- tiup/tiup-component-dm-reload.md | 6 +++--- tiup/tiup-component-dm-scale-in.md | 2 +- tiup/tiup-component-dm-scale-out.md | 4 ++-- tiup/tiup-component-dm-start.md | 6 +++--- tiup/tiup-component-dm-stop.md | 6 +++--- 16 files changed, 34 insertions(+), 38 deletions(-) diff --git a/tiup/tiup-command-mirror-rotate.md b/tiup/tiup-command-mirror-rotate.md index 212516e86d03d..4441cf7600d68 100644 --- a/tiup/tiup-command-mirror-rotate.md +++ b/tiup/tiup-command-mirror-rotate.md @@ -45,13 +45,13 @@ tiup mirror rotate [flags] After executing this command, TiUP starts an editor for the user to modify the file content to the target value, such as changing the value of the `expires` field to a later date. Then, TiUP changes the `version` field from `N` to `N+1` and saves the file. After the file is saved, TiUP starts a temporary HTTP server and waits for all mirror administrators to sign the file. -For how mirror administrators sign files, refer to the `sign` command. +For how mirror administrators sign files, refer to the [`sign` command](/tiup/tiup-command-mirror-sign.md). ## Options ### --addr -- Specifies the listening address of the temporary server. You need to make sure that the address is accessible to other mirror administrators so that they can use the `sign` command to sign the file. +- Specifies the listening address of the temporary server. You need to make sure that the address is accessible to other mirror administrators so that they can use the [`sign` command](/tiup/tiup-command-mirror-sign.md) to sign the file. - Data type: `STRING` - If this option is not specified in the command, TiUP listens on `0.0.0.0:8080` by default. diff --git a/tiup/tiup-command-mirror.md b/tiup/tiup-command-mirror.md index 61394d6e6b4c1..22277aafe1ab3 100644 --- a/tiup/tiup-command-mirror.md +++ b/tiup/tiup-command-mirror.md @@ -27,11 +27,11 @@ None - [genkey](/tiup/tiup-command-mirror-genkey.md): generates the private key file - [sign](/tiup/tiup-command-mirror-sign.md): signs a specific file using a private key file -- init: initiates an empty mirror +- [init](/tiup/tiup-command-mirror-init.md): initiates an empty mirror - [set](/tiup/tiup-command-mirror-set.md): sets the current mirror - [grant](/tiup/tiup-command-mirror-grant.md): grants a new component owner for the current mirror - [publish](/tiup/tiup-command-mirror-publish.md): publishes new components to the current mirror - [modify](/tiup/tiup-command-mirror-modify.md): modifies the attributes of the components in the current mirror -- rotate: updates the root certificate in the current mirror +- [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 diff --git a/tiup/tiup-component-cluster-check.md b/tiup/tiup-component-cluster-check.md index cd3a78f88fb81..99b4dfd53bf1f 100644 --- a/tiup/tiup-component-cluster-check.md +++ b/tiup/tiup-component-cluster-check.md @@ -117,7 +117,7 @@ Use flexible I/O tester (fio) to test the performance of the disk where `data_di tiup cluster check [flags] ``` -- If a cluster is not deployed yet, you need to pass the topology.yml file that is used to deploy the cluster. According to the content in this file, tiup-cluster connects to the corresponding machine to perform the check. +- If a cluster is not deployed yet, you need to pass the [topology.yml](/tiup/tiup-cluster-topology-reference.md) file that is used to deploy the cluster. According to the content in this file, tiup-cluster connects to the corresponding machine to perform the check. - If a cluster is already deployed, you can use the `` as the check object. > **Note:** diff --git a/tiup/tiup-component-cluster-deploy.md b/tiup/tiup-component-cluster-deploy.md index 9da927733bfc2..5d71e44304e15 100644 --- a/tiup/tiup-component-cluster-deploy.md +++ b/tiup/tiup-component-cluster-deploy.md @@ -14,7 +14,7 @@ tiup cluster deploy [flags] - ``: the name of the new cluster, which cannot be the same as the existing cluster names. - ``: the version number of the TiDB cluster to deploy, such as `v4.0.9`. -- ``: the prepared topology file. +- ``: the prepared [topology file](/tiup/tiup-cluster-topology-reference.md). ## Options diff --git a/tiup/tiup-component-cluster-edit-config.md b/tiup/tiup-component-cluster-edit-config.md index a2654c16b9a5c..b222327e8ee27 100644 --- a/tiup/tiup-component-cluster-edit-config.md +++ b/tiup/tiup-component-cluster-edit-config.md @@ -4,11 +4,11 @@ title: tiup cluster edit-config # tiup cluster edit-config -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 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. +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:** > -> + When you modify the configuration, you cannot add or delete machines. For how to add machines, see Scale out a cluster. For how to delete machines, see Scale in a cluster. +> + When you modify the configuration, you cannot add or delete machines. For how to add machines, see [Scale out a cluster](/tiup/tiup-component-cluster-scale-out.md). For how to delete machines, see [Scale in a cluster](/tiup/tiup-component-cluster-scale-in.md). > + After you execute the `tiup cluster edit-config` command, the configuration is modified only on the control machine. Then you need to execute the `tiup cluster reload` command to reload the configuration. ## Syntax @@ -30,4 +30,4 @@ tiup cluster edit-config [flags] ## Output - 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. +- 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). diff --git a/tiup/tiup-component-cluster-patch.md b/tiup/tiup-component-cluster-patch.md index 5b329c64fbe24..f282a9d9e2135 100644 --- a/tiup/tiup-component-cluster-patch.md +++ b/tiup/tiup-component-cluster-patch.md @@ -54,7 +54,7 @@ You need to pack the binary package required for this command in advance accordi ### -N, --node -- Specifies nodes to be replaced. The value of this option is a comma-separated list of node IDs. You can get the node ID from the first column of the cluster status table returned by the `tiup cluster display` command. +- Specifies nodes to be replaced. The value of this option is a comma-separated list of node IDs. You can get the node ID from the first column of the [cluster status table](/tiup/tiup-component-cluster-display.md) returned by the `tiup cluster display` command. - Data type: `STRINGS` - If this option is not specified, TiUP does not select any nodes to replace by default. @@ -64,7 +64,7 @@ You need to pack the binary package required for this command in advance accordi ### -R, --role -- Specifies the roles to be replaced. The value of this option is a comma-separated list of the roles of the nodes. You can get the role deployed on a node from the second column of the cluster status table returned by the `tiup cluster display` command. +- Specifies the roles to be replaced. The value of this option is a comma-separated list of the roles of the nodes. You can get the role deployed on a node from the second column of the [cluster status table](/tiup/tiup-component-cluster-display.md) returned by the `tiup cluster display` command. - Data type: `STRINGS` - If this option is not specified, TiUP does not select any roles to replace by default. diff --git a/tiup/tiup-component-cluster-prune.md b/tiup/tiup-component-cluster-prune.md index cebbb93cb3b2d..de2b81008becb 100644 --- a/tiup/tiup-component-cluster-prune.md +++ b/tiup/tiup-component-cluster-prune.md @@ -4,7 +4,7 @@ title: tiup cluster prune # tiup cluster prune -When [scaling in the cluster], 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. +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-scale-out.md b/tiup/tiup-component-cluster-scale-out.md index e297b75ad4395..478eaab8d4413 100644 --- a/tiup/tiup-component-cluster-scale-out.md +++ b/tiup/tiup-component-cluster-scale-out.md @@ -14,9 +14,9 @@ When PD is scaled out, new PD nodes are added to the cluster by the join operati tiup cluster scale-out [flags] ``` -``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the `cluster list`command. +``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [`cluster list`](/tiup/tiup-component-dm-list.md) command. -``: the prepared topology file. This topology file should only contain the new nodes that are to be added to the current cluster. +``: the prepared [topology file](/tiup/tiup-dm-topology-reference.md). This topology file should only contain the new nodes that are to be added to the current cluster. ## Options diff --git a/tiup/tiup-component-cluster.md b/tiup/tiup-component-cluster.md index bd46f9aa8eed6..0d91dcd2e13f6 100644 --- a/tiup/tiup-component-cluster.md +++ b/tiup/tiup-component-cluster.md @@ -59,26 +59,22 @@ tiup cluster [command] [flags] ## Command list -- import: imports a cluster deployed by Ansible - -- check: checks a cluster before and after the deployment - +- [import](/tiup/tiup-component-cluster-import.md): imports a cluster deployed by Ansible +- [check](/tiup/tiup-component-cluster-check.md): checks a cluster before and after the deployment - [deploy](/tiup/tiup-component-cluster-deploy.md): deploys a cluster based on a specified topology - [list](/tiup/tiup-component-cluster-list.md): queries the list of deployed clusters - [display](/tiup/tiup-component-cluster-display.md): displays the status of a specified cluster - [start](/tiup/tiup-component-cluster-start.md): starts a specified cluster - [stop](/tiup/tiup-component-cluster-stop.md): stops a specified cluster -- restart: restarts a specified cluster - -- scale-in: scales in a specified cluster - +- [restart](/tiup/tiup-component-cluster-restart.md): restarts a specified cluster +- [scale-in](/tiup/tiup-component-cluster-scale-in.md): scales in a specified cluster - [scale-out](/tiup/tiup-component-cluster-scale-out.md): scales out a specified cluster - [upgrade](/tiup/tiup-component-cluster-upgrade.md): upgrades a specified cluster - [prune](/tiup/tiup-component-cluster-prune.md): cleans up the instances in the Tombstone status for a specified cluster - [edit-config](/tiup/tiup-component-cluster-edit-config.md): modifies the configuration of a specified cluster - [reload](/tiup/tiup-component-cluster-reload.md): reloads the configuration of a specified cluster - [patch](/tiup/tiup-component-cluster-patch.md): replaces a service in a deployed cluster - +- [rename](/tiup/tiup-component-cluster-rename.md): renames a cluster - [clean](/tiup/tiup-component-cluster-clean.md): deletes data from the specified cluster - [destroy](/tiup/tiup-component-cluster-destroy.md): destroys a specified cluster - [audit](/tiup/tiup-component-cluster-audit.md): queries the operation audit log of a specified cluster diff --git a/tiup/tiup-component-dm-deploy.md b/tiup/tiup-component-dm-deploy.md index 0d21a7fdb4f6d..bd612752b90b3 100644 --- a/tiup/tiup-component-dm-deploy.md +++ b/tiup/tiup-component-dm-deploy.md @@ -14,7 +14,7 @@ tiup dm deploy [flags] - ``: the name of the new cluster, which cannot be the same as the existing cluster names. - ``: the version number of the DM cluster to be deployed, such as `v2.0.0`. -- ``: the prepared [topology file]. +- ``: the prepared [topology file](/tiup/tiup-dm-topology-reference.md). ## Options diff --git a/tiup/tiup-component-dm-edit-config.md b/tiup/tiup-component-dm-edit-config.md index a125478902a2e..7b2ba042b3d81 100644 --- a/tiup/tiup-component-dm-edit-config.md +++ b/tiup/tiup-component-dm-edit-config.md @@ -4,7 +4,7 @@ title: tiup dm edit-config # tiup dm edit-config -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]. 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. +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:** > @@ -30,4 +30,4 @@ tiup dm edit-config [flags] ## Output - 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]. +- 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). diff --git a/tiup/tiup-component-dm-reload.md b/tiup/tiup-component-dm-reload.md index f0a24d8520ee6..ede64aeecde90 100644 --- a/tiup/tiup-component-dm-reload.md +++ b/tiup/tiup-component-dm-reload.md @@ -4,7 +4,7 @@ title: tiup dm reload # tiup dm reload -After [modifying the cluster configuration], the cluster needs to be reloaded using the `tiup dm reload` command for the configuration to take effect. This command publishes the configuration of the control machine to the remote machine where the service is running and restarts the service in order according to the upgrade process. The cluster remains available during the restart process. +After [modifying the cluster configuration](/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 @@ -18,7 +18,7 @@ tiup dm reload [flags] ### -N, --node -- Specifies the nodes to be restarted. If not specified, all nodes are restarted. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status]table. +- Specifies the nodes to be restarted. If not specified, all nodes are restarted. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status](/tiup/tiup-component-dm-display.md) table. - Data type: `strings` - Default: `[]`, which means all nodes are selected. @@ -29,7 +29,7 @@ tiup dm reload [flags] ### -R, --role -- Specifies the roles to be restarted. If not specified, all roles are restarted. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status]table. +- Specifies the roles to be restarted. If not specified, all roles are restarted. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status](/tiup/tiup-component-dm-display.md) table. - Data type: `strings` - Default: `[]`, which means all roles are selected. diff --git a/tiup/tiup-component-dm-scale-in.md b/tiup/tiup-component-dm-scale-in.md index b52614b80fcb9..8a13b80d0b1a0 100644 --- a/tiup/tiup-component-dm-scale-in.md +++ b/tiup/tiup-component-dm-scale-in.md @@ -12,7 +12,7 @@ The `tiup dm scale-in` command is used to scale in the cluster. Scaling in the c tiup dm scale-in [flags] ``` -``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list] command. +``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list](/tiup/tiup-component-dm-list.md) command. ## Options diff --git a/tiup/tiup-component-dm-scale-out.md b/tiup/tiup-component-dm-scale-out.md index 64daca0e5d257..b103b6b18d54d 100644 --- a/tiup/tiup-component-dm-scale-out.md +++ b/tiup/tiup-component-dm-scale-out.md @@ -12,9 +12,9 @@ The `tiup dm scale-out` command is used for scaling out the cluster. The interna tiup dm scale-out [flags] ``` -``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list]. +``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list](/tiup/tiup-component-dm-list.md) command. -``: the prepared [topology file]. This topology file should only contain the new nodes that are to be added to the current cluster. +``: the prepared [topology file](/tiup/tiup-dm-topology-reference.md). This topology file should only contain the new nodes that are to be added to the current cluster. ## Options diff --git a/tiup/tiup-component-dm-start.md b/tiup/tiup-component-dm-start.md index 551f61777a66d..1b93e51491ad1 100644 --- a/tiup/tiup-component-dm-start.md +++ b/tiup/tiup-component-dm-start.md @@ -12,13 +12,13 @@ The `tiup dm start` command is used to start all or part of the services of the tiup dm start [flags] ``` -``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list] command. +``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list](/tiup/tiup-component-dm-list.md) command. ## Options ### -N, --node -- Specifies the nodes to be started. If not specified, all nodes are started. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status]table. +- Specifies the nodes to be started. If not specified, all nodes are started. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status](/tiup/tiup-component-dm-display.md) table. - Data type: `strings` - Default: `[]`. If this option is not specified in the command, all nodes are started. @@ -28,7 +28,7 @@ tiup dm start [flags] ### -R, --role -- Specifies the roles to be started. If not specified, all roles are started. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status] table. +- Specifies the roles to be started. If not specified, all roles are started. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status](/tiup/tiup-component-dm-display.md) table. - Data type: `strings` - Default: `[]`. If this option is not specified in the command, all roles are started. diff --git a/tiup/tiup-component-dm-stop.md b/tiup/tiup-component-dm-stop.md index c8a73a788301f..9bfb529d8de8f 100644 --- a/tiup/tiup-component-dm-stop.md +++ b/tiup/tiup-component-dm-stop.md @@ -16,13 +16,13 @@ The `tiup dm stop` command is used to stop all or part of the services of the sp tiup dm stop [flags] ``` -``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list]command. +``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list](/tiup/tiup-component-dm-list.md) command. ## Options ### -N, --node -- Specifies the nodes to be stopped. If not specified, all nodes are stopped. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status] table. +- Specifies the nodes to be stopped. If not specified, all nodes are stopped. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status](/tiup/tiup-component-dm-display.md) table. - Data type: `strings` - Default: `[]`, which means all nodes are selected. @@ -32,7 +32,7 @@ tiup dm stop [flags] ### -R, --role -- Specifies the roles to be stopped. If not specified, all roles are stopped. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status] table. +- Specifies the roles to be stopped. If not specified, all roles are stopped. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status](/tiup/tiup-component-dm-display.md) table. - Data type: `strings` - Default: `[]`, which means all roles are selected.