From 43082f9061165520964d139bf2c02803111bfba5 Mon Sep 17 00:00:00 2001 From: Ran Date: Tue, 2 Jun 2020 13:32:08 +0800 Subject: [PATCH 1/5] how-to: update hardware-and-sofware-requirements --- hardware-and-software-requirements.md | 37 +++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/hardware-and-software-requirements.md b/hardware-and-software-requirements.md index c1f1eac28e51e..da89bdc8a6664 100644 --- a/hardware-and-software-requirements.md +++ b/hardware-and-software-requirements.md @@ -9,7 +9,7 @@ aliases: ['/docs/dev/how-to/deploy/hardware-recommendations/'] ## About -As an open source distributed NewSQL database with high performance, TiDB can be deployed in the Intel architecture server and major virtualization environments and runs well. TiDB supports most of the major hardware networks and Linux operating systems. +As an open source distributed NewSQL database with high performance, TiDB can be deployed in the Intel architecture server, ARM architecture server, and major virtualization environments and runs well. TiDB supports most of the major hardware networks and Linux operating systems. ## Linux OS version requirements @@ -26,9 +26,29 @@ As an open source distributed NewSQL database with high performance, TiDB can be > - A large number of TiDB tests have been run on the CentOS 7.3 system, and in our community there are a lot of best practices in which TiDB is deployed on the Linux operating system. Therefore, it is recommended to deploy TiDB on CentOS 7.3 or later. > - The support for the Linux operating systems above includes the deployment and operation in physical servers as well as in major virtualized environments like VMware, KVM and XEN. +## Software recommendations + +### Control Machine + +| Software | Version | +| :--- | :--- | +| sshpass | 1.06 or later | +| TiUP | 0.6.2 or later | + +> **Note:** +> +> [Deploy TiUP](/tiup/tiup-cluster.md) on the Control Machine to operate and manage TiDB clusters. + +### Target machines + +| Software | Version | +| :--- | :--- | +| sshpass | 1.06 or later | +| numa | 2.0.12 or later | + ## Server recommendations -You can deploy and run TiDB on the 64-bit generic hardware server platform in the Intel x86-64 architecture. The requirements and recommendations about server hardware configuration (ignoring the resources occupied by the operating system itself) for development, test, and production environments are as follows: +You can deploy and run TiDB on the 64-bit generic hardware server platform in the Intel x86-64 architecture or the hardware server platform in the ARM architecture. The requirements and recommendations about server hardware configuration (ignoring the resources occupied by the operating system itself) for development, test, and production environments are as follows: ### Development and test environments @@ -44,6 +64,7 @@ You can deploy and run TiDB on the 64-bit generic hardware server platform in th > - In the test environment, the TiDB and PD instances can be deployed on the same server. > - For performance-related test, do not use low-performance storage and network hardware configuration, in order to guarantee the correctness of the test result. > - For the TiKV server, it is recommended to use NVMe SSDs to ensure faster reads and writes. +> - If you only want to verify the features, follow [Quick Start Guide for TiDB](/quick-start-with-tidb.md) to deploy TiDB and test the features on a single machine. > - The TiDB server uses the disk to store server logs, so there are no special requirements for the disk type and capacity in the test environment. ### Production environment @@ -73,15 +94,21 @@ As an open source distributed NewSQL database, TiDB requires the following netwo | TiKV | 20160 | the TiKV communication port | | PD | 2379 | the communication port between TiDB and PD | | PD | 2380 | the inter-node communication port within the PD cluster | +| TiFlash | 9000 | the TiFlash TCP service port | +| TiFlash | 8123 | the TiFlash HTTP service port | +| TiFlash | 3930 | the TiFlash RAFT and Coprocessor service port | +| TiFlash | 20170 |the TiFlash Proxy service port | +| TiFlash | 20292 | the port for Prometheus to pull TiFlash Proxy metrics | +| TiFlash | 8234 | the port for Prometheus to pull TiFlash metrics | | Pump | 8250 | the Pump communication port | | Drainer | 8249 | the Drainer communication port | +| TiCDC | 8300 | the TiCDC communication port | | Prometheus | 9090 | the communication port for the Prometheus service| -| Pushgateway | 9091 | the aggregation and report port for tikv-importer | | Node_exporter | 9100 | the communication port to report the system information of every TiDB cluster node | | Blackbox_exporter | 9115 | the Blackbox_exporter communication port, used to monitor the ports in the TiDB cluster | | Grafana | 3000 | the port for the external Web monitoring service and client (Browser) access| -| Grafana | 8686 | the grafana_collector communication port, used to export the Dashboard as the PDF format | -| Kafka_exporter | 9308 | the Kafka_exporter communication port, used to monitor the binlog Kafka cluster | +| Alertmanager | 9093 | the port for the alert web service | +| Alertmanager | 9094 | the alert communication port | ## Web browser requirements From 60f62de666600bd945632180778d15edc0f72941 Mon Sep 17 00:00:00 2001 From: yikeke Date: Tue, 2 Jun 2020 16:00:39 +0800 Subject: [PATCH 2/5] Update TOC.md --- TOC.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TOC.md b/TOC.md index d5d19f4cb2530..f4bf5740b5643 100644 --- a/TOC.md +++ b/TOC.md @@ -50,7 +50,7 @@ - [TiDB Lightning Tutorial](/get-started-with-tidb-lightning.md) - [TiSpark Quick Start Guide](/get-started-with-tispark.md) + Deploy - - [Hardware Recommendations](/hardware-and-software-requirements.md) + - [Software and Hardware Requirements](/hardware-and-software-requirements.md) + From Binary Tarball - [For Testing Environments](/test-deployment-from-binary-tarball.md) - [For Production Environments](/production-deployment-from-binary-tarball.md) From 1fc822bc8348d20e91ef69d7c8b0e0d3a309baa6 Mon Sep 17 00:00:00 2001 From: Ran Date: Tue, 2 Jun 2020 16:07:29 +0800 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> --- hardware-and-software-requirements.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/hardware-and-software-requirements.md b/hardware-and-software-requirements.md index da89bdc8a6664..c31f9fde344b7 100644 --- a/hardware-and-software-requirements.md +++ b/hardware-and-software-requirements.md @@ -7,8 +7,6 @@ aliases: ['/docs/dev/how-to/deploy/hardware-recommendations/'] # Software and Hardware Recommendations -## About - As an open source distributed NewSQL database with high performance, TiDB can be deployed in the Intel architecture server, ARM architecture server, and major virtualization environments and runs well. TiDB supports most of the major hardware networks and Linux operating systems. ## Linux OS version requirements @@ -37,7 +35,7 @@ As an open source distributed NewSQL database with high performance, TiDB can be > **Note:** > -> [Deploy TiUP](/tiup/tiup-cluster.md) on the Control Machine to operate and manage TiDB clusters. +> It is required that you [deploy TiUP](/tiup/tiup-cluster.md) on the Control Machine to operate and manage TiDB clusters. ### Target machines @@ -48,7 +46,7 @@ As an open source distributed NewSQL database with high performance, TiDB can be ## Server recommendations -You can deploy and run TiDB on the 64-bit generic hardware server platform in the Intel x86-64 architecture or the hardware server platform in the ARM architecture. The requirements and recommendations about server hardware configuration (ignoring the resources occupied by the operating system itself) for development, test, and production environments are as follows: +You can deploy and run TiDB on the 64-bit generic hardware server platform in the Intel x86-64 architecture or on the hardware server platform in the ARM architecture. The requirements and recommendations about server hardware configuration (ignoring the resources occupied by the operating system itself) for development, test, and production environments are as follows: ### Development and test environments @@ -64,7 +62,7 @@ You can deploy and run TiDB on the 64-bit generic hardware server platform in th > - In the test environment, the TiDB and PD instances can be deployed on the same server. > - For performance-related test, do not use low-performance storage and network hardware configuration, in order to guarantee the correctness of the test result. > - For the TiKV server, it is recommended to use NVMe SSDs to ensure faster reads and writes. -> - If you only want to verify the features, follow [Quick Start Guide for TiDB](/quick-start-with-tidb.md) to deploy TiDB and test the features on a single machine. +> - If you only want to test and verify the features, follow [Quick Start Guide for TiDB](/quick-start-with-tidb.md) to deploy TiDB on a single machine. > - The TiDB server uses the disk to store server logs, so there are no special requirements for the disk type and capacity in the test environment. ### Production environment From eaf501a95af39edd17c4aac48c7d8948f62a5ebd Mon Sep 17 00:00:00 2001 From: Ran Date: Tue, 2 Jun 2020 18:29:21 +0800 Subject: [PATCH 4/5] Update hardware-and-software-requirements.md Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> --- hardware-and-software-requirements.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/hardware-and-software-requirements.md b/hardware-and-software-requirements.md index c31f9fde344b7..ea33740340905 100644 --- a/hardware-and-software-requirements.md +++ b/hardware-and-software-requirements.md @@ -35,7 +35,7 @@ As an open source distributed NewSQL database with high performance, TiDB can be > **Note:** > -> It is required that you [deploy TiUP](/tiup/tiup-cluster.md) on the Control Machine to operate and manage TiDB clusters. +> It is required that you [deploy TiUP on the Control Machine](/tiup/tiup-documentation-guide.md) to operate and manage TiDB clusters. ### Target machines From ede064d49e66c449280a4ea50011eac4df4f1fde Mon Sep 17 00:00:00 2001 From: Ran Date: Tue, 2 Jun 2020 18:34:34 +0800 Subject: [PATCH 5/5] Update hardware-and-software-requirements.md --- hardware-and-software-requirements.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/hardware-and-software-requirements.md b/hardware-and-software-requirements.md index ea33740340905..8d3c05b4a2373 100644 --- a/hardware-and-software-requirements.md +++ b/hardware-and-software-requirements.md @@ -35,7 +35,7 @@ As an open source distributed NewSQL database with high performance, TiDB can be > **Note:** > -> It is required that you [deploy TiUP on the Control Machine](/tiup/tiup-documentation-guide.md) to operate and manage TiDB clusters. +> It is required that you deploy TiUP on the Control Machine to operate and manage TiDB clusters. ### Target machines