Skip to content
Permalink
Browse files

dev, v2.1, v3.0/*: correct TiDB tool names (#1466)

  • Loading branch information...
TomShawn authored and lilin90 committed Aug 27, 2019
1 parent e41da9c commit 02512fb38c6d7ec850510a6b2d91a17ef91f1d1c
Showing with 614 additions and 611 deletions.
  1. +2 −2 README.md
  2. +1 −1 dev/contribute.md
  3. +5 −5 dev/faq/tidb-lightning.md
  4. +10 −8 dev/faq/tidb.md
  5. +4 −4 dev/how-to/deploy/orchestrated/ansible-operations.md
  6. +7 −7 dev/how-to/deploy/orchestrated/ansible.md
  7. +4 −4 dev/how-to/deploy/orchestrated/offline-ansible.md
  8. +4 −4 dev/how-to/deploy/tidb-binlog.md
  9. +2 −2 dev/how-to/deploy/tispark.md
  10. +3 −3 dev/how-to/get-started/data-migration.md
  11. +13 −13 dev/how-to/get-started/tidb-binlog.md
  12. +3 −3 dev/how-to/migrate/from-aurora.md
  13. +1 −1 dev/how-to/migrate/from-mysql.md
  14. +6 −6 dev/how-to/migrate/overview.md
  15. +4 −4 dev/how-to/scale/horizontally.md
  16. +3 −3 dev/how-to/scale/with-ansible.md
  17. +3 −3 dev/how-to/troubleshoot/tidb-lightning.md
  18. +3 −3 dev/how-to/upgrade/rolling-updates-with-ansible.md
  19. +2 −2 dev/key-features.md
  20. +1 −1 dev/reference/mysql-compatibility.md
  21. +8 −8 dev/reference/tools/data-migration/configure/task-configuration-file.md
  22. +4 −4 dev/reference/tools/data-migration/deploy.md
  23. +3 −3 dev/reference/tools/download.md
  24. +3 −3 dev/reference/tools/loader.md
  25. +9 −9 dev/reference/tools/mydumper.md
  26. +2 −2 dev/reference/tools/syncer.md
  27. +1 −1 dev/reference/tools/tidb-binlog/tidb-binlog-local.md
  28. +1 −1 dev/reference/tools/tidb-lightning/checkpoints.md
  29. +1 −1 dev/reference/tools/tidb-lightning/csv.md
  30. +2 −2 dev/reference/tools/tidb-lightning/deployment.md
  31. +1 −1 dev/reference/tools/tidb-lightning/monitor.md
  32. +1 −1 dev/reference/tools/tidb-lightning/overview.md
  33. +1 −1 dev/releases/2.0.10.md
  34. +1 −1 dev/releases/2.0.11.md
  35. +1 −1 dev/releases/2.1.1.md
  36. +4 −4 dev/releases/2.1.2.md
  37. +2 −2 dev/releases/2.1.3.md
  38. +1 −1 dev/releases/2.1.4.md
  39. +2 −2 dev/releases/2.1.5.md
  40. +1 −1 dev/releases/2.1.6.md
  41. +2 −2 dev/releases/2.1.7.md
  42. +6 −6 dev/releases/2.1.8.md
  43. +2 −2 dev/releases/2.1.9.md
  44. +1 −1 dev/releases/2.1ga.md
  45. +7 −7 dev/releases/21rc5.md
  46. +16 −16 dev/releases/3.0.0-beta.1.md
  47. +23 −23 dev/releases/3.0.0-rc.1.md
  48. +1 −1 dev/releases/3.0beta.md
  49. +1 −1 dev/releases/rc3.md
  50. +1 −1 dev/tidb-in-kubernetes/deploy/aws-eks.md
  51. +1 −1 dev/tidb-in-kubernetes/get-started/deploy-tidb-from-kubernetes-dind.md
  52. +2 −2 dev/tidb-in-kubernetes/get-started/deploy-tidb-from-kubernetes-minikube.md
  53. +2 −2 dev/tidb-in-kubernetes/maintain/backup-and-restore.md
  54. +4 −4 v2.1/faq/tidb-lightning.md
  55. +11 −9 v2.1/faq/tidb.md
  56. +4 −5 v2.1/how-to/deploy/orchestrated/ansible-operations.md
  57. +7 −7 v2.1/how-to/deploy/orchestrated/ansible.md
  58. +4 −4 v2.1/how-to/deploy/orchestrated/offline-ansible.md
  59. +5 −4 v2.1/how-to/deploy/tidb-binlog.md
  60. +2 −2 v2.1/how-to/deploy/tispark.md
  61. +3 −3 v2.1/how-to/get-started/data-migration.md
  62. +12 −12 v2.1/how-to/get-started/tidb-binlog.md
  63. +3 −3 v2.1/how-to/migrate/from-aurora.md
  64. +6 −5 v2.1/how-to/migrate/from-mysql.md
  65. +6 −6 v2.1/how-to/migrate/overview.md
  66. +9 −10 v2.1/how-to/scale/horizontally.md
  67. +3 −3 v2.1/how-to/scale/with-ansible.md
  68. +3 −3 v2.1/how-to/troubleshoot/tidb-lightning.md
  69. +3 −3 v2.1/how-to/upgrade/from-previous-version.md
  70. +3 −3 v2.1/how-to/upgrade/rolling-updates-with-ansible.md
  71. +2 −2 v2.1/key-features.md
  72. +9 −9 v2.1/reference/mysql-compatibility.md
  73. +8 −8 v2.1/reference/tools/data-migration/configure/task-configuration-file.md
  74. +4 −4 v2.1/reference/tools/data-migration/deploy.md
  75. +4 −4 v2.1/reference/tools/download.md
  76. +3 −3 v2.1/reference/tools/loader.md
  77. +9 −9 v2.1/reference/tools/mydumper.md
  78. +3 −3 v2.1/reference/tools/syncer.md
  79. +1 −1 v2.1/reference/tools/tidb-binlog/reparo.md
  80. +1 −1 v2.1/reference/tools/tidb-binlog/tidb-binlog-local.md
  81. +1 −1 v2.1/reference/tools/tidb-lightning/checkpoints.md
  82. +1 −1 v2.1/reference/tools/tidb-lightning/csv.md
  83. +1 −1 v2.1/reference/tools/tidb-lightning/deployment.md
  84. +1 −1 v2.1/reference/tools/tidb-lightning/monitor.md
  85. +1 −1 v2.1/reference/tools/tidb-lightning/overview.md
  86. +1 −1 v2.1/releases/2.0.10.md
  87. +1 −1 v2.1/releases/2.0.11.md
  88. +1 −1 v2.1/releases/2.1.1.md
  89. +4 −4 v2.1/releases/2.1.2.md
  90. +2 −2 v2.1/releases/2.1.3.md
  91. +1 −1 v2.1/releases/2.1.4.md
  92. +2 −2 v2.1/releases/2.1.5.md
  93. +1 −1 v2.1/releases/2.1.6.md
  94. +2 −2 v2.1/releases/2.1.7.md
  95. +6 −6 v2.1/releases/2.1.8.md
  96. +2 −2 v2.1/releases/2.1.9.md
  97. +1 −1 v2.1/releases/2.1ga.md
  98. +3 −3 v2.1/releases/21rc5.md
  99. +16 −16 v2.1/releases/3.0.0-beta.1.md
  100. +24 −27 v2.1/releases/3.0.0-rc.1.md
  101. +1 −1 v2.1/releases/3.0beta.md
  102. +4 −4 v2.1/releases/rc3.md
  103. +2 −2 v2.1/tispark/tispark-quick-start-guide_v1.x.md
  104. +1 −1 v3.0/contribute.md
  105. +5 −5 v3.0/faq/tidb-lightning.md
  106. +11 −9 v3.0/faq/tidb.md
  107. +4 −5 v3.0/how-to/deploy/orchestrated/ansible-operations.md
  108. +7 −7 v3.0/how-to/deploy/orchestrated/ansible.md
  109. +4 −4 v3.0/how-to/deploy/orchestrated/offline-ansible.md
  110. +5 −4 v3.0/how-to/deploy/tidb-binlog.md
  111. +2 −2 v3.0/how-to/deploy/tispark.md
  112. +3 −3 v3.0/how-to/get-started/data-migration.md
  113. +13 −13 v3.0/how-to/get-started/tidb-binlog.md
  114. +3 −3 v3.0/how-to/migrate/from-aurora.md
  115. +6 −5 v3.0/how-to/migrate/from-mysql.md
  116. +6 −6 v3.0/how-to/migrate/overview.md
  117. +9 −10 v3.0/how-to/scale/horizontally.md
  118. +3 −3 v3.0/how-to/scale/with-ansible.md
  119. +3 −3 v3.0/how-to/troubleshoot/tidb-lightning.md
  120. +3 −3 v3.0/how-to/upgrade/from-previous-version.md
  121. +3 −3 v3.0/how-to/upgrade/rolling-updates-with-ansible.md
  122. +2 −2 v3.0/key-features.md
  123. +1 −1 v3.0/reference/mysql-compatibility.md
  124. +8 −8 v3.0/reference/tools/data-migration/configure/task-configuration-file.md
  125. +4 −4 v3.0/reference/tools/data-migration/deploy.md
  126. +3 −3 v3.0/reference/tools/download.md
  127. +3 −3 v3.0/reference/tools/loader.md
  128. +9 −9 v3.0/reference/tools/mydumper.md
  129. +3 −3 v3.0/reference/tools/syncer.md
  130. +1 −1 v3.0/reference/tools/tidb-binlog/reparo.md
  131. +1 −1 v3.0/reference/tools/tidb-binlog/tidb-binlog-local.md
  132. +1 −1 v3.0/reference/tools/tidb-lightning/checkpoints.md
  133. +1 −1 v3.0/reference/tools/tidb-lightning/csv.md
  134. +1 −1 v3.0/reference/tools/tidb-lightning/deployment.md
  135. +1 −1 v3.0/reference/tools/tidb-lightning/monitor.md
  136. +1 −1 v3.0/reference/tools/tidb-lightning/overview.md
  137. +1 −1 v3.0/releases/2.0.10.md
  138. +1 −1 v3.0/releases/2.0.11.md
  139. +1 −1 v3.0/releases/2.1.1.md
  140. +4 −4 v3.0/releases/2.1.2.md
  141. +2 −2 v3.0/releases/2.1.3.md
  142. +1 −1 v3.0/releases/2.1.4.md
  143. +2 −2 v3.0/releases/2.1.5.md
  144. +1 −1 v3.0/releases/2.1.6.md
  145. +2 −2 v3.0/releases/2.1.7.md
  146. +6 −6 v3.0/releases/2.1.8.md
  147. +1 −1 v3.0/releases/2.1ga.md
  148. +7 −7 v3.0/releases/21rc5.md
  149. +16 −16 v3.0/releases/3.0.0-beta.1.md
  150. +23 −23 v3.0/releases/3.0.0-rc.1.md
  151. +1 −1 v3.0/releases/3.0beta.md
  152. +4 −4 v3.0/releases/rc3.md
  153. +1 −1 v3.0/tidb-in-kubernetes/deploy/aws-eks.md
  154. +1 −1 v3.0/tidb-in-kubernetes/get-started/deploy-tidb-from-kubernetes-dind.md
  155. +2 −2 v3.0/tidb-in-kubernetes/get-started/deploy-tidb-from-kubernetes-minikube.md
@@ -23,7 +23,7 @@ TiDB does not have 100% MySQL compatibility because we built the layer from scra

### Replicate from and to MySQL

TiDB supports the ability to replicate from a MySQL or MariaDB installation, using its Data Migration (DM) toolchain. Replication is also possible in the direction of TiDB to MySQL using the TiDB-Binlog.
TiDB supports the ability to replicate from a MySQL or MariaDB installation, using its Data Migration (DM) toolchain. Replication is also possible in the direction of TiDB to MySQL using the TiDB Binlog.

We believe that being able to replicate in both directions lowers the risk when either evaluating or migrating to TiDB from MySQL.

@@ -79,7 +79,7 @@ Your session will be placed in read-only mode while reading the earlier versions

### Fast Import and Restore of Data

TiDB supports the ability to fast-import both mydumper and .csv formatted data using an optimized insert mode that disables redo logging, and applies a number of optimizations.
TiDB supports the ability to fast-import both Mydumper and .csv formatted data using an optimized insert mode that disables redo logging, and applies a number of optimizations.

With TiDB Lightning, you can import data into TiDB at over 100GiB/hour using production-grade hardware.

@@ -10,7 +10,7 @@ category: how-to

We recommend starting with an existing issue with the [help-wanted](https://github.com/pingcap/tidb/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) label. These issues are well suited for new contributors.

If a PR (Pull Request) submitted to the [TiDB/TiKV/TiSpark/PD/TiDB-Operator/Docs/Docs-cn](https://github.com/pingcap) projects by you is approved and merged, then you become a TiDB Contributor.
If a PR (Pull Request) submitted to the [TiDB/TiKV/TiSpark/PD/TiDB Operator/Docs/Docs-cn](https://github.com/pingcap) projects by you is approved and merged, then you become a TiDB Contributor.

Before submitting a pull request, sign the [CLA](https://cla-assistant.io/pingcap/tidb?pullRequest=5567).

@@ -16,7 +16,7 @@ Yes.

## What is the privilege requirements for the target database?

Lightning requires the following privileges:
TiDB Lightning requires the following privileges:

* SELECT
* UPDATE
@@ -37,7 +37,7 @@ If only one table has an error encountered, the rest will still be processed nor

## How to ensure the integrity of the imported data?

Lightning by default performs checksum on the local data source and the imported tables. If there is checksum mismatch, the process would be aborted. These checksum information can be read from the log.
TiDB Lightning by default performs checksum on the local data source and the imported tables. If there is checksum mismatch, the process would be aborted. These checksum information can be read from the log.

You could also execute the `ADMIN CHECKSUM TABLE` SQL command on the target table to recompute the checksum of the imported data.

@@ -54,7 +54,7 @@ mysql> ADMIN CHECKSUM TABLE `schema`.`table`;
## What kind of data source format is supported by Lightning?

In version 2.1.6, TiDB Lightning only supports the SQL dump generated by
[mydumper](/reference/tools/mydumper.md)
[Mydumper](/reference/tools/mydumper.md)
or [CSV files](/reference/tools/tidb-lightning/csv.md) stored in the local filesystem.

## Could TiDB Lightning skip creating schema and tables?
@@ -79,13 +79,13 @@ Yes, as long as every `tidb-lightning` instance operates on different tables.

## How to stop `tikv-importer`?

If it is deployed using TiDB-Ansible, run `scripts/stop_importer.sh` under the deployed folder.
If it is deployed using TiDB Ansible, run `scripts/stop_importer.sh` under the deployed folder.

Otherwise, obtain the process ID with `ps aux | grep tikv-importer`, and then run `kill «pid»`.

## How to stop `tidb-lightning`?

If it is deployed using TiDB-Ansible, run `scripts/stop_lightning.sh` under the deployed folder.
If it is deployed using TiDB Ansible, run `scripts/stop_lightning.sh` under the deployed folder.

If `tidb-lightning` is running in foreground, simply press <kbd>Ctrl</kbd>+<kbd>C</kbd> to stop it.

@@ -6,6 +6,8 @@ category: faq

# TiDB FAQ

<!-- markdownlint-disable MD026 -->

This document lists the Most Frequently Asked Questions about TiDB.

## About TiDB
@@ -228,7 +230,7 @@ Check the time difference between the machine time of the monitor and the time w
| Variable | Description |
| ---- | ------- |
| cluster_name | the name of a cluster, adjustable |
| tidb_version | the version of TiDB, configured by default in TiDB-Ansible branches |
| tidb_version | the version of TiDB, configured by default in TiDB Ansible branches |
| deployment_method | the method of deployment, binary by default, Docker optional |
| process_supervision | the supervision way of processes, systemd by default, supervise optional |
| timezone | the timezone of the managed node, adjustable, `Asia/Shanghai` by default, used with the `set_timezone` variable |
@@ -287,7 +289,7 @@ The Direct mode wraps the Write request into the I/O command and sends this comm
./fio -ioengine=psync -bs=32k -fdatasync=1 -thread -rw=randrw -percentage_random=100,0 -size=10G -filename=fio_randread_write_test.txt -name='fio mixed randread and sequential write test' -iodepth=4 -runtime=60 -numjobs=4 -group_reporting --output-format=json --output=fio_randread_write_test.json
```

#### Error `UNREACHABLE! "msg": "Failed to connect to the host via ssh: "` when deploying TiDB using TiDB-Ansible
#### Error `UNREACHABLE! "msg": "Failed to connect to the host via ssh: "` when deploying TiDB using TiDB Ansible

Two possible reasons and solutions:

@@ -400,11 +402,11 @@ Take `Release Version: v1.0.3-1-ga80e796` as an example of version number descri
- `-1` indicates the current version has one commit.
- `ga80e796` indicates the version `git-hash`.

#### What's the difference between various TiDB master versions? How to avoid using the wrong TiDB-Ansible version?
#### What's the difference between various TiDB master versions? How to avoid using the wrong TiDB Ansible version?

The TiDB community is highly active. After the 1.0 GA release, the engineers have been keeping optimizing and fixing bugs. Therefore, the TiDB version is updated quite fast. If you want to keep informed of the latest version, see [TiDB Weekly update](https://pingcap.com/weekly/).

It is recommended to deploy the TiDB cluster using the latest version of TiDB-Ansible, which will also be updated along with the TiDB version. TiDB has a unified management of the version number after the 1.0 GA release. You can view the version number using the following two methods:
It is recommended to deploy the TiDB cluster using the latest version of TiDB Ansible, which will also be updated along with the TiDB version. TiDB has a unified management of the version number after the 1.0 GA release. You can view the version number using the following two methods:

- `select tidb_version()`
- `tidb-server -V`
@@ -489,7 +491,7 @@ The offline node usually indicates the TiKV node. You can determine whether the

#### Why couldn't I connect to the PD server using `127.0.0.1` when I was using the PD Control?

If your TiDB cluster is deployed using TiDB-Ansible, the PD external service port is not bound to `127.0.0.1`, so PD Control does not recognize `127.0.0.1` and you can only connect to it using the local IP address.
If your TiDB cluster is deployed using TiDB Ansible, the PD external service port is not bound to `127.0.0.1`, so PD Control does not recognize `127.0.0.1` and you can only connect to it using the local IP address.

### Manage the TiDB server

@@ -711,7 +713,7 @@ TiDB is not suitable for tables of small size (such as below ten million level),

#### How to back up data in TiDB?

Currently, the preferred method for backup is using the [PingCAP fork of mydumper](/reference/tools/mydumper.md). Although the official MySQL tool `mysqldump` is also supported in TiDB to back up and restore data, its performance is poorer than [`mydumper`](/reference/tools/mydumper.md)/[`loader`](/reference/tools/loader.md) and it needs much more time to back up and restore large volumes of data.
Currently, the preferred method for backup is using the [PingCAP fork of Mydumper](/reference/tools/mydumper.md). Although the official MySQL tool `mysqldump` is also supported in TiDB to back up and restore data, its performance is poorer than [`mydumper`](/reference/tools/mydumper.md)/[`loader`](/reference/tools/loader.md) and it needs much more time to back up and restore large volumes of data.

Keep the size of the data file exported from `mydumper` as small as possible. It is recommended to keep the size within 64M. You can set value of the `-F` parameter to 64.

@@ -723,7 +725,7 @@ You can edit the `t` parameter of `loader` based on the number of TiKV instances

#### Mydumper

See [mydumper Instructions](/reference/tools/mydumper.md).
See [Mydumper Instructions](/reference/tools/mydumper.md).

#### Loader

@@ -863,7 +865,7 @@ Frequent DDL operations may affect the replication speed. For Sycner, DDL operat

##### If the machine that Syncer is in is broken and the directory of the `syncer.meta` file is lost, what should I do?

When you replicate data using Syncer GTID, the `syncer.meta` file is constantly updated during the replication process. The current version of Syncer does not contain the design for high availability. The `syncer.meta` configuration file of Syncer is directly stored on the hard disks, which is similar to other tools in the MySQL ecosystem, such as mydumper.
When you replicate data using Syncer GTID, the `syncer.meta` file is constantly updated during the replication process. The current version of Syncer does not contain the design for high availability. The `syncer.meta` configuration file of Syncer is directly stored on the hard disks, which is similar to other tools in the MySQL ecosystem, such as Mydumper.

Two solutions:

@@ -1,12 +1,12 @@
---
title: TiDB-Ansible Common Operations
summary: Learn some common operations when using TiDB-Ansible to administer a TiDB cluster.
title: TiDB Ansible Common Operations
summary: Learn some common operations when using TiDB Ansible to administer a TiDB cluster.
category: how-to
---

# TiDB-Ansible Common Operations
# TiDB Ansible Common Operations

This guide describes the common operations when you administer a TiDB cluster using TiDB-Ansible.
This guide describes the common operations when you administer a TiDB cluster using TiDB Ansible.

## Start a cluster

@@ -12,9 +12,9 @@ This guide describes how to deploy a TiDB cluster using Ansible. For the product

Ansible is an IT automation tool that can configure systems, deploy software, and orchestrate more advanced IT tasks such as continuous deployments or zero downtime rolling updates.

[TiDB-Ansible](https://github.com/pingcap/tidb-ansible) is a TiDB cluster deployment tool developed by PingCAP, based on Ansible playbook. TiDB-Ansible enables you to quickly deploy a new TiDB cluster which includes PD, TiDB, TiKV, and the cluster monitoring modules.
[TiDB Ansible](https://github.com/pingcap/tidb-ansible) is a TiDB cluster deployment tool developed by PingCAP, based on Ansible playbook. TiDB Ansible enables you to quickly deploy a new TiDB cluster which includes PD, TiDB, TiKV, and the cluster monitoring modules.

You can use the TiDB-Ansible configuration file to set up the cluster topology and complete all the following operation tasks:
You can use the TiDB Ansible configuration file to set up the cluster topology and complete all the following operation tasks:

- Initialize operating system parameters
- Deploy the whole TiDB cluster
@@ -128,7 +128,7 @@ Make sure you have logged in to the Control Machine using the `root` user accoun
+----[SHA256]-----+
```

## Step 3: Download TiDB-Ansible to the Control Machine
## Step 3: Download TiDB Ansible to the Control Machine

1. Log in to the Control Machine using the `tidb` user account and enter the `/home/tidb` directory. The relationship between the `tidb-ansible` version and the TiDB version is as follows:

@@ -139,7 +139,7 @@ Make sure you have logged in to the Control Machine using the `root` user accoun
| 3.0 version | v3.0.0-beta, v3.0.0-beta.1 | It is currently a beta version which is not recommended to use in the production environment. |
| `master` branch | None | It includes the newest features and is updated on a daily basis, so it is not recommended to use it in the production environment. |

2. Download the [corresponding TiDB-Ansible versions](https://github.com/pingcap/tidb-ansible/tags) from the [TiDB-Ansible project](https://github.com/pingcap/tidb-ansible). The default folder name is `tidb-ansible`.
2. Download the [corresponding TiDB Ansible versions](https://github.com/pingcap/tidb-ansible/tags) from the [TiDB Ansible project](https://github.com/pingcap/tidb-ansible). The default folder name is `tidb-ansible`.

> **Note:**
>
@@ -167,7 +167,7 @@ Make sure you have logged in to the Control Machine using the `root` user accoun

Make sure you have logged in to the Control Machine using the `tidb` user account.

It is required to use `pip` to install Ansible and its dependencies, otherwise a compatibility issue occurs. Currently, the release-2.0, release-2.1, and master branches of TiDB-Ansible are compatible with Ansible 2.4 and Ansible 2.5.
It is required to use `pip` to install Ansible and its dependencies, otherwise a compatibility issue occurs. Currently, the release-2.0, release-2.1, and master branches of TiDB Ansible are compatible with Ansible 2.4 and Ansible 2.5.

1. Install Ansible and the dependencies on the Control Machine:

@@ -549,7 +549,7 @@ To enable the following control variables, use the capitalized `True`. To disabl
| Variable Name | Description |
| :---- | :------- |
| cluster_name | the name of a cluster, adjustable |
| tidb_version | the version of TiDB, configured by default in TiDB-Ansible branches |
| tidb_version | the version of TiDB, configured by default in TiDB Ansible branches |
| process_supervision | the supervision way of processes, systemd by default, supervise optional |
| timezone | the global default time zone configured when a new TiDB cluster bootstrap is initialized; you can edit it later using the global `time_zone` system variable and the session `time_zone` system variable as described in [Time Zone Support](/how-to/configure/time-zone.md); the default value is `Asia/Shanghai` and see [the list of time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for more optional values |
| enable_firewalld | to enable the firewall, closed by default; to enable it, add the ports in [network requirements](/how-to/deploy/hardware-recommendations.md#network-requirements) to the white list |
@@ -789,7 +789,7 @@ Run the following command:
process_supervision = systemd
```

For versions earlier than TiDB 1.0.4, the TiDB-Ansible supervision method of a process is `supervise` by default. The previously installed cluster can remain the same. If you need to change the supervision method to `systemd`, stop the cluster and run the following command:
For versions earlier than TiDB 1.0.4, the TiDB Ansible supervision method of a process is `supervise` by default. The previously installed cluster can remain the same. If you need to change the supervision method to `systemd`, stop the cluster and run the following command:

```shell
ansible-playbook stop.yml
@@ -14,7 +14,7 @@ Before you start, make sure that you have:

1. A download machine

- The machine must have access to the Internet in order to download TiDB-Ansible, TiDB and related packages.
- The machine must have access to the Internet in order to download TiDB Ansible, TiDB and related packages.
- For Linux operating system, it is recommended to install CentOS 7.3 or later.

2. Several target machines and one Control Machine
@@ -78,7 +78,7 @@ Currently, the TiDB 2.0 GA version and the master version are compatible with An
ansible 2.5.0
```

## Step 4: Download TiDB-Ansible and TiDB packages on the download machine
## Step 4: Download TiDB Ansible and TiDB packages on the download machine

The relationship between the `tidb-ansible` version and the TiDB version is as follows:

@@ -108,9 +108,9 @@ The relationship between the `tidb-ansible` version and the TiDB version is as f
>
> Make sure that the version of Ansible is 2.5, otherwise a compatibility issue occurs.
2. Download TiDB-Ansible.
2. Download TiDB Ansible.

Use the following command to download the corresponding version of TiDB-Ansible from the GitHub [TiDB-Ansible project](https://github.com/pingcap/tidb-ansible). The default folder name is `tidb-ansible`.
Use the following command to download the corresponding version of TiDB Ansible from the GitHub [TiDB Ansible project](https://github.com/pingcap/tidb-ansible). The default folder name is `tidb-ansible`.

> **Note:**
>
@@ -8,24 +8,24 @@ category: reference

This document describes two methods of deploying TiDB Binlog:

- [Deploy TiDB Binlog using TiDB-Ansible](#deploy-tidb-binlog-using-tidb-ansible)
- [Deploy TiDB Binlog using TiDB Ansible](#deploy-tidb-binlog-using-tidb-ansible)
- [Deploy TiDB Binlog using a Binary package](#deploy-tidb-binlog-using-a-binary-package)

It is recommended to deploy TiDB Binlog using TiDB-Ansible. If you just want to do a simple testing, you can deploy TiDB Binlog using a Binary package.
It is recommended to deploy TiDB Binlog using TiDB Ansible. If you just want to do a simple testing, you can deploy TiDB Binlog using a Binary package.

## Deploy TiDB Binlog using TiDB Ansible

### Step 1: Download TiDB Ansible

1. Use the TiDB user account to log in to the central control machine and go to the `/home/tidb` directory. The information about the branch of TiDB-Ansible and the corresponding TiDB version is as follows. If you have questions regarding which version to use, email to [info@pingcap.com](mailto:info@pingcap.com) for more information or [file an issue](https://github.com/pingcap/tidb-ansible/issues/new).
1. Use the TiDB user account to log in to the central control machine and go to the `/home/tidb` directory. The information about the branch of TiDB Ansible and the corresponding TiDB version is as follows. If you have questions regarding which version to use, email to [info@pingcap.com](mailto:info@pingcap.com) for more information or [file an issue](https://github.com/pingcap/tidb-ansible/issues/new).

| tidb-ansible branch | TiDB version | Note |
| ------------------- | ------------ | ---- |
| release-2.0 | 2.0 version | The latest 2.0 stable version. You can use it in the production environment. |
| release-2.1 | 2.1 version | The latest 2.1 stable version. You can use it in the production environment (recommended). |
| master | master version | This version includes the latest features with a daily update. |

2. Use the following command to download the corresponding branch of TiDB-Ansible from the [TiDB-Ansible project](https://github.com/pingcap/tidb-ansible) on GitHub. The default folder name is `tidb-ansible`.
2. Use the following command to download the corresponding branch of TiDB Ansible from the [TiDB Ansible project](https://github.com/pingcap/tidb-ansible) on GitHub. The default folder name is `tidb-ansible`.

- Download the 2.0 version:

0 comments on commit 02512fb

Please sign in to comment.
You can’t perform that action at this time.