Expand feature gates page (#17535)
* Tidy feature gate metadata * Tweak feature gate headings Use sentence case where appropriate * Add feature gate explanation for GA * Add what's next section to feature gate page * Signpost readers to explanation of feature gate stages
This commit is contained in:
committed by
Kubernetes Prow Robot
parent
69964e8529
commit
939f3ebd7e
@@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
title: Feature Gates
|
|
||||||
weight: 10
|
weight: 10
|
||||||
title: Feature Gates
|
title: Feature Gates
|
||||||
content_template: templates/concept
|
content_template: templates/concept
|
||||||
@@ -8,15 +7,20 @@ content_template: templates/concept
|
|||||||
{{% capture overview %}}
|
{{% capture overview %}}
|
||||||
This page contains an overview of the various feature gates an administrator
|
This page contains an overview of the various feature gates an administrator
|
||||||
can specify on different Kubernetes components.
|
can specify on different Kubernetes components.
|
||||||
|
|
||||||
|
See [feature stages](#feature-stages) for an explanation of the stages for a feature.
|
||||||
{{% /capture %}}
|
{{% /capture %}}
|
||||||
|
|
||||||
{{% capture body %}}
|
{{% capture body %}}
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Feature gates are a set of key=value pairs that describe alpha or experimental
|
Feature gates are a set of key=value pairs that describe Kubernetes features.
|
||||||
features.
|
You can turn these features on or off using the `--feature-gates` command line flag
|
||||||
An administrator can use the `--feature-gates` command line flag on each component
|
on each Kubernetes component.
|
||||||
to turn a feature on or off. Each component supports a set of feature gates unique to that component.
|
|
||||||
|
|
||||||
|
Each Kubernetes component lets you enable or disable a set of feature gates that
|
||||||
|
are relevant to that component.
|
||||||
Use `-h` flag to see a full set of feature gates for all components.
|
Use `-h` flag to see a full set of feature gates for all components.
|
||||||
To set feature gates for a component, such as kubelet, use the `--feature-gates` flag assigned to a list of feature pairs:
|
To set feature gates for a component, such as kubelet, use the `--feature-gates` flag assigned to a list of feature pairs:
|
||||||
|
|
||||||
@@ -32,9 +36,11 @@ different Kubernetes components.
|
|||||||
- The "Until" column, if not empty, contains the last Kubernetes release in which
|
- The "Until" column, if not empty, contains the last Kubernetes release in which
|
||||||
you can still use a feature gate.
|
you can still use a feature gate.
|
||||||
- If a feature is in the Alpha or Beta state, you can find the feature listed
|
- If a feature is in the Alpha or Beta state, you can find the feature listed
|
||||||
in the Alpha/Beta feature gate table.
|
in the [Alpha/Beta feature gate table](#feature-gates-for-alpha-or-beta-features).
|
||||||
- If a feature is stable (GA) or deprecated, you can find all stages for that feature listed
|
- If a feature is stable you can find all stages for that feature listed in the
|
||||||
in the GA/Deprecated feature gate table.
|
[Graduated/Deprecated feature gate table](#feature-gates-for graduated-or-deprecated-features).
|
||||||
|
- The [Graduated/Deprecated feature gate table](#feature-gates-for graduated-or-deprecated-features).
|
||||||
|
also lists deprecated and withdrawn features.
|
||||||
|
|
||||||
### Feature gates for Alpha or Beta features
|
### Feature gates for Alpha or Beta features
|
||||||
|
|
||||||
@@ -240,9 +246,9 @@ different Kubernetes components.
|
|||||||
| `VolumeSubpath` | `true` | GA | 1.13 | - |
|
| `VolumeSubpath` | `true` | GA | 1.13 | - |
|
||||||
{{< /table >}}
|
{{< /table >}}
|
||||||
|
|
||||||
## Using a Feature
|
## Using a feature
|
||||||
|
|
||||||
### Feature Stages
|
### Feature stages
|
||||||
|
|
||||||
A feature can be in *Alpha*, *Beta* or *GA* stage.
|
A feature can be in *Alpha*, *Beta* or *GA* stage.
|
||||||
An *Alpha* feature means:
|
An *Alpha* feature means:
|
||||||
@@ -273,12 +279,13 @@ Please do try *Beta* features and give feedback on them!
|
|||||||
After they exit beta, it may not be practical for us to make more changes.
|
After they exit beta, it may not be practical for us to make more changes.
|
||||||
{{< /note >}}
|
{{< /note >}}
|
||||||
|
|
||||||
A *GA* feature is also referred to as a *stable* feature. It means:
|
A *General Availability* (GA) feature is also referred to as a *stable* feature. It means:
|
||||||
|
|
||||||
|
* The feature is always enabled; you cannot disable it.
|
||||||
* The corresponding feature gate is no longer needed.
|
* The corresponding feature gate is no longer needed.
|
||||||
* Stable versions of features will appear in released software for many subsequent versions.
|
* Stable versions of features will appear in released software for many subsequent versions.
|
||||||
|
|
||||||
### Feature Gates
|
## List of feature gates {#feature-gates}
|
||||||
|
|
||||||
Each feature gate is designed for enabling/disabling a specific feature:
|
Each feature gate is designed for enabling/disabling a specific feature:
|
||||||
|
|
||||||
@@ -443,3 +450,7 @@ Each feature gate is designed for enabling/disabling a specific feature:
|
|||||||
- `WinOverlay`: Allows kube-proxy to run in overlay mode for Windows.
|
- `WinOverlay`: Allows kube-proxy to run in overlay mode for Windows.
|
||||||
|
|
||||||
{{% /capture %}}
|
{{% /capture %}}
|
||||||
|
{{% capture whatsnext %}}
|
||||||
|
* The [deprecation policy](/docs/reference/using-api/deprecation-policy/) for Kubernetes explains
|
||||||
|
the project's approach to removing features and components.
|
||||||
|
{{% /capture %}}
|
||||||
|
|||||||
Reference in New Issue
Block a user