Skip to content

Commit 8828f0e

Browse files
update and refine feature-gates.md
1 parent 544dc8c commit 8828f0e

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

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

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,24 @@
22

33
Feature flags are how Kubernetes tracks progression of functionality that is available when deployed.
44

5+
Feature gates are intended to cover the development life cycle of a feature - they are not intended to be long-term APIs. As such, they are expected to be [deprecated](https://kubernetes.io/docs/reference/using-api/deprecation-policy) and removed after a feature becomes GA or is dropped. Optional features intended to be enabled or disabled by users even once the feature is GA should include a mechanism for enabling or disabling the feature (like a command-line flag or config file option) in addition to the associated feature gate.
6+
57
## Lifecycle
68

79
Feature progress through `Alpha` -> `Beta` -> `GA`. Sometimes we end up deciding that a feature is not going to be supported and we end up marking them as `Deprecated`.
810

9-
When we add a feature flag, we basically add if/else conditions to ensure that a feature is ONLY activated when either the default is on or if the deployer has switched it on explicitly.
11+
The majority of features will go through all three stages, but occasionally there are features which may skip stages.
12+
13+
When we add a feature flag, we basically add if/else conditions to ensure that a feature is ONLY activated when either the default is on or if the deployer has switched it on explicitly. When a feature gate is disabled, the system should behave as if the feature doesn't exist. The only exception to this is [API input validation](https://kubernetes.io/docs/reference/using-api/deprecation-policy/#deprecating-parts-of-the-api) on updates, which should preserve and validate data if and only if it was present before the update (which could occur in case of a version rollback).
1014

11-
## Fields in the specification are
12-
// Default is the default enablement state for the feature. possible values are true/false.
15+
## Specification Fields
16+
// Default is the default enablement state for the feature. Possible values are true/false.
1317
Default bool
1418

15-
// LockToDefault indicates that the feature is locked to its default and cannot be changed. possible values are true/false.
19+
// LockToDefault indicates that the feature is locked to its default and cannot be changed. Possible values are true/false.
1620
LockToDefault bool
1721

18-
// PreRelease indicates the maturity level of the feature. possible values are "featuregate.Alpha", "featuregate.Beta", "featuregate.GA", "featuregate.Deprecated"
22+
// PreRelease indicates the maturity level of the feature. possible values are "featuregate.Alpha", "featuregate.Beta", "featuregate.GA", "featuregate.Deprecated"
1923
PreRelease prerelease
2024

2125

@@ -25,17 +29,17 @@ When we add a feature flag, we basically add if/else conditions to ensure that a
2529
* `Default` is always set to `false`
2630
* `LockToDefault` is not set. Defaults to `false`
2731

28-
This enables folks to switch on the feature using the command line. By default it is not switched on.
32+
By default it is not switched on. This enables folks to switch on the feature using the command line. All API changes must start with an Alpha gate, which makes it possible to rollback from future versions.
2933

3034
## Beta Features
3135

3236
* `PreRelease` is set to `featuregate.Beta`
33-
* `Default` is set to `true`
37+
* `Default` is usually set to `true` (see below)
3438
* `LockToDefault` is not set. Defaults to `false`
3539

36-
This enables the feature to be on and available in the default installation of kubernetes.
40+
This enables the feature to be on and available in the default installation of Kubernetes.
3741

38-
Sometimes (rarely) the `Default` is set to `false`. For example when this flag needs some explicit action or support outside of Kubernetes. This tells folks that while this feature is Beta, you still need to do some work to switch it on and use it.
42+
Sometimes (rarely) the `Default` is set to `false`. This tells folks that while this feature is in Beta, they will still need to do some work to switch it on and use it and potentially take some other explicit action outside of Kubernetes. For example, see the [CSIMigration feature gates](https://github.com/kubernetes/kubernetes/blob/5b0a2c3a29f6b5392e0f8f94ba5669bdc9eb73f6/pkg/features/kube_features.go#L792).
3943

4044
## GA Features
4145

@@ -47,16 +51,15 @@ GA features are always on.
4751

4852
Sometimes (rarely) we do not set `LockToDefault` and let it default to `false`. This enables folks to switch off the GA feature. We do this to tell folks that while the feature (for example `coredns`) is GA, they need to move off say `kubedns` to `coredns` in their infrastructures pretty soon and if they want to continue `kubedns` for a short time, they will have to switch off the GA flag. When we do remove the support for `kubedns` entirely we would set `LockToDefault` to `true` with some grace period for the transition.
4953

50-
51-
Typically we add a comment `// remove in 1.23` to signal when we would entirely remove the feature gate. Remember when the feature gate is removed and the deployer has forgotten to drop the reference to the feature in the CLI flags (say the `kube-apiserver`), then they will see a hard failure.
54+
[After at least two releases post-GA and deprecation](https://kubernetes.io/docs/reference/using-api/deprecation-policy/#deprecation), the feature gate is removed. Typically, we add a comment in [kubefeatures.go](https://github.com/kubernetes/kubernetes/blob/master/pkg/features/kube_features.go) such as: `// remove in 1.23` to signal when we plan to remove the feature gate. Remember when the feature gate is removed and the deployer has forgotten to drop the reference to the feature in the CLI flags (say the `kube-apiserver`), then they will see a hard failure.
5255

5356
Also note that when we set `LockToDefault` to `true`, we remove all references (if/then conditions) to the feature gate from the codebase.
5457

5558
## Deprecation
5659

5760
* `PreRelease` is set to `featuregate.Deprecated`
58-
* `Default` is always set to `true`
61+
* See [Kubernetes Deprecation Policy](https://kubernetes.io/docs/reference/using-api/deprecation-policy/#deprecation) for more details
5962

6063
## Other scenarios
6164

62-
Sometimes we use`{Default: true, PreRelease: featuregate.Beta}` for keeping legacy behavior (see `LegacyNodeRoleBehavior`) on and when we basically want to drop the legacy behavior with new default behavior. So at GA we will end up with `{Default: false, PreRelease: featuregate.GA, LockToDefault: true}`
65+
Sometimes we use`{Default: true, PreRelease: featuregate.Beta}` for keeping legacy behavior on while a new alternative is being implemented. When the new default behavior is transitioning to GA and it is time to drop the old legacy behavior, we will end up with `{Default: false, PreRelease: featuregate.GA, LockToDefault: true}`. For an example, see: [LegacyNodeRoleBehavior & ServiceNodeExclusion](https://github.com/kubernetes/kubernetes/pull/97543/files).

0 commit comments

Comments
 (0)