Skip to content

Commit 14d7dfb

Browse files
authored
Merge pull request #8131 from Jefftree/feature-gate-nits
Update feature gate documentation for compatibility version - fixups
2 parents 6977d1b + 7c058b2 commit 14d7dfb

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

contributors/devel/sig-architecture/feature-gates.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,8 @@ As a feature progresses through the lifecycle, we must preserve enough
115115
information to allow such compatible configuration, including both the old and
116116
new states, along with the version that the transition occurred.
117117

118+
Example:
119+
118120
```
119121
RetryGenerateName: {
120122
{Version: version.MustParse("1.30"), Default: false, PreRelease: featuregate.Alpha},
@@ -260,7 +262,7 @@ the gate back to `true` for a release or two and eventually removing it.
260262
Once the [deprecation period](https://kubernetes.io/docs/reference/using-api/deprecation-policy/#deprecation)
261263
has passed, the gate should be locked to the default value (`LockToDefault:
262264
true`). As with GA features, all references to the feature gate must be kept for
263-
a minimum of three releases after gate has been locked to the default value. the
265+
a minimum of three releases after gate has been locked to the default value. The
264266
gate, all references to it, and all gated logic may be removed after those three
265267
releases. See [compatibility version](#compatibility-versions) for more details.
266268

@@ -271,7 +273,7 @@ DeprecatedFeature: {
271273
{Version: version.MustParse("1.29"), Default: false, PreRelease: featuregate.Alpha}, // feature graduated to alpha.
272274
{Version: version.MustParse("1.30"), Default: true, PreRelease: featuregate.Beta}, // feature graduated to beta.
273275
{Version: version.MustParse("1.32"), Default: false, PreRelease: featuregate.Deprecated}, // feature is deprecated and turned off. LockToDefault is unset to give users time to transition.
274-
{Version: version.MustParse("1.34"), Default: false, LockToDefault: true, PreRelease: featuregate.Deprecated}, // feature is deprecated, off, and locked. remove in v1.37 once versions up to v1.34 cannot be emulated anymore.
276+
{Version: version.MustParse("1.34"), Default: false, LockToDefault: true, PreRelease: featuregate.Deprecated}, // feature is deprecated, off, and locked. remove in v1.37 once versions prior to v1.34 cannot be emulated anymore.
275277
},
276278
```
277279

0 commit comments

Comments
 (0)