Skip to content

Commit abbbf2e

Browse files
liubog2008Oreoxmt
andauthored
Apply suggestions from code review
Co-authored-by: Aolin <aolinz@outlook.com>
1 parent e184b89 commit abbbf2e

File tree

1 file changed

+26
-16
lines changed

1 file changed

+26
-16
lines changed

zh/feature-gates.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
---
22
title: 特性门控
3-
summary: 介绍如何配置 TiDB 集群的特性门控
3+
summary: 介绍如何使用特性门控 (Feature Gates) 在 TiDB 集群中开启或关闭特定功能。
44
---
55

66
# 特性门控
77

8-
TiDB Operator 支持通过 Cluster CR 上的 `spec.featureGates` 开启或关闭一些不成熟或者可能导致组件重启的特性。
8+
特性门控 (Feature Gates) 是一组开关,用于控制 TiDB Operator 中特定功能的启用状态。这些功能通常处于实验阶段,启用后可能需要重启部分组件。
9+
10+
你可以在 Cluster CR 的 `spec.featureGates` 字段中配置特性门控。以下示例展示如何启用 `FeatureModification` 特性:
11+
12+
```yaml
13+
spec:
14+
featureGates:
15+
FeatureModification: true
916

1017
## 特性门控列表
1118

@@ -17,32 +24,35 @@ TiDB Operator 支持通过 Cluster CR 上的 `spec.featureGates` 开启或关闭
1724
| UsePDReadyAPI | false | Alpha | 2.0 | - | PD |
1825
| SessionTokenSigning | false | Alpha | 2.0 | - | TiDB |
1926

20-
## 阶段
27+
## 特性门控阶段
28+
29+
特性门控根据功能的成熟度分为 Alpha、Beta 和 GA 三个阶段。
2130

2231
### Alpha
2332

24-
Alpha 阶段的特性有如下特征
33+
Alpha 阶段的特性具有以下特点:
2534

26-
- 默认关闭
27-
- 建议只在新建集群时开启
28-
- 不一定支持对已经创建的集群开启或关闭
29-
- 启用此特性可能会有错误
30-
- 建议未充分测试的情况不在生产环境下开启
35+
- 默认关闭
36+
- 建议仅在新建集群中开启
37+
- 不保证支持在已有集群中动态开启或关闭。
38+
- 开启后可能出现已知或未知问题。
39+
- **不建议在生产环境中使用**,除非已充分评估并验证风险。
3140

3241
### Beta
3342

34-
Beta 阶段的特性有如下特征
43+
Beta 阶段的特性具有以下特点:
3544

36-
- 通常已经经过良好的测试
37-
- 建议对所有新建集群开启
38-
- 通常支持对已经创建的集群开启或关闭(可能重启组件)
45+
- 通常已经过较充分的测试。
46+
- 建议在所有新建集群中开启。
47+
- 通常支持在已有集群中开启或关闭,但可能需要重启相关组件。
3948

4049
### GA
4150

42-
GA 阶段的特性有如下特征
51+
GA (General Availability) 阶段的特性具有以下特点:
4352

44-
- 通常已经经过长期的测试
45-
- 默认开启,并不支持关闭
53+
- 通常已经过长期和大规模测试。
54+
- 默认开启。
55+
- 不支持关闭。
4656

4757
## 特性说明
4858

0 commit comments

Comments
 (0)