Skip to content

Commit b1fa3ee

Browse files
committed
Incorporate review feedback
Signed-off-by: Christian Zunker <[email protected]>
1 parent 2ec502a commit b1fa3ee

File tree

1 file changed

+9
-18
lines changed

1 file changed

+9
-18
lines changed

contributors/devel/sig-architecture/api_changes.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -921,11 +921,8 @@ doing!
921921

922922
Check out the [E2E docs](../sig-testing/e2e-tests.md) for detailed information about how to
923923
write end-to-end tests for your feature.
924-
Make sure the E2E tests are running in the default presubmits for a feature that
925-
is being promoted to Beta (disabled by default, make sure to enable with flag).
926-
This behavior changed with Kubernetes v1.24 (see the
927-
[KEP](https://github.com/kubernetes/enhancements/blob/master/keps/sig-architecture/3136-beta-apis-off-by-default/README.md)
928-
for more details) and only applies to new beta API introduced after v1.24.
924+
Make sure the E2E tests are running in the default presubmits for a feature/API that
925+
is enabled by default.
929926

930927
## Examples and docs
931928

@@ -988,11 +985,10 @@ complexity of upgradeability and lack of long-term support and lack of
988985
upgradability.
989986
- Beta level:
990987
- Object Versioning: API version name contains `beta` (e.g. `v2beta3`)
991-
- Availability: in official Kubernetes releases; feature is disabled by default,
992-
but may be enabled by flag. This applies to new beta API introduced after v1.24
993-
(see [KEP](https://github.com/kubernetes/enhancements/blob/master/keps/sig-architecture/3136-beta-apis-off-by-default/README.md)
994-
for more deatils). Beta APIs which were introduced before v1.24 are enabled by
995-
default.
988+
- Availability: in official Kubernetes releases; API is disabled by default
989+
but may be enabled by a flag.
990+
(Note: beta APIs introduced before v1.24 were enabled by default, but this
991+
[changed for new beta APIs](https://github.com/kubernetes/enhancements/blob/master/keps/sig-architecture/3136-beta-apis-off-by-default/README.md))
996992
- Audience: users interested in providing feedback on features
997993
- Completeness: all API operations, CLI commands, and UI support should be
998994
implemented; end-to-end tests complete; the API has had a thorough API review
@@ -1198,7 +1194,7 @@ provides some details
11981194

11991195
In future Kubernetes versions:
12001196

1201-
* if the feature progresses to stable status, the feature gate can be removed or be enabled by default.
1197+
* if the feature progresses to beta or stable status, the feature gate can be removed or be enabled by default.
12021198
* if the schema of the alpha field must change in an incompatible way, a new field name must be used.
12031199
* if the feature is abandoned, or the field name is changed, the field should be removed from the go struct, with a tombstone comment ensuring the field name and protobuf tag are not reused:
12041200

@@ -1260,12 +1256,7 @@ This ensures a cluster with multiple servers at skewed releases (which happens d
12601256
will not allow data to be persisted which the previous release of the API server would choke on.
12611257

12621258
Typically, a feature gate is used to do this rollout, starting in alpha and disabled by default in release 1,
1263-
and graduating to stable and enabled by default in release 2.
1264-
With beta as an intermediate step, release 3 (stable) would enable the feature gate by default.
1265-
The behavior changed with Kubernetes v1.24
1266-
(for details see the [KEP](https://github.com/kubernetes/enhancements/blob/master/keps/sig-architecture/3136-beta-apis-off-by-default/README.md)).
1267-
Beta APIs introduced before v1.24 will be enabled by default.
1268-
Beta API introduced after v1.24 will be disabled by default.
1259+
and graduating to beta and enabled by default in release 2.
12691260

12701261
1. Add a feature gate to the API server to control enablement of the new enum value (and associated function):
12711262

@@ -1354,7 +1345,7 @@ The recommended place to do this is in the REST storage strategy's Validate/Vali
13541345
}
13551346
```
13561347

1357-
5. After at least one release, the feature can be promoted to beta or GA. But it will only be enabled by default for GA.
1348+
5. After at least one release, the feature can be promoted to beta or GA and enabled by default.
13581349

13591350
In [staging/src/k8s.io/apiserver/pkg/features/kube_features.go](https://git.k8s.io/kubernetes/staging/src/k8s.io/apiserver/pkg/features/kube_features.go):
13601351

0 commit comments

Comments
 (0)