diff options
| author | Kubernetes Prow Robot <k8s-ci-robot@users.noreply.github.com> | 2022-08-25 06:04:07 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-25 06:04:07 -0700 |
| commit | aebb7a3860612bf7df485013c762f9e42e5ac82a (patch) | |
| tree | 24d4bbea2e4ae4dc1d39ad88b7741796c9ff2562 | |
| parent | 2ffb16959f6d20d4e91642235ee2d15affbfb3a1 (diff) | |
| parent | b1fa3ee688ed73348c7216920d8a7c9272181ca6 (diff) | |
Merge pull request #6816 from czunker/docs_beta_api
Fix some beta API documentation now that they are off by default
| -rw-r--r-- | contributors/devel/sig-architecture/api_changes.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/contributors/devel/sig-architecture/api_changes.md b/contributors/devel/sig-architecture/api_changes.md index b51e7a7d..22c22b05 100644 --- a/contributors/devel/sig-architecture/api_changes.md +++ b/contributors/devel/sig-architecture/api_changes.md @@ -921,8 +921,8 @@ doing! Check out the [E2E docs](../sig-testing/e2e-tests.md) for detailed information about how to write end-to-end tests for your feature. -Make sure the E2E tests are running in the default presubmits for a feature that -is being promoted to Beta (enabled by default). +Make sure the E2E tests are running in the default presubmits for a feature/API that +is enabled by default. ## Examples and docs @@ -984,7 +984,10 @@ complexity of upgradeability and lack of long-term support and lack of upgradability. - Beta level: - Object Versioning: API version name contains `beta` (e.g. `v2beta3`) - - Availability: in official Kubernetes releases, and enabled by default + - Availability: in official Kubernetes releases; API is disabled by default +but may be enabled by a flag. +(Note: beta APIs introduced before v1.24 were enabled by default, but this +[changed for new beta APIs](https://github.com/kubernetes/enhancements/blob/master/keps/sig-architecture/3136-beta-apis-off-by-default/README.md)) - Audience: users interested in providing feedback on features - Completeness: all API operations, CLI commands, and UI support should be implemented; end-to-end tests complete; the API has had a thorough API review |