Skip to content
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.

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

*: improve deployment doc and toc (#19317) #19319

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion dr-secondary-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)。
Expand Down
2 changes: 1 addition & 1 deletion explore-htap.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: HTAP 深入探索指南
summary: 本文介绍如何深入探索并使用 TiDB 的 HTAP 功能。
summary: 本文介绍如何深入探索并使用 TiDB 的 HTAP 功能。
---

# HTAP 深入探索指南
Expand Down
4 changes: 2 additions & 2 deletions faq/deploy-and-maintain-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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#服务器配置要求)。

### 两块网卡的目的是?万兆的目的是?

Expand Down
8 changes: 4 additions & 4 deletions hardware-and-software-requirements.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: TiDB 软件和硬件环境建议配置
title: TiDB 软件和硬件环境需求
summary: TiDB 是一款开源的一站式实时 HTAP 数据库,支持部署在多种硬件环境和操作系统上。软件和硬件环境建议配置包括操作系统要求、编译和运行依赖库、Docker 镜像依赖、软件配置要求、服务器建议配置、网络要求、磁盘空间要求、客户端 Web 浏览器要求以及 TiFlash 存算分离架构的软硬件要求。
---

# TiDB 软件和硬件环境建议配置
# TiDB 软件和硬件环境需求

<!-- Localization note for TiDB:

Expand All @@ -13,7 +13,7 @@ summary: TiDB 是一款开源的一站式实时 HTAP 数据库,支持部署在

-->

TiDB 作为一款开源一栈式实时 HTAP 数据库,可以很好地部署和运行在 Intel 架构服务器环境、ARM 架构的服务器环境及主流虚拟化环境,并支持绝大多数的主流硬件网络。作为一款高性能数据库系统,TiDB 支持主流的 Linux 操作系统环境。
本文介绍 TiDB 数据库对软件和硬件环境的需求。TiDB 作为一款开源一栈式实时 HTAP 数据库,可以很好地部署和运行在 Intel 架构服务器环境、ARM 架构的服务器环境及主流虚拟化环境,并支持绝大多数的主流硬件网络。作为一款高性能数据库系统,TiDB 支持主流的 Linux 操作系统环境。

## 操作系统及平台要求

Expand Down Expand Up @@ -100,7 +100,7 @@ TiDB 作为一款开源一栈式实时 HTAP 数据库,可以很好地部署和
| numa | 2.0.12 及以上 |
| tar | 任意 |

## 服务器建议配置
## 服务器配置要求

TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器平台或者 ARM 架构的硬件服务器平台。对于开发、测试及生产环境的服务器硬件配置(不包含操作系统 OS 本身的占用)有以下要求和建议:

Expand Down
15 changes: 11 additions & 4 deletions production-deployment-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 组件

Expand Down Expand Up @@ -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)。
6 changes: 6 additions & 0 deletions quick-start-with-tidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion releases/release-8.4.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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#操作系统及平台要求)。

## 移除功能

Expand Down
2 changes: 1 addition & 1 deletion ticdc/deploy-ticdc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 集群

Expand Down
Loading