Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tiup: batch uncomment links #5375

Merged
merged 1 commit into from
Apr 16, 2021
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
4 changes: 2 additions & 2 deletions tiup/tiup-command-mirror-rotate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<!-- (/tiup/tiup-command-mirror-sign.md) -->.
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<!-- (/tiup/tiup-command-mirror-sign.md) --> 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.

Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-command-mirror.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<!-- (/tiup/tiup-command-mirror-init.md) -->: 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<!-- (/tiup/tiup-command-mirror-rotate.md) -->: 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
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Use flexible I/O tester (fio) to test the performance of the disk where `data_di
tiup cluster check <topology.yml | cluster-name> [flags]
```

- If a cluster is not deployed yet, you need to pass the topology.yml <!--[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 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 `<cluster-name>` as the check object.

> **Note:**
Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ tiup cluster deploy <cluster-name> <version> <topology.yaml> [flags]

- `<cluster-name>`: the name of the new cluster, which cannot be the same as the existing cluster names.
- `<version>`: the version number of the TiDB cluster to deploy, such as `v4.0.9`.
- `<topology.yaml>`: the prepared topology file<!-- (/tiup/tiup-cluster-topology-reference.md) -->.
- `<topology.yaml>`: the prepared [topology file](/tiup/tiup-cluster-topology-reference.md).

## Options

Expand Down
6 changes: 3 additions & 3 deletions tiup/tiup-component-cluster-edit-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<!-- (/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.
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<!-- (/tiup/tiup-component-cluster-scale-out.md) -->. For how to delete machines, see Scale in a cluster<!-- (/tiup/tiup-component-cluster-scale-in.md) -->.
> + 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
Expand All @@ -30,4 +30,4 @@ tiup cluster edit-config <cluster-name> [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<!-- /tiup/tiup-cluster-topology-reference.md) -->.
- 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).
4 changes: 2 additions & 2 deletions tiup/tiup-component-cluster-patch.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<!--(/tiup/tiup-component-cluster-display.md)--> 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.

Expand All @@ -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<!--(/tiup/tiup-component-cluster-display.md)--> 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.

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-prune.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: tiup cluster prune

# tiup cluster prune

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

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 @@ -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 <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-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.
`<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.

## Options

Expand Down
14 changes: 5 additions & 9 deletions tiup/tiup-component-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,26 +59,22 @@ tiup cluster [command] [flags]

## Command list

- import: imports a cluster deployed by Ansible
<!--- - [import](/tiup/tiup-component-cluster-import.md): imports a cluster deployed by Ansible-->
- check: checks a cluster before and after the deployment
<!--- - [check](/tiup/tiup-component-cluster-check.md): 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
<!--- - [restart](/tiup/tiup-component-cluster-restart.md): restarts a specified cluster-->
- scale-in: scales in a specified cluster
<!--- - [scale-in](/tiup/tiup-component-cluster-scale-in.md): 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-->
- [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
Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-dm-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ tiup dm deploy <cluster-name> <version> <topology.yaml> [flags]

- `<cluster-name>`: the name of the new cluster, which cannot be the same as the existing cluster names.
- `<version>`: the version number of the DM cluster to be deployed, such as `v2.0.0`.
- `<topology.yaml>`: the prepared [topology file]<!-- (/tiup/tiup-dm-topology-reference.md) -->.
- `<topology.yaml>`: the prepared [topology file](/tiup/tiup-dm-topology-reference.md).

## Options

Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-component-dm-edit-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]<!-- (/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 All @@ -30,4 +30,4 @@ tiup dm edit-config <cluster-name> [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]<!-- (/tiup/tiup-dm-topology-reference.md)-->.
- 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).
6 changes: 3 additions & 3 deletions tiup/tiup-component-dm-reload.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: tiup dm reload

# tiup dm reload

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

Expand All @@ -18,7 +18,7 @@ tiup dm reload <cluster-name> [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]<!--(/tiup/tiup-component-dm-display.md) -->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.

Expand All @@ -29,7 +29,7 @@ tiup dm reload <cluster-name> [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]<!-- (/tiup/tiup-component-dm-display.md) -->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.

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 @@ -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 <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 [cluster list](/tiup/tiup-component-dm-list.md) command.

## Options

Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-component-dm-scale-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ 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 [cluster 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.
`<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.

## Options

Expand Down
6 changes: 3 additions & 3 deletions tiup/tiup-component-dm-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ 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 [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]<!-- (/tiup/tiup-component-dm-display.md) -->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.

Expand All @@ -28,7 +28,7 @@ tiup dm start <cluster-name> [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]<!--(/tiup/tiup-component-dm-display.md) --> 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.

Expand Down
Loading