Skip to content

Commit 36811ea

Browse files
authored
Merge pull request #6238 from ehashman/feature-gate-docs
Document expectations of feature gate use per PRR
2 parents a3e0618 + 8076461 commit 36811ea

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ The majority of features will go through all three stages, but occasionally ther
1212

1313
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).
1414

15+
There is no supported way to trigger a feature gate at runtime for production Kubernetes use. A feature gate is typically toggled by a component restart.
16+
17+
Unless an exception is granted for a particular feature, as documented and approved as part of [Production Readiness Review], it is expected that:
18+
19+
- Toggling a feature gate will not affect other components, i.e. disabling a feature gate in the API server will work independently of disabling that same feature gate in the kubelet or scheduler, and no coordination between components is needed.
20+
- The effects of toggling a feature gate should be limited to the scope of the feature. Enabling or disabling a feature gate should not affect workloads that do not use the feature gate.
21+
- Toggling feature gates should not result in fanout effects or cascading interactions in a cluster.
22+
23+
[Production Readiness Review]: /sig-architecture/production-readiness.md
24+
1525
## Specification Fields
1626
// Default is the default enablement state for the feature. Possible values are true/false.
1727
Default bool

0 commit comments

Comments
 (0)