From 3a9c0b514b5c823050f6f79c4967975208db4222 Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Wed, 18 Dec 2024 10:56:09 +0800 Subject: [PATCH] This is an automated cherry-pick of #19317 Signed-off-by: ti-chi-bot --- dr-secondary-cluster.md | 2 +- explore-htap.md | 2 +- faq/deploy-and-maintain-faq.md | 4 ++-- hardware-and-software-requirements.md | 12 +++++++++--- production-deployment-using-tiup.md | 15 +++++++++++---- quick-start-with-tidb.md | 6 ++++++ releases/release-8.4.0.md | 2 +- ticdc/deploy-ticdc.md | 2 +- 8 files changed, 32 insertions(+), 13 deletions(-) diff --git a/dr-secondary-cluster.md b/dr-secondary-cluster.md index 7f7c5a41efec..d25c6aefabb5 100644 --- a/dr-secondary-cluster.md +++ b/dr-secondary-cluster.md @@ -57,7 +57,7 @@ summary: 了解如何使用 TiCDC 构建主备集群进行容灾。 关于服务器配置信息，可以参考如下文档： -- [TiDB 软件和硬件环境建议配置](/hardware-and-software-requirements.md) +- [TiDB 软件和硬件环境需求](/hardware-and-software-requirements.md) - [TiCDC 软件和硬件环境推荐配置](/ticdc/deploy-ticdc.md#软件和硬件环境推荐配置) 部署 TiDB 主集群和备用集群的详细过程，可以参考[部署 TiDB 集群](/production-deployment-using-tiup.md)。 diff --git a/explore-htap.md b/explore-htap.md index 1a4955603e21..da02997b43bf 100644 --- a/explore-htap.md +++ b/explore-htap.md @@ -1,6 +1,6 @@ --- title: HTAP 深入探索指南 -summary: 本文介绍如何深入探索并使用 TiDB 的 HTAP 功能。 +summary: 本文介绍如何深入探索并使用 TiDB 的 HTAP 功能。 --- # HTAP 深入探索指南 diff --git a/faq/deploy-and-maintain-faq.md b/faq/deploy-and-maintain-faq.md index 4a68782006a6..12e8d36ae007 100644 --- a/faq/deploy-and-maintain-faq.md +++ b/faq/deploy-and-maintain-faq.md @@ -11,11 +11,11 @@ summary: 介绍 TiDB 集群安装部署的常见问题、原因及解决方法 ### TiDB 支持哪些操作系统？ -关于 TiDB 支持的操作系统，参见 [TiDB 软件和硬件环境建议配置](/hardware-and-software-requirements.md)。 +关于 TiDB 支持的操作系统，参见[操作系统及平台要求](/hardware-and-software-requirements.md#操作系统及平台要求)。 ### TiDB 对开发、测试、生产环境的服务器硬件配置有什么要求？ -TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器平台。对于开发、测试、生产环境的服务器硬件配置，参见 [TiDB 软件和硬件环境建议配置 - 服务器建议配置](/hardware-and-software-requirements.md#服务器建议配置)。 +TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器平台。对于开发、测试、生产环境的服务器硬件配置，参见[服务器配置要求](/hardware-and-software-requirements.md#服务器配置要求)。 ### 两块网卡的目的是？万兆的目的是？ diff --git a/hardware-and-software-requirements.md b/hardware-and-software-requirements.md index 9d31422d1dd5..32d2812c741a 100644 --- a/hardware-and-software-requirements.md +++ b/hardware-and-software-requirements.md @@ -1,9 +1,15 @@ --- +<<<<<<< HEAD title: TiDB 软件和硬件环境建议配置 summary: TiDB 是一款开源的一站式实时 HTAP 数据库，支持部署在多种硬件环境和操作系统上。软件和硬件环境建议配置包括操作系统要求、编译和运行依赖库、Docker 镜像依赖、软件配置要求、服务器建议配置、网络要求、磁盘空间要求、客户端 Web 浏览器要求以及 TiFlash 存算分离架构的软硬件要求。 +======= +title: TiDB 软件和硬件环境需求 +aliases: ['/docs-cn/dev/hardware-and-software-requirements/','/docs-cn/dev/how-to/deploy/hardware-recommendations/'] +summary: TiDB 是一款开源的一站式实时 HTAP 数据库，支持部署在多种硬件环境和操作系统上。软件和硬件环境需求包括操作系统要求、编译和运行依赖库、Docker 镜像依赖、软件配置要求、服务器配置要求、网络要求、磁盘空间要求、客户端 Web 浏览器要求以及 TiFlash 存算分离架构的软硬件要求。 +>>>>>>> 978eaeb6cc (*: improve deployment doc and toc (#19317)) --- -# TiDB 软件和硬件环境建议配置 +# TiDB 软件和硬件环境需求 -TiDB 作为一款开源一栈式实时 HTAP 数据库，可以很好地部署和运行在 Intel 架构服务器环境、ARM 架构的服务器环境及主流虚拟化环境，并支持绝大多数的主流硬件网络。作为一款高性能数据库系统，TiDB 支持主流的 Linux 操作系统环境。 +本文介绍 TiDB 数据库对软件和硬件环境的需求。TiDB 作为一款开源一栈式实时 HTAP 数据库，可以很好地部署和运行在 Intel 架构服务器环境、ARM 架构的服务器环境及主流虚拟化环境，并支持绝大多数的主流硬件网络。作为一款高性能数据库系统，TiDB 支持主流的 Linux 操作系统环境。 ## 操作系统及平台要求 @@ -100,7 +106,7 @@ TiDB 作为一款开源一栈式实时 HTAP 数据库，可以很好地部署和 | numa | 2.0.12 及以上 | | tar | 任意 | -## 服务器建议配置 +## 服务器配置要求 TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器平台或者 ARM 架构的硬件服务器平台。对于开发、测试及生产环境的服务器硬件配置（不包含操作系统 OS 本身的占用）有以下要求和建议： diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md index d41ba4995c07..0a62a8731a2e 100644 --- a/production-deployment-using-tiup.md +++ b/production-deployment-using-tiup.md @@ -5,15 +5,20 @@ summary: 了解如何使用 TiUP 部署 TiDB 集群。 # 使用 TiUP 部署 TiDB 集群 -[TiUP](https://github.com/pingcap/tiup) 是 TiDB 4.0 版本引入的集群运维工具，[TiUP cluster](https://github.com/pingcap/tiup/tree/master/components/cluster) 是 TiUP 提供的使用 Golang 编写的集群管理组件，通过 TiUP cluster 组件就可以进行日常的运维工作，包括部署、启动、关闭、销毁、弹性扩缩容、升级 TiDB 集群，以及管理 TiDB 集群参数。 +本指南介绍如何在生产环境中使用 [TiUP](https://github.com/pingcap/tiup) 部署 TiDB 集群。 -目前 TiUP 可以支持部署 TiDB、TiFlash、TiCDC 以及监控系统。本文将介绍不同集群拓扑的具体部署步骤。 +TiUP 是在 TiDB v4.0 中引入的集群运维工具，提供了使用 Golang 编写的集群管理组件 [TiUP cluster](https://github.com/pingcap/tiup/tree/master/components/cluster)。通过使用 TiUP cluster 组件，你可以轻松执行日常的数据库运维操作，包括部署、启动、关闭、销毁、弹性扩缩容、升级 TiDB 集群，以及管理 TiDB 集群参数。 + +TiUP 还支持部署 TiDB、TiFlash、TiCDC 以及监控系统。本指南介绍了如何部署不同拓扑的 TiDB 集群。 ## 第 1 步：软硬件环境需求及前置检查 -[软硬件环境需求](/hardware-and-software-requirements.md) +务必阅读以下文档： + +- [软硬件环境需求](/hardware-and-software-requirements.md) +- [环境与系统配置检查](/check-before-deployment.md) -[环境与系统配置检查](/check-before-deployment.md) +此外，建议阅读了解 [TiDB 安全配置最佳实践](/best-practices-for-security-configuration.md)。 ## 第 2 步：在中控机上部署 TiUP 组件 @@ -441,3 +446,5 @@ tiup cluster display tidb-test - [管理 Changefeed](/ticdc/ticdc-manage-changefeed.md) - [TiCDC 故障处理](/ticdc/troubleshoot-ticdc.md) - [TiCDC 常见问题](/ticdc/ticdc-faq.md) + +如果你想在不中断线上服务的情况下扩容或缩容 TiDB 集群，请参阅[使用 TiUP 扩容缩容 TiDB 集群](/scale-tidb-using-tiup.md)。 diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index 57e63dd44267..ebeaf09155ae 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -512,6 +512,12 @@ TiDB 是一个分布式系统。最基础的 TiDB 测试集群通常由 2 个 Ti - [使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md) - [使用 TiDB Operator 在 Kubernetes 上部署 TiDB 集群](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable) +如果你是应用开发者，想要快速使用 TiDB 构建应用，可参阅以下文档： + +- [开发者手册概览](/develop/dev-guide-overview.md) +- [使用 TiDB Cloud Serverless 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md) +- [示例程序](/develop/dev-guide-sample-application-java-jdbc.md) + 如果你想使用 TiFlash 作为数据分析的解决方案，可参阅以下文档： - [使用 TiFlash](/tiflash/tiflash-overview.md#使用-tiflash) diff --git a/releases/release-8.4.0.md b/releases/release-8.4.0.md index 88823b2ffd08..81b1aa081462 100644 --- a/releases/release-8.4.0.md +++ b/releases/release-8.4.0.md @@ -341,7 +341,7 @@ TiDB 版本：8.4.0 - 根据 [CentOS Linux EOL](https://www.centos.org/centos-linux-eol/)，CentOS Linux 7 的上游支持已于 2024 年 6 月 30 日终止。从 v8.4.0 版本开始，TiDB 已结束对 CentOS 7 的支持，建议使用 Rocky Linux 9.1 及以上的版本。 - 根据 [Red Hat Enterprise Linux Life Cycle](https://access.redhat.com/support/policy/updates/errata/#Life_Cycle_Dates)，Red Hat Enterprise Linux 7 的 Maintenance Support 已于 2024 年 6 月 30 日终止。从 v8.4.0 版本开始，TiDB 已结束对 Red Hat Enterprise Linux 7 的支持，建议使用 Rocky Linux 9.1 及以上的版本。 -关于 TiDB 支持的操作系统和平台，请参考 [TiDB 软件和硬件环境建议配置](/hardware-and-software-requirements.md#操作系统及平台要求)。 +关于 TiDB 支持的操作系统和平台，请参考[操作系统及平台要求](/hardware-and-software-requirements.md#操作系统及平台要求)。 ## 移除功能 diff --git a/ticdc/deploy-ticdc.md b/ticdc/deploy-ticdc.md index 84d1d577e711..0993ecdb0c46 100644 --- a/ticdc/deploy-ticdc.md +++ b/ticdc/deploy-ticdc.md @@ -15,7 +15,7 @@ summary: 了解 TiCDC 软硬件环境要求以及如何安装部署和运维 TiC | --- | --- |------------------| --- | --- | | 16 核+ | 64 GB+ | 500 GB+ SSD 类型硬盘 | 万兆网卡（2 块最佳） | 2 | -软件配置推荐及更多信息参见 [TiDB 软件和硬件环境建议配置](/hardware-and-software-requirements.md)。 +软件配置推荐及更多信息，参见 [TiDB 软件和硬件环境需求](/hardware-and-software-requirements.md)。 ## 使用 TiUP 部署包含 TiCDC 组件的全新 TiDB 集群