Skip to content

hardware-and-software-requirements: Add note about supported filesystems (#21379) #21391

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

Merged
merged 4 commits into from
Jul 15, 2025
Merged

hardware-and-software-requirements: Add note about supported filesystems (#21379) #21391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7973603
hardware-and-software-requirements: Add note about supported filesystems
dveeden Jul 11, 2025
88a9eb2
Add redhat blog to lycheeignore
dveeden Jul 11, 2025
c4e1c6a
Update hardware-and-software-requirements.md
dveeden Jul 14, 2025
c1a34f1
fix a broken link
qiancai Jul 14, 2025
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
1 change: 1 addition & 0 deletions .lycheeignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,4 @@ https://dash\.cloudflare\.com/.*
https://centminmod\.com/mydumper\.html
https://docs\.pingcap\.com/tidb/v6\.6/system-variables#tidb_pessimistic_txn_aggressive_locking-new-in-v660
https://docs\.pingcap\.com/tidb/v7\.6/system-variables#tidb_ddl_version-new-in-v760
https://developers\.redhat\.com/blog/2021/01/05/building-red-hat-enterprise-linux-9-for-the-x86-64-v2-microarchitecture-level
6 changes: 4 additions & 2 deletions hardware-and-software-requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ You can deploy and run TiDB on the 64-bit generic hardware server platform in th

| Component | CPU | Memory | Local Storage | Network | Number of Instances (Minimum Requirement) |
| :------: | :-----: | :-----: | :----------: | :------: | :----------------: |
| TiDB | 8 core+ | 16 GB+ | [Disk space requirements](#disk-space-requirements) | Gigabit network card | 1 (can be deployed on the same machine with PD) |
| 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 |
Expand Down Expand Up @@ -248,7 +248,7 @@ As an open-source distributed SQL database, TiDB requires the following network
| Alertmanager | 9093 | the port for the alert web service |
| Alertmanager | 9094 | the alert communication port |

## Disk space requirements
## Storage requirements

<table>
<thead>
Expand Down Expand Up @@ -292,6 +292,8 @@ As an open-source distributed SQL database, TiDB requires the following network
</tbody>
</table>

TiDB supports the XFS and Ext4 file systems. Other file systems are not recommended for production environments.
Copy link

Choose a reason for hiding this comment

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

low

This sentence is clear, but has a couple of minor issues:

  • There are two trailing spaces at the end of the line. These are used for hard line breaks in Markdown, but are unnecessary here because the sentence is followed by a blank line to create a new paragraph.
  • The phrase "Other file systems are not recommended" is in passive voice. The style guide recommends using active voice and addressing the user with "you".12

A more direct and active phrasing would be better. Here is a suggestion.

Style Guide References

Suggested change
TiDB supports the XFS and Ext4 file systems. Other file systems are not recommended for production environments.
TiDB supports the XFS and Ext4 file systems. For production environments, it is recommended that you use only these file systems.

Footnotes

  1. The style guide recommends writing in the second person ('you') when addressing users. (link) ↩

  2. The style guide advises against overusing passive voice, providing an example of converting a passive sentence to an active one. (link) ↩


## Web browser requirements

TiDB relies on [Grafana](https://grafana.com/) to provide visualization of database metrics. A recent version of Microsoft Edge, Safari, Chrome or Firefox with Javascript enabled is sufficient.
Expand Down