Skip to content
Permalink
Browse files

*: correct TiDB tool names (#1798)

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

我们推荐您先尝试解决带 [help-wanted](https://github.com/pingcap/tidb/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) 标签的现有 Issue,这些问题非常适合新的贡献者。

一旦您提交给 [TiDB/TiKV/TiSpark/PD/TiDB-Operator/Docs/Docs-cn](https://github.com/pingcap) 项目的 PR (Pull Request) 被批准且合并,您即成为 TiDB 的贡献者。
一旦您提交给 [TiDB/TiKV/TiSpark/PD/TiDB Operator/Docs/Docs-cn](https://github.com/pingcap) 项目的 PR (Pull Request) 被批准且合并,您即成为 TiDB 的贡献者。

在提交 PR 之前,请先签署 [CLA](https://cla-assistant.io/pingcap/tidb?pullRequest=5567)。

@@ -15,7 +15,7 @@ category: FAQ

## TiDB Lightning 对下游数据库的账号权限要求是怎样的?

Lightning 需要以下权限:
TiDB Lightning 需要以下权限:

* SELECT
* UPDATE
@@ -36,7 +36,7 @@ Lightning 需要以下权限:

## 如何校验导入的数据的正确性?

Lightning 默认会对导入数据计算校验和 (checksum),如果校验和不一致就会停止导入该表。可以在日志看到相关的信息。
TiDB Lightning 默认会对导入数据计算校验和 (checksum),如果校验和不一致就会停止导入该表。可以在日志看到相关的信息。

TiDB 也支持从 MySQL 命令行运行 `ADMIN CHECKSUM TABLE` 指令来计算校验和。

@@ -52,7 +52,7 @@ mysql> ADMIN CHECKSUM TABLE `schema`.`table`;

## TiDB Lightning 支持哪些格式的数据源?

到 v2.1.6 版本为止,只支持本地文档形式的数据源,支持 [mydumper](/reference/tools/mydumper.md) 或 [CSV](/reference/tools/tidb-lightning/csv.md) 格式。
到 v2.1.6 版本为止,只支持本地文档形式的数据源,支持 [Mydumper](/reference/tools/mydumper.md) 或 [CSV](/reference/tools/tidb-lightning/csv.md) 格式。

## 我已经在下游创建好库和表了,TiDB Lightning 可以忽略建库建表操作吗?

@@ -77,11 +77,11 @@ sql-mode = ""

## 如何正确关闭 `tikv-importer` 进程?

如使用 TiDB-Ansible 部署,在 Importer 的服务器上运行 `scripts/stop_importer.sh` 即可。否则,可通过 `ps aux | grep tikv-importer` 获取进程ID,然后 `kill «pid»`
如使用 TiDB Ansible 部署,在 Importer 的服务器上运行 `scripts/stop_importer.sh` 即可。否则,可通过 `ps aux | grep tikv-importer` 获取进程ID,然后 `kill «pid»`

## 如何正确关闭 `tidb-lightning` 进程?

如使用 TiDB-Ansible 部署,在 Lightning 的服务器上运行 `scripts/stop_lightning.sh` 即可。
如使用 TiDB Ansible 部署,在 Lightning 的服务器上运行 `scripts/stop_lightning.sh` 即可。

如果 `tidb-lightning` 正在前台运行,可直接按 <kbd>Ctrl</kbd>+<kbd>C</kbd> 退出。

@@ -107,11 +107,11 @@ tidb-lightning-ctl --switch-mode=normal

## TiDB Lightning 可以使用千兆网卡吗?

使用 TiDB-Lightning 必须配置万兆网卡。**不能使用**千兆网卡,尤其是在部署 `tikv-importer` 的机器上。千兆网卡的总带宽只有 120 MB/s,而且需要与整个 TiKV 集群共享。在使用 TiDB-Lightning 导入时,极易用尽所有带宽,继而因 PD 无法联络集群使集群断连。
使用 TiDB Lightning 必须配置万兆网卡。**不能使用**千兆网卡,尤其是在部署 `tikv-importer` 的机器上。千兆网卡的总带宽只有 120 MB/s,而且需要与整个 TiKV 集群共享。在使用 TiDB Lightning 导入时,极易用尽所有带宽,继而因 PD 无法联络集群使集群断连。

## 为什么 TiDB Lightning 需要在 TiKV 集群预留这么多空间?

当使用默认的 3 副本设置时,TiDB-Lightning 需要 TiKV 集群预留数据源大小 6 倍的空间。多出来的 2 倍是算上下列没储存在数据源的因素的保守估计:
当使用默认的 3 副本设置时,TiDB Lightning 需要 TiKV 集群预留数据源大小 6 倍的空间。多出来的 2 倍是算上下列没储存在数据源的因素的保守估计:

- 索引会占据额外的空间
- RocksDB 的空间放大效应
@@ -210,11 +210,11 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器

#### 2.2.1 Ansible 部署方式(强烈推荐)

详细可参考 [TiDB Ansible 部署方案](/how-to/deploy/orchestrated/ansible.md)。
详细可参考[使用 TiDB Ansible 部署 TiDB 集群](/how-to/deploy/orchestrated/ansible.md)。

##### 2.2.1.1 为什么修改了 TiKV/PD 的 toml 配置文件,却没有生效?

这种情况一般是因为没有使用 `--config` 参数来指定配置文件(目前只会出现在 binary 部署的场景),TiKV/PD 会按默认值来设置。如果要使用配置文件,请设置 TiKV/PD 的 `--config` 参数。对于 TiKV 组件,修改配置后重启服务即可;对于 PD 组件,只会在第一次启动时读取配置文件,之后可以使用 pd-ctl 的方式来修改配置,详情可参考 [这里](/reference/configuration/pd-server/configuration.md)。
这种情况一般是因为没有使用 `--config` 参数来指定配置文件(目前只会出现在 binary 部署的场景),TiKV/PD 会按默认值来设置。如果要使用配置文件,请设置 TiKV/PD 的 `--config` 参数。对于 TiKV 组件,修改配置后重启服务即可;对于 PD 组件,只会在第一次启动时读取配置文件,之后可以使用 pd-ctl 的方式来修改配置,详情可参考[这里](/reference/configuration/pd-server/configuration.md)。

##### 2.2.1.2 TiDB 监控框架 Prometheus + Grafana 监控机器建议单独还是多台部署?

@@ -235,7 +235,7 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器
| **变量** | **含义** |
| --- | --- |
| cluster_name | 集群名称,可调整 |
| tidb_version | TiDB 版本,TiDB-Ansible 各分支默认已配置 |
| tidb_version | TiDB 版本,TiDB Ansible 各分支默认已配置 |
| deployment_method | 部署方式,默认为 binary,可选 docker |
| process_supervision | 进程监管方式,默认为 systemd,可选 supervise |
| timezone | 修改部署目标机器时区,默认为 Asia/Shanghai, 可调整,与set_timezone 变量结合使用 |
@@ -395,9 +395,9 @@ TiDB 版本目前逐步标准化,每次 Release 都包含详细的 Change log
- `1` 表示该版本 commit 1 次
- `ga80e796` 代表版本的 `git-hash`

#### 3.1.11 分不清 TiDB master 版本之间的区别,经常用错 TiDB-Ansible 版本?
#### 3.1.11 分不清 TiDB master 版本之间的区别,经常用错 TiDB Ansible 版本?

TiDB 目前社区非常活跃,在 1.0 GA 版本发布后,还在不断的优化和修改 BUG,因此 TiDB 的版本更新周期比较快,会不定期有新版本发布,请关注我们的[新版本发布官方网站](https://pingcap.com/weekly/)。此外 TiDB 安装推荐使用 TiDB-Ansible 进行安装,TiDB-Ansible 的版本也会随着 TiDB 的版本发布进行更新,因此建议用户在安装升级新版本的时候使用最新的 TiDB-Ansible 安装包版本进行安装。此外,在 TiDB 1.0 GA 版本后,对 TiDB 的版本号进行了统一管理,TiDB 的版本可以通过以下两种方式进行查看:
TiDB 目前社区非常活跃,在 1.0 GA 版本发布后,还在不断的优化和修改 BUG,因此 TiDB 的版本更新周期比较快,会不定期有新版本发布,请关注我们的[新版本发布官方网站](https://pingcap.com/weekly/)。此外 TiDB 安装推荐使用 TiDB Ansible 进行安装,TiDB Ansible 的版本也会随着 TiDB 的版本发布进行更新,因此建议用户在安装升级新版本的时候使用最新的 TiDB Ansible 安装包版本进行安装。此外,在 TiDB 1.0 GA 版本后,对 TiDB 的版本号进行了统一管理,TiDB 的版本可以通过以下两种方式进行查看:

- 通过 `select tidb_version()` 进行查看
- 通过执行 `tidb-server -V` 进行查看
@@ -682,9 +682,9 @@ TiDB 设计的目标就是针对 MySQL 单台容量限制而被迫做的分库

#### 3.6.1 TiDB 主要备份方式?

目前,推荐的备份方式是使用 [PingCAP fork 的 mydumper](/reference/tools/mydumper.md)。尽管 TiDB 也支持使用 MySQL 官方工具 `mysqldump` 进行数据备份、恢复,但其性能低于 [`mydumper`](/reference/tools/mydumper.md)/[`loader`](/reference/tools/loader.md),并且该工具备份、恢复大量数量时,要耗费更多时间。
目前,推荐的备份方式是使用 [PingCAP fork 的 Mydumper](/reference/tools/mydumper.md)。尽管 TiDB 也支持使用 MySQL 官方工具 `mysqldump` 进行数据备份、恢复,但其性能低于 [`mydumper`](/reference/tools/mydumper.md)/[`loader`](/reference/tools/loader.md),并且该工具备份、恢复大量数量时,要耗费更多时间。

使用 mydumper 导出来的数据文件尽可能的小, 最好不要超过 64M, 可以设置参数 -F 64;
使用 Mydumper 导出来的数据文件尽可能的小, 最好不要超过 64M, 可以设置参数 -F 64;

loader 的 -t 参数可以根据 TiKV 的实例个数以及负载进行评估调整,例如 3 个 TiKV 的场景, 此值可以设为 3 * (1 ~ n),当 TiKV 负载过高,loader 以及 TiDB 日志中出现大量 `backoffer.maxSleep 15000ms is exceeded` 可以适当调小该值,当 TiKV 负载不是太高的时候,可以适当调大该值。

@@ -694,7 +694,7 @@ loader 的 -t 参数可以根据 TiKV 的实例个数以及负载进行评估调

#### 4.1.1 Mydumper

参见 [mydumper 使用文档](/reference/tools/mydumper.md)。
参见 [Mydumper 使用文档](/reference/tools/mydumper.md)。

#### 4.1.2 Loader

@@ -764,7 +764,7 @@ sqoop export \

- job_name: &#39;syncer_ops&#39; // 任务名字
static_configs:
- targets: [&#39;10.10.1.1:10096&#39;] //syncer监听地址与端口,通知 prometheus 拉取 syncer 的数据。
- targets: [&#39;10.10.1.1:10096&#39;] //Syncer 监听地址与端口,通知 prometheus 拉取 Syncer 的数据。

重启 Prometheus 即可。

@@ -782,7 +782,7 @@ sqoop export \

##### 4.2.1.6 使用 Syncer gtid 的方式同步时,同步过程中会不断更新 syncer.meta 文件,如果 Syncer 所在的机器坏了,导致 syncer.meta 文件所在的目录丢失,该如何处理?

当前 Syncer 版本的没有进行高可用设计,Syncer 目前的配置信息 syncer.meta 直接存储在硬盘上,其存储方式类似于其他 MySQL 生态工具,比如 mydumper。 因此,要解决这个问题当前可以有两个方法:
当前 Syncer 版本的没有进行高可用设计,Syncer 目前的配置信息 syncer.meta 直接存储在硬盘上,其存储方式类似于其他 MySQL 生态工具,比如 Mydumper。因此,要解决这个问题当前可以有两个方法:

1)把 syncer.meta 数据放到比较安全的磁盘上,例如磁盘做好 raid1;

@@ -1,13 +1,13 @@
---
title: TiDB-Ansible 部署方案
title: 使用 TiDB Ansible 部署 TiDB 集群
category: how-to
---

# TiDB-Ansible 部署方案
# 使用 TiDB Ansible 部署 TiDB 集群

## 概述

Ansible 是一款自动化运维工具,[TiDB-Ansible](https://github.com/pingcap/tidb-ansible) 是 PingCAP 基于 Ansible playbook 功能编写的集群部署工具。本文档介绍如何使用 TiDB-Ansible 部署一个完整的 TiDB 集群。
Ansible 是一款自动化运维工具,[TiDB Ansible](https://github.com/pingcap/tidb-ansible) 是 PingCAP 基于 Ansible playbook 功能编写的集群部署工具。本文档介绍如何使用 TiDB Ansible 部署一个完整的 TiDB 集群。

本部署工具可以通过配置文件设置集群拓扑,完成以下各项运维工作:

@@ -24,7 +24,7 @@ Ansible 是一款自动化运维工具,[TiDB-Ansible](https://github.com/pingc

> **注意:**
>
> 对于生产环境,须使用 TiDB-Ansible 部署 TiDB 集群。如果只是用于测试 TiDB 或体验 TiDB 的特性,建议[使用 Docker Compose 在单机上快速部署 TiDB 集群](/how-to/get-started/deploy-tidb-from-docker-compose.md)。
> 对于生产环境,须使用 TiDB Ansible 部署 TiDB 集群。如果只是用于测试 TiDB 或体验 TiDB 的特性,建议[使用 Docker Compose 在单机上快速部署 TiDB 集群](/how-to/get-started/deploy-tidb-from-docker-compose.md)。
## 准备机器

@@ -117,9 +117,9 @@ The key's randomart image is:
+----[SHA256]-----+
```

## 在中控机器上下载 TiDB-Ansible
## 在中控机器上下载 TiDB Ansible

`tidb` 用户登录中控机并进入 `/home/tidb` 目录。使用以下命令从 [TiDB-Ansible 项目](https://github.com/pingcap/tidb-ansible)上下载 master 分支的 TiDB-Ansible,默认的文件夹名称为 `tidb-ansible`
`tidb` 用户登录中控机并进入 `/home/tidb` 目录。使用以下命令从 [TiDB Ansible 项目](https://github.com/pingcap/tidb-ansible)上下载 master 分支的 TiDB Ansible,默认的文件夹名称为 `tidb-ansible`

```
$ git clone https://github.com/pingcap/tidb-ansible.git
@@ -478,7 +478,7 @@ TiKV1-1 ansible_host=172.16.10.4 deploy_dir=/data1/deploy
| 变量 | 含义 |
| --------------- | ---------------------------------------------------------- |
| cluster_name | 集群名称,可调整 |
| tidb_version | TiDB 版本,TiDB-Ansible 各分支默认已配置 |
| tidb_version | TiDB 版本,TiDB Ansible 各分支默认已配置 |
| process_supervision | 进程监管方式,默认为 systemd,可选 supervise |
| timezone | 新安装 TiDB 集群第一次启动 bootstrap(初始化)时,将 TiDB 全局默认时区设置为该值。TiDB 使用的时区后续可通过 `time_zone` 全局变量和 session 变量来修改,参考[时区支持](how-to/configure/time-zone.md)。 默认为 `Asia/Shanghai`,可选值参考 [timzone 列表](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)。 |
| enable_firewalld | 开启防火墙,默认不开启,如需开启,请将[部署建议-网络要求](/how-to/deploy/hardware-recommendations.md#网络要求) 中的端口加入白名单 |
@@ -1,15 +1,15 @@
---
title: 离线 TiDB-Ansible 部署方案
title: 离线 TiDB Ansible 部署方案
category: how-to
---

# 离线 TiDB-Ansible 部署方案
# 离线 TiDB Ansible 部署方案

## 准备机器

1. 下载机一台

- 该机器需开放外网访问,用于下载 TiDB-Ansible、TiDB 及相关软件安装包。
- 该机器需开放外网访问,用于下载 TiDB Ansible、TiDB 及相关软件安装包。
- 推荐安装 CentOS 7.3 及以上版本 Linux 操作系统。

2. 部署目标机器若干及部署中控机一台
@@ -65,7 +65,7 @@ category: how-to
ansible 2.5.0
```

## 在下载机上下载 TiDB-Ansible 及 TiDB 安装包
## 在下载机上下载 TiDB Ansible 及 TiDB 安装包

以下为 tidb-ansible 与 TiDB 的版本对应关系,版本选择可以咨询官方。

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

2. 下载 tidb-ansible

使用以下命令从 Github [TiDB-Ansible 项目](https://github.com/pingcap/tidb-ansible)上下载 TiDB-Ansible 相应版本,默认的文件夹名称为 `tidb-ansible`
使用以下命令从 Github [TiDB Ansible 项目](https://github.com/pingcap/tidb-ansible)上下载 TiDB Ansible 相应版本,默认的文件夹名称为 `tidb-ansible`

> **注意:**
>
@@ -122,7 +122,7 @@ Pump 和 Drainer 均可部署和运行在 Intel x86-64 架构的 64 位通用硬

**方式二**:从零开始部署含 Pump 组件的 TiDB 集群

使用 Ansible 部署 TiDB 集群,方法参考 [TiDB Ansible 部署方案](/how-to/deploy/orchestrated/ansible.md)。
使用 Ansible 部署 TiDB 集群,方法参考 [使用 TiDB Ansible 部署 TiDB 集群](/how-to/deploy/orchestrated/ansible.md)。

3. 查看 Pump 服务状态

@@ -5,13 +5,13 @@ category: how-to

# TiSpark 快速入门指南

为了让大家快速体验 [TiSpark](/reference/tispark.md),通过 TiDB-Ansible 安装的 TiDB 集群中默认已集成 Spark、TiSpark jar 包及 TiSpark sample data。
为了让大家快速体验 [TiSpark](/reference/tispark.md),通过 TiDB Ansible 安装的 TiDB 集群中默认已集成 Spark、TiSpark jar 包及 TiSpark sample data。

## 部署信息

- Spark 默认部署在 TiDB 实例部署目录下 spark 目录中
- TiSpark jar 包默认部署在 Spark 部署目录 jars 文件夹下:`spark/jars/tispark-${name_with_version}.jar`
- TiSpark sample data 及导入脚本默认部署在 TiDB-Ansible 目录下:`tidb-ansible/resources/bin/tispark-sample-data`
- TiSpark sample data 及导入脚本默认部署在 TiDB Ansible 目录下:`tidb-ansible/resources/bin/tispark-sample-data`

## 环境准备

@@ -1,9 +1,9 @@
---
title: TiDB-Ansible 常见运维操作
title: TiDB Ansible 常见运维操作
category: how-to
---

# TiDB-Ansible 常见运维操作
# TiDB Ansible 常见运维操作

## 启动集群

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

在这个备份恢复过程中,我们会用到下面的工具:

- mydumper 从 TiDB 导出数据
- Mydumper 从 TiDB 导出数据
- Loader 导入数据到 TiDB

## 下载 TiDB 工具集 (Linux)
@@ -60,17 +60,17 @@ cd tidb-enterprise-tools-latest-linux-amd64

为了快速地备份恢复数据 (特别是数据量巨大的库),可以参考以下建议:

* 使用 mydumper 导出来的数据文件尽可能的小,最好不要超过 64M,可以将参数 `-F` 设置为 64。
* 使用 Mydumper 导出来的数据文件尽可能的小,最好不要超过 64M,可以将参数 `-F` 设置为 64。
* Loader的 `-t` 参数可以根据 TiKV 的实例个数以及负载进行评估调整,例如 3 个 TiKV 实例的场景,此值可以设为 `3 *(1 ~ n)` 左右。当 TiKV 负载过高,Loader 以及 TiDB 日志中出现大量 `backoffer.maxSleep 15000ms is exceeded` 时,可以适当调小该值;当 TiKV 负载不是太高的时候,可以适当调大该值。

数据恢复示例及相关的配置:

- mydumper 导出后总数据量 214G,单表 8 列,20 亿行数据
- Mydumper 导出后总数据量 214G,单表 8 列,20 亿行数据
- 集群拓扑
- TIKV * 12
- TIDB * 4
- PD * 3
- mydumper `-F` 参数设置为 16,Loader `-t` 参数设置为 64
- Mydumper `-F` 参数设置为 16,Loader `-t` 参数设置为 64

结果:导入时间 11 小时左右,19.4 G/小时

@@ -108,7 +108,7 @@ mysql-instances:
source-id: "mysql-replica-01"
# 需要同步的库名或表名的黑白名单的配置项名称,用于引用全局的黑白名单配置,全局配置见下面的 `black-white-list` 的配置。
black-white-list: "global"
# mydumper 的配置项名称,用于引用全局的 mydumper 配置。
# Mydumper 的配置项名称,用于引用全局的 Mydumper 配置。
mydumper-config-name: "global"
-
@@ -123,10 +123,10 @@ black-white-list:
- db-name: "test_db" # 需要同步的表的库名。
tbl-name: "test_table" # 需要同步的表的名称。
# mydumper 全局配置,各实例通过配置项名引用。
# Mydumper 全局配置,各实例通过配置项名引用。
mydumpers:
global:
extra-args: "-B test_db -T test_table" # 只导出 `test_db` 库中的 `test_table` 表,可设置 mydumper 的任何参数。
extra-args: "-B test_db -T test_table" # 只导出 `test_db` 库中的 `test_table` 表,可设置 Mydumper 的任何参数。
```

## 第 5 步:启动任务

0 comments on commit aeb4c74

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