update deploy document (pingcap#3476)

* update deploy document * Update geo-distributed-deployment-topology.md * Update tiflash-deployment-topology.md * Update tidb-binlog-deployment-topology.md * Update ticdc-deployment-topology.md * Update hybrid-deployment-topology.md * Update production-deployment-using-tiup.md * Update TOC.md * Update quick-start-with-tidb.md * Update geo-distributed-deployment-topology.md Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> * Update minimal-deployment-topology.md Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> * Update production-deployment-using-tiup.md * Update ticdc-deployment-topology.md Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> * Update tidb-binlog-deployment-topology.md Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> * Update tiflash-deployment-topology.md Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>
shawn0915 · Jun 4, 2020 · 355d064 · 355d064
1 parent 06bf85a
commit 355d064
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 16 deletions.
diff --git a/TOC.md b/TOC.md
@@ -52,11 +52,12 @@
   + [从 SQL 文件迁移到 TiDB](/migrate-from-mysql-mydumper-files.md)
 + 运维操作
   + 升级 TiDB 版本
-    + [使用 TiUP](/upgrade-tidb-using-tiup.md)
+    + [使用 TiUP（推荐）](/upgrade-tidb-using-tiup.md)
     + [使用 TiDB Operator](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/upgrade-a-tidb-cluster/)
     + [使用 TiDB Ansible](/upgrade-tidb-using-ansible.md)
   + 扩缩容
-    + [使用 TiUP](/scale-tidb-using-tiup.md)
+    + [使用 TiUP（推荐）](/scale-tidb-using-tiup.md)
+    + [使用 TiDB Ansible](/scale-tidb-using-ansible.md)
     + [使用 TiDB Operator](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/scale-a-tidb-cluster/)
   + 备份与恢复
     + [使用 Mydumper 和 TiDB Lightning 进行备份与恢复](/backup-and-restore-using-mydumper-lightning.md)
@@ -66,8 +67,9 @@
       + [BR 备份与恢复场景示例](/br/backup-and-restore-use-cases.md)
   + [日常巡检](/daily-inspection.md)
   + [TiCDC 运维操作及任务管理](/ticdc/manage-ticdc.md)
-  + [TiUP 常用运维操作](/maintain-tidb-using-tiup.md)
   + [TiFlash 常用运维操作](/tiflash/maintain-tiflash.md)
+  + [TiUP 常用运维操作](/maintain-tidb-using-tiup.md)
+  + [Ansible 常用运维操作](/maintain-tidb-using-ansible.md)
 + 监控与告警
   + [监控框架概述](/tidb-monitoring-framework.md)
   + [监控 API](/tidb-monitoring-api.md)

diff --git a/geo-distributed-deployment-topology.md b/geo-distributed-deployment-topology.md
@@ -82,4 +82,5 @@ category: how-to
 
 > **注意：**
 >
-> 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在部署主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。
+> - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在目标主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。
+> - 如果部署目录配置为相对路径，会部署在用户家目录下。
diff --git a/hybrid-deployment-topology.md b/hybrid-deployment-topology.md
@@ -98,7 +98,6 @@ category: how-to
 > **注意：**
 >
 > - 编辑配置文件模版时，注意修改必要参数、IP、端口及目录。
->
 > - 各个组件的 deploy_dir，默认会使用 global 中的 `<deploy_dir>/<components_name>-<port>`。例如 tidb 端口指定 4001，则 deploy_dir 默认为 /tidb-deploy/tidb-4001。因此，在多实例场景下指定非默认端口时，无需再次指定目录。
->
 > - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在部署主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。
+> - 如果部署目录配置为相对路径，会部署在用户家目录下。
diff --git a/minimal-deployment-topology.md b/minimal-deployment-topology.md
@@ -25,4 +25,5 @@ category: how-to
 
 > **注意：**
 >
-> - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在部署主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。
+> - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在目标主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。
+> - 如果部署目录配置为相对路径，会部署在用户家目录下。
diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md
@@ -8,7 +8,7 @@ aliases: ['/docs-cn/dev/how-to/deploy/orchestrated/tiup/']
 
 [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。本文将介绍不同集群拓扑的具体部署步骤。
+目前 TiUP 可以支持部署 TiDB、TiFlash、TiDB Binlog、TiCDC，以及监控系统。本文将介绍不同集群拓扑的具体部署步骤。
 
 ## 第 1 步：软硬件环境需求及前置检查
 
@@ -186,4 +186,4 @@ tiup cluster display tidb-test
 mysql -u root -h 10.0.1.4 -P 4000
 ```
 
-更多方式可参考[验证集群运行状态](/post-installation-check.md)。
+此外，也需要验证监控系统、TiDB Dashboard 的运行状态，以及简单命令的执行，验证方式可参考[验证集群运行状态](/post-installation-check.md)。
diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md
@@ -67,10 +67,12 @@ TiDB-Wasm 是运行在浏览器中的 TiDB 数据库，打开网页即可使用
         {{< copyable "shell-regular" >}}
 
         ```shell
-        tiup playground v4.0.0-rc --db 2 --pd 3 --kv 3 --monitor
+        tiup playground v4.0.0 --db 2 --pd 3 --kv 3 --monitor
         ```
 
-        上述命令会在本地下载并启动一个 `v4.0.0-rc` 版本的集群，`--monitor` 表示同时部署监控组件。运行结果将显示集群的访问方式：
+        上述命令会在本地下载并启动一个 `v4.0.0` 版本的集群，`--monitor` 表示同时部署监控组件。
+        最新版本可以通过执行 `tiup list tidb` 来查看。
+        运行结果将显示集群的访问方式：
 
         ```log
         CLUSTER START SUCCESSFULLY, Enjoy it ^-^
@@ -159,7 +161,7 @@ TiDB-Wasm 是运行在浏览器中的 TiDB 数据库，打开网页即可使用
     {{< copyable "shell-regular" >}}
 
     ```shell
-    tiup update cluster
+    tiup update --self && tiup update cluster
     ```
 
 4. 由于模拟多机部署，需要通过 `root` 用户调大 sshd 服务的连接数限制：

diff --git a/ticdc-deployment-topology.md b/ticdc-deployment-topology.md
@@ -31,4 +31,5 @@ aliases: ['/docs-cn/dev/reference/tools/ticdc/deploy/','/docs-cn/dev/ticdc/deplo
 
 > **注意：**
 >
-> - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在部署主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。
+> - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在目标主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。
+> - 如果部署目录配置为相对路径，会部署在用户家目录下。
diff --git a/tidb-binlog-deployment-topology.md b/tidb-binlog-deployment-topology.md
@@ -39,5 +39,5 @@ category: how-to
 > **注意：**
 >
 > - 编辑配置文件模版时，如无需自定义端口或者目录，仅修改 IP 即可。 
->
-> - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在部署主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。
+> - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在目标主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。
+> - 如果部署目录配置为相对路径，会部署在用户家目录下。
diff --git a/tiflash-deployment-topology.md b/tiflash-deployment-topology.md
@@ -34,4 +34,5 @@ category: how-to
 
 > **注意：**
 >
-> 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在部署主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。
+> - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在目标主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。
+> - 如果部署目录配置为相对路径，会部署在用户家目录下。