Skip to content

Commit b5f33bd

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

File tree

1 file changed

+38
-9
lines changed

1 file changed

+38
-9
lines changed

zh/feature-gates.md

Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,44 @@ spec:
1414
featureGates:
1515
FeatureModification: true
1616

17-
## 特性门控列表
18-
19-
| 特性 | 默认值 | 阶段 | 自从 | 直到 | 重启 |
20-
|:---|:---|:---|:---|:---|:---|
21-
| FeatureModification | false | Alpha | 2.0 | - | |
22-
| VolumeAttributesClass | false | Alpha | 2.0 | - | |
23-
| DisablePDDefaultReadinessProbe | false | Alpha | 2.0 | - | PD |
24-
| UsePDReadyAPI | false | Alpha | 2.0 | - | PD |
25-
| SessionTokenSigning | false | Alpha | 2.0 | - | TiDB |
17+
## 支持的特性门控
18+
19+
本节列出了 TiDB Operator 支持的特性门控。关于特性阶段的定义,请参考[特性门控阶段](#特性门控阶段)。
20+
21+
### `FeatureModification`
22+
23+
- 开启该特性后,你可以修改 `spec.featureGates` 配置。
24+
- 默认值:`false`
25+
- 阶段:v2.0 及之后版本为 Alpha
26+
- 需要重启的组件:无
27+
28+
### `VolumeAttributesClass`
29+
30+
- 开启该特性后,你可以修改 PVC 的 `VolumeAttributesClass` 属性。该功能依赖 Kubernetes 的对应能力。更多信息,请参考 [Kubernetes 官方文档 VolumeAttributesClass](https://kubernetes.io/zh-cn/docs/concepts/storage/volume-attributes-classes/)。
31+
- 默认值:`false`
32+
- 阶段:v2.0 及之后版本为 Alpha
33+
- 需要重启的组件:无
34+
35+
### `DisablePDDefaultReadinessProbe`
36+
37+
- 开启该特性后,TiDB Operator 不再通过 TCP 探测方式检查 PD 的就绪状态。
38+
- 默认值:`false`
39+
- 阶段:v2.0 及之后版本为 Alpha
40+
- 需要重启的组件:PD
41+
42+
### `UsePDReadyAPI`
43+
44+
- 开启该特性后,TiDB Operator 将通过 PD 的 `/ready` API 检查就绪状态。有关实现细节,请参阅 [`tikv/pd` #8749](https://github.com/tikv/pd/pull/8749)。
45+
- 默认值:`false`
46+
- 阶段:v2.0 及之后版本为 Alpha
47+
- 需要重启的组件:PD
48+
49+
### `SessionTokenSigning`
50+
51+
- 开启该特性后,TiDB Operator 会自动配置 TiDB 的 [`session-token-signing-cert`](https://docs.pingcap.com/zh/tidb/stable/tidb-configuration-file/#session-token-signing-cert-从-v640-版本开始引入) 和 [`session-token-signing-key`](https://docs.pingcap.com/zh/tidb/stable/tidb-configuration-file/#session-token-signing-key-从-v640-版本开始引入) 参数。
52+
- 默认值:`false`
53+
- 阶段:v2.0 及之后版本为 Alpha
54+
- 需要重启的组件:TiDB
2655

2756
## 特性门控阶段
2857

0 commit comments

Comments
 (0)