Recommended configuration of tidb software and hardware environment

TiDB As an open source distributed NewSQL database , It can be well deployed and run in Intel Architecture server environment 、ARM Architecture server environment and mainstream virtualization environment , And support most of the mainstream hardware network . As a high performance database system ,TiDB Support the mainstream Linux Operating system environment .

Linux Operating system version requirements

Linux operating system	edition
Red Hat Enterprise Linux	7.3 And above 7.x edition
CentOS	7.3 And above 7.x edition
Oracle Enterprise Linux	7.3 And above 7.x edition
Amazon Linux	2
Ubuntu LTS	16.04 And above

Be careful

• TiDB Only support Red Hat Compatible with kernel (RHCK) Of Oracle Enterprise Linux, I won't support it Oracle Enterprise Linux Provided Unbreakable Enterprise Kernel.
• TiDB stay CentOS 7.3 A lot of testing has been done in the environment of , At the same time, the community also has many best practices for the deployment of this operating system , therefore , It is recommended to use CentOS 7.3 The above 7.x Linux Operating system to deploy TiDB.
• above Linux The operating system can run on physical servers as well as VMware、KVM And XEN In the mainstream virtualization environment .
• Not yet Red Hat Enterprise Linux 8.0、CentOS 8 Stream and Oracle Enterprise Linux 8.0, Because the testing of these platforms is still in progress .
• Do not plan to support CentOS 8 Linux, because CentOS The upstream support of has been 2021 year 12 month 31 Day termination .
• TiDB Will no longer support Ubuntu 16.04. It is highly recommended to upgrade to Ubuntu 18.04 Or later .

other Linux Operating system version （ for example Debian Linux and Fedora Linux） Maybe it can run TiDB, But not yet TiDB Official support .

Software configuration requirements

Software configuration of central control computer

Software	edition
sshpass	1.06 And above
TiUP	1.5.0 And above

Be careful

The central computer needs to be deployed  TiUP Software To complete TiDB Cluster operation and maintenance management .

The target host is recommended to configure software

Software	edition
sshpass	1.06 And above
numa	2.0.12 And above
tar	arbitrarily

Server recommended configuration

TiDB Support deployment and running in Intel x86-64 Architecturally 64 Bit universal hardware server platform or ARM Architecture of the hardware server platform . For development 、 Server hardware configuration for test and production environment （ No operating system OS The occupation of itself ） There are the following requirements and suggestions ：

Development and test environment

Components	CPU	Memory	The local store	The Internet	Number of instances ( Minimum requirements )
TiDB	8 nucleus +	16 GB+	No special requirements	Gigabit nics	1（ But with PD With the machine ）
PD	4 nucleus +	8 GB+	SAS, 200 GB+	Gigabit nics	1（ But with TiDB With the machine ）
TiKV	8 nucleus +	32 GB+	SSD, 200 GB+	Gigabit nics	3
TiFlash	32 nucleus +	64 GB+	SSD, 200 GB+	Gigabit nics	1
TiCDC	8 nucleus +	16 GB+	SAS, 200 GB+	Gigabit nics	1

Be careful

• Verify TiDB and PD It can be deployed on the same server .
• Such as performance related testing , Avoid low performance storage and network hardware configuration , To prevent interference with the correctness of test results .
• TiKV Of SSD Disk is recommended NVME Interface to ensure faster reading and writing .
• If only the function is verified , It is recommended to use  TiDB Database Quick Start Guide Conduct single machine function test .
• TiDB The disk is mainly used to store logs , Therefore, there are no special requirements for disk type and capacity in the test environment .

Production environment

Components	CPU	Memory	Hard disk type	The Internet	Number of instances ( Minimum requirements )
TiDB	16 nucleus +	48 GB+	SAS	Wan Zhao nic （2 Pieces of the best ）	2
PD	8 nucleus +	16 GB+	SSD	Wan Zhao nic （2 Pieces of the best ）	3
TiKV	16 nucleus +	64 GB+	SSD	Wan Zhao nic （2 Pieces of the best ）	3
TiFlash	48 nucleus +	128 GB+	1 or more SSDs	Wan Zhao nic （2 Pieces of the best ）	2
TiCDC	16 nucleus +	64 GB+	SSD	Wan Zhao nic （2 Pieces of the best ）	2
monitor	8 nucleus +	16 GB+	SAS	Gigabit nics	1

Be careful

• In production environment TiDB and PD It can be deployed and run on the same server , Such as higher requirements for performance and reliability , It should be deployed as separately as possible .
• Higher configurations are highly recommended for production environments .
• TiKV Hard disk size configuration recommendations PCI-E SSD No more than 2 TB, Ordinary SSD No more than 1.5 TB.
• TiFlash Support Multi disk deployment .
• TiFlash High performance is recommended for the first disk of the data directory SSD To buffer TiKV Real time writing of synchronous data , The performance of the disc shall not be lower than TiKV Disks used , such as PCI-E SSD. And the disk capacity is recommended to be no less than 10%, Otherwise, it may become the bottleneck of the amount of data that this node can carry . Other disks can be deployed with multiple common disks according to requirements SSD, Of course, it's better PCI-E SSD Hard disk will bring better performance .
• TiFlash Recommend and TiKV Deployed on different nodes , If conditions are limited, you must TiFlash And TiKV Deployed on the same node , It needs to be appropriately increased CPU Cores and memory , And try to TiFlash And TiKV Deployed on different disks , So as not to interfere with each other .
• TiFlash The total capacity of the hard disk is approximately ： Whole TiKV The data capacity of the cluster to be synchronized / TiKV replications * TiFlash replications . For example, the whole TiKV The planned capacity is 1 TB、TiKV Replications for 3、TiFlash Replications for 2, be TiFlash The recommended total capacity of is  1024 GB / 3 * 2. Users can choose to synchronize some table data instead of all , The specific capacity can be analyzed according to the data volume of the table that needs to be synchronized .
• TiCDC Hard disk configuration recommendations 1 TB+ PCIE-SSD.

Network requirements

TiDB As an open source distributed system NewSQL database , Its normal operation requires the network environment to provide the following network port configuration requirements , According to the actual environment TiDB Component deployment scheme , Open related ports on the network side and the host side ：

Components	Default port	explain
TiDB	4000	Application and DBA The tool accesses the communication port
TiDB	10080	TiDB Status information reporting communication port
TiKV	20160	TiKV Communication port
TiKV	20180	TiKV Status information reporting communication port
PD	2379	Provide TiDB and PD Communication port
PD	2380	PD Communication port between cluster nodes
TiFlash	9000	TiFlash TCP Service port
TiFlash	8123	TiFlash HTTP Service port
TiFlash	3930	TiFlash RAFT Service and Coprocessor Service port
TiFlash	20170	TiFlash Proxy Service port
TiFlash	20292	Prometheus Pull TiFlash Proxy metrics port
TiFlash	8234	Prometheus Pull TiFlash metrics port
Pump	8250	Pump Communication port
Drainer	8249	Drainer Communication port
CDC	8300	CDC communication interface
Monitoring	9090	Prometheus Service communication port
Monitoring	20120	NgMonitoring Service communication port
Node_exporter	9100	TiDB The system information of each node of the cluster is reported to the communication port
Blackbox_exporter	9115	Blackbox_exporter Communication port , be used for TiDB Cluster port monitoring
Grafana	3000	Web Monitoring service external service and client ( browser ) Access port
Alertmanager	9093	The alarm web Service port
Alertmanager	9094	Alarm communication port

Disk space requirements

Components	Disk space requirements	Utilization rate of healthy water level
TiDB	It is recommended to reserve the log disk at least 30 GB	lower than 90%
PD	It is recommended to reserve data disk and log disk at least 20 GB	lower than 90%
TiKV	It is recommended to reserve data disk and log disk at least 100 GB	lower than 80%
TiFlash	It is recommended to reserve at least 100 GB, It is recommended to reserve the log disk at least 30 GB	lower than 80%
TiUP	Central computer ： Deploy a version of TiDB The cluster occupies no more than 1 GB Space , The space occupied by deploying multiple version clusters will increase accordingly Deployment server （ Actual operation TiDB Machine of each component ）：TiFlash Take up about 700 MB Space , Other components （PD、TiDB、TiKV etc. ） Each occupies about 200 MB Space . meanwhile , The deployment process will take less than 1 MB Temporary space （/tmp） Storage of temporary documents	Don't involve
Ngmonitoring	Conprof：3 x 1 GB x Number of components （ It means that each component occupies about 1 GB, in total 3 God ） + 20 GB Reserve space Top SQL：30 x 50 MB x Number of components （ Each component takes up about 50 MB, in total 30 God ） Top SQL and Conprof Share reserved space	Don't involve

client Web Browser requirements

TiDB Provides the basis for  Grafana  Technology platform , Visualize the indicators of the database cluster . Adopt support Javascript Microsoft IE、Google Chrome、Mozilla Firefox The newer version of can access the monitoring portal .