From f958a6bd969eb2ec294352fac0bae7dc472bb939 Mon Sep 17 00:00:00 2001 From: windsonsea Date: Thu, 29 Sep 2022 09:44:36 +0800 Subject: [PATCH] [zh] Sync /reference/using-api/_index.md --- .../zh-cn/docs/reference/using-api/_index.md | 70 +++++++++++-------- 1 file changed, 40 insertions(+), 30 deletions(-) diff --git a/content/zh-cn/docs/reference/using-api/_index.md b/content/zh-cn/docs/reference/using-api/_index.md index ba1defcecde..6d6407c78d5 100644 --- a/content/zh-cn/docs/reference/using-api/_index.md +++ b/content/zh-cn/docs/reference/using-api/_index.md @@ -58,9 +58,8 @@ describes how clients can authenticate to the Kubernetes API server, and how the requests are authorized. --> 如需了解一般背景信息,请查阅 [Kubernetes API](/zh-cn/docs/concepts/overview/kubernetes-api/)。 -[Kubernetes API 控制访问](/zh-cn/docs/concepts/security/controlling-access/)描述了客户端如何 -向 Kubernetes API 服务器进行身份认证以及他们的请求如何被鉴权。 - +[Kubernetes API 控制访问](/zh-cn/docs/concepts/security/controlling-access/)描述了客户端如何向 +Kubernetes API 服务器进行身份认证以及他们的请求如何被鉴权。 API 版本控制和软件版本控制是间接相关的。 -[API 和发布版本控制提案](https://git.k8s.io/sig-release/release-engineering/versioning.md) -描述了 API 版本控制和软件版本控制间的关系。 +[API 和发布版本控制提案](https://git.k8s.io/sig-release/release-engineering/versioning.md)描述了 +API 版本控制和软件版本控制间的关系。 - Alpha: - 版本名称包含 `alpha`(例如:`v1alpha1`)。 + - 内置的 Alpha API 版本默认被禁用且必须在 `kube-apiserver` 配置中显式启用才能使用。 - 软件可能会有 Bug。启用某个特性可能会暴露出 Bug。 - 某些特性可能默认禁用。 - - 对某个特性的支持可能会随时被删除,恕不另行通知。 + - 对某个 Alpha API 特性的支持可能会随时被删除,恕不另行通知。 - API 可能在以后的软件版本中以不兼容的方式更改,恕不另行通知。 - 由于缺陷风险增加和缺乏长期支持,建议该软件仅用于短期测试集群。 - Beta: - 版本名称包含 `beta`(例如:`v2beta3`)。 + - 内置的 Alpha API 版本默认被禁用且必须在 `kube-apiserver` 配置中显式启用才能使用 + (例外情况是 Kubernetes 1.22 之前引入的 Beta 版本的 API,这些 API 默认被启用)。 + - 内置 Beta API 版本从引入到弃用的最长生命周期为 9 个月或 3 个次要版本(以较长者为准), + 从弃用到移除的最长生命周期为 9 个月或 3 个次要版本(以较长者为准)。 - 软件被很好的测试过。启用某个特性被认为是安全的。 - 特性默认开启。 - 尽管一些特性会发生细节上的变化,但它们将会被长期支持。 - 在随后的 Beta 版或 Stable 版中,对象的模式和(或)语义可能以不兼容的方式改变。 当这种情况发生时,将提供迁移说明。 - 模式更改可能需要删除、编辑和重建 API 对象。 - 编辑过程可能并不简单。 + 适配后续的 Beta 或 Stable API 版本可能需要编辑或重新创建 API 对象,这可能并不简单。 对于依赖此功能的应用程序,可能需要停机迁移。 - 该版本的软件不建议生产使用。 后续发布版本可能会有不兼容的变动。 - 如果你有多个集群可以独立升级,可以放宽这一限制。 + 一旦 Beta API 版本被弃用且不再提供服务, + 则使用 Beta API 版本的用户需要转为使用后续的 Beta 或 Stable API 版本。 {{< note >}} - Stable: - 版本名称如 `vX`,其中 `X` 为整数。 - 特性的 Stable 版本会出现在后续很多版本的发布软件中。 + Stable API 版本仍然适用于 Kubernetes 主要版本范围内的所有后续发布, + 并且 Kubernetes 的主要版本当前没有移除 Stable API 的修订计划。 -[API 组](https://git.k8s.io/design-proposals-archive/api-machinery/api-group.md) -能够简化对 Kubernetes API 的扩展。 -API 组信息出现在REST 路径中,也出现在序列化对象的 `apiVersion` 字段中。 +[API 组](https://git.k8s.io/design-proposals-archive/api-machinery/api-group.md)能够简化对 +Kubernetes API 的扩展。API 组信息出现在 REST 路径中,也出现在序列化对象的 `apiVersion` 字段中。 ## 启用或禁用 API 组 {#enabling-or-disabling} + 资源和 API 组是在默认情况下被启用的。 你可以通过在 API 服务器上设置 `--runtime-config` 参数来启用或禁用它们。 `--runtime-config` 参数接受逗号分隔的 `[=]` 对, 来描述 API 服务器的运行时配置。如果省略了 `=` 部分,那么视其指定为 `=true`。 例如: - - 禁用 `batch/v1`,对应参数设置 `--runtime-config=batch/v1=false` - - 启用 `batch/v2alpha1`,对应参数设置 `--runtime-config=batch/v2alpha1` - - 要启用特定版本的 API,如 `storage.k8s.io/v1beta1/csistoragecapacities`,可以设置 - `--runtime-config=storage.k8s.io/v1beta1/csistoragecapacities` + +- 禁用 `batch/v1`,对应参数设置 `--runtime-config=batch/v1=false` +- 启用 `batch/v2alpha1`,对应参数设置 `--runtime-config=batch/v2alpha1` +- 要启用特定版本的 API,如 `storage.k8s.io/v1beta1/csistoragecapacities`,可以设置 + `--runtime-config=storage.k8s.io/v1beta1/csistoragecapacities` {{< note >}} - 进一步了解 [API 惯例](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#api-conventions) -- 阅读 [聚合器](https://git.k8s.io/design-proposals-archive/api-machinery/aggregated-api-servers.md) +- 阅读[聚合器](https://git.k8s.io/design-proposals-archive/api-machinery/aggregated-api-servers.md)