From 0088ed076baca462cb8240f9f832181b8dd31ab2 Mon Sep 17 00:00:00 2001 From: Elana Hashman Date: Wed, 1 Dec 2021 12:26:08 -0800 Subject: [PATCH] Add documentation to template about feature gates --- keps/NNNN-kep-template/README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/keps/NNNN-kep-template/README.md b/keps/NNNN-kep-template/README.md index 8a3b9ce2fb4..3114c6cd094 100644 --- a/keps/NNNN-kep-template/README.md +++ b/keps/NNNN-kep-template/README.md @@ -277,12 +277,13 @@ when drafting this test plan. Define graduation milestones. -These may be defined in terms of API maturity, or as something else. The KEP -should keep this high-level with a focus on what signals will be looked at to -determine graduation. +These may be defined in terms of API maturity, [feature gate] graduations, or as +something else. The KEP should keep this high-level with a focus on what +signals will be looked at to determine graduation. Consider the following in developing the graduation criteria for this enhancement: - [Maturity levels (`alpha`, `beta`, `stable`)][maturity-levels] +- [Feature gate][feature gate] lifecycle - [Deprecation policy][deprecation-policy] Clearly define what graduation means by either linking to the [API doc @@ -292,6 +293,7 @@ or by redefining what graduation means. In general we try to use the same stages (alpha, beta, GA), regardless of how the functionality is accessed. +[feature gate]: https://git.k8s.io/community/contributors/devel/sig-architecture/feature-gates.md [maturity-levels]: https://git.k8s.io/community/contributors/devel/sig-architecture/api_changes.md#alpha-beta-and-stable-versions [deprecation-policy]: https://kubernetes.io/docs/reference/using-api/deprecation-policy/ @@ -395,6 +397,12 @@ This section must be completed when targeting alpha to a release. - [ ] Feature gate (also fill in values in `kep.yaml`) @@ -420,6 +428,10 @@ automations, so be extremely careful here. Describe the consequences on existing workloads (e.g., if this is a runtime feature, can it break the existing applications?). +Feature gates are typically disabled by setting the flag to `false` and +restarting the component. No other changes should be necessary to disable the +feature. + NOTE: Also set `disable-supported` to `true` or `false` in `kep.yaml`. -->