Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tiup/tiup-cluster-topology-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-command-mirror-modify.md
Original file line number Diff line number Diff line change
@@ -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 <component>[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 <component>[: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.
Comment thread
coderabbitai[bot] marked this conversation as resolved.
---

# tiup mirror modify
Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-command-mirror-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-audit-cleanup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 6 additions & 6 deletions tiup/tiup-component-cluster-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,15 +108,15 @@ 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

Check the memory size of the target machine. For a production cluster, it is recommended that the total memory capacity is greater than or equal to 32GB.

> **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

Expand All @@ -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

Expand Down Expand Up @@ -162,9 +162,9 @@ tiup cluster check <topology.yml | cluster-name> [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 <cluster-name> scale-out.yml --cluster --apply --user root [-p] [-i /home/root/.ssh/gcp_rsa]
>```
> ```

### --cluster

Expand Down Expand Up @@ -232,7 +232,7 @@ tiup cluster check <topology.yml | cluster-name> [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

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ tiup cluster clean <cluster-name> [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

Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-component-cluster-display.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ tiup cluster display <cluster-name> [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

Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-component-cluster-import.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-meta-backup.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-reload.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ tiup cluster reload <cluster-name> [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

Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-component-cluster-scale-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <cluster-name> <topology.yaml> [flags]
```

`<cluster-name>`: 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.
`<cluster-name>`: 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.

`<topology.yaml>`: 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.
`<topology.yaml>`: 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

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ tiup cluster upgrade <cluster-name> <version> [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

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-dm-edit-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**
>
Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-component-dm-patch.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-dm-prune.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions tiup/tiup-component-dm-restart.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ The command `tiup dm restart` is used to restart all or some of the services of
tiup dm restart <cluster-name> [flags]
```

`<cluster-name>`: 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.
`<cluster-name>`: 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.

Expand All @@ -33,7 +33,7 @@ tiup dm restart <cluster-name> [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.

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-dm-scale-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <cluster-name> [flags]
```

`<cluster-name>`: 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.
`<cluster-name>`: 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

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-dm-scale-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The `tiup dm scale-out` command is used for scaling out the cluster. The interna
tiup dm scale-out <cluster-name> <topology.yaml> [flags]
```

`<cluster-name>`: 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.
`<cluster-name>`: 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.

`<topology.yaml>`: 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.

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-dm-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The `tiup dm start` command is used to start all or part of the services of the
tiup dm start <cluster-name> [flags]
```

`<cluster-name>`: 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.
`<cluster-name>`: 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

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-dm-stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <cluster-name> [flags]
```

`<cluster-name>`: 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.
`<cluster-name>`: 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

Expand Down
8 changes: 4 additions & 4 deletions tiup/tiup-component-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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 <component>`: installs the latest stable version of a specified component.
- `tiup install <component>:[version]`: installs the specified version of a specified component.
- `tiup install <component>[:version]`: installs the specified version of a specified component.

Example 1: Use TiUP to install the latest stable version of TiDB.

Expand Down
Loading
Loading