Skip to content

hardware-and-software-requirements: add tiproxy #21840

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+17 −15
Open

hardware-and-software-requirements: add tiproxy #21840

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 17 additions & 15 deletions hardware-and-software-requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,13 +148,14 @@ You can deploy and run TiDB on the 64-bit generic hardware server platform in th

### Development and test environments

| Component | CPU | Memory | Local Storage | Network | Number of Instances (Minimum Requirement) |
| :------: | :-----: | :-----: | :----------: | :------: | :----------------: |
| TiDB | 8 core+ | 16 GB+ | [Storage requirements](#storage-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 |
| TiFlash | 32 core+ | 64 GB+ | SSD, 200 GB+ | Gigabit network card | 1 |
| TiCDC | 8 core+ | 16 GB+ | SAS, 200 GB+ | Gigabit network card | 1 |
| Component | CPU | Memory | Local Storage | Network | Number of Instances (Minimum Requirement) |
| :-------: | :-------: | :----: | :------------: | :------: | :----------------: |
| TiDB | 8 core+ | 16 GB+ | [Storage requirements](#storage-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 |
| TiFlash | 32 core+ | 64 GB+ | SSD, 200 GB+ | Gigabit network card | 1 |
| TiCDC | 8 core+ | 16 GB+ | SAS, 200 GB+ | Gigabit network card | 1 |
| TiProxy | 4 core+ | 8 GB+ | SAS | Gigabit network card | 1 |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

For consistency with other components in the table, consider specifying a minimum storage size. Since TiProxy is a stateless proxy, its storage is mainly for logs and binaries. A size such as 30 GB+ would be appropriate for development and test environments, similar to TiDB's log disk requirement.

Suggested change
| TiProxy | 4 core+ | 8 GB+ | SAS | Gigabit network card | 1 |
| TiProxy | 4 core+ | 8 GB+ | SAS, 30 GB+ | Gigabit network card | 1 |


> **Note:**
>
Expand All @@ -166,14 +167,15 @@ You can deploy and run TiDB on the 64-bit generic hardware server platform in th

### Production environment

| Component | CPU | Memory | Hard Disk Type | Network | Number of Instances (Minimum Requirement) |
| :-----: | :------: | :------: | :------: | :------: | :-----: |
| TiDB | 16 core+ | 48 GB+ | SSD | 10 Gigabit network card (2 preferred) | 2 |
| PD | 8 core+ | 16 GB+ | SSD | 10 Gigabit network card (2 preferred) | 3 |
| TiKV | 16 core+ | 64 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 |
| TiCDC | 16 core+ | 64 GB+ | SSD | 10 Gigabit network card (2 preferred) | 2 |
| Monitor | 8 core+ | 16 GB+ | SAS | Gigabit network card | 1 |
| Component | CPU | Memory | Hard Disk Type | Network | Number of Instances (Minimum Requirement) |
| :-------: | :------: | :------: | :------: | :------: | :-----: |
| TiDB | 16 core+ | 48 GB+ | SSD | 10 Gigabit network card (2 preferred) | 2 |
| PD | 8 core+ | 16 GB+ | SSD | 10 Gigabit network card (2 preferred) | 3 |
| TiKV | 16 core+ | 64 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 |
| TiCDC | 16 core+ | 64 GB+ | SSD | 10 Gigabit network card (2 preferred) | 2 |
| Monitor | 8 core+ | 16 GB+ | SAS | Gigabit network card | 1 |
| TiProxy | 8 core+ | 16 GB+ | SAS | 10 Gigabit network card (2 preferred) | 2 |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

For consistency with other components in this table, consider specifying a storage size for TiProxy. For a production environment, a size like 100 GB+ would be a safe recommendation to account for logs and potential traffic capture files.

Suggested change
| TiProxy | 8 core+ | 16 GB+ | SAS | 10 Gigabit network card (2 preferred) | 2 |
| TiProxy | 8 core+ | 16 GB+ | SAS, 100 GB+ | 10 Gigabit network card (2 preferred) | 2 |


> **Note:**
>
Expand Down