diff --git a/tiup/tiup-cluster-topology-reference.md b/tiup/tiup-cluster-topology-reference.md index 47c4a88e2af06..982df3707f484 100644 --- a/tiup/tiup-cluster-topology-reference.md +++ b/tiup/tiup-cluster-topology-reference.md @@ -641,7 +641,7 @@ scheduling_servers: - `host`: Specifies the machine to which the monitoring services are deployed. The field value is an IP address and is mandatory. -- `ng_port`: Specifies the port that NgMonitoring listens to. Introduced in TiUP v1.7.0, this field supports [Continuous Profiling](/dashboard/dashboard-profiling.md) and [Top SQL](/dashboard/top-sql.md). The default value is `12020`. +- `ng_port`: Specifies the port that NgMonitoring listens to. Introduced in TiUP v1.7.0, this field supports [Continuous Profiling](/dashboard/continuous-profiling.md) and [Top SQL](/dashboard/top-sql.md). The default value is `12020`. - `ssh_port`: Specifies the SSH port to connect to the target machine for operations. If it is not specified, the `ssh_port` of the `global` section is used. diff --git a/tiup/tiup-command-mirror-modify.md b/tiup/tiup-command-mirror-modify.md index 1b3a03a4a22ec..21102f61e28db 100644 --- a/tiup/tiup-command-mirror-modify.md +++ b/tiup/tiup-command-mirror-modify.md @@ -1,6 +1,6 @@ --- title: tiup mirror modify -summary: The tiup mirror modify command is used to modify published components. Only valid component owners can modify their published components. The syntax is "tiup mirror modify [version] [flags]". Options include -k, --yank, --hide, and --standalone. If the command is executed successfully, there is no output. If the component owner is not authorized to modify the target component, TiUP reports an error. +summary: The tiup mirror modify command is used to modify published components. Only valid component owners can modify their published components. The syntax is "tiup mirror modify [:version] [flags]". Options include -k, --yank, --hide, and --standalone. If the command is executed successfully, there is no output. If the component owner is not authorized to modify the target component, TiUP reports an error. --- # tiup mirror modify diff --git a/tiup/tiup-command-mirror-publish.md b/tiup/tiup-command-mirror-publish.md index 6012c12f138eb..9d6e8323fbf62 100644 --- a/tiup/tiup-command-mirror-publish.md +++ b/tiup/tiup-command-mirror-publish.md @@ -66,7 +66,7 @@ The meaning of each parameter is as follows: ### --hide -- Specifies whether the component is hidden. If it is a hidden component, it can be seen in the result list of `tiup list -all`, but not in that of `tiup list`. +- Specifies whether the component is hidden. If it is a hidden component, it can be seen in the result list of `tiup list --all`, but not in that of `tiup list`. - Data type: `STRING` - Default: NULL diff --git a/tiup/tiup-component-cluster-audit-cleanup.md b/tiup/tiup-component-cluster-audit-cleanup.md index c07be416d5b78..d21c9257ffbf2 100644 --- a/tiup/tiup-component-cluster-audit-cleanup.md +++ b/tiup/tiup-component-cluster-audit-cleanup.md @@ -5,7 +5,7 @@ summary: The `tiup cluster audit cleanup` command is used to clean up logs gener # tiup cluster audit cleanup -The `tiup cluster audit cleanup` command is used to clean up the logs generated in executing the `tiup cluster`command. +The `tiup cluster audit cleanup` command is used to clean up the logs generated in executing the `tiup cluster` command. ## Syntax diff --git a/tiup/tiup-component-cluster-check.md b/tiup/tiup-component-cluster-check.md index 5742ccd8bbc13..c993ffd4c4275 100644 --- a/tiup/tiup-component-cluster-check.md +++ b/tiup/tiup-component-cluster-check.md @@ -108,7 +108,7 @@ Check the CPU information of the target machine. For a production cluster, it is > **Note:** > -> CPU core count is not checked by default. To enable the check, you need to add the `-enable-cpu` option to the command. +> CPU core count is not checked by default. To enable the check, you need to add the `--enable-cpu` option to the command. ### Memory size @@ -116,7 +116,7 @@ Check the memory size of the target machine. For a production cluster, it is rec > **Note:** > -> Memory size is not checked by default. To enable the check, you need to add the `-enable-mem` option to the command. +> Memory size is not checked by default. To enable the check, you need to add the `--enable-mem` option to the command. ### Fio disk performance test @@ -128,7 +128,7 @@ Use flexible I/O tester (fio) to test the performance of the disk where `data_di > **Note:** > -> The fio disk performance test is not performed by default. To perform the test, you need to add the `-enable-disk` option to the command. +> The fio disk performance test is not performed by default. To perform the test, you need to add the `--enable-disk` option to the command. ## Syntax @@ -162,9 +162,9 @@ tiup cluster check [flags] > > `tiup cluster check` also supports repairing the `scale-out.yml` file for an existing cluster with the following command format: > ->```shell +> ```shell > tiup cluster check scale-out.yml --cluster --apply --user root [-p] [-i /home/root/.ssh/gcp_rsa] ->``` +> ``` ### --cluster @@ -232,7 +232,7 @@ tiup cluster check [flags] > **Note:** > -> This option is valid only if the `-cluster` option is false. Otherwise, the value of this option is fixed to the username specified in the topology file for the cluster deployment. +> This option is valid only if the `--cluster` option is false. Otherwise, the value of this option is fixed to the username specified in the topology file for the cluster deployment. ### -i, --identity_file diff --git a/tiup/tiup-component-cluster-clean.md b/tiup/tiup-component-cluster-clean.md index 8b7270286a946..c57bcb83d6819 100644 --- a/tiup/tiup-component-cluster-clean.md +++ b/tiup/tiup-component-cluster-clean.md @@ -26,7 +26,7 @@ tiup cluster clean [flags] - Cleans data and the log at the same time. It is equivalent to specifying `--data` and `--log` at the same time. - Data type: `BOOLEAN` - This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. -- If it is not specified, you must specify at lease one of the following options: +- If it is not specified, you must specify at least one of the following options: - --data: Cleans data - --log: Cleans the log diff --git a/tiup/tiup-component-cluster-display.md b/tiup/tiup-component-cluster-display.md index 960124e9ce533..272117d5f0d2b 100644 --- a/tiup/tiup-component-cluster-display.md +++ b/tiup/tiup-component-cluster-display.md @@ -27,11 +27,11 @@ tiup cluster display [flags] - Specifies the node to display. If this option is not specified, all nodes are displayed. The value of this option is a comma-separated list of node IDs. If you are not sure about the ID of a node, you can skip this option in the command to show the IDs and status of all nodes in the output. - Data type: `STRINGS` -- If this option is not specified in the command, all nodes are checked by default. +- If this option is not specified in the command, all nodes are displayed 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 checked. +> 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 displayed. ### -R, --role diff --git a/tiup/tiup-component-cluster-import.md b/tiup/tiup-component-cluster-import.md index d4a29661c6e7d..23e597c303c26 100644 --- a/tiup/tiup-component-cluster-import.md +++ b/tiup/tiup-component-cluster-import.md @@ -38,7 +38,7 @@ tiup cluster import [flags] - Specifies the path of the Ansible configuration file. - Data type: `STRING` -- The option is enabled by default with `. /ansible.cfg` (the default value) passed in. +- The option is enabled by default with `./ansible.cfg` (the default value) passed in. ### --inventory @@ -50,7 +50,7 @@ tiup cluster import [flags] - Controls whether to disable the backup of files in the directory where TiDB Ansible is located. - Data type: `BOOLEAN` -- This option is disabled by default with the `false` value. After a successful import, everything in the directory specified by the `-dir` option is backed up to the `${TIUP_HOME}/.tiup/storage/cluster/clusters/{cluster-name}/ansible-backup` directory. If there are multiple inventory files (when multiple clusters are deployed) in this directory, it is recommended to enable this option. To enable this option, add this option to the command, and either pass the `true` value or do not pass any value. +- This option is disabled by default with the `false` value. After a successful import, everything in the directory specified by the `--dir` option is backed up to the `${TIUP_HOME}/.tiup/storage/cluster/clusters/{cluster-name}/ansible-backup` directory. If there are multiple inventory files (when multiple clusters are deployed) in this directory, it is recommended to enable this option. To enable this option, add this option to the command, and either pass the `true` value or do not pass any value. ### --rename diff --git a/tiup/tiup-component-cluster-meta-backup.md b/tiup/tiup-component-cluster-meta-backup.md index 1e8ff6bd61b4c..11a875dfd397c 100644 --- a/tiup/tiup-component-cluster-meta-backup.md +++ b/tiup/tiup-component-cluster-meta-backup.md @@ -1,6 +1,6 @@ --- title: tiup cluster meta backup -summary: The TiUP meta file is crucial for cluster operation and maintenance. Use `tiup cluster meta backup` to regularly back up the file. Use `tiup dm list` to check the cluster name. Specify the target directory with `--file` option. Use `-h, --help` for help information. The output includes execution logs of tiup-cluster. +summary: The TiUP meta file is crucial for cluster operation and maintenance. Use `tiup cluster meta backup` to regularly back up the file. Use `tiup cluster list` to check the cluster name. Specify the target directory with `--file` option. Use `-h, --help` for help information. The output includes execution logs of tiup-cluster. --- # tiup cluster meta backup diff --git a/tiup/tiup-component-cluster-reload.md b/tiup/tiup-component-cluster-reload.md index b349235fa185b..6915cebdcf08f 100644 --- a/tiup/tiup-component-cluster-reload.md +++ b/tiup/tiup-component-cluster-reload.md @@ -25,7 +25,7 @@ tiup cluster reload [flags] ### --transfer-timeout -- When restarting PD or TiKV, the leader of the restarted node is migrated to other nodes first, and the migration process takes some time. You can set the maximum wait time (in seconds) by setting `-transfer-timeout`. After the timeout, the service can be restarted directly without waiting. +- When restarting PD or TiKV, the leader of the restarted node is migrated to other nodes first, and the migration process takes some time. You can set the maximum wait time (in seconds) by setting `--transfer-timeout`. After the timeout, the service can be restarted directly without waiting. - Data type: `UINT` - Default: 600 diff --git a/tiup/tiup-component-cluster-scale-out.md b/tiup/tiup-component-cluster-scale-out.md index 049e5b35b6a1c..05870f6c8f085 100644 --- a/tiup/tiup-component-cluster-scale-out.md +++ b/tiup/tiup-component-cluster-scale-out.md @@ -15,9 +15,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`](/tiup/tiup-component-dm-list.md) command. +``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [`cluster list`](/tiup/tiup-component-cluster-list.md) command. -``: the prepared [topology file](/tiup/tiup-dm-topology-reference.md). This topology file should only contain the new nodes that are to be added to the current cluster. +``: the prepared [topology file](/tiup/tiup-cluster-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-upgrade.md b/tiup/tiup-component-cluster-upgrade.md index 3d5fc6d449041..ac6752aae1866 100644 --- a/tiup/tiup-component-cluster-upgrade.md +++ b/tiup/tiup-component-cluster-upgrade.md @@ -30,7 +30,7 @@ tiup cluster upgrade [flags] ### --transfer-timeout -- When upgrading PD or TiKV, the leader of the upgraded node is migrated to other nodes first. The migration process takes some time, and you can set the maximum wait time (in seconds) by the `-transfer-timeout` option. After the timeout, the wait is skipped and the service is upgraded directly. +- When upgrading PD or TiKV, the leader of the upgraded node is migrated to other nodes first. The migration process takes some time, and you can set the maximum wait time (in seconds) by the `--transfer-timeout` option. After the timeout, the wait is skipped and the service is upgraded directly. - Data type: `uint` - Default: 600 diff --git a/tiup/tiup-component-dm-edit-config.md b/tiup/tiup-component-dm-edit-config.md index 6b3e2f273ea8e..46b705bb162d4 100644 --- a/tiup/tiup-component-dm-edit-config.md +++ b/tiup/tiup-component-dm-edit-config.md @@ -5,7 +5,7 @@ summary: The `tiup dm edit-config` command allows you to modify the cluster serv # 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](/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. +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-patch.md b/tiup/tiup-component-dm-patch.md index 64489416a273c..f89d6e3b32716 100644 --- a/tiup/tiup-component-dm-patch.md +++ b/tiup/tiup-component-dm-patch.md @@ -45,7 +45,7 @@ You need to pack the binary package required for this command in advance accordi ### -N, --node -- Specifies the nodes to be replaced. The value of this option is a comma-separated list of node IDs. You can get the node IDs from the first column of the cluster status table returned by the `[tiup dm display](/tiup/tiup-component-dm-display.md)` command. +- Specifies the nodes to be replaced. The value of this option is a comma-separated list of node IDs. You can get the node IDs from the first column of the cluster status table returned by the [`tiup dm display`](/tiup/tiup-component-dm-display.md) command. - Data type: `STRING` - If this option is not specified, TiUP selects all nodes to replace by default. @@ -55,7 +55,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 roles of the nodes from the second column of the cluster status table returned by the `[tiup dm display](/tiup/tiup-component-dm-display.md)` 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 roles of the nodes from the second column of the cluster status table returned by the [`tiup dm display`](/tiup/tiup-component-dm-display.md) command. - Data type: `STRING` - If this option is not specified, TiUP selects all roles to replace by default. diff --git a/tiup/tiup-component-dm-prune.md b/tiup/tiup-component-dm-prune.md index e2cfc028d737d..7dd9aa0f51cea 100644 --- a/tiup/tiup-component-dm-prune.md +++ b/tiup/tiup-component-dm-prune.md @@ -5,7 +5,7 @@ summary: When scaling in the cluster, a small amount of metadata in etcd may not # tiup dm prune -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. +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-restart.md b/tiup/tiup-component-dm-restart.md index d1b228a4e3ca0..36ef301f8ded1 100644 --- a/tiup/tiup-component-dm-restart.md +++ b/tiup/tiup-component-dm-restart.md @@ -17,13 +17,13 @@ The command `tiup dm restart` is used to restart all or some of the services of tiup dm restart [flags] ``` -``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list](/tiup/tiup-component-cluster-list.md) command. +``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [tiup dm list](/tiup/tiup-component-dm-list.md) command. ## Options ### -N, --node -- Specifies the nodes to be restarted. The value of this option is a comma-separated list of node IDs. You can get the node IDs from the first column of the cluster status table returned by the `[tiup dm display](/tiup/tiup-component-dm-display.md)` command. +- Specifies the nodes to be restarted. The value of this option is a comma-separated list of node IDs. You can get the node IDs from the first column of the cluster status table returned by the [`tiup dm display`](/tiup/tiup-component-dm-display.md) command. - Data type: `STRING` - If this option is not specified, TiUP restarts all nodes by default. @@ -33,7 +33,7 @@ tiup dm restart [flags] ### -R, --role -- Specifies the roles of nodes to be restarted. The value of this option is a comma-separated list of the roles of the nodes. You can get the roles of the nodes from the second column of the cluster status table returned by the `[tiup dm display](/tiup/tiup-component-dm-display.md)` command. +- Specifies the roles of nodes to be restarted. The value of this option is a comma-separated list of the roles of the nodes. You can get the roles of the nodes from the second column of the cluster status table returned by the [`tiup dm display`](/tiup/tiup-component-dm-display.md) command. - Data type: `STRING` - If this option is not specified, TiUP restarts nodes of all roles by default. diff --git a/tiup/tiup-component-dm-scale-in.md b/tiup/tiup-component-dm-scale-in.md index 9b48cf03177be..ed1be9924724c 100644 --- a/tiup/tiup-component-dm-scale-in.md +++ b/tiup/tiup-component-dm-scale-in.md @@ -13,7 +13,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](/tiup/tiup-component-dm-list.md) command. +``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [tiup dm 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 0a9c27cf9933a..21bbc55b2eafa 100644 --- a/tiup/tiup-component-dm-scale-out.md +++ b/tiup/tiup-component-dm-scale-out.md @@ -13,7 +13,7 @@ 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](/tiup/tiup-component-dm-list.md) command. +``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [tiup dm list](/tiup/tiup-component-dm-list.md) command. ``: the prepared [topology file](/tiup/tiup-dm-topology-reference.md). This topology file should only contain the new nodes that are to be added to the current cluster. diff --git a/tiup/tiup-component-dm-start.md b/tiup/tiup-component-dm-start.md index 06df1a607d81b..b823d47af1a5c 100644 --- a/tiup/tiup-component-dm-start.md +++ b/tiup/tiup-component-dm-start.md @@ -13,7 +13,7 @@ The `tiup dm start` command is used to start all or part of the services of the tiup dm start [flags] ``` -``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list](/tiup/tiup-component-dm-list.md) command. +``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [tiup dm list](/tiup/tiup-component-dm-list.md) command. ## Options diff --git a/tiup/tiup-component-dm-stop.md b/tiup/tiup-component-dm-stop.md index 98d6763330089..6ab582af67458 100644 --- a/tiup/tiup-component-dm-stop.md +++ b/tiup/tiup-component-dm-stop.md @@ -17,7 +17,7 @@ The `tiup dm stop` command is used to stop all or part of the services of the sp tiup dm stop [flags] ``` -``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list](/tiup/tiup-component-dm-list.md) command. +``: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [tiup dm list](/tiup/tiup-component-dm-list.md) command. ## Options diff --git a/tiup/tiup-component-management.md b/tiup/tiup-component-management.md index 686ac87a126cb..0bd2e7b505d56 100644 --- a/tiup/tiup-component-management.md +++ b/tiup/tiup-component-management.md @@ -30,8 +30,8 @@ You can use the `tiup list` command to query the component list. This usage of t You can also use the following flags in the above commands: - `--installed`: checks which components or which version of a specific component has been installed locally. --`--all`: views all components, including the hidden ones --`--verbose`: views all columns (including installed versions and supported platforms) +- `--all`: views all components, including the hidden ones +- `--verbose`: views all columns (including installed versions and supported platforms) Example 1: View all currently installed components. @@ -51,10 +51,10 @@ tiup list tikv ## Install components -You can use the `tiup install` command to query the component list. This usage of this command is as follows: +You can use the `tiup install` command to install components. This usage of this command is as follows: - `tiup install `: installs the latest stable version of a specified component. -- `tiup install :[version]`: installs the specified version of a specified component. +- `tiup install [:version]`: installs the specified version of a specified component. Example 1: Use TiUP to install the latest stable version of TiDB. diff --git a/tiup/tiup-dm-topology-reference.md b/tiup/tiup-dm-topology-reference.md index 775b9ef2c3e22..bd1114a5e46ef 100644 --- a/tiup/tiup-dm-topology-reference.md +++ b/tiup/tiup-dm-topology-reference.md @@ -37,7 +37,7 @@ The `global` section corresponds to the cluster's global configuration and has t - If the absolute path `data_dir` is configured at the instance level, the actual data directory is the `data_dir` configured for the instance. - For each instance, if `data_dir` is not configured, the default value is ``. - If `data_dir` is set to a relative path, the component data is stored in `/`. For the construction rules of ``, see the construction rules of the `deploy_dir` field. -- `log_dir`: the data directory. The default value is "log". The construction rules are as follows. +- `log_dir`: the log directory. The default value is "log". The construction rules are as follows. - If the absolute path of `log_dir` is configured at the instance level, the actual log directory is the `log_dir` configured for the instance. - For each instance, if `log_dir` is not configured by the user, the default value is ``. - If `log_dir` is a relative path, the component logs will be stored in `/`. For the construction rules of ``, see the construction rules of the `deploy_dir` field. @@ -140,7 +140,7 @@ master_servers: ## `worker_servers` -`worker_servers` specifies the machines to which the master node of the DM component is deployed. You can also specify the service configuration on each machine. `worker_servers` is an array. Each array element contains the following fields: +`worker_servers` specifies the machines to which the worker node of the DM component is deployed. You can also specify the service configuration on each machine. `worker_servers` is an array. Each array element contains the following fields: - `host`: specifies the machine to deploy to. The field value is an IP address and is mandatory. - `ssh_port`: specifies the SSH port to connect to the target machine for operations. If the field is not specified, the `ssh_port` in the `global` section is used.