Skip to content

Commit cbfbd7a

Browse files
lilin90CaitinChen
authored andcommitted
op-guide: update links, format, and port variable (#513)
Via: pingcap/docs-cn#766, pingcap/docs-cn#782
1 parent 1ab588b commit cbfbd7a

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

op-guide/ansible-deployment.md

+16-20
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ You can use the TiDB-Ansible configuration file to set up the cluster topology a
1717

1818
- Initialize operating system parameters
1919
- Deploy the whole TiDB cluster
20-
- Start the TiDB cluster
21-
- Stop the TiDB cluster
22-
- Modify component configuration
23-
- Scale the TiDB cluster
24-
- Upgrade the component version
25-
- Clean up data of the TiDB cluster
26-
- Destroy the TiDB cluster
20+
- [Start the TiDB cluster](ansible-operation.md#start-a-cluster)
21+
- [Stop the TiDB cluster](ansible-operation.md#stop-a-cluster)
22+
- [Modify component configuration](ansible-deployment-rolling-update.md#modify-component-configuration)
23+
- [Scale the TiDB cluster](ansible-deployment-scale.md)
24+
- [Upgrade the component version](ansible-deployment-rolling-update.md#upgrade-the-component-version)
25+
- [Clean up data of the TiDB cluster](ansible-operation.md#clean-up-cluster-data)
26+
- [Destroy the TiDB cluster](ansible-operation.md#destroy-a-cluster)
2727

2828
## Prerequisites
2929

@@ -53,16 +53,16 @@ Log in to the Control Machine using the `root` user account, and run the corresp
5353

5454
- If you use a Control Machine installed with CentOS 7, run the following command:
5555

56-
```
57-
# yum -y install epel-release git curl sshpass
58-
# yum -y install python-pip
59-
```
56+
```
57+
# yum -y install epel-release git curl sshpass
58+
# yum -y install python-pip
59+
```
6060
6161
- If you use a Control Machine installed with Ubuntu, run the following command:
6262
63-
```
64-
# apt-get -y install git curl sshpass python-pip
65-
```
63+
```
64+
# apt-get -y install git curl sshpass python-pip
65+
```
6666
6767
## Step 2: Create the `tidb` user on the Control Machine and generate the SSH key
6868
@@ -213,11 +213,7 @@ Log in to the Control Machine using the `root` user account.
213213

214214
Format your data disks to the ext4 filesystem and mount the filesystem with the `nodelalloc` and `noatime` options. It is required to mount the `nodelalloc` option, or else the Ansible deployment cannot pass the test. The `noatime` option is optional.
215215

216-
> **Note:** If your data disks have been formatted to ext4 and have mounted the options, you can uninstall it by running the following `umount` command, follow the steps starting from editing the `/etc/fstab` file, and remount the filesystem with options.
217-
>
218-
> ```
219-
> # umount /dev/nvme0n1
220-
> ```
216+
> **Note:** If your data disks have been formatted to ext4 and have mounted the options, you can uninstall it by running the `# umount /dev/nvme0n1` command, follow the steps starting from editing the `/etc/fstab` file, and remount the filesystem with options.
221217
222218
Take the `/dev/nvme0n1` data disk as an example:
223219

@@ -286,7 +282,7 @@ Log in to the Control Machine using the `tidb` user account, and edit the `tidb-
286282
- Do not deploy TiKV together with TiDB or PD on the same machine.
287283
- Use the first TiDB machine as the monitoring machine.
288284
289-
> **Note:** It is required to use the internal IP address to deploy.
285+
> **Note:** It is required to use the internal IP address to deploy. If the SSH port of the target machines are not the default 22 port, you need to add the `ansible_port` variable. For example, `TiDB1 ansible_host=172.16.10.1 ansible_port=5555`.
290286
291287
You can choose one of the following two types of cluster topology according to your scenario:
292288

0 commit comments

Comments
 (0)