cherry pick pingcap#2730 to release-4.0

ran-huang · sre-bot · commit 89c9b2534b67 · 2020-06-08T19:27:19.000+08:00
Signed-off-by: sre-bot &lt;sre-bot@pingcap.com&gt;
diff --git a/geo-distributed-deployment-topology.md b/geo-distributed-deployment-topology.md
@@ -84,4 +84,5 @@ This section describes the key parameter configuration of the TiDB geo-distribut
 
 > **Note:**
 >
-> You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
+> - You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
+> - If you configure the deployment directory as a relative path, the cluster will be deployed in the home directory of the user.
diff --git a/hardware-and-software-requirements.md b/hardware-and-software-requirements.md
@@ -55,7 +55,7 @@ You can deploy and run TiDB on the 64-bit generic hardware server platform in th
 | TiDB    | 8 core+   | 16 GB+  | No special requirements | Gigabit network card | 1 (can be deployed on the same machine with PD)      |
 | PD      | 4 core+   | 8 GB+  | SAS, 200 GB+ | Gigabit network card | 1 (can be deployed on the same machine with TiDB)       |
 | TiKV    | 8 core+   | 32 GB+  | SAS, 200 GB+ | Gigabit network card | 3       |
-|         |         |         |              | Total Server Number |  4      |
+| TiFlash | 32 core+  | 64 GB+  | SSD, 200 GB+ | Gigabit network card | 1     |
 
 > **Note:**
 >
@@ -72,15 +72,22 @@ You can deploy and run TiDB on the 64-bit generic hardware server platform in th
 |  TiDB  | 16 core+ | 32 GB+ | SAS | 10 Gigabit network card (2 preferred) | 2 |
 | PD | 4 core+ | 8 GB+ | SSD | 10 Gigabit network card (2 preferred) | 3 |
 | TiKV | 16 core+ | 32 GB+ | SSD | 10 Gigabit network card (2 preferred) | 3 |
+| TiFlash | 48 core+ | 128 GB+ | 1 or more SSDs | 10 Gigabit network card (2 preferred) | 2 |
 | Monitor | 8 core+ | 16 GB+ | SAS | Gigabit network card | 1 |
-|     |     |     |      |  Total Server Number   |    9   |
 
 > **Note:**
 >
 > - In the production environment, the TiDB and PD instances can be deployed on the same server. If you have a higher requirement for performance and reliability, try to deploy them separately.
 > - It is strongly recommended to use higher configuration in the production environment.
 > - It is recommended to keep the size of TiKV hard disk within 2 TB if you are using PCIe SSDs or within 1.5 TB if you are using regular SSDs.
 
+Before you deploy TiFlash, note the following items:
+
+- TiFlash can be [deployed on multiple disks](/tiflash/tiflash-configuration.md#multi-disk-deployment), so you do not have to use RAID.
+- It is recommended to use a high-performance SSD as the first disk of the TiFlash data directory to buffer the real-time replication of TiKV data. The performance of this disk should not be lower than that of TiKV, such as PCI-E SSD. The disk capacity should be no less than 10% of the total capacity; otherwise, it might become the bottleneck of this node. You can deploy ordinary SSDs for other disks, but note that a better PCI-E SSD brings better performance. 
+- It is recommended to deploy TiFlash on different nodes from TiKV. If you must deploy TiFlash and TiKV on the same node, increase the number of CPU cores and memory, and try to deploy TiFlash and TiKV on different disks to avoid interfering each other.
+- The total capacity of the TiFlash disks is calculated in this way: `the data volume of the entire TiKV cluster to be replicated / the number of TiKV replicas * the number of TiFlash replicas`. For example, if the overall planned capacity of TiKV is 1 TB, the number of TiKV replicas is 3, and the number of TiFlash replicas is 2, then the recommended total capacity of TiFlash is `1024 GB / 3 * 2`. You can replicate only the data of some tables. In such case, determine the TiFlash capacity according to the data volume of the tables to be replicated.
+
 ## Network requirements
 
 As an open source distributed NewSQL database, TiDB requires the following network port configuration to run. Based on the TiDB deployment in actual environments, the administrator can open relevant ports in the network side and host side.
diff --git a/hybrid-deployment-topology.md b/hybrid-deployment-topology.md
@@ -103,3 +103,4 @@ This section introduces the key parameters when you deploy multiple instances on
 > - When editing the configuration file template, modify the required parameter, IP, port, and directory.
 > - Each component uses the global `<deploy_dir>/<components_name>-<port>` as their `deploy_dir` by default. For example, if TiDB specifies the `4001` port, its `deploy_dir` is `/tidb-deploy/tidb-4001` by default. Therefore, in multi-instance scenarios, when specifying a non-default port, you do not need to specify the directory again.
 > - You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
+> - If you configure the deployment directory as a relative path, the cluster will be deployed in the home directory of the user.
diff --git a/minimal-deployment-topology.md b/minimal-deployment-topology.md
@@ -24,4 +24,5 @@ This document describes the minimal deployment topology of TiDB clusters.
 
 > **Note:**
 >
-> You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
+> - You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
+> - If you configure the deployment directory as a relative path, the cluster will be deployed in the home directory of the user.
diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md
@@ -9,7 +9,7 @@ aliases: ['/docs/stable/how-to/deploy/orchestrated/tiup/']
 
 [TiUP](https://github.com/pingcap/tiup) is a cluster operation and maintenance tool introduced in TiDB 4.0. TiUP provides [TiUP cluster](https://github.com/pingcap/tiup/tree/master/components/cluster), a cluster management component written in Golang. By using TiUP cluster, you can easily perform daily database operations, including deploying, starting, stopping, destroying, scaling, and upgrading a TiDB cluster, and manage TiDB cluster parameters.
 
-TiUP supports deploying TiDB, TiFlash, TiDB Binlog, TiCDC, and monitoring system. This document introduces how to deploy TiDB clusters of different topologies.
+TiUP supports deploying TiDB, TiFlash, TiDB Binlog, TiCDC, and the monitoring system. This document introduces how to deploy TiDB clusters of different topologies.
 
 ## Step 1: Prerequisites and precheck
 
@@ -191,3 +191,16 @@ If the output log includes ```Started cluster `tidb-test` successfully```, the s
     ```
 
 In addition, you also need to verify the status of the monitoring system, TiDB Dashboard, and the execution of simple SQL commands. For the specific operations, see [Verify Cluster Status](/post-installation-check.md).
+
+## What's next
+
+If you have deployed [TiFlash](/tiflash/tiflash-overview.md) along with the TiDB cluster, see the following documents:
+
+- [Use TiFlash](/tiflash/use-tiflash.md)
+- [Maintain a TiFlash Cluster](/tiflash/maintain-tiflash.md)
+- [TiFlash Alert Rules and Solutions](/tiflash/tiflash-alert-rules.md)
+- [Troubleshoot TiFlash](/tiflash/troubleshoot-tiflash.md)
+
+If you have deployed [TiCDC](/ticdc/ticdc-overview.md) along with the TiDB cluster, see the following documents:
+
+- [Manage TiCDC Cluster and Replication Tasks](/ticdc/manage-ticdc.md)
diff --git a/ticdc-deployment-topology.md b/ticdc-deployment-topology.md
@@ -31,4 +31,5 @@ TiCDC is a tool for replicating the incremental data of TiDB, introduced in TiDB
 
 > **Note:**
 >
-> You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
+> - You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
+> - If you configure the deployment directory as a relative path, the cluster will be deployed in the home directory of the user.
diff --git a/tidb-binlog-deployment-topology.md b/tidb-binlog-deployment-topology.md
@@ -44,3 +44,4 @@ The key parameters in the topology configuration templates are as follows:
 >
 > - When editing the configuration file template, if you do not need custom ports or directories, modify the IP only.
 > - You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
+> - If you configure the deployment directory as a relative path, the cluster will be deployed in the home directory of the user.
diff --git a/tiflash-deployment-topology.md b/tiflash-deployment-topology.md
@@ -33,4 +33,5 @@ TiFlash is a columnar storage engine, and gradually becomes the standard cluster
 
 > **Note:**
 >
-> You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
+> - You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
+> - If you configure the deployment directory as a relative path, the cluster will be deployed in the home directory of the user.

Original file line number	Diff line number	Diff line change
`@@ -84,4 +84,5 @@ This section describes the key parameter configuration of the TiDB geo-distribut`
`84`	`84`
`85`	`85`	`> Note:`
`86`	`86`	`>`
`87`		-> You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
	`87`	+> - You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
	`88`	`+> - If you configure the deployment directory as a relative path, the cluster will be deployed in the home directory of the user.`
Original file line number	Diff line number	Diff line change
`@@ -24,4 +24,5 @@ This document describes the minimal deployment topology of TiDB clusters.`
`24`	`24`
`25`	`25`	`> Note:`
`26`	`26`	`>`
`27`		-> You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
	`27`	+> - You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
	`28`	`+> - If you configure the deployment directory as a relative path, the cluster will be deployed in the home directory of the user.`
Original file line number	Diff line number	Diff line change
`@@ -31,4 +31,5 @@ TiCDC is a tool for replicating the incremental data of TiDB, introduced in TiDB`
`31`	`31`
`32`	`32`	`> Note:`
`33`	`33`	`>`
`34`		-> You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
	`34`	+> - You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
	`35`	`+> - If you configure the deployment directory as a relative path, the cluster will be deployed in the home directory of the user.`
Original file line number	Diff line number	Diff line change
`@@ -44,3 +44,4 @@ The key parameters in the topology configuration templates are as follows:`
`44`	`44`	`>`
`45`	`45`	`> - When editing the configuration file template, if you do not need custom ports or directories, modify the IP only.`
`46`	`46`	> - You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
	`47`	`+> - If you configure the deployment directory as a relative path, the cluster will be deployed in the home directory of the user.`
Original file line number	Diff line number	Diff line change
`@@ -33,4 +33,5 @@ TiFlash is a columnar storage engine, and gradually becomes the standard cluster`
`33`	`33`
`34`	`34`	`> Note:`
`35`	`35`	`>`
`36`		-> You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
	`36`	+> - You do not need to manually create the `tidb` user in the configuration file. The TiUP cluster component automatically creates the `tidb` user on the target machines. You can customize the user, or keep the user consistent with the control machine.
	`37`	`+> - If you configure the deployment directory as a relative path, the cluster will be deployed in the home directory of the user.`