You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: en/feature-gates.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ summary: Learn how to use feature gates to enable or disable specific features i
5
5
6
6
# Feature Gates
7
7
8
-
Feature gates are configuration switches that enable or disable specific features in TiDB Operator. These features are typically experimental, and enabling them might require restarting certain cluster components.
8
+
Feature gates are configuration switches that enable or disable specific features in TiDB Operator. These features are generally experimental, and enabling them might require restarting certain components for the changes to take effect.
9
9
10
10
You can configure feature gates in the `spec.featureGates` field of the Cluster Custom Resource (CR). The following example shows how to enable the `FeatureModification` feature gate:
11
11
@@ -17,7 +17,7 @@ spec:
17
17
18
18
## Supported feature gates
19
19
20
-
This section describes the feature gates supported by TiDB Operator. For the definition of feature stages, see [Feature gate stages](#feature-gate-stages).
20
+
This section describes the feature gates supported by TiDB Operator. For definitions of feature stages, see [Feature gate stages](#feature-gate-stages).
21
21
22
22
### `FeatureModification`
23
23
@@ -56,16 +56,16 @@ This section describes the feature gates supported by TiDB Operator. For the def
56
56
57
57
## Feature gate stages
58
58
59
-
TiDB Operator classifies feature gates into three stages based on maturity: Alpha, Beta, and GA.
59
+
TiDB Operator classifies feature gates into three stages based on feature maturity: Alpha, Beta, and GA.
60
60
61
61
### Alpha
62
62
63
63
Alpha-stage features have the following characteristics:
64
64
65
65
- Disabled by default.
66
-
- Recommended for use only in newly created clusters.
66
+
- Recommended only for newly created clusters.
67
67
- Dynamic enabling or disabling in existing clusters is not guaranteed.
68
-
- Known or unknown issues might occur after enabling.
68
+
- Known or unknown issues might occur after being enabled.
69
69
- **Not recommended for production environments** unless risks are fully evaluated and validated.
70
70
71
71
### Beta
@@ -74,12 +74,12 @@ Beta-stage features have the following characteristics:
74
74
75
75
- Typically have undergone thorough testing.
76
76
- Recommended to enable in all newly created clusters.
77
-
- Usually support enabling or disabling on existing clusters, but might require restarting related components.
77
+
- Usually support enabling or disabling in existing clusters, but might require restarting related components.
78
78
79
79
### GA
80
80
81
81
GA (General Availability) features have the following characteristics:
82
82
83
83
- Typically have undergone long-term and large-scale testing.
0 commit comments