tiup: refactor tiup reference (pingcap#4868)

* Prepare to change * Introduce reference * Add reference for tiup list and tiup uninstall * mirror WIP * Update * Add tiup mirror command * More document for mirror * Add doc * Update publish document * Update document for mirror * Finish the command section * Add topology reference for tiup-cluster * Document for dm cluster topology * Update * Finish dm * Finish dm * Address comment * Fix lint * Fix link * Fix lint * Remove unused aliases * Remove description title * Apply suggestions from code review Co-authored-by: King-Dylan <50897894+King-Dylan@users.noreply.github.com> Co-authored-by: kissmydb <likun@pingcap.com> * Apply suggestions from code review Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> * Address comment * Apply suggestions from code review Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update tiup/tiup-reference.md Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> * Address comment * Address comment * Update tiup-command-clean.md * fix a typo * Apply suggestions from code review Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> * Address comment * Address comment * Apply suggestions from code review Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> * Update tiup/tiup-mirror-reference.md Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> * Address comment * Apply suggestions from code review Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com> * Address comment * Apply suggestions from code review Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com> * refine format and remove control characters * correct spelling and format * Resolve comment * Apply suggestions from code review Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com> * Update tiup/tiup-command-completion.md Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> * Address comment * Fix link * Apply suggestions from code review Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> * Address comment * Fix link * Address comment * add links to tiup-cluster-topology-reference.md * fix links Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> Co-authored-by: King-Dylan <50897894+King-Dylan@users.noreply.github.com> Co-authored-by: kissmydb <likun@pingcap.com> Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> Co-authored-by: yikeke <yikeke@pingcap.com> Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com>
shawn0915 · Mar 1, 2021 · 687d2a4 · 687d2a4
1 parent 33be7cd
commit 687d2a4
Show file tree

Hide file tree

Showing 78 changed files with 4,087 additions and 22 deletions.
diff --git a/TOC.md b/TOC.md
@@ -493,12 +493,15 @@
       + [TiFlash 简介](/tiflash/tiflash-overview.md)
       + [使用 TiFlash](/tiflash/use-tiflash.md)
   + TiUP
-    + [文档指南](/tiup/tiup-documentation-guide.md)
+    + [文档地图](/tiup/tiup-documentation-guide.md)
     + [概览](/tiup/tiup-overview.md)
     + [术语及核心概念](/tiup/tiup-terminology-and-concepts.md)
     + [TiUP 组件管理](/tiup/tiup-component-management.md)
     + [FAQ](/tiup/tiup-faq.md)
     + [故障排查](/tiup/tiup-troubleshooting-guide.md)
+    + [参考手册](/tiup/tiup-reference.md)
+    + [TiDB 集群拓扑文件配置](/tiup/tiup-cluster-topology-reference.md)
+    + [TiUP 镜像参考指南](/tiup/tiup-mirror-reference.md)
     + TiUP 组件文档
       + [tiup-playground 运行本地测试集群](/tiup/tiup-playground.md)
       + [tiup-cluster 部署运维生产集群](/tiup/tiup-cluster.md)

diff --git a/geo-distributed-deployment-topology.md b/geo-distributed-deployment-topology.md
@@ -21,14 +21,16 @@ aliases: ['/docs-cn/dev/geo-distributed-deployment-topology/']
 
 [跨机房配置模板](https://github.com/pingcap/docs-cn/blob/master/config-templates/geo-redundancy-deployment.yaml)
 
+以上 TiDB 集群拓扑文件中，详细的配置项说明见[通过 TiUP 部署 TiDB 集群的拓扑文件配置](/tiup/tiup-cluster-topology-reference.md)。
+
 ### 关键参数配置
 
 本节介绍跨数据中心部署 TiDB 集群的关键参数配置。
 
 #### TiKV 参数
 
 - 设置 gRPC 的压缩格式，默认为 `none`。为提高跨机房部署场景的目标节点间 gRPC 包的传输速度，建议设置为 gzip 格式。
-    
+
     ```yaml
     server.grpc-compression-type: gzip
     ```

diff --git a/hybrid-deployment-topology.md b/hybrid-deployment-topology.md
@@ -23,6 +23,8 @@ aliases: ['/docs-cn/dev/hybrid-deployment-topology/']
 
 [详细混部配置模板](https://github.com/pingcap/docs-cn/blob/master/config-templates/complex-multi-instance.yaml)
 
+以上 TiDB 集群拓扑文件中，详细的配置项说明见[通过 TiUP 部署 TiDB 集群的拓扑文件配置](/tiup/tiup-cluster-topology-reference.md)。
+
 ### 混合部署的关键参数介绍
 
 本节介绍单机多实例的关键参数，主要用于 TiDB、TiKV 的单机多实例部署场景。你需要按照提供的计算公式，将结果填写至上一步的配置模板中。
@@ -32,7 +34,7 @@ aliases: ['/docs-cn/dev/hybrid-deployment-topology/']
     - readpool 线程池自适应，配置 `readpool.unified.max-thread-count` 参数可以使 `readpool.storage` 和 `readpool.coprocessor` 共用统一线程池，同时要分别设置自适应开关。
 
         - 开启 `readpool.storage` 和 `readpool.coprocessor`：
-          
+
             ```yaml
             readpool.storage.use-unified-pool: true
             readpool.coprocessor.use-unified-pool: true
@@ -51,7 +53,7 @@ aliases: ['/docs-cn/dev/hybrid-deployment-topology/']
             ```yaml
             storage.block-cache.shared: true
             ```
-     
+
         - 计算公式如下：
 
             ```
@@ -93,7 +95,7 @@ aliases: ['/docs-cn/dev/hybrid-deployment-topology/']
 
     - numa 绑核使用前，确认已经安装 numactl 工具，以及物理机对应的物理机 CPU 的信息后，再进行参数配置；
 
-    - `numa_node` 这个配置参数与 `numactl --membind` 配置对应。 
+    - `numa_node` 这个配置参数与 `numactl --membind` 配置对应。
 
 > **注意：**
 >

diff --git a/minimal-deployment-topology.md b/minimal-deployment-topology.md
@@ -23,6 +23,8 @@ aliases: ['/docs-cn/dev/minimal-deployment-topology/']
 
 [详细最小配置模板](https://github.com/pingcap/docs-cn/blob/master/config-templates/complex-mini.yaml)
 
+以上 TiDB 集群拓扑文件中，详细的配置项说明见[通过 TiUP 部署 TiDB 集群的拓扑文件配置](/tiup/tiup-cluster-topology-reference.md)。
+
 > **注意：**
 >
 > - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在目标主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。

diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md
@@ -5,7 +5,7 @@ aliases: ['/docs-cn/dev/production-deployment-using-tiup/','/docs-cn/dev/how-to/
 
 # 使用 TiUP 部署 TiDB 集群
 
-[TiUP](https://github.com/pingcap/tiup) 是 TiDB 4.0 版本引入的集群运维工具，[TiUP cluster](https://github.com/pingcap/tiup/tree/master/components/cluster) 是 TiUP 提供的使用 Golang 编写的集群管理组件，通过 TiUP cluster 组件就可以进行日常的运维工作，包括部署、启动、关闭、销毁、弹性扩缩容、升级 TiDB 集群；管理 TiDB 集群参数。
+[TiUP](https://github.com/pingcap/tiup) 是 TiDB 4.0 版本引入的集群运维工具，[TiUP cluster](https://github.com/pingcap/tiup/tree/master/components/cluster) 是 TiUP 提供的使用 Golang 编写的集群管理组件，通过 TiUP cluster 组件就可以进行日常的运维工作，包括部署、启动、关闭、销毁、弹性扩缩容、升级 TiDB 集群，以及管理 TiDB 集群参数。
 
 目前 TiUP 可以支持部署 TiDB、TiFlash、TiDB Binlog、TiCDC，以及监控系统。本文将介绍不同集群拓扑的具体部署步骤。
 

diff --git a/telemetry.md b/telemetry.md
@@ -6,7 +6,7 @@ aliases: ['/docs-cn/dev/telemetry/']
 
 # 遥测
 
-TiDB、TiUP 及 TiDB Dashboard 默认会收集使用情况信息，并将这些信息分享给 PingCAP 用于改善产品，例如，通过这些使用情况信息，PingCAP 可以了解常见的 TiDB 集群操作，从而确定新功能优先级。
+TiDB、TiUP 及 TiDB Dashboard 默认会收集使用情况信息，并将这些信息分享给 PingCAP 用于改善产品，例如，通过这些使用信息，PingCAP 可以了解常见的 TiDB 集群操作，从而确定新功能优先级。
 
 ## 哪些使用情况信息会被收集？
 
@@ -43,7 +43,7 @@ ADMIN SHOW TELEMETRY;
 
 ### TiUP
 
-当 TiUP 遥测功能开启时，执行 TiUP 命令时将会将使用情况信息分享给 PingCAP，包括（但不限于）：
+当 TiUP 遥测功能开启时，执行 TiUP 命令时会将使用情况信息分享给 PingCAP，包括（但不限于）：
 
 - 随机生成的遥测标示符
 - TiUP 命令的执行情况，如命令执行是否成功、命令执行耗时等

diff --git a/ticdc-deployment-topology.md b/ticdc-deployment-topology.md
@@ -28,6 +28,8 @@ aliases: ['/docs-cn/dev/ticdc-deployment-topology/','/docs-cn/dev/reference/tool
 
 [详细 TiCDC 配置模板](https://github.com/pingcap/docs-cn/blob/master/config-templates/complex-cdc.yaml)
 
+以上 TiDB 集群拓扑文件中，详细的配置项说明见[通过 TiUP 部署 TiDB 集群的拓扑文件配置](/tiup/tiup-cluster-topology-reference.md#cdc_servers)。
+
 > **注意：**
 >
 > - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在目标主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。

diff --git a/tidb-binlog-deployment-topology.md b/tidb-binlog-deployment-topology.md
@@ -26,6 +26,8 @@ aliases: ['/docs-cn/dev/tidb-binlog-deployment-topology/']
 
 [详细 TiDB Binlog 配置模板](https://github.com/pingcap/docs-cn/blob/master/config-templates/complex-tidb-binlog.yaml)
 
+以上 TiDB 集群拓扑文件中，详细的配置项说明见[通过 TiUP 部署 TiDB 集群的拓扑文件配置](/tiup/tiup-cluster-topology-reference.md)。
+
 ### 关键参数介绍
 
 拓扑配置模版的关键参数如下：

diff --git a/tiflash-deployment-topology.md b/tiflash-deployment-topology.md
@@ -24,6 +24,8 @@ aliases: ['/docs-cn/dev/tiflash-deployment-topology/']
 
 - [详细 TiFlash 配置模版](https://github.com/pingcap/docs-cn/blob/master/config-templates/complex-tiflash.yaml)
 
+以上 TiDB 集群拓扑文件中，详细的配置项说明见[通过 TiUP 部署 TiDB 集群的拓扑文件配置](/tiup/tiup-cluster-topology-reference.md#tiflash_servers)。
+
 ### 关键参数介绍
 
 - 需要将配置模板中 `replication.enable-placement-rules` 设置为 `true`，以开启 PD 的 [Placement Rules](/configure-placement-rules.md) 功能。
@@ -35,4 +37,4 @@ aliases: ['/docs-cn/dev/tiflash-deployment-topology/']
 > **注意：**
 >
 > - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在目标主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。
-> - 如果部署目录配置为相对路径，会部署在用户家目录下。
+> - 如果部署目录配置为相对路径，会部署在用户家目录下。
diff --git a/tispark-deployment-topology.md b/tispark-deployment-topology.md
@@ -30,6 +30,8 @@ aliases: ['/docs-cn/dev/tispark-deployment-topology/']
 
 [详细 TiSpark 配置模板](https://github.com/pingcap/docs-cn/blob/master/config-templates/complex-tispark.yaml)
 
+以上 TiDB 集群拓扑文件中，详细的配置项说明见[通过 TiUP 部署 TiDB 集群的拓扑文件配置](/tiup/tiup-cluster-topology-reference.md#tispark_masters)。
+
 > **注意：**
 >
 > - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在目标主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。