Skip to content

Commit 097b1fe

Browse files
authored
Merge pull request #8480 from deads2k/ga-disableable
explain that GA features must be disableable if it is the first release they are default-on
2 parents e40e687 + 286a24a commit 097b1fe

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,8 +175,12 @@ Kubernetes. For example, the CSIMigration feature gates looked like this:
175175

176176
GA features are always on by default, and usually cannot be disabled.
177177

178-
Sometimes (rarely) a GA feature is allowed to be disabled (`LockToDefault:
179-
false`). This indicates that while this feature is GA, they need to take some
178+
Sometimes (rarely) a GA feature is allowed to be disabled (`LockToDefault: false`).
179+
This is used for features that are being enabled by default for the first time.
180+
Such features must be disable-able in the first release they are on by default.
181+
The most common case is when an entirely new API is created and is not enabled by
182+
default until the serialization is stable (GA).
183+
This can also indicate that while this feature is GA, they need to take some
180184
other action outside of Kubernetes to use it. This gives some grace period for
181185
users to take action, but such feature gates will eventually set
182186
`LockToDefault` to `true` and then be retired, like normal.

0 commit comments

Comments
 (0)