Add security best practices to deployment

pingcap · Dec 16, 2024 · 603a617 · 603a617
1 parent 8e10d31
commit 603a617
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 9 deletions.
diff --git a/faq/deploy-and-maintain-faq.md b/faq/deploy-and-maintain-faq.md
@@ -15,7 +15,7 @@ For the TiDB-supported operating systems, see [Software and Hardware Recommendat
 
 ### What is the recommended hardware configuration for a TiDB cluster in the development, test, or production environment?
 
-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. For the requirements and recommendations about server hardware configuration for development, test, and production environments, see [Software and Hardware Recommendations - Server recommendations](/hardware-and-software-requirements.md#server-recommendations).
+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. For the requirements and recommendations about server hardware configuration for development, test, and production environments, see [Software and Hardware Recommendations - Server requirements](/hardware-and-software-requirements.md#server-requirements).
 
 ### What's the purposes of 2 network cards of 10 gigabit?
 

diff --git a/hardware-and-software-requirements.md b/hardware-and-software-requirements.md
@@ -1,10 +1,10 @@
 ---
-title: Software and Hardware Recommendations
-summary: Learn the software and hardware recommendations for deploying and running TiDB.
+title: Software and Hardware Requirements
+summary: Learn the software and hardware requirements for deploying and running TiDB.
 aliases: ['/docs/dev/hardware-and-software-requirements/','/docs/dev/how-to/deploy/hardware-recommendations/']
 ---
 
-# Software and Hardware Recommendations
+# Software and Hardware Requirements
 
 <!-- Localization note for TiDB:
 
@@ -93,7 +93,7 @@ As an open-source distributed SQL database with high performance, TiDB can be de
 >
 > - For Oracle Enterprise Linux, TiDB supports the Red Hat Compatible Kernel (RHCK) and does not support the Unbreakable Enterprise Kernel provided by Oracle Enterprise Linux.
 > - According to [CentOS Linux EOL](https://www.centos.org/centos-linux-eol/), the upstream support for CentOS Linux 7 ends on June 30, 2024. TiDB ends the support for CentOS 7 starting from the 8.4 DMR version. It is recommended to use Rocky Linux 9.1 or a later version. While the upstream support for CentOS Linux 8 ends on December 31, 2021, CentOS Stream 8 continues to be supported by the CentOS organization.
-> - According to [Red Hat Enterprise Linux Life Cycle](https://access.redhat.com/support/policy/updates/errata/#Life_Cycle_Dates), the maintenance support for Red Hat Enterprise Linux 7 ends on June 30, 2024. TiDB ends the support for Red Hat Enterprise Linux 7 starting from the 8.4 DMR version. It is recommended to use Rocky Linux 9.1 or a later version. 
+> - According to [Red Hat Enterprise Linux Life Cycle](https://access.redhat.com/support/policy/updates/errata/#Life_Cycle_Dates), the maintenance support for Red Hat Enterprise Linux 7 ends on June 30, 2024. TiDB ends the support for Red Hat Enterprise Linux 7 starting from the 8.4 DMR version. It is recommended to use Rocky Linux 9.1 or a later version.
 > - Support for Ubuntu 16.04 will be removed in future versions of TiDB. Upgrading to Ubuntu 18.04 or later is strongly recommended.
 > - If you are using the 32-bit version of an operating system listed in the preceding table, TiDB **is not guaranteed** to be compilable, buildable or deployable on the 32-bit operating system and the corresponding CPU architecture, or TiDB does not actively adapt to the 32-bit operating system.
 > - Other operating system versions not mentioned above might work but are not officially supported.
@@ -116,7 +116,7 @@ The following CPU architectures are supported:
 - x86_64. Starting from TiDB v6.6.0, the [x86-64-v2 instruction set](https://developers.redhat.com/blog/2021/01/05/building-red-hat-enterprise-linux-9-for-the-x86-64-v2-microarchitecture-level) is required.
 - ARM 64
 
-## Software recommendations
+## Software requirements
 
 ### Control machine
 
@@ -137,7 +137,7 @@ The following CPU architectures are supported:
 | numa | 2.0.12 or later |
 | tar | any |
 
-## Server recommendations
+## Server requirements
 
 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:
 

diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md
@@ -16,8 +16,10 @@ TiUP also supports deploying TiDB, TiFlash, TiCDC, and the monitoring system. Th
 
 Make sure that you have read the following documents:
 
-- [Hardware and software requirements](/hardware-and-software-requirements.md)
-- [Environment and system configuration check](/check-before-deployment.md)
+- [Software and Hardware Requirements](/hardware-and-software-requirements.md)
+- [TiDB Environment and System Configuration Check](/check-before-deployment.md)
+
+In addition, it is recommended to learn the [Best Practices for TiDB Security Configuration](/best-practices-for-security-configuration.md).
 
 ## Step 2. Deploy TiUP on the control machine