Skip to content

Commit 50cecf7

Browse files
authored
Add documentation to template about feature gates (kubernetes#3069)
1 parent 18b4a6f commit 50cecf7

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

keps/NNNN-kep-template/README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -277,12 +277,13 @@ when drafting this test plan.
277277
278278
Define graduation milestones.
279279
280-
These may be defined in terms of API maturity, or as something else. The KEP
281-
should keep this high-level with a focus on what signals will be looked at to
282-
determine graduation.
280+
These may be defined in terms of API maturity, [feature gate] graduations, or as
281+
something else. The KEP should keep this high-level with a focus on what
282+
signals will be looked at to determine graduation.
283283
284284
Consider the following in developing the graduation criteria for this enhancement:
285285
- [Maturity levels (`alpha`, `beta`, `stable`)][maturity-levels]
286+
- [Feature gate][feature gate] lifecycle
286287
- [Deprecation policy][deprecation-policy]
287288
288289
Clearly define what graduation means by either linking to the [API doc
@@ -292,6 +293,7 @@ or by redefining what graduation means.
292293
In general we try to use the same stages (alpha, beta, GA), regardless of how the
293294
functionality is accessed.
294295
296+
[feature gate]: https://git.k8s.io/community/contributors/devel/sig-architecture/feature-gates.md
295297
[maturity-levels]: https://git.k8s.io/community/contributors/devel/sig-architecture/api_changes.md#alpha-beta-and-stable-versions
296298
[deprecation-policy]: https://kubernetes.io/docs/reference/using-api/deprecation-policy/
297299
@@ -395,6 +397,12 @@ This section must be completed when targeting alpha to a release.
395397

396398
<!--
397399
Pick one of these and delete the rest.
400+
401+
Documentation is available on [feature gate lifecycle] and expectations, as
402+
well as the [existing list] of feature gates.
403+
404+
[feature gate lifecycle]: https://git.k8s.io/community/contributors/devel/sig-architecture/feature-gates.md
405+
[existing list]: https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/
398406
-->
399407

400408
- [ ] Feature gate (also fill in values in `kep.yaml`)
@@ -420,6 +428,10 @@ automations, so be extremely careful here.
420428
Describe the consequences on existing workloads (e.g., if this is a runtime
421429
feature, can it break the existing applications?).
422430
431+
Feature gates are typically disabled by setting the flag to `false` and
432+
restarting the component. No other changes should be necessary to disable the
433+
feature.
434+
423435
NOTE: Also set `disable-supported` to `true` or `false` in `kep.yaml`.
424436
-->
425437

0 commit comments

Comments
 (0)