Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
39 changes: 32 additions & 7 deletions hardware-and-software-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ 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 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

Expand All @@ -26,9 +24,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:**
>
> It is required that you deploy TiUP 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 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

Expand All @@ -44,6 +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 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
Expand Down Expand Up @@ -73,15 +92,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

Expand Down