红帽全球峰会API 参考
第 1 章 了解 API 层
这个指南不包括层次的红帽构建的 MicroShift 产品。
红帽要求应用程序开发人员验证他们所依赖的所有行为是否在正式的 API 文档中明确定义，以防止引入特定实施特定行为或对 API 特定实施错误的依赖项。例如，如果应用程序使用未文档化的 API 或依赖于未定义行为，则入口路由器的新版本可能无法与旧的版本兼容。
1.1. API 层
所有商业支持的 API、组件和功能都与以下支持级别之一相关联：
API 层 1
API 和应用程序操作环境(AOE)在主发行版本中保持稳定。它们在主版本中可能被弃用，但在后续的主发行版本前不会删除它们。
API 层 2
API 和 AOEs 在主发行版本中至少为 9 个月或 3 个次版本的发布周期（以更长的时间为准）。
API 层 3
此级别适用于通过 Operator Hub 的红帽构建 MicroShift 附带的语言、工具、应用程序和可选 Operator。每个组件都将指定一个生命周期，在其中支持 API 和 AOE。较新的语言运行时组件版本将尽量作为 API 和 AOE 兼容次版本。但是，无法保证次版本的兼容性。
通过 Operator Hub 接收持续更新的组件和开发人员工具（称为 Operator 和操作对象）应该被视为 API 层 3。开发人员应谨慎使用，并了解这些组件如何在每个次发行版本中改变。我们鼓励用户参考组件所记录的兼容性指南。
API 层 4
不提供兼容性。API 和 AOE 可在任何时候更改。这些功能不应由需要长期支持的应用程序使用。
Operator 在内部使用自定义资源定义 (CRD) 来完成任务是常见的。这些对象并应由 Operator 外部执行者使用，它旨在隐藏。如果任何 CRD 没有被 Operator 外部执行者使用，则 Operator ClusterServiceVersion (CSV)中的 operators.operatorframework.io/internal-objects 注解应指定给对应资源使用范围，并且 CRD 可能会明确标记为层 4。
1.2. 将 API 层映射到 API 组
对于由红帽定义的每个 API 层，我们为上游社区致力于保持向前兼容性的特定 API 组提供映射表。默认情况下，任何没有指定显式兼容性级别且未特别讨论的 API 组都会被分配 API 层 3，但 v1alpha1 API 默认被分配层 4。
1.2.1. 支持 Kubernetes API 组
以后缀 *.k8s.io 结尾的 API 组，或带有任何后缀的 version.<name> 均由 Kubernetes 弃用策略管理，并遵循公开和对应的支持层之间的通用映射，除非另有指定。
| API 版本示例 | API 层 |
|---|---|
|
| 1 级 |
|
| 2 级 |
|
| 4 级 |
1.2.2. 支持 OpenShift API 组
以后缀 If openshift.io 结尾的 API 组由红帽构建的 MicroShift 弃用策略管理，并遵循公开和对应的兼容性级别之间的通用映射，除非另有指定。
| API 版本示例 | API 层 |
|---|---|
|
| 1 级 |
|
|
1 级，除 |
1.3. API 弃用策略
红帽构建的 MicroShift 由许多来自上游社区的组件组成。因此，我们预计许多组件、关联的 API 接口和关联的功能集合将随着时间推移而有所变化，并且在功能被完成删除前会提供一个弃用的阶段。
1.3.1. 弃用的 API 部分
红帽构建的 MicroShift 是一个分布式系统，多个组件通过一组结构化 API 与由集群 control plane 管理的共享状态进行交互。根据 Kubernetes 惯例，红帽构建的 MicroShift 提供的每个 API 都与组标识符关联，每个 API 组都是独立的版本。每个 API 组都在不同的上游社区中管理，包括 Kubernetes、Metal3、Multus、Operator Framework、Open Cluster Management、OpenShift 本身等。
虽然每个上游社区可能会为给定的 API 组和版本定义自己的唯一弃用策略，但红帽会将社区特定策略规范化为之前定义的兼容性级别之一，具体取决于我们的集成和认知，以简化最终用户消费和支持。
API 的弃用策略和调度因兼容性级别而异。
弃用策略涵盖 API 的所有元素，包括：
- REST 资源，也称为 API 对象
- REST 资源的字段
- REST 资源的注解，不包括特定于版本的限定符
- Enumerated 或 constant 值
除每个组中最新的 API 版本外，在宣布弃用后，必须支持旧的 API 版本，且时间不少于：
| API 层 | Duration |
|---|---|
| 1 级 | 在一个主版本内是稳定的。它们在主版本中可能被弃用，但在后续的主发行版本前不会删除它们。 |
| 2 级 | 从公布弃用后的 9 个月或 3 个发行版本（以更长的时间为准）。 |
| 3 级 | 请参阅特定于组件的调度。 |
| 4 级 | 无。无法保证兼容性。 |
以下规则适用于所有 1 级 API：
- API 元素只能通过递增组版本来删除。
- API 对象必须能够在没有信息丢失的情况下在 API 版本之间往返，除非整个 REST 资源在某些版本中不存在。如果在版本之间没有对等的字段，数据将在转换过程中以注解的形式保留。
- 一个特定组中的 API 版本在新的 API 版本至少发行了一个稳定的版本前不会被弃用，除非整个 API 对象已被删除。
1.3.2. 弃用的 CLI 元素
对于面向客户端的 CLI 命令，它们的版本模式与 API 不同，它们是面向用户的组件系统。用户与 CLI 交互的两种主要方法是通过命令或标志（在此上下文中称为 CLI 元素）。
除非另有说明，否则所有 CLI 元素都默认为 API 层 1，除非另有说明或 CLI 依赖于较低层 API。
| 元素 | API 层 | |
|---|---|---|
| 正式发布(GA) | 标志和命令 | 1 级 |
| 技术预览 | 标志和命令 | 3 级 |
| 开发者预览 | 标志和命令 | 4 级 |
1.3.3. 弃用整个组件
弃用整个组件的持续时间和调度直接映射到与该组件公开的 API 的最高 API 层关联的持续时间。例如，在满足第 1 层弃用计划前，无法删除带有级别 1 和 2 的 API 的组件。
| API 层 | Duration |
|---|---|
| 1 级 | 在一个主版本内是稳定的。它们在主版本中可能被弃用，但在后续的主发行版本前不会删除它们。 |
| 2 级 | 从公布弃用后的 9 个月或 3 个发行版本（以更长的时间为准）。 |
| 3 级 | 请参阅特定于组件的调度。 |
| 4 级 | 无。无法保证兼容性。 |
第 2 章 了解 API 兼容性指南
按照兼容性指南以了解为 MicroShift 的红帽构建启用的 API。
这个指南不包括层次的红帽构建的 MicroShift 产品。
2.1. API 兼容性指南
红帽建议应用程序开发人员使用以下原则来改进与红帽构建的 MicroShift 的兼容性：
- 使用与应用需求匹配的 API 和组件，支持层。
- 尽可能使用公布的客户端库构建应用程序。
- 只有应用程序在作为新环境构建的环境中执行时，才能保证正确运行。为红帽构建的 MicroShift 4.14 构建的应用程序无法保证在红帽构建的 MicroShift 4.13 上正常工作。
- 不要设计依赖于系统软件包或其他组件提供的配置文件的应用程序。除非上游社区明确提交来保留它们，否则这些文件可以在不同版本之间更改。在适当的情况下，依靠任何红帽在这些配置文件中提供接口抽象，以便保持向前兼容性。不鼓励直接修改配置文件，强烈建议用户与提供的 API 集成，以避免双写器冲突。
-
不要依赖于以
unsupported<FieldName>或在产品文档中未明确提及的注解作为前缀的 API 字段。 - 不要依赖于比您的应用程序更短的兼容性保证。
- 不要在 etcd 服务器上执行直接存储操作。所有 etcd 访问都必须通过 api-server 或记录的备份和恢复步骤执行。
红帽建议应用程序开发人员遵循 Red Hat Enterprise Linux (RHEL)定义的兼容性指南。红帽构建的 MicroShift 强烈推荐以下准则，在构建应用程序或在此平台上托管应用程序：
- 不要依赖于特定的 Linux 内核或 MicroShift 版本的红帽构建。
-
避免从
proc、sys和debug文件系统，或任何其他伪文件系统读取。 -
避免使用
ioctls直接与硬件交互。 -
避免直接与
cgroups交互，以便不与红帽构建的 MicroShift 主机代理冲突，后者提供容器执行环境。
在发行版本的生命周期中，红帽采取商业合理的努力来维护所有次发行版本和 z-stream 版本中的 API 和应用程序操作环境 (AOE) 兼容性。但是如有必要，红帽会就安全影响级别为“关键（Critical）”的安全问题或者其他严重问题在兼容性方面做例外处理。
2.2. API 兼容性例外
以下是红帽构建的 MicroShift 中兼容性的例外：
升级的集群和新安装之间的功能默认
目前，产品次版本的新安装功能与之前次版本一起安装的产品版本相同，不会进行保证。例如，未来版本的产品可能会置备云基础架构，其默认值与之前的次版本不同。此外，未来版本的产品中可能会进行不同的默认安全选择。产品的过去版本将会向前升级，但仍然保留了旧的选择，以便保持向后兼容性。
使用前缀 "unsupported" 或 undocumented 注解的 API 字段
在产品公开字段中，选择带有前缀 unsupported<FieldName> 的 API。不保证，目前在不同版本间或一个版本内支持使用这个字段。产品支持可在调试特定问题时请求在此字段中指定值，但在该交互之外不支持其使用。在未明确记录的对象中使用注解在次版本间不会保证支持。
每个产品安装拓扑的 API 可用性
OpenShift 发行版将继续演进其支持的安装拓扑，且不是一个安装拓扑中的所有 API 都必须包含在另一个安装中。例如，如果某些拓扑与产品安装拓扑冲突，或者根本不包括特定的 API，则某些拓扑可能会限制对特定 API 的读/写访问。根据上面定义的兼容性层，支持给定拓扑中存在的 API。
2.3. API 兼容性常见术语
2.3.1. 应用程序编程接口 (API)
API 是一个由软件程序实现的公共接口，它允许它与其他软件交互。在 MicroShift 的红帽构建中，API 从集中式 API 服务器提供，用作所有系统交互的中心。
2.3.2. 应用程序操作环境 (AOE)
AOE 是执行最终用户应用程序程序的集成环境。AOE 是一个容器化环境，提供与主机操作系统 (OS) 隔离的。至少，AOE 允许应用程序以独立于主机操作系统库和二进制文件运行，但仍然与主机上的所有其他容器共享相同的 OS 内核。AOE 在运行时强制执行，它描述了应用程序及其操作环境之间的接口。它包括平台操作系统和环境的交集点，以及用户应用程序，包括 Downward API、DNS、资源核算、设备访问、平台工作负载身份、容器之间隔离、容器和主机操作系统之间的隔离。
AOE 不包括安装可能因安装而异的组件，如 Container Network Interface (CNI)插件选择或对产品的扩展，如准入 hook。在容器环境下面的级别与集群集成的组件可能会受到不同版本之间的其他变化。
2.3.3. 虚拟化环境中的兼容性
虚拟环境模拟裸机环境，这样在裸机环境中运行的非特权应用程序将在对应的虚拟环境中运行。虚拟环境改进了物理资源的抽象视图，因此可能存在一些差异。
2.3.4. 云环境中的兼容性
红帽构建的 MicroShift 可能会选择通过云供应商特定集成提供与托管云环境的集成点。这些集成点的兼容性特定于原生云供应商提供的保证，及其与红帽构建的 MicroShift 兼容性窗口交集。如果红帽构建的 MicroShift 作为默认安装的一部分原生地与云环境集成，红帽针对稳定的云 API 端点开发，以提供合理的商业支持，包括稳定的弃用策略。云供应商与红帽构建的 MicroShift 之间的集成示例包括：但不仅限于动态卷置备、服务负载均衡器集成、pod 工作负载身份、计算的动态管理，以及作为初始安装的一部分置备的基础架构。
2.3.5. 主版本、次版本和 z-stream 版本
红帽主发行版本代表了开发产品的显著步骤。次发行版本会出现在主发行版本范围内，并代表弃用界限可能会影响将来的应用程序兼容性。z-stream 版本是次版本的更新，它为关联的次版本提供持续修复流。API 和 AOE 兼容性永远不会在 z-stream 版本中中断，除非明确覆盖此策略以响应不可预见的安全影响。
例如，在版本 4.13.2 中：
- 4 是主版本
- 13 是次版本
- 2 是 z-stream 版本
2.3.6. 扩展的用户支持 (EUS)
一个 Red Hat build of MicroShift 主发行版本中的一个次发行版本，它有一个对关键程序错误修复的延长支持窗口。通过在 EUS 版本之间使用次版本，用户可以在 EUS 版本之间迁移 EUS 版本。请注意，弃用策略是在次发行版本中定义，而不是 EUS 版本。因此，在通过每个次版本按顺序升级时，EUS 用户可能需要在迁移到将来的 EUS 时响应弃用。
2.3.7. 开发者预览
可选的产品功能不受红帽官方支持，但旨在提供探索早期阶段技术的机制。默认情况下，开发人员预览功能是 opt-in，可以随时删除。启用开发人员预览功能可能会导致集群无法支持，这取决于该功能的范围。
2.3.8. 技术预览
提供即将推出的产品创新的可选产品功能，以测试功能并在开发过程中提供反馈。这个功能没有被完全支持，可能无法正常工作，且不适用于生产环境。使用技术预览功能需要明确选择。了解有关 技术预览功能支持范围 的更多信息。
第 3 章 API 索引
| API | API 组 |
|---|---|
| apiregistration.k8s.io/v1 | |
| v1 | |
| certificates.k8s.io/v1 | |
| rbac.authorization.k8s.io/v1 | |
| rbac.authorization.k8s.io/v1 | |
| v1 | |
| v1 | |
| apps/v1 | |
| batch/v1 | |
| storage.k8s.io/v1 | |
| storage.k8s.io/v1 | |
| storage.k8s.io/v1 | |
| apiextensions.k8s.io/v1 | |
| apps/v1 | |
| apps/v1 | |
| v1 | |
| discovery.k8s.io/v1 | |
| v1 | |
| events.k8s.io/v1 | |
| policy/v1 | |
| flowcontrol.apiserver.k8s.io/v1beta3 | |
| autoscaling/v2 | |
| networking.k8s.io/v1 | |
| networking.k8s.io/v1 | |
| batch/v1 | |
| coordination.k8s.io/v1 | |
| v1 | |
| authorization.k8s.io/v1 | |
| topolvm.io/v1 | |
| admissionregistration.k8s.io/v1 | |
| v1 | |
| networking.k8s.io/v1 | |
| v1 | |
| v1 | |
| v1 | |
| v1 | |
| policy/v1 | |
| v1 | |
| scheduling.k8s.io/v1 | |
| flowcontrol.apiserver.k8s.io/v1beta3 | |
| security.internal.openshift.io/v1 | |
| apps/v1 | |
| v1 | |
| v1 | |
| rbac.authorization.k8s.io/v1 | |
| rbac.authorization.k8s.io/v1 | |
| route.openshift.io/v1 | |
| node.k8s.io/v1 | |
| autoscaling/v1 | |
| v1 | |
| security.openshift.io/v1 | |
| authorization.k8s.io/v1 | |
| authorization.k8s.io/v1 | |
| v1 | |
| v1 | |
| apps/v1 | |
| storage.k8s.io/v1 | |
| migration.k8s.io/v1alpha1 | |
| authorization.k8s.io/v1 | |
| authentication.k8s.io/v1 | |
| authentication.k8s.io/v1 | |
| admissionregistration.k8s.io/v1 | |
| storage.k8s.io/v1 | |
| snapshot.storage.k8s.io/v1 | |
| snapshot.storage.k8s.io/v1 | |
| snapshot.storage.k8s.io/v1 |
第 4 章 API 对象引用
4.1. 通用对象引用
- 描述
- MutatingWebhookConfigurationList 是 MutatingWebhookConfiguration 列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| MutatingWebhookConfiguration 列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
- 描述
- ValidatingWebhookConfigurationList 是 ValidatingWebhookConfiguration 列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| ValidatingWebhookConfiguration 列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.3. io.k8s.api.apps.v1.ControllerRevisionList schema
- 描述
- ControllerRevisionList 是一个包含 ControllerRevision 对象列表的资源。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 ControllerRevisions 列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
4.1.4. io.k8s.api.apps.v1.DaemonSetList schema
- 描述
- DaemonSetList 是守护进程集的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| 守护进程集列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
4.1.5. io.k8s.api.apps.v1.DeploymentList schema
- 描述
- DeploymentList 是一个 Deployments 列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 Deployments 列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。 |
4.1.6. io.k8s.api.apps.v1.ReplicaSetList schema
- 描述
- ReplicaSetList 是 ReplicaSets 的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| ReplicaSets 列表。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.7. io.k8s.api.apps.v1.StatefulSetList schema
- 描述
- StatefulSetList 是 StatefulSets 的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是有状态的集合的列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表的元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
- 描述
- HorizontalPodAutoscalerList 是 pod 横向自动扩展对象的列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 pod 横向自动扩展对象的列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| metadata 是标准列表元数据。 |
4.1.9. io.k8s.api.batch.v1.CronJobList schema
- 描述
- CronJobList 是 cron 任务的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 CronJobs 的列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
4.1.10. io.k8s.api.batch.v1.JobList schema
- 描述
- JobList 是作业的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是作业列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
- 描述
- CertificateSigningRequestList 是 CertificateSigningRequest 对象的集合
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 CertificateSigningRequest 对象的集合 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
4.1.12. io.k8s.api.coordination.v1.LeaseList schema
- 描述
- LeaseList 是 Lease 对象的列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 schema 对象列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
4.1.13. io.k8s.api.core.v1.Affinity schema
- 描述
- affinity 是一组关联性调度规则。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 描述 pod 的节点关联性调度规则。 | |
|
| 描述 pod 关联性调度规则（例如，将这个 pod 放置到同一节点、区域等）中。 | |
|
| 描述 pod 反关联性调度规则（例如，避免将此 pod 放置到同一节点、区域等）中。 |
- 描述
代表 AWS 中的 Persistent Disk 资源。
挂载到容器前必须存在 AWS EBS 磁盘。磁盘还必须与 kubelet 位于同一个 AWS 区域。AWS EBS 磁盘只能以读写模式挂载。AWS EBS 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
object - 必填
-
volumeID
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| fstype 是您要挂载的卷的文件系统类型。提示： 确保主机操作系统支持文件系统类型。示例："ext4", "xfs", "ntfs"。如果未指定，则隐式推断为"ext4"。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
|
| partition 是您要挂载的卷中的分区。如果省略，则默认为按卷名称挂载。示例：对于卷 /dev/sda1，您可以将分区指定为 "1"。同样，/dev/sda 的卷分区是 "0" （或者您可以将属性留空）。 |
|
|
| readonly 值 true 将强制 VolumeMounts 中的 readOnly 设置。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
|
| VolumeId 是 AWS (Amazon EBS 卷)中的持久磁盘资源的唯一 ID。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
4.1.15. io.k8s.api.core.v1.AzureDiskVolumeSource schema
- 描述
- azureDisk 代表主机上的 Azure Data Disk 挂载，并绑定到 pod。
- 类型
-
object - 必填
-
diskName -
diskURI
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| cachingMode 是主机缓存模式： None、Read Only、Read Write。
可能枚举值： - |
|
|
| diskname 是 blob 存储中的数据磁盘的名称 |
|
|
| diskURI 是 blob 存储中数据磁盘的 URI |
|
|
| fstype 是要挂载的 Filesystem 类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定，则隐式推断为"ext4"。 |
|
|
| kind expected 值是 Shared: multiple blob disk per storage account Managed: azure disk per storage account Managed: azure managed data disk (only in managed availability set)）。默认为 shared
possible enum 值： - |
|
|
| 只读默认值为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
- 描述
- azureFile 代表主机上的 Azure File Service 挂载，并绑定到 pod。
- 类型
-
object - 必填
-
secretName -
shareName
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 只读默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
|
| secretName 是包含 Azure Storage Account Name 和 Key 的 secret 名称 |
|
|
| secretNamespace 是包含 Azure Storage Account Name 和 Key default 的 secret 的命名空间与 Pod 相同 |
|
|
| sharename 是 azure Share Name |
4.1.17. io.k8s.api.core.v1.AzureFileVolumeSource schema
- 描述
- azureFile 代表主机上的 Azure File Service 挂载，并绑定到 pod。
- 类型
-
object - 必填
-
secretName -
shareName
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 只读默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
|
| secretName 是包含 Azure Storage Account Name 和 Key 的 secret 名称 |
|
|
| sharename 是 azure 共享名称 |
4.1.18. io.k8s.api.core.v1.Capabilities schema
- 描述
- 从正在运行的容器中添加和删除 POSIX 功能。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 添加了功能 |
|
|
| 删除的功能 |
- 描述
- 代表 Ceph 文件系统挂载，最后一个 pod Cephfs 卷的生命周期不支持所有权管理或 SELinux 重新标记。
- 类型
-
object - 必填
-
monitor
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Monitors is Required: Monitor is a collection of Ceph monitors more info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
|
| 路径为可选： 作为挂载的 root 使用，而不是完整的 Ceph 树，默认为 / |
|
|
| readonly 是可选的：默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。更多信息： https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
|
| secretfile 是可选：SecretFile 是 User 的密钥环的路径，默认为 /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| secretRef 是可选的：SecretRef 是对 User 的身份验证 secret 的引用，默认为空。更多信息： https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it | |
|
|
| 用户是可选的： User 是 rados 用户名，默认为 admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
4.1.20. io.k8s.api.core.v1.CephFSVolumeSource schema
- 描述
- 代表 Ceph 文件系统挂载，最后一个 pod Cephfs 卷的生命周期不支持所有权管理或 SELinux 重新标记。
- 类型
-
object - 必填
-
monitor
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Monitors is Required: Monitor is a collection of Ceph monitors more info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
|
| 路径为可选： 作为挂载的 root 使用，而不是完整的 Ceph 树，默认为 / |
|
|
| readonly 是可选的：默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。更多信息： https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
|
| secretfile 是可选：SecretFile 是 User 的密钥环的路径，默认为 /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| secretRef 是可选的：SecretRef 是对 User 的身份验证 secret 的引用，默认为空。更多信息： https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it | |
|
|
| 用户是可选的： User 是 rados 用户名，默认为 admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
- 描述
- 代表 Openstack 中的 cinder 卷资源。挂载到容器之前必须存在 Cinder 卷。卷还必须与 kubelet 位于同一区域。Cinder 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
object - 必填
-
volumeID
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 要挂载的 fstype Filesystem 类型。必须是主机操作系统支持的文件系统类型。示例："ext4", "xfs", "ntfs"。如果未指定，则隐式推断为"ext4"。更多信息： https://examples.k8s.io/mysql-cinder-pd/README.md |
|
|
| readonly 是可选的：默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。更多信息： https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| secretRef 是可选的：指向包含用于连接 OpenStack 的参数的 secret 对象。 | |
|
|
| 用于识别 cinder 中的卷的卷 ID。更多信息： https://examples.k8s.io/mysql-cinder-pd/README.md |
4.1.22. io.k8s.api.core.v1.CinderVolumeSource schema
- 描述
- 代表 Openstack 中的 cinder 卷资源。挂载到容器之前必须存在 Cinder 卷。卷还必须与 kubelet 位于同一区域。Cinder 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
object - 必填
-
volumeID
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。示例："ext4", "xfs", "ntfs"。如果未指定，则隐式推断为"ext4"。更多信息： https://examples.k8s.io/mysql-cinder-pd/README.md |
|
|
| 只读默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。更多信息： https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| secretRef 是可选的：指向包含用于连接 OpenStack 的参数的 secret 对象。 | |
|
|
| 用于识别 cinder 中的卷的卷 ID。更多信息： https://examples.k8s.io/mysql-cinder-pd/README.md |
4.1.23. io.k8s.api.core.v1.ClaimSource schema
- 描述
ClaimSource 描述了对 ResourceClaim 的引用。
应设置其中一个字段。这个类型的消费者必须将空对象视为一个未知值。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| ResourceClaimName 是与这个 pod 相同的命名空间中的 ResourceClaim 对象的名称。 |
|
|
| ResourceClaimTemplateName 是与这个 pod 相同的命名空间中的 ResourceClaimTemplate 对象的名称。 模板将用于创建新的 ResourceClaim，它将绑定到此 pod。删除此 pod 后，ResourceClaim 也会被删除。ResourceClaim 的名称将是 <pod name>-<resource name>，其中 <resource name> 是 PodResourceClaim.Name。如果串联名称对 ResourceClaim 无效（如太长，则 Pod 验证将拒绝 pod）。 没有为 pod 拥有该名称的现有 ResourceClaim 不会被用于 pod，以避免错误地使用不相关的资源。然后，调度和 pod 启动会被阻断，直到删除不相关的 ResourceClaim。 此字段不可变，在创建 ResourceClaim 后，control plane 不会对对应的 ResourceClaim 进行更改。 |
4.1.24. io.k8s.api.core.v1.ComponentStatusList schema
- 描述
- 组件的所有条件的状态作为 ComponentStatus 对象列表。弃用：此 API 在 v1.19+ 中弃用
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| 组件状态对象列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.25. io.k8s.api.core.v1.ConfigMapEnvSource schema
- 描述
ConfigMapEnvSource 选择一个 ConfigMap 来填充环境变量。
目标 ConfigMap 的 Data 字段的内容将以环境变量的形式表示键值对。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 指定是否必须定义 ConfigMap |
4.1.26. io.k8s.api.core.v1.ConfigMapKeySelector schema
- 描述
- 从 ConfigMap 中选择一个键。
- 类型
-
object - 必填
-
key
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 要选择的密钥。 |
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 指定是否必须定义 ConfigMap 还是其键 |
4.1.27. io.k8s.api.core.v1.ConfigMapList schema
- 描述
- ConfigMapList 是一个包含 ConfigMap 对象列表的资源。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 ConfigMap 的列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
4.1.28. io.k8s.api.core.v1.ConfigMapProjection schema
- 描述
将 ConfigMap 调整为投射卷。
目标 ConfigMap 的 Data 字段的内容将作为文件出现在投射卷中，使用 Data 字段中的密钥作为文件名，除非 items 元素填充了键到路径的特定映射。请注意，这与没有默认模式的 configmap 卷源相同。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 如果未指定项目，则引用 ConfigMap 的 Data 字段中的每一键值对将投射到卷中，名称为键，内容是值。如果指定，列出的键将投射到指定的路径中，且未列出的密钥将不存在。如果指定了在 ConfigMap 中不存在的密钥，则卷设置将错误，除非标记为可选。路径必须是 relative，且不能包含 '..' 路径或以 '..' 开头。 | |
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 可选指定是否必须定义 ConfigMap 还是其键 |
4.1.29. io.k8s.api.core.v1.ConfigMapVolumeSource schema
- 描述
将 ConfigMap 调整为卷。
目标 ConfigMap 的 Data 字段的内容将作为文件显示在卷中，使用 Data 字段中的密钥作为文件名，除非 items 元素填充了键到路径的特定映射。ConfigMap 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| defaultMode 是可选的：用于默认设置创建文件的权限的模式位。必须是 0000 到 0777 之间的数值，也可以是 0 到 511 之间的十进制值。YAML 接受八进制值和十进制值，JSON 需要模式位的十进制值。默认值为 0644。该路径中的目录不受此设置的影响。这可能会与影响文件模式的其他选项（如 fsGroup ）冲突，结果可以是设置其他模式位。 |
|
| 如果未指定项目，则引用 ConfigMap 的 Data 字段中的每一键值对将投射到卷中，名称为键，内容是值。如果指定，列出的键将投射到指定的路径中，且未列出的密钥将不存在。如果指定了在 ConfigMap 中不存在的密钥，则卷设置将错误，除非标记为可选。路径必须是 relative，且不能包含 '..' 路径或以 '..' 开头。 | |
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 可选指定是否必须定义 ConfigMap 还是其键 |
4.1.30. io.k8s.api.core.v1.Container schema
- 描述
- 要在 pod 中运行的单一应用程序容器。
- 类型
-
object - 必填
-
name
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 入口点的参数。如果没有提供，则使用容器镜像的 CMD。变量引用 $(VAR_NAME)使用容器环境扩展。如果无法解析变量，输入字符串中的引用将不会改变。双引号被减少为一个 $，它允许转义 $(VAR_NAME)语法：例如：" (VAR_NAME) " 将生成字符串 literal "$(VAR_NAME) "。转义的引用永远不会被扩展，无论变量是否存在。无法更新。更多信息： https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
|
|
| ENTRYPOINT 数组.不会在 shell 中执行。如果没有提供，则使用容器镜像的 ENTRYPOINT。变量引用 $(VAR_NAME)使用容器环境扩展。如果无法解析变量，输入字符串中的引用将不会改变。双引号被减少为一个 $，它允许转义 $(VAR_NAME)语法：例如：" (VAR_NAME) " 将生成字符串 literal "$(VAR_NAME) "。转义的引用永远不会被扩展，无论变量是否存在。无法更新。更多信息： https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
|
| 要在容器中设置的环境变量列表。无法更新。 | |
|
| 用于在容器中填充环境变量的源列表。源中定义的键必须是 C_IDENTIFIER。当容器启动时，所有无效的密钥都会被报告为事件。当多个源中存在键时，与最后一个源关联的值将具有优先权。由带有重复键的 Env 定义的值将具有优先权。无法更新。 | |
|
|
| 容器镜像名称。更多信息： https://kubernetes.io/docs/concepts/containers/images 此字段是可选的，允许更高级别的配置管理默认或覆盖工作负载控制器中的容器镜像，如 Deployment 和 StatefulSets。 |
|
|
| 镜像拉取策略。Always, Never, IfNotPresent 之一。如果指定了 :latest 标签，则默认为 Always，否则为 IfNotPresent。无法更新。更多信息： https://kubernetes.io/docs/concepts/containers/images#updating-images
可能枚举值： - |
|
| 管理系统应采取的操作来响应容器生命周期事件。无法更新。 | |
|
| 容器存活度的定期探测.如果探测失败，将重启容器。无法更新。更多信息： https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | |
|
|
| 指定为 DNS_LABEL 的容器的名称。pod 中的每个容器都必须具有唯一名称(DNS_LABEL)。无法更新。 |
|
| 要从容器公开的端口列表。不在此处指定端口 不会阻止公开该端口。任何正在侦听容器内的默认"0.0.0.0"地址的端口都可以从网络访问。使用战略合并补丁修改此阵列可能会破坏数据。如需更多信息，请参阅 https://github.com/kubernetes/kubernetes/issues/108255。无法更新。 | |
|
| 容器服务的定期探测就绪。如果探测失败，容器将从服务端点中删除。无法更新。更多信息： https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | |
|
| 容器的资源重新定义策略大小。 | |
|
| 此容器所需的计算资源。无法更新。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | |
|
| securityContext 定义容器应使用运行的安全选项。如果设置，SecurityContext 的字段会覆盖 PodSecurityContext 的等效字段。更多信息： https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ | |
|
| startupProbe 表示 Pod 已成功初始化。如果指定，则不会执行其他探测，直到成功完成为止。如果这个探测失败，则 Pod 将重启，就像 livenessProbe 失败一样。这可用于在 Pod 生命周期开始时提供不同的探测参数，当可能需要很长时间才能加载数据或温缓存，而不是在 steady-state 操作期间进行。这不能被更新。更多信息： https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | |
|
|
| 此容器是否应该为容器运行时中的 stdin 分配缓冲区。如果没有设置，则从容器中的 stdin 读取总是会导致 EOF。默认值为 false。 |
|
|
| 容器运行时是否应该在单个附加打开后关闭 stdin 频道。当 stdin 为 true 时，stdin 流将在多个附加会话之间保持打开。如果将 stdinOnce 设为 true，则 stdin 在容器启动时打开，会为空，直到第一个客户端附加到 stdin，然后保持打开并接受数据，直到客户端断开连接，而时间 stdin 被关闭并保持关闭，直到容器重启为止。如果此标志为 false，则从 stdin 读取的容器进程永远不会收到 EOF。默认值为 false |
|
|
| 可选：将容器终止消息写入的文件路径被挂载到容器文件系统中。编写的消息应该是简短的最终状态，如断言失败消息。如果大于 4096 字节，则节点将被截断。所有容器的消息长度限制为 12kb。默认为 /dev/termination-log。无法更新。 |
|
|
| 指明如何填充终止消息。文件将使用 terminationMessagePath 的内容在成功和失败时填充容器状态消息。如果终止消息文件为空，并且容器退出并显示错误，则 FallbackToLogsOnError 将使用容器日志输出的最后块。日志输出限制为 2048 字节或 80 行，以较大者为准。默认为 file。无法更新。
可能的 enum 值： - |
|
|
| 此容器是否应为自己分配 TTY，还需要 'stdin' 为 true。默认值为 false。 |
|
| volumeDevices 是容器使用的块设备列表。 | |
|
| 要挂载到容器文件系统中的 Pod 卷。无法更新。 | |
|
|
| 容器的工作目录。如果没有指定，则使用容器运行时的默认值，这可能会在容器镜像中配置。无法更新。 |
4.1.31. io.k8s.api.core.v1.ContainerPort schema
- 描述
- containerPort 代表单一容器中的网络端口。
- 类型
-
object - 必填
-
containerPort
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 在 pod 的 IP 地址上公开的端口号。这必须是有效的端口号 0 < x < 65536。 |
|
|
| 将外部端口绑定到的主机 IP。 |
|
|
| 要在主机上公开的端口号。如果指定，这必须是有效的端口号，0 < x < 65536。如果指定了 HostNetwork，则必须匹配 ContainerPort。大多数容器都不需要此操作。 |
|
|
| 如果指定，这必须是 IANA_SVC_NAME，并在 pod 中唯一。pod 中的每个指定端口都必须具有唯一的名称。服务可以引用的端口的名称。 |
|
|
| 端口的协议。必须是 UDP、TCP 或 SCTP。默认为 "TCP"。
可能的值有： - |
4.1.32. io.k8s.api.core.v1.ContainerResizePolicy schema
- 描述
- ContainerResizePolicy 代表容器的资源大小策略。
- 类型
-
object - 必填
-
resourceName -
restartPolicy
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 应用此资源调整大小策略的资源名称。支持的值：cpu、memory。 |
|
|
| 在调整指定资源大小时，重启策略会应用。如果没有指定，则默认为 NotRequired。 |
- 描述
- 代表由外部 CSI 卷驱动程序(Beta 功能)管理的存储
- 类型
-
object - 必填
-
driver -
volumeHandle
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| controllerExpandSecretRef 是对包含要传递给 CSI 驱动程序的敏感信息的 secret 对象的引用，以完成 CSI ControllerExpandVolume 调用。此字段是可选的，如果不需要 secret，则可能为空。如果 secret 对象包含多个 secret，则所有 secret 都会被传递。 | |
|
| controllerPublishSecretRef 是对包含要传递给 CSI 驱动程序的 secret 对象的引用，以完成 CSI ControllerPublishVolume 和 ControllerUnpublishVolume 调用。此字段是可选的，如果不需要 secret，则可能为空。如果 secret 对象包含多个 secret，则所有 secret 都会被传递。 | |
|
|
| driver 是要用于此卷的驱动程序名称。必需。 |
|
|
| 要挂载的 fstype。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs". |
|
| nodeExpandSecretRef 是对包含要传递给 CSI 驱动程序的 secret 对象的引用，以完成 CSI NodeExpandVolume 调用。这是一个 beta 字段，由 CSINodeExpandSecret 功能门启用。如果不需要 secret，则可以省略此字段。如果 secret 对象包含多个 secret，则所有 secret 都会被传递。 | |
|
| nodePublishSecretRef 是对包含要传递给 CSI 驱动程序的 secret 对象的引用，以完成 CSI NodePublishVolume 和 NodeUnpublishVolume 调用。此字段是可选的，如果不需要 secret，则可能为空。如果 secret 对象包含多个 secret，则所有 secret 都会被传递。 | |
|
| nodeStageSecretRef 是包含传递给 CSI 驱动程序的 secret 对象的引用，以完成 CSI NodeStageVolume 和 NodeStageVolume 和 NodeUnstageVolume 调用。此字段是可选的，如果不需要 secret，则可能为空。如果 secret 对象包含多个 secret，则所有 secret 都会被传递。 | |
|
|
| 传递给 ControllerPublishVolumeRequest 的 readonly 值。默认为 false （读/写）。 |
|
|
| 要发布的卷的 volumeAttributes。 |
|
|
| volumeHandle 是 CSI 卷插件的 CreateVolume 返回的唯一卷名称，以在所有后续调用中引用卷。必需。 |
4.1.34. io.k8s.api.core.v1.CSIVolumeSource schema
- 描述
- 代表由外部 CSI 驱动程序管理的卷的源位置
- 类型
-
object - 必填
-
driver
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| driver 是处理这个卷的 CSI 驱动程序的名称。请参考您的管理员获取集群中注册的正确名称。 |
|
|
| 要挂载的 fstype。Ex. "ext4", "xfs", "ntfs".如果没有提供，空值会被传递给关联的 CSI 驱动程序，该驱动程序将决定要应用的默认文件系统。 |
|
| nodePublishSecretRef 是对包含要传递给 CSI 驱动程序的 secret 对象的引用，以完成 CSI NodePublishVolume 和 NodeUnpublishVolume 调用。此字段是可选的，如果不需要 secret，则可能为空。如果 secret 对象包含多个 secret，则所有 secret 引用都会传递。 | |
|
|
| readonly 指定卷的只读配置。默认为 false （读/写）。 |
|
|
| volumeAttributes 存储传递给 CSI 驱动程序的特定于驱动程序的属性。如需支持的值，请参考您的驱动程序文档。 |
4.1.35. io.k8s.api.core.v1.DownwardAPIProjection schema
- 描述
- 代表下下 API 信息，用于项目到投射卷中。请注意，这与没有默认模式的卷源相同。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| items 是 DownwardAPIVolume 文件列表 |
4.1.36. io.k8s.api.core.v1.DownwardAPIVolumeFile schema
- 描述
- DownwardAPIVolumeFile 代表信息，以创建包含 pod 字段的文件
- 类型
-
object - 必填
-
path
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 必需：选择 pod 的字段：只支持注解、标签、名称和命名空间。 | |
|
|
| 可选：用于在此文件上设置权限的模式位，必须是 0000 到 0777 之间或 0 到 511 之间的十进制值。YAML 接受八进制值和十进制值，JSON 需要模式位的十进制值。如果没有指定，则使用卷 defaultMode。这可能会与影响文件模式的其他选项（如 fsGroup ）冲突，结果可以是设置其他模式位。 |
|
|
| 必需：Path 是要创建的文件的相对路径名称。不能绝对或包含 '..' 路径。必须采用 utf-8 编码。相对路径的第一个项目不能以 '..' 开头。 |
|
| 选择容器的资源：当前仅支持资源限值和请求(limits.cpu、limit.memory、request.cpu 和 requests.memory)。 |
- 描述
- DownwardAPIVolumeSource 代表包含 Downward API 信息的卷。Downward API 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 可选：默认在创建的文件中使用的模式位。必须是可选：用于默认设置创建文件的权限的模式位。必须是 0000 到 0777 之间的数值，也可以是 0 到 511 之间的十进制值。YAML 接受八进制值和十进制值，JSON 需要模式位的十进制值。默认值为 0644。该路径中的目录不受此设置的影响。这可能会与影响文件模式的其他选项（如 fsGroup ）冲突，结果可以是设置其他模式位。 |
|
| items 是 Downward API 卷文件列表 |
4.1.38. io.k8s.api.core.v1.EmptyDirVolumeSource schema
- 描述
- 表示 pod 的空目录。空目录卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Medium 代表这个目录应该支持哪些存储类型。默认值为 ""，它需要使用节点的默认介质。必须是空字符串（默认）或 Memory。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
|
| sizeLimit 是此 EmptyDir 卷所需的本地存储总量。大小限制也适用于内存介质。内存用量 EmptyDir 的最大用法是此处指定的 SizeLimit 和 pod 中所有容器的内存限值总和。默认值为 nil，表示限制未定义。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
4.1.39. io.k8s.api.core.v1.EndpointsList schema
- 描述
- EndpointsList 是端点列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| 端点列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.40. io.k8s.api.core.v1.EnvFromSource schema
- 描述
- EnvFromSource 代表一组 ConfigMap 的源
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 要从中选择的 ConfigMap | |
|
|
| 用于添加到 ConfigMap 中每个键的可选标识符。必须是 C_IDENTIFIER。 |
|
| 要从中选择的 Secret |
4.1.41. io.k8s.api.core.v1.EnvVar schema
- 描述
- EnvVar 代表容器中存在的环境变量。
- 类型
-
object - 必填
-
name
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 环境变量的名称。必须是 C_IDENTIFIER。 |
|
|
| 变量引用 $(VAR_NAME)使用容器中之前定义的环境变量和任何服务环境变量进行扩展。如果无法解析变量，输入字符串中的引用将不会改变。双引号被减少为一个 $，它允许转义 $(VAR_NAME)语法：例如：" (VAR_NAME) " 将生成字符串 literal "$(VAR_NAME) "。转义的引用永远不会被扩展，无论变量是否存在。默认值为 ""。 |
|
| 环境变量的值的源。如果 value 不是空，则无法使用。 |
4.1.42. io.k8s.api.core.v1.EnvVarSource schema
- 描述
- EnvVarSource 代表 EnvVarar 的值的一个源。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 选择 ConfigMap 的密钥。 | |
|
|
选择 pod 的字段：支持 metadata.name, metadata.namespace, | |
|
| 选择容器的资源：当前仅支持资源限值和请求(limits.cpu、limits.memory、limits.ephemeral-storage、request.cpu、request.memory 和 requests.ephemeral-storage)。 | |
|
| 在 pod 命名空间中选择 secret 的密钥 |
4.1.43. io.k8s.api.core.v1.EphemeralContainer schema
- 描述
EphemeralContainer 是一个临时容器，您可以为用户发起的活动（如调试）添加到现有 Pod 中。临时容器没有资源或调度保证，在 Pod 退出或重启时不会重启它们。如果临时容器导致 Pod 超过其资源分配，kubelet 可能会驱除 Pod。
要添加临时容器，请使用现有 Pod 的 ephemeralcontainers 子资源。可能无法删除或重启临时容器。
- 类型
-
object - 必填
-
name
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 入口点的参数。如果没有提供，则使用镜像的 CMD。变量引用 $(VAR_NAME)使用容器环境扩展。如果无法解析变量，输入字符串中的引用将不会改变。双引号被减少为一个 $，它允许转义 $(VAR_NAME)语法：例如：" (VAR_NAME) " 将生成字符串 literal "$(VAR_NAME) "。转义的引用永远不会被扩展，无论变量是否存在。无法更新。更多信息： https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
|
|
| ENTRYPOINT 数组.不会在 shell 中执行。如果没有提供，则使用镜像的 ENTRYPOINT。变量引用 $(VAR_NAME)使用容器环境扩展。如果无法解析变量，输入字符串中的引用将不会改变。双引号被减少为一个 $，它允许转义 $(VAR_NAME)语法：例如：" (VAR_NAME) " 将生成字符串 literal "$(VAR_NAME) "。转义的引用永远不会被扩展，无论变量是否存在。无法更新。更多信息： https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
|
| 要在容器中设置的环境变量列表。无法更新。 | |
|
| 用于在容器中填充环境变量的源列表。源中定义的键必须是 C_IDENTIFIER。当容器启动时，所有无效的密钥都会被报告为事件。当多个源中存在键时，与最后一个源关联的值将具有优先权。由带有重复键的 Env 定义的值将具有优先权。无法更新。 | |
|
|
| 容器镜像名称。更多信息： https://kubernetes.io/docs/concepts/containers/images |
|
|
| 镜像拉取策略。Always, Never, IfNotPresent 之一。如果指定了 :latest 标签，则默认为 Always，否则为 IfNotPresent。无法更新。更多信息： https://kubernetes.io/docs/concepts/containers/images#updating-images
可能枚举值： - |
|
| 临时容器不允许使用生命周期。 | |
|
| 临时容器不允许探测。 | |
|
|
| 指定为 DNS_LABEL 的临时容器的名称。此名称在所有容器、init 容器和临时容器中必须是唯一的。 |
|
| 临时容器不允许使用端口。 | |
|
| 临时容器不允许探测。 | |
|
| 容器的资源重新定义策略大小。 | |
|
| 临时容器不允许使用资源。临时容器使用已分配给 pod 的备用资源。 | |
|
| 可选： SecurityContext 定义临时容器应使用的安全选项。如果设置，SecurityContext 的字段会覆盖 PodSecurityContext 的等效字段。 | |
|
| 临时容器不允许探测。 | |
|
|
| 此容器是否应该为容器运行时中的 stdin 分配缓冲区。如果没有设置，则从容器中的 stdin 读取总是会导致 EOF。默认值为 false。 |
|
|
| 容器运行时是否应该在单个附加打开后关闭 stdin 频道。当 stdin 为 true 时，stdin 流将在多个附加会话之间保持打开。如果将 stdinOnce 设为 true，则 stdin 在容器启动时打开，会为空，直到第一个客户端附加到 stdin，然后保持打开并接受数据，直到客户端断开连接，而时间 stdin 被关闭并保持关闭，直到容器重启为止。如果此标志为 false，则从 stdin 读取的容器进程永远不会收到 EOF。默认值为 false |
|
|
| 如果设置，则此临时容器目标的 PodSpec 中的容器名称。临时容器将在此容器的命名空间中运行(IPC、PID 等)。如果没有设置，则临时容器将使用 Pod spec 中配置的命名空间。 容器运行时必须实施对此功能的支持。如果运行时不支持以命名空间为目标，则设置此字段的结果未定义。 |
|
|
| 可选：将容器终止消息写入的文件路径被挂载到容器文件系统中。编写的消息应该是简短的最终状态，如断言失败消息。如果大于 4096 字节，则节点将被截断。所有容器的消息长度限制为 12kb。默认为 /dev/termination-log。无法更新。 |
|
|
| 指明如何填充终止消息。文件将使用 terminationMessagePath 的内容在成功和失败时填充容器状态消息。如果终止消息文件为空，并且容器退出并显示错误，则 FallbackToLogsOnError 将使用容器日志输出的最后块。日志输出限制为 2048 字节或 80 行，以较大者为准。默认为 file。无法更新。
可能的 enum 值： - |
|
|
| 此容器是否应为自己分配 TTY，还需要 'stdin' 为 true。默认值为 false。 |
|
| volumeDevices 是容器使用的块设备列表。 | |
|
| 要挂载到容器文件系统中的 Pod 卷。临时容器不允许进行 subPath 挂载。无法更新。 | |
|
|
| 容器的工作目录。如果没有指定，则使用容器运行时的默认值，这可能会在容器镜像中配置。无法更新。 |
4.1.44. io.k8s.api.core.v1.EphemeralVolumeSource schema
- 描述
- 代表由普通存储驱动程序处理的临时卷。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
将用于创建独立 PVC 来置备卷。嵌入了此 EphemeralVolumeSource 的 pod 将是 PVC 的所有者，即 PVC 将与 pod 一起删除。PVC 的名称将是 < 没有为 pod 拥有该名称的现有 PVC 不会被 用于 pod，以避免错误地使用不相关的卷。然后，启动 pod 会被阻断，直到删除不相关的 PVC。如果 pod 使用预先创建的 PVC，则在 pod 存在后，PVC 必须使用所有者引用 pod 更新。通常，这不应该是必需的，但在手动重新创建损坏的集群时可能很有用。 此字段是只读的，在创建后 Kubernetes 不会对 PVC 进行任何更改。 必需，不能是 nil。 |
4.1.45. io.k8s.api.core.v1.EventList schema
- 描述
- EventList 是事件列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| 事件列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.46. io.k8s.api.core.v1.EventSource schema
- 描述
- EventSource 包含事件的信息。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 生成事件的组件。 |
|
|
| 生成事件的节点名称。 |
4.1.47. io.k8s.api.core.v1.ExecAction schema
- 描述
- ExecAction 描述了 "run in container" 操作。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 命令是在容器内执行的命令行，命令的工作目录是容器文件系统中的 root ('/')。命令只是 exec'd，它不在 shell 中运行，因此传统的 shell 指令('|' 等)不起作用。要使用 shell，您需要明确调用该 shell。0 的退出状态被视为 live/healthy，非零为不健康。 |
4.1.48. io.k8s.api.core.v1.FCVolumeSource schema
- 描述
- 代表光纤通道卷。Fibre Channel 卷只能以读写模式挂载。Fibre Channel 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定，则隐式推断为"ext4"。 |
|
|
| LUN 是可选的： FC 目标 lun 号 |
|
|
| readonly 是可选的：默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
|
| targetWWN 可选： FC 目标全球名称(WWN) |
|
|
| wwids 可选：FC 卷全局广泛的标识符(wwids) Either wwids 或 targetWWNs 和 lun 的组合必须同时设置，但不能同时设置。 |
- 描述
- FlexPersistentVolumeSource 代表使用基于 exec 的插件置备/附加的通用持久性卷资源。
- 类型
-
object - 必填
-
driver
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| driver 是要用于此卷的驱动程序名称。 |
|
|
| fstype 是要挂载的 Filesystem 类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认文件系统取决于 FlexVolume 脚本。 |
|
|
| 选项是可选的：此字段包含额外的命令选项（若有）。 |
|
|
| readonly 是可选的：默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
| secretRef 是可选的：SecretRef 是对包含要传递给插件脚本的敏感信息的 secret 对象的引用。如果没有指定 secret 对象，则这可能为空。如果 secret 对象包含多个 secret，则所有 secret 都会传递给插件脚本。 |
4.1.50. io.k8s.api.core.v1.FlexVolumeSource schema
- 描述
- FlexVolume 代表一个通用卷资源，它使用基于 exec 的插件置备/附加。
- 类型
-
object - 必填
-
driver
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| driver 是要用于此卷的驱动程序名称。 |
|
|
| fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认文件系统取决于 FlexVolume 脚本。 |
|
|
| 选项是可选的：此字段包含额外的命令选项（若有）。 |
|
|
| readonly 是可选的：默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
| secretRef 是可选的：secretRef 是对包含要传递给插件脚本的敏感信息的 secret 对象的引用。如果没有指定 secret 对象，则这可能为空。如果 secret 对象包含多个 secret，则所有 secret 都会传递给插件脚本。 |
4.1.51. io.k8s.api.core.v1.FlockerVolumeSource schema
- 描述
- 代表由 Flocker 代理挂载的 Flocker 卷。应该只设置其中一个 datasetName 和 datasetUUID。flocker 卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| datasetName 是存储在 Flocker 的 dataset 的 dataset 的 dataset 的 Name。 |
|
|
| datasetUUID 是 dataset 的 UUID。这是 Flocker 数据集的唯一标识符 |
- 描述
代表 Google Compute Engine 中的 Persistent Disk 资源。
在挂载到容器前，GCE PD 必须已经存在。磁盘还必须与 kubelet 位于同一个 GCE 项目和区。GCE PD 只能以读写一次挂载，或者多次只读。GCE PDs 支持所有权管理和 SELinux 重新标记。
- 类型
-
object - 必填
-
pdName
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| fstype 是您要挂载的卷的文件系统类型。提示： 确保主机操作系统支持文件系统类型。示例："ext4", "xfs", "ntfs"。如果未指定，则隐式推断为"ext4"。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
|
| partition 是您要挂载的卷中的分区。如果省略，则默认为按卷名称挂载。示例：对于卷 /dev/sda1，您可以将分区指定为 "1"。同样，/dev/sda 的卷分区是 "0" （或者您可以将属性留空）。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
|
| pdName 是 GCE 中的 PD 资源的唯一名称。用于识别 GCE 中的磁盘。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
|
| 此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
4.1.53. io.k8s.api.core.v1.GitRepoVolumeSource schema
- 描述
代表填充 git 存储库内容的卷。Git 仓库卷不支持所有权管理。Git repo 卷支持 SELinux 重新标记。
DEPRECATED: GitRepo 已被弃用。要使用 git 仓库置备容器，请将 EmptyDir 挂载到使用 git 克隆存储库的 InitContainer 中，然后将 EmptyDir 挂载到 Pod 的容器中。
- 类型
-
object - 必填
-
软件仓库
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| directory 是目标目录名称。不得包含或以 '..' 开头。如果提供了 '.'，则卷目录将是 git 存储库。否则，如果指定，卷将包含具有指定名称的子目录中的 git 存储库。 |
|
|
| repository 是 URL |
|
|
| revision 是指定修订版本的提交哈希。 |
- 描述
- 代表 pod 生命周期的 Glusterfs 挂载。GlusterFS 卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
object - 必填
-
端点 -
path
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Endpoints 是详细信息 Glusterfs 拓扑的端点名称。更多信息： https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
|
| endpointsNamespace 是包含 Glusterfs 端点的命名空间。如果此字段为空，则 EndpointNamespace 默认为与绑定 PVC 相同的命名空间。更多信息： https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
|
| path 是 Glusterfs 卷路径。更多信息： https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
|
| 此处的只读将强制使用只读权限挂载 Glusterfs 卷。默认为false。更多信息： https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
4.1.55. io.k8s.api.core.v1.GlusterfsVolumeSource schema
- 描述
- 代表 pod 生命周期的 Glusterfs 挂载。GlusterFS 卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
object - 必填
-
端点 -
path
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Endpoints 是详细信息 Glusterfs 拓扑的端点名称。更多信息： https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
|
| path 是 Glusterfs 卷路径。更多信息： https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
|
| 此处的只读将强制使用只读权限挂载 Glusterfs 卷。默认为false。更多信息： https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
4.1.56. io.k8s.api.core.v1.GRPCAction schema
- 描述
- 类型
-
object - 必填
-
port
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| gRPC 服务的端口号。数字必须在 1 到 65535 之间。 |
|
|
| service 是要放在 gRPC HealthCheckRequest 中的服务名称（请参阅 https://github.com/grpc/grpc/blob/master/doc/health-checking.md）。 如果没有指定，则默认的行为由 gRPC 定义。 |
4.1.57. io.k8s.api.core.v1.HostAlias schema
- 描述
- HostAlias 包含将作为 pod 主机文件中的条目注入的 IP 和主机名之间的映射。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 以上 IP 地址的主机名。 |
|
|
| 主机文件条目的 IP 地址。 |
4.1.58. io.k8s.api.core.v1.HostPathVolumeSource schema
- 描述
- 代表映射到 pod 的主机路径。主机路径卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
object - 必填
-
path
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 主机上目录的路径。如果路径是符号链接，它将遵循到实际路径的链接。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
|
| HostPath Volume Defaults 为 "" more info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
可能枚举值：- |
4.1.59. io.k8s.api.core.v1.HTTPGetAction schema
- 描述
- HTTPGetAction 描述了基于 HTTP 获取请求的操作。
- 类型
-
object - 必填
-
port
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 要连接的主机名，默认为 pod IP。您可能想在 httpHeaders 中设置"主机"。 |
|
| 在请求中设置的自定义标头。HTTP 允许重复标头。 | |
|
|
| 在 HTTP 服务器上访问的路径。 |
|
| 在容器中要访问的端口的名称或数量。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。 | |
|
|
| 用于连接到主机的方案。默认为 HTTP。
可能枚举的值： - |
4.1.60. io.k8s.api.core.v1.HTTPHeader schema
- 描述
- HTTPHeader 描述了 HTTP 探测中使用的自定义标头
- 类型
-
object - 必填
-
name -
value
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 标头字段名称。这将在输出时规范，因此案例名称将理解为相同的标头。 |
|
|
| 标头字段值 |
- 描述
- ISCSIPersistentVolumeSource 代表 ISCSI 磁盘。ISCSI 卷只能以读写模式挂载。ISCSI 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
object - 必填
-
targetPortal -
IQN -
LUN
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| chapAuthDiscovery 定义是否支持 iSCSI Discovery CHAP 身份验证 |
|
|
| chapAuthSession 定义是否支持 iSCSI Session CHAP 身份验证 |
|
|
| fstype 是您要挂载的卷的文件系统类型。提示： 确保主机操作系统支持文件系统类型。示例："ext4", "xfs", "ntfs"。如果未指定，则隐式推断为"ext4"。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#iscsi |
|
|
| initiatorname 是自定义 iSCSI 启动器名称。如果同时使用 iscsiInterface 指定 initiatorName，则会为连接创建新的 iSCSI 接口 <target portal>:<volume name>。 |
|
|
| IQN 是 iSCSI 限定名称的目标。 |
|
|
| iscsiInterface 是使用 iSCSI 传输的接口名称。默认为 'default'(tcp)。 |
|
|
| LUN 是 iSCSI 目标 Lun 编号。 |
|
|
| 门户是 iSCSI 目标门户列表。如果端口不是默认值（通常是 TCP 端口 860 和 3260），则门户可以是 IP 或 ip_addr:port。 |
|
|
| 此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。 |
|
| secretRef 是 iSCSI 目标和启动器验证的 CHAP Secret | |
|
|
| targetPortal 是 iSCSI 目标门户。如果端口不是默认值（通常是 TCP 端口 860 和 3260），则门户可以是 IP 或 ip_addr:port。 |
4.1.62. io.k8s.api.core.v1.ISCSIVolumeSource schema
- 描述
- 代表 ISCSI 磁盘。ISCSI 卷只能以读写模式挂载。ISCSI 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
object - 必填
-
targetPortal -
IQN -
LUN
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| chapAuthDiscovery 定义是否支持 iSCSI Discovery CHAP 身份验证 |
|
|
| chapAuthSession 定义是否支持 iSCSI Session CHAP 身份验证 |
|
|
| fstype 是您要挂载的卷的文件系统类型。提示： 确保主机操作系统支持文件系统类型。示例："ext4", "xfs", "ntfs"。如果未指定，则隐式推断为"ext4"。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#iscsi |
|
|
| initiatorname 是自定义 iSCSI 启动器名称。如果同时使用 iscsiInterface 指定 initiatorName，则会为连接创建新的 iSCSI 接口 <target portal>:<volume name>。 |
|
|
| IQN 是目标 iSCSI 限定名称。 |
|
|
| iscsiInterface 是使用 iSCSI 传输的接口名称。默认为 'default'(tcp)。 |
|
|
| LUN 代表 iSCSI 目标 Lun 编号。 |
|
|
| 门户是 iSCSI 目标门户列表。如果端口不是默认值（通常是 TCP 端口 860 和 3260），则门户可以是 IP 或 ip_addr:port。 |
|
|
| 此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。 |
|
| secretRef 是 iSCSI 目标和启动器验证的 CHAP Secret | |
|
|
| targetPortal 是 iSCSI 目标门户。如果端口不是默认值（通常是 TCP 端口 860 和 3260），则门户可以是 IP 或 ip_addr:port。 |
4.1.63. io.k8s.api.core.v1.KeyToPath schema
- 描述
- 将字符串键映射到卷中的路径。
- 类型
-
object - 必填
-
key -
path
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是项目的关键。 |
|
|
| 模式是可选的：用于设置此文件权限的模式位。必须是 0000 到 0777 之间的数值，也可以是 0 到 511 之间的十进制值。YAML 接受八进制值和十进制值，JSON 需要模式位的十进制值。如果没有指定，则使用卷 defaultMode。这可能会与影响文件模式的其他选项（如 fsGroup ）冲突，结果可以是设置其他模式位。 |
|
|
| path 是要将密钥映射到的文件的相对路径。可能不是绝对路径。不得包含 path 元素 '..'。不能以字符串 '..' 开始。 |
4.1.64. io.k8s.api.core.v1.Lifecycle schema
- 描述
- 生命周期描述了管理系统在响应容器生命周期事件时应采取的操作。对于 PostStart 和 PreStop 生命周期处理程序，在操作完成前管理容器块，除非容器进程失败，在这种情况下，处理程序会中止。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 在创建容器后，postStart 会立即调用。如果处理程序失败，容器会根据重启策略终止并重启。对容器块的其他管理，直到 hook 完成为止。更多信息： https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks | |
|
| 由于 API 请求或管理事件（如存活度/启动探测失败、抢占、资源争用等）在容器终止前立即调用 preStop。如果容器崩溃或退出，则不会调用处理程序。Pod 的终止宽限期倒计时在执行 PreStop hook 前开始。无论处理程序的结果如何，容器最终都会在 Pod 终止宽限期内终止（除非终结器没有延迟）。对容器进行其他管理，直到 hook 完成或到达终止宽限期为止。更多信息： https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
4.1.65. io.k8s.api.core.v1.LifecycleHandler schema
- 描述
- LifecycleHandler 定义在生命周期 hook 中应执行的特定操作。必须指定其中一个字段，但必须指定 TCPSocket。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| exec 指定要执行的操作。 | |
|
| httpGet 指定要执行的 http 请求。 | |
|
| 已弃用。tcpSocket 不支持作为 LifecycleHandler，并保持向后兼容。当指定了 tcp 处理程序时，没有此字段验证，生命周期 hook 会在运行时失败。 |
4.1.66. io.k8s.api.core.v1.LimitRangeList schema
- 描述
- LimitRangeList 是 LimitRange 项目的列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 LimitRange 对象列表。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.67. io.k8s.api.core.v1.LocalObjectReference schema
- 描述
- LocalObjectReference 包含足够的信息，供您在同一个命名空间中找到引用的对象。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
4.1.68. io.k8s.api.core.v1.LocalVolumeSource schema
- 描述
- local 代表与节点关联性直接附加的存储(Beta 功能)
- 类型
-
object - 必填
-
path
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| fstype 是要挂载的文件系统类型。只有在路径是块设备时，它才会应用。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定，则默认值为自动选择文件系统。 |
|
|
| 到节点上卷的完整路径的路径。它可以是目录或块设备(disk, partition, …)。 |
4.1.69. io.k8s.api.core.v1.NamespaceList schema
- 描述
- NamespaceList 是命名空间列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是列表中的 Namespace 对象列表。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.70. io.k8s.api.core.v1.NFSVolumeSource schema
- 描述
- 代表 pod 的生命周期最后一个 NFS 挂载。NFS 卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
object - 必填
-
server -
path
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| NFS 服务器导出的路径。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
| 此处的只读将强制使用只读权限挂载 NFS 导出。默认为false。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
| server 是 NFS 服务器的主机名或 IP 地址。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#nfs |
4.1.71. io.k8s.api.core.v1.NodeAffinity schema
- 描述
- 节点关联性是一组节点关联性调度规则。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 调度程序希望将 pod 调度到满足此字段指定的关联性表达式的节点，但可以选择违反了一个或多个表达式的节点。最首选节点是具有最大权重总和的节点，即对于满足所有调度要求（资源请求、requiredDuringScheduling 关联性表达式等）的每个节点，它通过迭代此字段元素并将 "weight" 添加到摘要中（如果节点与相应的 matchExpressions 匹配）；节点具有最高总和和最高的节点。 | |
|
| 如果在调度时不满足此字段指定的关联性要求，则 pod 不会调度到该节点上。如果在 Pod 执行期间由此字段指定的关联性要求满足（例如，由于更新），系统可能无法尝试最终从其节点中驱除 pod。 |
4.1.72. io.k8s.api.core.v1.NodeList schema
- 描述
- NodeList 是所有使用 master 注册的节点的完整列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| 节点列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.73. io.k8s.api.core.v1.NodeSelector schema
- 描述
- 节点选择器表示一个或多个对一组节点的标签查询结果的联合；即，它代表节点选择器术语代表的选择器的 OR。
- 类型
-
object - 必填
-
nodeSelectorTerms
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 必需。节点选择器术语列表。条款是 ORed。 |
- 描述
- 节点选择器要求是一个选择器，其中包含值、键和与键和值关联的操作器。
- 类型
-
object - 必填
-
key -
operator
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 选择器应用到的标签键。 |
|
|
| 代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt, 和 Lt.
possible enum 值：- |
|
|
| 字符串值数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。如果 Operator 是 Gt 或 Lt，则值数组必须具有单个元素，该元素将解释为整数。这个数组会在策略性合并补丁中被替换。 |
4.1.75. io.k8s.api.core.v1.NodeSelectorTerm schema
- 描述
- null 或 empty 节点选择器术语不匹配任何对象。它们的要求是 AND。TopologySelectorTerm 类型实现 NodeSelectorTerm 的子集。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 节点标签(label)的节点选择器要求列表。 | |
|
| 节点字段的节点选择器要求列表。 |
4.1.76. io.k8s.api.core.v1.ObjectFieldSelector schema
- 描述
- ObjectFieldSelector 选择对象的 APIVersioned 字段。
- 类型
-
object - 必填
-
fieldPath
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| FieldPath 用术语编写的 schema 版本，默认为 "v1"。 |
|
|
| 在指定 API 版本中选择的字段路径。 |
4.1.77. io.k8s.api.core.v1.ObjectReference schema
- 描述
- ObjectReference 包含足够信息供您检查或修改引用的对象。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 引用的 API 版本。 |
|
|
| 如果引用的是对象的一部分而非整个对象，则该字符串应包含有效的 JSON/Go 字段访问声明，如 desiredState.manifest.containers[2]。例如，如果对象引用是一个 pod 中的容器，它应该还以下类似： "spec.containers{name}"（其中 "name" 是指触发事件的容器的名称）,如果不使用容器名称，则应类似于 "spec.containers[2]"（使用此 pod 中索引值为 2 的容器）。选择这个语法的原因是，为了有一些指向对象部分的正确定义方法。 |
|
|
| 引用的类型。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 引用的命名空间。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| 指定构成这个引用的 resourceVersion（如果存在）。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| 引用的 UID。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
4.1.78. io.k8s.api.core.v1.PersistentVolumeClaim schema
- 描述
- PersistentVolumeClaim 是用户对持久性卷的请求并声明
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| PersistentVolumeClaimSpec 描述了存储设备的通用属性，并允许特定于供应商的属性的源 |
|
|
| PersistentVolumeClaimStatus 是持久性卷声明的当前状态。 |
..spec Description::
+
PersistentVolumeClaimSpec 描述了存储设备的通用属性，并允许特定于供应商的属性的源
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| accessModes 包含卷应具有的所需访问模式。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
|
| TypedLocalObjectReference 包含足够信息，可让您找到同一命名空间中的 typed referenced 对象。 |
|
|
| dataSourceRef 指定在需要非空卷时，使用数据填充卷的对象。这可以是来自非空 API 组（非核心对象）或 PersistentVolumeClaim 对象的任何对象。当指定此字段时，只有在指定对象的类型与一些已安装的卷填充器或动态置备程序匹配时才会成功。此字段将替换 dataSource 字段的功能，因此如果这两个字段都不是空的，则它们必须具有相同的值。为向后兼容，当 namespace 没有在 dataSourceRef 中指定时，如果其中一个字段(dataSource 和 dataSourceRef)都自动设置为相同的值，另一个是非空的值。当在 dataSourceRef 中指定命名空间时，dataSource 不会设置为相同的值，且必须为空。dataSource 和 dataSourceRef: * While dataSource 有三个重要区别：但 dataSourceRef 只允许两种特定类型的对象，dataSourceRef 允许任何非核心对象和 PersistentVolumeClaim 对象。* 虽然 dataSource 忽略禁止的值（过滤它们），dataSourceRef 会保留所有值，并在指定了禁止的值时生成错误。* 虽然 dataSource 只允许本地对象，但 dataSourceRef 允许任何命名空间中的对象。(beta)使用此字段需要启用 AnyVolumeDataSource 功能门。(alpha)使用 dataSourceRef 的 namespace 字段需要启用 CrossNamespaceVolumeDataSource 功能门。 |
|
|
| ResourceRequirements 描述计算资源要求。 |
|
| selector 是卷上的标签查询，用于绑定。 | |
|
|
| storageClassName 是声明所需的 StorageClass 的名称。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
|
| volumeMode 定义声明所需的卷类型。当没有包括在 claim spec 中时，文件系统的值会被简化。
可能枚举值： - |
|
|
| volumeName 是支持此声明的 PersistentVolume 的绑定引用。 |
..spec.dataSource Description::
+
TypedLocalObjectReference 包含足够信息，可让您找到同一命名空间中的 typed referenced 对象。
- 类型
-
object - 必填
-
kind -
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| apiGroup 是被引用资源的组。如果没有指定 APIGroup，则指定的 Kind 必须位于 core API 组中。对于任何其他第三方类型，需要 APIGroup。 |
|
|
| kind 是被引用的资源类型 |
|
|
| name 是被引用的资源的名称 |
..spec.dataSourceRef Description::
+
dataSourceRef 指定在需要非空卷时，使用数据填充卷的对象。这可以是来自非空 API 组（非核心对象）或 PersistentVolumeClaim 对象的任何对象。当指定此字段时，只有在指定对象的类型与一些已安装的卷填充器或动态置备程序匹配时才会成功。此字段将替换 dataSource 字段的功能，因此如果这两个字段都不是空的，则它们必须具有相同的值。为向后兼容，当 namespace 没有在 dataSourceRef 中指定时，如果其中一个字段(dataSource 和 dataSourceRef)都自动设置为相同的值，另一个是非空的值。当在 dataSourceRef 中指定命名空间时，dataSource 不会设置为相同的值，且必须为空。dataSource 和 dataSourceRef: * While dataSource 有三个重要区别：但 dataSourceRef 只允许两种特定类型的对象，dataSourceRef 允许任何非核心对象和 PersistentVolumeClaim 对象。* 虽然 dataSource 忽略禁止的值（过滤它们），dataSourceRef 会保留所有值，并在指定了禁止的值时生成错误。* 虽然 dataSource 只允许本地对象，但 dataSourceRef 允许任何命名空间中的对象。(beta)使用此字段需要启用 AnyVolumeDataSource 功能门。(alpha)使用 dataSourceRef 的 namespace 字段需要启用 CrossNamespaceVolumeDataSource 功能门。
- 类型
-
object - 必填
-
kind -
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| apiGroup 是被引用资源的组。如果没有指定 APIGroup，则指定的 Kind 必须位于 core API 组中。对于任何其他第三方类型，需要 APIGroup。 |
|
|
| kind 是被引用的资源类型 |
|
|
| name 是被引用的资源的名称 |
|
|
| namespace 是被引用的资源的命名空间。在指定命名空间时，引用命名空间中需要 gateway.networking.k8s.io/ReferenceGrant 对象，以允许该命名空间的所有者接受引用。详情请查看 ReferenceGrant 文档。(alpha)此字段需要启用 CrossNamespaceVolumeDataSource 功能门。 |
..spec.resources Description::
+
ResourceRequirements 描述计算资源要求。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 声明列出了此容器使用的 spec.resourceClaims 中定义的资源名称。 这是一个 alpha 字段，需要启用 DynamicResourceAllocation 功能门。 此字段是不可变的。它只能为容器设置。 |
|
|
| ResourceClaim 引用 PodSpec.ResourceClaims 中的一个条目。 |
|
| 限制描述了允许的最大计算资源量。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | |
|
| Requests 描述了所需的最少计算资源。如果容器省略了 Requests，则默认为 Limits （如果明确指定），否则默认为实现定义的值。请求不能超过限值。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
..spec.resources.claims Description::
+
声明列出了此容器使用的 spec.resourceClaims 中定义的资源名称。
这是一个 alpha 字段，需要启用 DynamicResourceAllocation 功能门。
此字段是不可变的。它只能为容器设置。
- 类型
-
数组
..spec.resources.claims[] Description::
+
ResourceClaim 引用 PodSpec.ResourceClaims 中的一个条目。
- 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 必须与使用此字段的 Pod 的 pod.spec.resourceClaims 中一个条目的名称匹配。它使得资源在容器内可用。 |
..status Description::
+
PersistentVolumeClaimStatus 是持久性卷声明的当前状态。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| accessModes 包含支持 PVC 的卷的实际访问模式。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
| allocatedResources 是 AllocatedResources 中的存储资源，跟踪分配给 PVC 的容量。当请求卷扩展操作时，它可能大于实际容量。对于存储配额，使用 allocatedResources 和 PVC.spec.resources 的较大的值。如果没有设置 allocatedResources，则只用于配额计算的 PVC.spec.resources。如果卷扩展容量请求较低，则仅当没有扩展操作且实际卷容量等于或小于请求的容量时，才会降低 allocatedResources。这是一个 alpha 字段，需要启用 RecoverVolumeExpansionFailure 功能。 | |
|
| capacity 代表底层卷的实际资源。 | |
|
|
| conditions 是持久性卷声明的当前条件。如果底层持久性卷大小调整，则 Condition 将设置为 'ResizeStarted'。 |
|
|
| PersistentVolumeClaimCondition 包含有关 pvc 状态的详细信息 |
|
|
| phase 代表 PersistentVolumeClaim 的当前阶段。
可能枚举值： - |
|
|
| resizeStatus 存储调整大小操作的状态。默认情况下，不会设置 ResizeStatus，但当扩展为 complete resizeStatus 时，通过调整大小 controller 或 kubelet 被设为空字符串。这是一个 alpha 字段，需要启用 RecoverVolumeExpansionFailure 功能。
可能枚举值： - |
..status.conditions Description::
+
conditions 是持久性卷声明的当前条件。如果底层持久性卷大小调整，则 Condition 将设置为 'ResizeStarted'。
- 类型
-
数组
..status.conditions[] Description::
+
PersistentVolumeClaimCondition 包含有关 pvc 状态的详细信息
- 类型
-
object - 必填
-
type -
status
-
- 描述
- PersistentVolumeClaimList 是 PersistentVolumeClaim 项列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是持久性卷声明列表。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
- 描述
- PersistentVolumeClaimSpec 描述了存储设备的通用属性，并允许特定于供应商的属性的源
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| accessModes 包含卷应具有的所需访问模式。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
| DataSource 字段可以用来指定：* 一个现有的 VolumeSnapshot 对象(snapshot.storage.k8s.io/VolumeSnapshot)* 一个现有的 PVC (PersistentVolumeClaim)，如果置备程序或外部控制器可以支持指定的数据源，它将根据指定数据源的内容创建一个新卷。当启用 AnyVolumeDataSource 功能门时，DataSource 内容将复制到 dataSourceRef，当没有指定 dataSourceRef.namespace 时，dataSourceRef 内容将复制到 dataSource。如果指定了命名空间，则 dataSourceRef 将不会复制到 dataSource 中。 | |
|
| dataSourceRef 指定在需要非空卷时，使用数据填充卷的对象。这可以是来自非空 API 组（非核心对象）或 PersistentVolumeClaim 对象的任何对象。当指定此字段时，只有在指定对象的类型与一些已安装的卷填充器或动态置备程序匹配时才会成功。此字段将替换 dataSource 字段的功能，因此如果这两个字段都不是空的，则它们必须具有相同的值。为向后兼容，当 namespace 没有在 dataSourceRef 中指定时，如果其中一个字段(dataSource 和 dataSourceRef)都自动设置为相同的值，另一个是非空的值。当在 dataSourceRef 中指定命名空间时，dataSource 不会设置为相同的值，且必须为空。dataSource 和 dataSourceRef: * While dataSource 有三个重要区别：但 dataSourceRef 只允许两种特定类型的对象，dataSourceRef 允许任何非核心对象和 PersistentVolumeClaim 对象。* 虽然 dataSource 忽略禁止的值（过滤它们），dataSourceRef 会保留所有值，并在指定了禁止的值时生成错误。* 虽然 dataSource 只允许本地对象，但 dataSourceRef 允许任何命名空间中的对象。(beta)使用此字段需要启用 AnyVolumeDataSource 功能门。(alpha)使用 dataSourceRef 的 namespace 字段需要启用 CrossNamespaceVolumeDataSource 功能门。 | |
|
| resources 代表卷应具有的最少资源。如果启用了 RecoverVolumeExpansionFailure 功能，则允许用户指定低于之前值的资源要求，但必须大于声明的 status 字段中记录的容量。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources | |
|
| selector 是卷上的标签查询，用于绑定。 | |
|
|
| storageClassName 是声明所需的 StorageClass 的名称。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
|
| volumeMode 定义声明所需的卷类型。当没有包括在 claim spec 中时，文件系统的值会被简化。
可能枚举值： - |
|
|
| volumeName 是支持此声明的 PersistentVolume 的绑定引用。 |
- 描述
- PersistentVolumeClaimTemplate 用于生成 PersistentVolumeClaim 对象，作为 EphemeralVolumeSource 的一部分。
- 类型
-
object - 必填
-
spec
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 可以包含在创建时复制到 PVC 中的标签和注解。不允许其他字段，并在验证过程中被拒绝。 | |
|
| PersistentVolumeClaim 的规格。整个内容都会不动地复制到从该模板创建的 PVC 中。PersistentVolumeClaim 中的相同字段也有效。 |
- 描述
- PersistentVolumeClaimVolumeSource 引用同一命名空间中的用户 PVC。此卷找到绑定的 PV，并为 pod 挂载这个卷。PersistentVolumeClaimVolumeSource 本质上是另一种类型的卷，它们归其他人（系统）所有。
- 类型
-
object - 必填
-
claimName
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| claimName 是使用此卷与 pod 相同的命名空间中的 PersistentVolumeClaim 的名称。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
|
| readonly 将强制 VolumeMount 中的 ReadOnly 设置。默认 false。 |
4.1.83. io.k8s.api.core.v1.PersistentVolumeList schema
- 描述
- PersistentVolumeList 是 PersistentVolume 项列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是持久性卷列表。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.84. io.k8s.api.core.v1.PersistentVolumeSpec schema
- 描述
- PersistentVolumeSpec 是持久性卷的规格。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| accessModes 包含可挂载卷的所有方法。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes |
|
| awsElasticBlockStore 代表附加到 kubelet 主机机器的 AWS Disk 资源，然后公开给 pod。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | |
|
| azureDisk 代表主机上的 Azure Data Disk 挂载，并绑定到 pod。 | |
|
| azureFile 代表主机上的 Azure File Service 挂载，并绑定到 pod。 | |
|
| capacity 是持久性卷资源和容量的描述。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity | |
|
| CephFS 代表共享 pod 生命周期的主机上的 Ceph FS 挂载 | |
|
| Cinder 代表附加并挂载到 kubelet 主机上的 cinder 卷。更多信息： https://examples.k8s.io/mysql-cinder-pd/README.md | |
|
| claimRef 是 PersistentVolume 和 PersistentVolumeClaim 之间的双向绑定的一部分。当绑定时，预期为非il。claim.VolumeName 是 PV 和 PVC 之间的权威绑定。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding | |
|
| CSI 代表由外部 CSI 驱动程序(Beta 功能)处理的存储。 | |
|
| FC 代表附加到 kubelet 主机的 Fibre Channel 资源，然后公开给 pod。 | |
|
| FlexVolume 代表一个通用卷资源，它使用基于 exec 的插件置备/附加。 | |
|
| flocker 代表附加到 kubelet 主机机器的 Flocker 卷，并公开给 pod 以供其使用。这取决于运行 Flocker 控制服务 | |
|
| gcePersistentDisk 代表附加到 kubelet 主机机器的 GCE Disk 资源，然后公开给 pod。由管理员调配。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | |
|
| GlusterFS 代表附加到主机并公开给 pod 的 Glusterfs 卷。由管理员调配。更多信息： https://examples.k8s.io/volumes/glusterfs/README.md | |
|
| hostpath 代表主机上的目录。由开发人员或测试程序调配。这仅适用于单节点开发和测试！在多节点集群中，不支持主机存储，在多节点集群中不支持 WILL NOT WORK。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#hostpath | |
|
| iSCSI 代表附加到 kubelet 主机机器的 ISCSI 磁盘资源，然后公开给 pod。由管理员调配。 | |
|
| local 代表与节点关联性直接附加的存储 | |
|
|
| mountOptions 是挂载选项列表，如 ["ro", "soft"]。未验证 - 如果挂载无效，则挂载将失败。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options |
|
| NFS 代表主机上的 NFS 挂载。由管理员调配。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#nfs | |
|
| nodeAffinity 定义限制此卷可从中访问哪些节点。此字段会影响使用这个卷的 pod 的调度。 | |
|
|
| persistentVolumeReclaimPolicy 定义从声明中释放持久性卷时会发生什么。有效选项为 Retain （为手动创建的 PersistentVolume 的默认设置）、Delete （动态置备的 PersistentVolume 的默认）和 Recycle （已弃用）。Recycle 必须被此 PersistentVolume 底层的卷插件支持。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
可能枚举值： - |
|
| photonPersistentDisk 代表在 kubelets 主机上附加并挂载的 PhotonController 持久磁盘 | |
|
| portworxVolume 代表附加并挂载到 kubelet 主机上的 portworx 卷 | |
|
| quobyte 代表共享 pod 生命周期的主机上的 Quobyte 挂载 | |
|
| RBD 代表共享 pod 生命周期的主机上的 Rados 块设备挂载。更多信息： https://examples.k8s.io/volumes/rbd/README.md | |
|
| scaleIO 代表一个在 Kubernetes 节点上附加并挂载的 ScaleIO 持久性卷。 | |
|
|
| storageClassName 是这个持久性卷所属的 StorageClass 的名称。空值意味着这个卷不属于任何 StorageClass。 |
|
| storageos 代表附加到 kubelet 主机机器的 StorageOS 卷，并挂载到 pod 更多信息： https://examples.k8s.io/volumes/storageos/README.md | |
|
|
| volumeMode 定义卷是否要与格式化的文件系统一起使用，或者保持在原始块状态。当没有包括在 spec 中时，文件系统的值会被简化。
可能枚举值： - |
|
| vsphereVolume 代表在 kubelets 主机上附加并挂载的 vSphere 卷 |
- 描述
- 代表 Photon Controller 持久磁盘资源。
- 类型
-
object - 必填
-
pdID
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定，则隐式推断为"ext4"。 |
|
|
| pdID 是标识 Photon Controller 持久磁盘的 ID |
4.1.86. io.k8s.api.core.v1.PodAffinity schema
- 描述
- Pod 关联性是一组 pod 关联性调度规则。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 调度程序希望将 pod 调度到满足此字段指定的关联性表达式的节点，但可以选择违反了一个或多个表达式的节点。最首选节点是具有最大权重总和的节点，即对于满足所有调度要求（资源请求、requiredDuringScheduling 关联性表达式等）的每个节点，它通过迭代此字段元素并将 "weight" 添加到摘要中，如果节点具有与相应 podAffinityTerm 匹配的 pod；具有最高总和最高的节点是首选的节点。 | |
|
| 如果在调度时不满足此字段指定的关联性要求，则 pod 不会调度到该节点上。如果在 pod 执行期间由此字段指定的关联性要求满足（例如，因为 pod 标签更新），则系统可能无法最终尝试从其节点中驱除 pod。当有多个元素时，每个 podAffinityTerm 对应的节点列表会被干扰，例如，所有术语都必须满足。 |
4.1.87. io.k8s.api.core.v1.PodAffinityTerm schema
- 描述
- 定义一组 pod （与给定命名空间匹配的 labelSelector 匹配），此 pod 应该与 pod 共存（关联性）或不共存（反关联性）匹配，其中 co-located 定义在带有键 <topologyKey> 标签的节点上运行，其标签的值与运行 pod 的任何节点匹配
- 类型
-
object - 必填
-
topologyKey
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 一个对一组资源的标签查询，本例中为 pod。 | |
|
| 对术语应用到的命名空间集合的标签查询。术语应用于此字段选择的命名空间的联合，以及 namespaces 字段中列出的命名空间。null selector 和 null 或 empty namespace 列表表示"此 pod 的命名空间"。空选择器({})与所有命名空间匹配。 | |
|
|
| namespaces 指定术语应用到的命名空间名称的静态列表。术语应用于此字段中列出的命名空间，由 namespaceSelector. null 或空命名空间列表和 null namespaceSelector 选择的命名空间合并意味着"此 pod 的命名空间"。 |
|
|
| 此 pod 应该与指定命名空间中 labelSelector 匹配的 pod 在一起（关联性）或不并置（反关联性），其中 co-located 定义为在具有键 topologyKey 标签的节点中运行。不允许空的 topologyKey。 |
4.1.88. io.k8s.api.core.v1.PodAntiAffinity schema
- 描述
- Pod 反关联性是一组 pod 反关联性调度规则。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 调度程序希望将 pod 调度到满足此字段指定的反关联性表达式的节点，但可以选择违反了一个或多个表达式的节点。最首选节点是具有最大权重总和的节点，即对于满足所有调度要求（资源请求、requiredDuringScheduling 反关联性表达式等）的每个节点，它通过迭代此字段元素来计算和将"权重"添加到节点具有与相应 podAffinityTerm 匹配的 pod；如果节点具有与相应 podAffinityTerm 匹配的 pod，则该节点是首选的。 | |
|
| 如果在调度时不满足由此字段指定的反关联性要求，则 pod 不会调度到节点上。如果在 pod 执行期间由此字段指定的反关联性要求满足（例如，因为 pod 标签更新），则系统可能无法最终尝试从其节点中驱除 pod。当有多个元素时，每个 podAffinityTerm 对应的节点列表会被干扰，例如，所有术语都必须满足。 |
4.1.89. io.k8s.api.core.v1.PodDNSConfig schema
- 描述
- PodDNSConfig 还定义了 pod 的 DNS 参数，除了从 DNSPolicy 生成的。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| DNS 名称服务器 IP 地址列表。这将附加到从 DNSPolicy 生成的基本名称服务器。将删除重复的名称服务器。 |
|
| DNS 解析器选项列表。这将与 DNSPolicy 生成的基本选项合并。将删除重复的条目。Options 中给出的解析选项将覆盖基本 DNSPolicy 中显示的解析选项。 | |
|
|
| host-name 查找的 DNS 搜索域列表。这将附加到 DNSPolicy 生成的基本搜索路径中。将删除重复的搜索路径。 |
4.1.90. io.k8s.api.core.v1.PodDNSConfigOption schema
- 描述
- PodDNSConfigOption 定义 pod 的 DNS 解析器选项。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 必需。 |
|
|
|
4.1.91. io.k8s.api.core.v1.PodList schema
- 描述
- PodList 是一个 Pod 列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| pod 列表。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.92. io.k8s.api.core.v1.PodOS schema
- 描述
- PodOS 定义 pod 的 OS 参数。
- 类型
-
object - 必填
-
name
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是操作系统的名称。目前支持的值有 linux 和 windows。额外值可能会在以后定义，可以是： https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration 客户端应该应该处理附加值，并将此字段中的未识别的值视为 os: null |
4.1.93. io.k8s.api.core.v1.PodReadinessGate schema
- 描述
- PodReadinessGate 包含对 pod 条件的引用
- 类型
-
object - 必填
-
conditionType
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditionType 指的是 pod 条件列表中具有匹配类型的条件。 |
4.1.94. io.k8s.api.core.v1.PodResourceClaim schema
- 描述
- PodResourceClaim 通过 ClaimSource 准确引用一个 ResourceClaim。它添加一个名称，用于唯一标识 Pod 中的 ResourceClaim。需要访问 ResourceClaim 的容器使用此名称引用它。
- 类型
-
object - 必填
-
name
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 在 pod 中唯一标识此资源声明的名称。这必须是 DNS_LABEL。 |
|
| source 描述在什么位置查找 ResourceClaim。 |
4.1.95. io.k8s.api.core.v1.PodSchedulingGate schema
- 描述
- PodSchedulingGate 与 Pod 关联，以保护其调度。
- 类型
-
object - 必填
-
name
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 调度授权的名称。每个调度最低要求都必须具有唯一的 name 字段。 |
4.1.96. io.k8s.api.core.v1.PodSecurityContext schema
- 描述
- PodSecurityContext 包含 pod 级别的安全属性和通用容器设置。container.securityContext 中也存在一些字段。container.securityContext 的字段值优先于 PodSecurityContext 的字段值。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 适用于 pod 中所有容器的特殊补充组。有些卷类型允许 Kubelet 将该卷的所有权更改为 pod 拥有： 1.所属 GID 将是 FSGroup 2。set setgid 位（在卷中创建的新文件将归 FSGroup 所有）3。权限位为 OR'd with rw-rw---- 如果未设置，Kubelet 将不修改任何卷的所有权和权限。请注意，当 spec.os.name 是窗口时，无法设置此字段。 |
|
|
| fsGroupChangePolicy 定义在 Pod 中公开卷之前更改卷的所有权和权限的行为。此字段仅适用于支持 fsGroup 基于所有权（和权限）的卷类型。它对临时卷类型没有影响，如： secret、configmaps 和 emptydir。有效值为 "OnRootMismatch" 和 "Always"。如果没有指定，则使用 "Always"。请注意，当 spec.os.name 是窗口时，无法设置此字段。
可能枚举值： - |
|
|
| 运行容器进程的入口点的 GID。如果未设置，则使用运行时默认值。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置，则在 SecurityContext 中指定的值优先于该容器。请注意，当 spec.os.name 是窗口时，无法设置此字段。 |
|
|
| 表示容器必须以非 root 用户身份运行。如果为 true，Kubelet 将在运行时验证镜像，以确保它不会以 UID 0 (root)运行，如果容器确实无法启动它，则无法启动它。如果未设置或 false，则不会执行这样的验证。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置，则优先使用 SecurityContext 指定的值。 |
|
|
| 运行容器进程的入口点的 UID。如果未指定，则默认为镜像元数据中指定的用户。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置，则在 SecurityContext 中指定的值优先于该容器。请注意，当 spec.os.name 是窗口时，无法设置此字段。 |
|
| 要应用到所有容器的 SELinux 上下文。如果未指定，容器运行时将为每个容器分配一个随机 SELinux 上下文。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置，则在 SecurityContext 中指定的值优先于该容器。请注意，当 spec.os.name 是窗口时，无法设置此字段。 | |
|
| 此 pod 中容器使用的 seccomp 选项。请注意，当 spec.os.name 是窗口时，无法设置此字段。 | |
|
|
| 除了容器的主 GID、fsGroup （如果指定）以及容器镜像中定义的组成员资格（如果指定）之外，应用于每个容器中的第一个进程运行的组列表。如果未指定，则不会将额外的组添加到任何容器中。请注意，容器进程的 uid 中定义的组成员资格仍然有效，即使它们没有包括在此列表中。请注意，当 spec.os.name 是窗口时，无法设置此字段。 |
|
| sysctl 包含用于 pod 的命名空间 sysctl 的列表。带有不支持的 sysctl （由容器运行时）的 Pod 可能无法启动。请注意，当 spec.os.name 是窗口时，无法设置此字段。 | |
|
| 应用到所有容器的 Windows 特定设置。如果未指定，则使用容器的 SecurityContext 选项。如果在 SecurityContext 和 PodSecurityContext 中设置，则优先使用 SecurityContext 指定的值。请注意，当 spec.os.name 是 linux 时，无法设置此字段。 |
4.1.97. io.k8s.api.core.v1.PodSpec schema
- 描述
- PodSpec 是 pod 的描述。
- 类型
-
object - 必填
-
containers
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 在系统主动尝试标记失败并终止相关的容器前，pod 可以在相对于 StartTime 的节点上处于活跃状态。值必须是正整数。 |
|
| 如果指定，pod 的调度限制 | |
|
|
| AutomountServiceAccountToken 指明是否应该自动挂载服务帐户令牌。 |
|
| 属于 pod 的容器列表。容器目前无法添加或删除。Pod 中必须至少有一个容器。无法更新。 | |
|
| 指定 pod 的 DNS 参数。此处指定的参数将根据 DNSPolicy 合并到生成的 DNS 配置中。 | |
|
|
| 为 pod 设置 DNS 策略。默认为 "ClusterFirst"。有效值为 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' 或 'None'。DNSConfig 中给定的 DNS 参数将与选择与 DNSPolicy 的策略合并。要将 DNS 选项与 hostNetwork 一起设置，您必须将 DNS 策略明确指定为 'ClusterFirstWithHostNet'。
可能枚举值： - |
|
|
| EnableServiceLinks 指示是否应将有关服务的信息注入到 pod 的环境变量中，与 Docker 链接的语法匹配。可选：默认为 true。 |
|
| 此 pod 中运行的临时容器列表。临时容器可以在现有 pod 中运行，以执行用户发起的操作，如调试。创建 pod 时无法指定此列表，无法通过更新 pod 规格来修改它。要将临时容器添加到现有 pod 中，请使用 pod 的 ephemeralcontainers 子资源。 | |
|
| hostAliases 是主机和 IP 的可选列表，如果指定，将注入到 pod 的主机文件中。这只适用于非主机网络 pod。 | |
|
|
| 使用主机的 ipc 命名空间。可选：默认为 false。 |
|
|
| 为此 pod 请求的主机网络。使用主机的网络命名空间。如果设置了这个选项，则必须指定要使用的端口。默认为 false。 |
|
|
| 使用主机的 pid 命名空间。可选：默认为 false。 |
|
|
| 使用主机的用户命名空间。可选：默认为 true。如果设置为 true 或不存在，则 pod 将在主机用户命名空间中运行，当 pod 需要可供主机用户命名空间使用的功能时，如加载带有 CAP_SYS_MODULE 的内核模块。当设置为 false 时，会为 pod 创建一个新的 userns。设置 false 有助于缓解容器中断漏洞，即使允许用户以 root 身份运行其容器，而无需实际在主机上具有 root 特权。此字段是 alpha-level，仅被启用 UserNamespacesSupport 功能的服务器所接受。 |
|
|
| 如果没有指定 Pod 的主机名，则 pod 的主机名将设置为系统定义的值。 |
|
| imagePullSecrets 是同一命名空间中 secret 的引用列表，用于拉取此 PodSpec 使用的任何镜像。如果指定，这些 secret 将传递给单独的 puller 实现，供它们使用。更多信息： https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod | |
|
| 属于 pod 的初始化容器列表。init 容器在容器启动前先执行。如果任何 init 容器失败，pod 被视为失败，并根据其 restartPolicy 处理。init 容器或普通容器的名称必须在所有容器间唯一。Init 容器可能没有生命周期操作、就绪度探测、存活度探测或启动探测。init 容器的 resourceRequirements 在调度过程中考虑，方法是为每个资源类型找到最高 request/limit，然后使用该值或普通容器的总和。限制以类似的方式应用到 init 容器。目前无法添加或删除 init 容器。无法更新。更多信息： https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ | |
|
|
| nodeName 是一个将此 pod 调度到特定节点的请求。如果是非空，调度程序只会将此 pod 调度到该节点上，假设它符合资源要求。 |
|
|
| nodeSelector 是一个选择器，必须为 true 才能使 pod 适合节点。必须与 pod 标签匹配的选择器，才能调度到该节点上。更多信息： https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
|
| 指定 pod 中容器的 OS。如果设置了，则一些 pod 和容器字段会被限制。 如果 OS 字段设为 linux，则必须取消设置以下字段： -securityContext.windowsOptions 如果 OS 字段设置为 windows，则必须取消设置以下字段： - spec.hostPID - spec.hostIPC - spec.hostUsers - spec.hostUsers - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup | |
|
| 开销代表了与为给定 RuntimeClass 运行 pod 相关的资源开销。此字段将由 RuntimeClass 准入控制器在准入时自动填充。如果启用了 RuntimeClass 准入控制器，则无法在 Pod 创建请求中设置开销。RuntimeClass 准入控制器将拒绝 Pod 创建已设置开销的请求。如果在 PodSpec 中配置并选择了 RuntimeClass，则 Overhead 将被设置为对应的 RuntimeClass 中定义的值，否则它将保留为未设置并被视为零。更多信息： https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md | |
|
|
| preemptionPolicy 是抢占优先级较低的 pod 的策略。Never, PreemptLowerPriority 之一。如果未设置，则默认为 PreemptLowerPriority。
可能枚举值： - |
|
|
| 优先级值。各种系统组件使用此字段查找 pod 的优先级。启用 Priority Admission Controller 时，它会阻止用户设置此字段。准入控制器从 PriorityClassName 填充此字段。数值越大，优先级越高。 |
|
|
| 如果指定，则表示 pod 的优先级。"system-node-critical"和"system-cluster-critical"是两个特殊关键字，表示前者最高的优先级。必须使用该名称创建 PriorityClass 对象来定义任何其他名称。如果没有指定，如果没有默认值，pod 优先级将为 default 或零。 |
|
| 如果指定，则会针对 pod 就绪度评估所有就绪度。当它的所有容器都就绪且在就绪度授权中指定的所有条件都等于"True"更多信息时，pod 已就绪： https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates | |
|
| ResourceClaims 定义在允许 Pod 启动前必须分配和保留哪些 ResourceClaims。资源将提供给那些按名称消耗它们的容器。 这是一个 alpha 字段，需要启用 DynamicResourceAllocation 功能门。 此字段是不可变的。 | |
|
|
| 为 pod 中的所有容器重启策略。Always、OnFailure、Never 之一。在某些上下文中，仅允许这些值的子集。默认值为 Always。更多信息： https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
可能枚举值： - |
|
|
| runtimeClassName 指的是 node.k8s.io 组中的 RuntimeClass 对象，它应该用于运行此 pod。如果没有 RuntimeClass 资源与命名类匹配，则不会运行 pod。如果未设置或为空，则使用 "legacy" RuntimeClass，它是一个带有使用默认运行时处理器的空定义的隐式类。更多信息： https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class |
|
|
| 如果指定，pod 将由指定的调度程序分配。如果没有指定，pod 将默认调度程序分配。 |
|
| SchedulingGates 是值（如果指定）将阻止调度 pod 的不透明列表。如果 schedulingGates 不是空的，pod 将保持在 SchedulingGated 状态，调度程序也不会尝试调度 pod。 SchedulingGates 只能在创建 pod 时设置，之后只能删除。 这是 PodSchedulingReadiness 功能门启用的 beta 功能。 | |
|
| securityContext 包含 pod 级别的安全属性和通用容器设置。可选：默认为空。有关每个字段的默认值，请参阅类型描述。 | |
|
|
| deprecatedServiceAccount 是 ServiceAccountName 的前文别名。deprecated ：改为使用 serviceAccountName。 |
|
|
| serviceAccountName 是用于运行此 pod 的 ServiceAccount 的名称。更多信息： https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
|
|
| 如果为 true，则 pod 的主机名将配置为 pod 的 FQDN，而不是叶名称（默认值）。在 Linux 容器中，这意味着在内核的 hostname 字段中设置 FQDN ( struct utsname 的 nodename 字段)。在 Windows 容器中，这意味着将 registry 键 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters 的 registry 值设置为 FQDN。如果 pod 没有 FQDN，则无效。默认为 false。 |
|
|
| 在 pod 中所有容器间共享单个进程命名空间。设置此容器后，将能够查看和信号来自同一 pod 中其他容器的进程，并且每个容器中的第一个进程不会被分配 PID 1。无法同时设置 hostPID 和 ShareProcessNamespace。可选：默认为 false。 |
|
|
| 如果指定，完全限定的 Pod 主机名将是 "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>"。如果没有指定，pod 根本不会具有 domainname。 |
|
|
| pod 需要安全终止的可选持续时间（以秒为单位）。在删除请求中可能会减少。值必须是非负整数。值零表示通过 kill 信号立即停止（没有关闭的机会）。如果这个值为 nil，则使用默认的宽限期。宽限期是 pod 中运行的进程发送终止信号的持续时间（以秒为单位），以及进程通过 kill 信号强制停止的时间。设置这个值比您的进程预期的清理时间长。默认值为 30 秒。 |
|
| 如果指定，pod 的容限。 | |
|
| topologySpreadConstraints 描述如何在拓扑域中分散的 pod 组。调度程序将通过约束来调度 pod。所有 topologySpreadConstraints 都是 AND。 | |
|
| 可由属于 pod 的容器挂载的卷列表。更多信息： https://kubernetes.io/docs/concepts/storage/volumes |
4.1.98. io.k8s.api.core.v1.PodTemplateList schema
- 描述
- PodTemplateList 是 PodTemplates 列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| pod 模板列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.99. io.k8s.api.core.v1.PodTemplateSpec schema
- 描述
- PodTemplateSpec 描述了从模板创建 pod 时应该具有的数据
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| pod 所需的行为的规格。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
4.1.100. io.k8s.api.core.v1.PortworxVolumeSource schema
- 描述
- PortworxVolumeSource 代表一个 Portworx volume 资源。
- 类型
-
object - 必填
-
volumeID
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| fstype 代表要挂载的文件系统类型，必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs".如果未指定，则隐式推断为"ext4"。 |
|
|
| 只读默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
|
| VolumeId 唯一标识一个 Portworx 卷 |
- 描述
- 空首选调度术语与所有带有隐式权重 0 的对象匹配（例如，它是一个 no-op）。null 首选调度术语不匹配任何对象（例如，也是 no-op）。
- 类型
-
object - 必填
-
weight -
preference
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 节点选择器术语，与对应的权重关联。 | |
|
|
| 与对应的 nodeSelectorTerm 匹配的权重，范围为 1-100。 |
4.1.102. io.k8s.api.core.v1.Probe schema
- 描述
- probe 描述了要对容器执行的健康检查，以确定它是否处于活动状态或准备好接收流量。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| exec 指定要执行的操作。 | |
|
|
| 在成功后，探测被视为失败的连续最小失败。默认值为 3。最小值为 1。 |
|
| GRPC 指定涉及 GRPC 端口的操作。 | |
|
| httpGet 指定要执行的 http 请求。 | |
|
|
| 容器启动后的秒数，然后再启动存活度探测。更多信息： https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
| 执行探测的频率（以秒为单位）。默认值为 10 秒。最小值为 1。 |
|
|
| 在失败后，探测被视为成功的最低连续成功。默认为 1。对于存活度和启动，必须为 1。最小值为 1。 |
|
| tcpSocket 指定涉及 TCP 端口的操作。 | |
|
|
| 可选持续时间（以秒为单位），pod 需要在探测失败时安全终止。宽限期是 pod 中运行的进程发送终止信号的持续时间（以秒为单位），以及进程通过 kill 信号强制停止的时间。设置这个值比您的进程预期的清理时间长。如果这个值为 nil，则使用 pod 的 terminationGracePeriodSeconds。否则，这个值会覆盖 pod 规格提供的值。值必须是非负整数。值零表示通过 kill 信号立即停止（没有关闭的机会）。这是一个 beta 字段，需要启用 ProbeTerminationGracePeriod 功能门。如果未设置，则使用最小值为 1. spec.terminationGracePeriodSeconds。 |
|
|
| 探测超时的秒数。默认值为 1 秒。最小值为 1。更多信息： https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
4.1.103. io.k8s.api.core.v1.ProjectedVolumeSource schema
- 描述
- 代表投射卷源
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| defaultMode 是默认用来对创建文件设置权限的模式位。必须是 0000 到 0777 之间的数值，也可以是 0 到 511 之间的十进制值。YAML 接受八进制值和十进制值，JSON 需要模式位的十进制值。该路径中的目录不受此设置的影响。这可能会与影响文件模式的其他选项（如 fsGroup ）冲突，结果可以是设置其他模式位。 |
|
| sources 是卷投射列表 |
4.1.104. io.k8s.api.core.v1.QuobyteVolumeSource schema
- 描述
- 代表 pod 的生命周期持续的 Quobyte 挂载。quobyte 卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
object - 必填
-
registry -
卷
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 将卷访问映射到 Default 的组没有组 |
|
|
| 此处的只读将强制使用只读权限挂载 Quobyte 卷。默认为false。 |
|
|
| registry 代表一个或多个 Quobyte Registry 服务，作为字符串指定为 host:port 对（多个条目用逗号分隔），后者充当卷的中央 registry |
|
|
| 在带有动态置备 Quobyte 卷的后端中拥有给定 Quobyte 卷的租户，值由插件设置 |
|
|
| 用户将卷访问权限映射到默认值到 serivceaccount 用户 |
|
|
| 卷是一个字符串，它根据名称引用已创建的 Quobyte 卷。 |
- 描述
- 代表 Rados 块设备挂载，该挂载最后是 pod 的生命周期。RBD 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
object - 必填
-
monitor -
image
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| fstype 是您要挂载的卷的文件系统类型。提示： 确保主机操作系统支持文件系统类型。示例："ext4", "xfs", "ntfs"。如果未指定，则隐式推断为"ext4"。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#rbd |
|
|
| image 是 rados 镜像名称。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| keyring 是 RBDUser 的密钥环的路径。默认为 /etc/ceph/keyring。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| monitor 是 Ceph 监视器的集合。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| pool 是 rados 池名称。默认为 rbd。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| 此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| secretRef 是 RBDUser 的身份验证 secret 的名称。如果提供，则会覆盖密钥环。默认为 nil。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it | |
|
|
| user 是 rados 用户名。默认为 admin。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
4.1.106. io.k8s.api.core.v1.RBDVolumeSource schema
- 描述
- 代表 Rados 块设备挂载，该挂载最后是 pod 的生命周期。RBD 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
object - 必填
-
monitor -
image
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| fstype 是您要挂载的卷的文件系统类型。提示： 确保主机操作系统支持文件系统类型。示例："ext4", "xfs", "ntfs"。如果未指定，则隐式推断为"ext4"。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#rbd |
|
|
| image 是 rados 镜像名称。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| keyring 是 RBDUser 的密钥环的路径。默认为 /etc/ceph/keyring。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| monitor 是 Ceph 监视器的集合。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| pool 是 rados 池名称。默认为 rbd。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
|
| 此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| secretRef 是 RBDUser 的身份验证 secret 的名称。如果提供，则会覆盖密钥环。默认为 nil。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it | |
|
|
| user 是 rados 用户名。默认为 admin。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
- 描述
- ReplicationControllerList 是复制控制器的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| 复制控制器列表。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.108. io.k8s.api.core.v1.ResourceClaim schema
- 描述
- ResourceClaim 引用 PodSpec.ResourceClaims 中的一个条目。
- 类型
-
object - 必填
-
name
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 必须与使用此字段的 Pod 的 pod.spec.resourceClaims 中一个条目的名称匹配。它使得资源在容器内可用。 |
4.1.109. io.k8s.api.core.v1.ResourceFieldSelector schema
- 描述
- ResourceFieldSelector 代表容器资源(cpu、memory)及其输出格式
- 类型
-
object - 必填
-
resource
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 容器名称：卷所需，对于 env vars 是可选的 |
|
| 指定公开资源的输出格式，默认为 "1" | |
|
|
| 必需：要选择的资源 |
4.1.110. io.k8s.api.core.v1.ResourceQuotaList schema
- 描述
- ResourceQuotaList 是 ResourceQuota 项目的列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 ResourceQuota 对象的列表。更多信息： https://kubernetes.io/docs/concepts/policy/resource-quotas/ | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.111. io.k8s.api.core.v1.ResourceRequirements schema
- 描述
- ResourceRequirements 描述计算资源要求。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 声明列出了此容器使用的 spec.resourceClaims 中定义的资源名称。 这是一个 alpha 字段，需要启用 DynamicResourceAllocation 功能门。 此字段是不可变的。它只能为容器设置。 | |
|
| 限制描述了允许的最大计算资源量。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | |
|
| Requests 描述了所需的最少计算资源。如果容器省略了 Requests，则默认为 Limits （如果明确指定），否则默认为实现定义的值。请求不能超过限值。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
- 描述
- ScaleIOPersistentVolumeSource 代表一个持久的 ScaleIO 卷
- 类型
-
object - 必填
-
gateway -
system -
secretRef
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认为 "xfs" |
|
|
| gateway 是 ScaleIO API 网关的主机地址。 |
|
|
| protectionDomain 是配置的存储的 ScaleIO 保护域的名称。 |
|
|
| 只读默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
| secretRef 对 secret for ScaleIO 用户和其他敏感信息的引用。如果没有提供，则 Login 操作将失败。 | |
|
|
| sslEnabled 是启用/禁用与网关的 SSL 通信的标记，默认为 false |
|
|
| storageMode 指示卷的存储应该是 ThickProvisioned 或 ThinProvisioned。默认为 ThinProvisioned。 |
|
|
| storagePool 是与保护域关联的 ScaleIO 存储池。 |
|
|
| system 是存储系统的名称，如 ScaleIO 中配置。 |
|
|
| volumeName 是在与这个卷源关联的 ScaleIO 系统中创建的卷的名称。 |
4.1.113. io.k8s.api.core.v1.ScaleIOVolumeSource schema
- 描述
- ScaleIOVolumeSource 代表一个持久的 ScaleIO 卷
- 类型
-
object - 必填
-
gateway -
system -
secretRef
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认为 "xfs"。 |
|
|
| gateway 是 ScaleIO API 网关的主机地址。 |
|
|
| protectionDomain 是配置的存储的 ScaleIO 保护域的名称。 |
|
|
| 只读默认值为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
| secretRef 对 secret for ScaleIO 用户和其他敏感信息的引用。如果没有提供，则 Login 操作将失败。 | |
|
|
| sslEnabled Flag 启用/禁用与网关的 SSL 通信，默认为 false |
|
|
| storageMode 指示卷的存储应该是 ThickProvisioned 或 ThinProvisioned。默认为 ThinProvisioned。 |
|
|
| storagePool 是与保护域关联的 ScaleIO 存储池。 |
|
|
| system 是存储系统的名称，如 ScaleIO 中配置。 |
|
|
| volumeName 是在与这个卷源关联的 ScaleIO 系统中创建的卷的名称。 |
4.1.114. io.k8s.api.core.v1.SeccompProfile schema
- 描述
- SeccompProfile 定义 pod/container 的 seccomp 配置集设置。只能设置一个配置文件源。
- 类型
-
object - 必填
-
type
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| localhostProfile 表示使用节点上文件中定义的配置集。该配置集必须在节点上预先配置才能正常工作。必须是相对于 kubelet 配置的 seccomp 配置集位置的降序路径。只有当 type 为 "Localhost" 时，才必须设置。 |
|
|
| type 表示将应用了哪些 seccomp 配置集。有效选项有： localhost - 应该使用节点上文件中定义的配置集。RuntimeDefault - 应使用容器运行时默认配置集。unconfined - 不应应用任何配置集。
可能枚举值： - |
4.1.115. io.k8s.api.core.v1.SecretEnvSource schema
- 描述
SecretEnvSource 选择一个 Secret 来填充环境变量。
目标 Secret 的数据字段的内容将以环境变量的形式表示键值对。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 指定是否需要定义 Secret |
4.1.116. io.k8s.api.core.v1.SecretKeySelector schema
- 描述
- SecretKeySelector 选择 Secret 的密钥。
- 类型
-
object - 必填
-
key
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。 |
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 指定是否需要定义 Secret 或其密钥 |
4.1.117. io.k8s.api.core.v1.SecretList schema
- 描述
- SecretList 是一个 Secret 列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 secret 对象的列表。更多信息： https://kubernetes.io/docs/concepts/configuration/secret | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.118. io.k8s.api.core.v1.SecretProjection schema
- 描述
将 secret 适应到投射卷中。
目标 Secret 的数据字段的内容将作为文件出现在投射卷中，使用 Data 字段中的密钥作为文件名。请注意，这与没有默认模式的 secret 卷源相同。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 如果未指定项目，则引用 Secret 的 Data 字段中每个键值对将投射到卷中，名称为键，内容是值。如果指定，列出的键将投射到指定的路径中，且未列出的密钥将不存在。如果指定了在 Secret 中不存在的密钥，则卷设置将错误，除非标记为可选。路径必须是 relative，且不能包含 '..' 路径或以 '..' 开头。 | |
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 可选字段指定是否需要定义 Secret 或其密钥 |
4.1.119. io.k8s.api.core.v1.SecretReference schema
- 描述
- secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 名称在命名空间内是唯一的，以引用 secret 资源。 |
|
|
| namespace 定义 secret 名称必须唯一的空间。 |
4.1.120. io.k8s.api.core.v1.SecretVolumeSource schema
- 描述
将 Secret 调整为卷。
目标 Secret 的数据字段的内容将作为文件显示在卷中，并将 Data 字段中的密钥用作文件名。Secret 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| defaultMode 是可选：用于默认设置创建文件的权限的模式位。必须是 0000 到 0777 之间的数值，也可以是 0 到 511 之间的十进制值。YAML 接受八进制值和十进制值，JSON 需要模式位的十进制值。默认值为 0644。该路径中的目录不受此设置的影响。这可能会与影响文件模式的其他选项（如 fsGroup ）冲突，结果可以是设置其他模式位。 |
|
| 如果未指定项目，则引用 Secret 的 Data 字段中每个键值对将投射到卷中，名称为键，内容是值。如果指定，列出的键将投射到指定的路径中，且未列出的密钥将不存在。如果指定了在 Secret 中不存在的密钥，则卷设置将错误，除非标记为可选。路径必须是 relative，且不能包含 '..' 路径或以 '..' 开头。 | |
|
|
| 可选字段指定是否需要定义 Secret 或其密钥 |
|
|
| secretName 是要使用的 pod 命名空间中的 secret 名称。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#secret |
4.1.121. io.k8s.api.core.v1.SecurityContext schema
- 描述
- securityContext 包含将应用到容器的安全配置。SecurityContext 和 PodSecurityContext 中都存在一些字段。当同时设置这两个时，SecurityContext 中的值就会优先使用。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| allowPrivilegeEscalation 控制进程是否可以获得比父进程更多的特权。此 bool 直接控制容器进程中是否设置了 no_new_privs 标志。当容器以 Privileged 2 运行为 Privileged 2 时，allowPrivilegeEscalation 为 true 时，当 spec.os.name 为窗口时，无法设置此字段。 |
|
| 运行容器时添加/过滤的功能。默认为容器运行时授予的默认功能集。请注意，当 spec.os.name 是窗口时，无法设置此字段。 | |
|
|
| 以特权模式运行容器。特权容器中的进程实质上相当于主机上的 root 用户。默认为false。请注意，当 spec.os.name 是窗口时，无法设置此字段。 |
|
|
| procMount 表示用于容器的 proc 挂载类型。默认为 DefaultProcMount，它对只读路径和屏蔽的路径使用容器运行时默认值。这需要启用 ProcMountType 功能标记。请注意，当 spec.os.name 是窗口时，无法设置此字段。
可能枚举值： - |
|
|
| 此容器是否具有只读根文件系统。默认值为 false。请注意，当 spec.os.name 是窗口时，无法设置此字段。 |
|
|
| 运行容器进程的入口点的 GID。如果未设置，则使用运行时默认值。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置，则优先使用 SecurityContext 指定的值。请注意，当 spec.os.name 是窗口时，无法设置此字段。 |
|
|
| 表示容器必须以非 root 用户身份运行。如果为 true，Kubelet 将在运行时验证镜像，以确保它不会以 UID 0 (root)运行，如果容器确实无法启动它，则无法启动它。如果未设置或 false，则不会执行这样的验证。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置，则优先使用 SecurityContext 指定的值。 |
|
|
| 运行容器进程的入口点的 UID。如果未指定，则默认为镜像元数据中指定的用户。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置，则优先使用 SecurityContext 指定的值。请注意，当 spec.os.name 是窗口时，无法设置此字段。 |
|
| 要应用到容器的 SELinux 上下文。如果未指定，容器运行时将为每个容器分配一个随机 SELinux 上下文。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置，则优先使用 SecurityContext 指定的值。请注意，当 spec.os.name 是窗口时，无法设置此字段。 | |
|
| 此容器使用的 seccomp 选项。如果 pod 和容器级别都提供了 seccomp 选项，容器选项将覆盖 pod 选项。请注意，当 spec.os.name 是窗口时，无法设置此字段。 | |
|
| 应用到所有容器的 Windows 特定设置。如果未指定，则使用 PodSecurityContext 中的选项。如果在 SecurityContext 和 PodSecurityContext 中设置，则优先使用 SecurityContext 指定的值。请注意，当 spec.os.name 是 linux 时，无法设置此字段。 |
4.1.122. io.k8s.api.core.v1.SELinuxOptions schema
- 描述
- seLinuxOptions 是要应用到容器的标签
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| level 是适用于容器的 SELinux 级别标签。 |
|
|
| role 是适用于容器的 SELinux 角色标签。 |
|
|
| type 是适用于容器的 SELinux 类型标签。 |
|
|
| user 是适用于容器的 SELinux 用户标签。 |
4.1.123. io.k8s.api.core.v1.ServiceAccountList schema
- 描述
- ServiceAccountList 是 ServiceAccount 对象列表
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| ServiceAccounts 列表。更多信息： https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
- 描述
- ServiceAccountTokenProjection 代表投射服务帐户令牌卷。此投射可用于将服务帐户令牌插入到 pod 运行时文件系统中，以用于 API (Kubernetes API 服务器或其他)。
- 类型
-
object - 必填
-
path
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 受众是令牌的预期受众。令牌的接收者必须使用令牌使用者中指定的标识符来识别自己，否则应拒绝令牌。使用者默认为 apiserver 的标识符。 |
|
|
| expirationSeconds 是服务帐户令牌的请求持续时间。随着令牌方法到期，kubelet 卷插件将主动轮转服务帐户令牌。如果令牌存在的时间超过这个值的 80%，或者令牌超过 24 小时，则 kubelet 将开始尝试轮转令牌，且必须至少为 10 分钟。 |
|
|
| path 是相对于文件挂载点的路径，以将令牌项目到其中。 |
4.1.125. io.k8s.api.core.v1.ServiceList schema
- 描述
- ServiceList 包含服务列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| 服务列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
- 描述
- 代表 StorageOS 持久性卷资源。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定，则隐式推断为"ext4"。 |
|
|
| 只读默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
| secretRef 指定用于获取 StorageOS API 凭证的 secret。如果没有指定，则会尝试默认值。 | |
|
|
| volumeName 是 StorageOS 卷的人类可读名称。卷名称只在命名空间中是唯一的。 |
|
|
| volumeNamespace 指定 StorageOS 中卷的范围。如果没有指定命名空间，则使用 Pod 的命名空间。这允许在 StorageOS 中镜像 Kubernetes 名称范围，以便在更紧密的集成。将 VolumeName 设置为任何名称来覆盖默认的行为。如果没有在 StorageOS 中使用命名空间，则设置为 "default"。将创建在 StorageOS 中没有预先存在的命名空间。 |
4.1.127. io.k8s.api.core.v1.StorageOSVolumeSource schema
- 描述
- 代表 StorageOS 持久性卷资源。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定，则隐式推断为"ext4"。 |
|
|
| 只读默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
| secretRef 指定用于获取 StorageOS API 凭证的 secret。如果没有指定，则会尝试默认值。 | |
|
|
| volumeName 是 StorageOS 卷的人类可读名称。卷名称只在命名空间中是唯一的。 |
|
|
| volumeNamespace 指定 StorageOS 中卷的范围。如果没有指定命名空间，则使用 Pod 的命名空间。这允许在 StorageOS 中镜像 Kubernetes 名称范围，以便在更紧密的集成。将 VolumeName 设置为任何名称来覆盖默认的行为。如果没有在 StorageOS 中使用命名空间，则设置为 "default"。将创建在 StorageOS 中没有预先存在的命名空间。 |
4.1.128. io.k8s.api.core.v1.Sysctl schema
- 描述
- sysctl 定义要设置的内核参数
- 类型
-
object - 必填
-
name -
value
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 要设置的属性的名称 |
|
|
| 要设置的属性值 |
4.1.129. io.k8s.api.core.v1.TCPSocketAction schema
- 描述
- TCPSocketAction 描述了基于打开套接字的操作
- 类型
-
object - 必填
-
port
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 可选：要连接到的主机名，默认为 pod IP。 |
|
| 在容器中访问的端口的数量或名称。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。 |
4.1.130. io.k8s.api.core.v1.Toleration schema
- 描述
- 附加到此 Toleration 的 pod，以容许任何与 triple <key,value,effect> 匹配的污点，使用匹配的 operator <operator>。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| effect 表示污点效果要匹配。空意味着匹配所有污点效果。指定后，允许的值为 NoSchedule、PreferNoSchedule 和 NoExecute。
可能枚举值： - |
|
|
| key 是容限应用到的污点键。empty 表示与所有污点键匹配。如果键为空，则运算符必须是 Exists；此组合意味着匹配所有值和所有键。 |
|
|
| Operator 代表键与值的关系。有效的运算符是 Exists 和 Equal。默认为 Equal。exists 等同于 value 的通配符，以便 pod 可以容忍特定类别的所有污点。
可能枚举值： - |
|
|
| TolerationSeconds 代表容限的期间（该容限必须是 NoExecute，否则将忽略此字段）容许污点。默认情况下，它没有被设置，这意味着容许永久污点（不驱除）。系统会将零值和负值视为 0 （立即撤离）。 |
|
|
| 值是容限匹配的污点值。如果运算符是 Exists，则该值应为空，否则只是一个常规字符串。 |
- 描述
- 拓扑选择器要求是与给定标签匹配的选择器。这是一个 alpha 功能，将来可能会改变。
- 类型
-
object - 必填
-
key -
values
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 选择器应用到的标签键。 |
|
|
| 字符串值数组。一个值必须与要选择的标签匹配。Values 中的每个条目都是 ORed。 |
4.1.132. io.k8s.api.core.v1.TopologySelectorTerm schema
- 描述
- 拓扑选择器术语代表标签查询的结果。null 或空拓扑选择器术语不匹配任何对象。它们的要求是 AND。它提供功能子集作为 NodeSelectorTerm。这是一个 alpha 功能，将来可能会改变。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 按标签划分的拓扑选择器要求列表。 |
- 描述
- TopologySpreadConstraint 指定如何在给定的拓扑中分散匹配的 pod。
- 类型
-
object - 必填
-
maxSkew -
topologyKey -
whenUnsatisfiable
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| labelSelector 用于查找匹配的 pod。与此标签选择器匹配的 Pod 被计算，以确定其对应拓扑域中的 pod 数量。 | |
|
|
| matchLabelKeys 是一组 pod 标签键，用于选择要计算分布的 pod。键用于从传入的 pod 标签中查找值，这些键值标签带有 labelSelector 的 ANDed 来选择要针对传入 pod 计算的现有 pod 组。禁止在 MatchLabelKeys 和 LabelSelector 中存在相同的键。当 LabelSelector 没有设置时，无法设置 matchLabelKeys。传入的 pod 标签中不存在的键将被忽略。null 或 empty 列表表示仅匹配 labelSelector。 这是一个 beta 字段，需要启用 MatchLabelKeysInPodTopologySpread 功能门（默认启用）。 |
|
|
|
maxSkew 描述了 pod 可能不均匀分布的程度。当 |
|
|
| MinDomains 表示最少的合格域数。当匹配拓扑键的合格域数量小于 minDomains 时，Pod Topology Spread 会将"global minimum"视为 0，然后执行 Skew 计算。当匹配拓扑键的合格域数量等于或大于 minDomains 时，这个值对调度没有影响。因此，当有资格的域数量小于 minDomains 时，调度程序不会将这些域的 maxSkew Pod 调度到这些域。如果值为 nil，则约束的行为就像 MinDomains 等于 1。有效值为大于 0 的整数。当值不是 nil 时，WhenUnsatisfiable 必须是 DoNotSchedule。 例如，在 3 区集群中，MaxSkew 设置为 2，MinDomains 被设置为 5，而带有与 2/2/2: | zone1 | zone2 | zone2 | zone2 | zone2 | zone2 | zone3 | zone3 | zone3 | 区域数量小于 5 (MinDomains)，因此"global minimum"被视为 0。在这种情况下，无法调度具有相同 labelSelector 的新 pod，因为如果新 Pod 调度到三个区，则 computed skew 将为 3 (3 - 0)，它将违反 MaxSkew。 这是一个 beta 字段，需要启用 MinDomainsInPodTopologySpread 功能门（默认启用）。 |
|
|
| NodeAffinityPolicy 表示在计算 pod 拓扑分布偏移时，我们将如何处理 Pod 的 nodeAffinity/nodeSelector。选项为：- Honor：计算中仅包含与 nodeAffinity/nodeSelector 匹配的节点。忽略 Ignore: nodeAffinity/nodeSelector。所有节点包含在计算中。 如果这个值为 nil，则行为等同于 Honor 策略。这是一个 beta 级别的功能，由 NodeInclusionPolicyInPodTopologySpread 功能标记启用。
可能枚举值： - |
|
|
| NodeTaintsPolicy 表示在计算 pod 拓扑分布偏移时，我们将如何处理节点污点。选项为：- Honor: 没有污点的节点，以及传入 pod 具有容限的污点节点被包含。- Ignore: node taint is ignored。包括所有节点。 如果这个值为 nil，则行为等同于 Ignore 策略。这是一个 beta 级别的功能，由 NodeInclusionPolicyInPodTopologySpread 功能标记启用。
可能枚举值： - |
|
|
| topologyKey 是节点标签的密钥。带有具有此键和相同值标签的节点被视为在同一拓扑中。我们将每个 <key, value> 视为"bucket"，并尝试在每个存储桶中均衡的 pod 数量。我们将域定义为拓扑的特定实例。另外，我们定义了一个有资格的域，其节点满足 nodeAffinityPolicy 和 nodeTaintsPolicy 的要求。例如，如果 TopologyKey 为 "kubernetes.io/hostname"，则每个节点都是该拓扑的域。如果 TopologyKey 是 "topology.kubernetes.io/zone"，则每个区都是该拓扑的域。它是必填字段。 |
|
|
| whenUnsatisfiable 表示在不满足分散约束的情况下如何处理 pod。- DoNotSchedule （默认）告知调度程序不调度它。- ScheduleAnyway 告知调度程序将 pod 调度到任何位置，但为拓扑赋予更高优先级，有助于减少偏移量。只有在每个可能的节点分配在某些拓扑中违反 "MaxSkew" 时，对传入 pod 的一个约束被视为"Unsatisfiable"。例如，在 3 区集群中，MaxSkew 设置为 1，具有相同 labelSelector 的 pod 分布为 3/1/1: | zone1 | zone3 | zone3 | | P P | P | P | If WhenUnsatisfiable 被设置为 DoNotSchedule，传入的 pod 只能调度到 zone2 (zone3) 要成为 3/2/1 (3/1/2)，在 zone2 (zone3)上作为 ActualSkew (2-1)满足 MaxSkew (1)。换句话说，集群仍然可以进行平衡，但调度程序不会使其更不平衡。它是必填字段。
可能枚举值： - |
- 描述
- TypedLocalObjectReference 包含足够信息，可让您找到同一命名空间中的 typed referenced 对象。
- 类型
-
object - 必填
-
kind -
name
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| apiGroup 是被引用资源的组。如果没有指定 APIGroup，则指定的 Kind 必须位于 core API 组中。对于任何其他第三方类型，需要 APIGroup。 |
|
|
| kind 是被引用的资源类型 |
|
|
| name 是被引用的资源的名称 |
4.1.135. io.k8s.api.core.v1.TypedObjectReference schema
- 描述
- 类型
-
object - 必填
-
kind -
name
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| apiGroup 是被引用资源的组。如果没有指定 APIGroup，则指定的 Kind 必须位于 core API 组中。对于任何其他第三方类型，需要 APIGroup。 |
|
|
| kind 是被引用的资源类型 |
|
|
| name 是被引用的资源的名称 |
|
|
| namespace 是被引用的资源的命名空间。在指定命名空间时，引用命名空间中需要 gateway.networking.k8s.io/ReferenceGrant 对象，以允许该命名空间的所有者接受引用。详情请查看 ReferenceGrant 文档。(alpha)此字段需要启用 CrossNamespaceVolumeDataSource 功能门。 |
4.1.136. io.k8s.api.core.v1.Volume schema
- 描述
- 卷代表一个 pod 中的命名卷，可以被 pod 中的任何容器访问。
- 类型
-
object - 必填
-
name
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| awsElasticBlockStore 代表附加到 kubelet 主机机器的 AWS Disk 资源，然后公开给 pod。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | |
|
| azureDisk 代表主机上的 Azure Data Disk 挂载，并绑定到 pod。 | |
|
| azureFile 代表主机上的 Azure File Service 挂载，并绑定到 pod。 | |
|
| CephFS 代表共享 pod 生命周期的主机上的 Ceph FS 挂载 | |
|
| Cinder 代表附加并挂载到 kubelet 主机上的 cinder 卷。更多信息： https://examples.k8s.io/mysql-cinder-pd/README.md | |
|
| ConfigMap 代表一个应该填充此卷的 configMap | |
|
| CSI （容器存储接口）代表由某些外部 CSI 驱动程序(Beta 功能)处理的临时存储。 | |
|
| downwardAPI 代表有关应该填充此卷的 pod 的 Downward API | |
|
| emptyDir 代表共享 pod 生命周期的临时目录。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#emptydir | |
|
| ephemeral 代表由集群存储驱动程序处理的卷。卷的生命周期与定义它的 pod 关联 - 它将在 pod 启动前创建，并在 pod 被删除时删除。 使用这个选项时：只有在 pod 运行、b）常规卷（如从快照或容量跟踪中恢复）时，才需要使用这个卷。c）存储驱动程序通过存储类来指定，而 d）存储驱动程序支持通过 PersistentVolumeClaim 进行动态卷置备（请参阅 EphemeralVolumeSource）。 对于比单个 pod 生命周期更长的卷，使用 PersistentVolumeClaim 或特定于供应商的 API。 如果 CSI 驱动程序旨在以这种方式使用该方法，请使用 CSI 作为轻量级本地临时卷 - 如需更多信息，请参阅驱动程序文档。 pod 可以同时使用两种类型的临时卷和持久性卷。 | |
|
| FC 代表附加到 kubelet 主机的 Fibre Channel 资源，然后公开给 pod。 | |
|
| FlexVolume 代表一个通用卷资源，它使用基于 exec 的插件置备/附加。 | |
|
| flocker 代表附加到 kubelet 主机机器的 Flocker 卷。这取决于运行 Flocker 控制服务 | |
|
| gcePersistentDisk 代表附加到 kubelet 主机机器的 GCE Disk 资源，然后公开给 pod。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | |
|
| gitRepo 代表特定修订版本的 git 存储库。DEPRECATED: GitRepo 已被弃用。要使用 git 仓库置备容器，请将 EmptyDir 挂载到使用 git 克隆存储库的 InitContainer 中，然后将 EmptyDir 挂载到 Pod 的容器中。 | |
|
| GlusterFS 代表共享 pod 生命周期的主机上的 Glusterfs 挂载。更多信息： https://examples.k8s.io/volumes/glusterfs/README.md | |
|
| hostpath 代表主机机器上直接公开给容器已存在的文件或目录。这通常用于系统代理或其他允许查看主机机器的特权。大多数容器都不需要此操作。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#hostpath | |
|
| iSCSI 代表附加到 kubelet 主机机器的 ISCSI 磁盘资源，然后公开给 pod。更多信息： https://examples.k8s.io/volumes/iscsi/README.md | |
|
|
| 卷的名称。必须是 DNS_LABEL，且在 pod 中唯一。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| NFS 代表共享 pod 生命周期的主机上的 NFS 挂载： https://kubernetes.io/docs/concepts/storage/volumes#nfs | |
|
| persistentVolumeClaimVolumeSource 代表对同一命名空间中的 PersistentVolumeClaim 的引用。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims | |
|
| photonPersistentDisk 代表在 kubelets 主机上附加并挂载的 PhotonController 持久磁盘 | |
|
| portworxVolume 代表附加并挂载到 kubelet 主机上的 portworx 卷 | |
|
| 在一个资源 secret、configmap 和 Downward API 中所有的项目 | |
|
| quobyte 代表共享 pod 生命周期的主机上的 Quobyte 挂载 | |
|
| RBD 代表共享 pod 生命周期的主机上的 Rados 块设备挂载。更多信息： https://examples.k8s.io/volumes/rbd/README.md | |
|
| scaleIO 代表一个在 Kubernetes 节点上附加并挂载的 ScaleIO 持久性卷。 | |
|
| secret 代表应填充此卷的 secret。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#secret | |
|
| storageos 代表在 Kubernetes 节点上附加并挂载的 StorageOS 卷。 | |
|
| vsphereVolume 代表在 kubelets 主机上附加并挂载的 vSphere 卷 |
4.1.137. io.k8s.api.core.v1.VolumeDevice schema
- 描述
- volumeDevice 描述容器中原始块设备的映射。
- 类型
-
object - 必填
-
name -
devicePath
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| DevicePath 是设备要映射到的容器内的路径。 |
|
|
| name 必须与 pod 中的 persistentVolumeClaim 的名称匹配 |
4.1.138. io.k8s.api.core.v1.VolumeMount schema
- 描述
- VolumeMount 描述了在容器中挂载卷。
- 类型
-
object - 必填
-
name -
mountPath
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 在容器中挂载卷的路径。不得包含 ':'。 |
|
|
| mountPropagation 决定如何将挂载从主机传播到容器，以及相关的其他方法。如果没有设置，则使用 MountPropagationNone。此字段是 1.10 中的 beta。
可能枚举值： - |
|
|
| 这必须与卷的 Name 匹配。 |
|
|
| 如果为 true，则以只读形式挂载（否则为 读写(false 或未指定)。默认为false。 |
|
|
| 应从中挂载容器卷的卷中的路径。默认为 "" （卷的根目录）。 |
|
|
| 应从中挂载容器卷的卷中扩展路径。行为与 SubPath 相似，但环境变量引用 $(VAR_NAME)使用容器的环境进行扩展。默认为 "" （卷的根目录）。SubPathExpr 和 SubPath 是互斥的。 |
4.1.139. io.k8s.api.core.v1.VolumeNodeAffinity schema
- 描述
- VolumeNodeAffinity 定义限制此卷可从中访问哪些节点。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 必需指定必须满足的硬节点限制。 |
4.1.140. io.k8s.api.core.v1.VolumeProjection schema
- 描述
- 可与其他支持的卷类型一起投射的预测
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 有关项目的 configMap 数据的 ConfigMap 信息 | |
|
| downwardAPI有关项目的 downwardAPI 数据的信息 | |
|
| 有关项目的 secret 数据的机密信息 | |
|
| serviceAccountToken 是项目的 serviceAccountToken 数据的信息 |
- 描述
- 代表 vSphere 卷资源。
- 类型
-
object - 必填
-
volumePath
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定，则隐式推断为"ext4"。 |
|
|
| StoragePolicyID 是与 StoragePolicyName 关联的存储 Policy Based Management (SPBM)配置集 ID。 |
|
|
| StoragePolicyName 是存储基于策略的管理(SPBM)配置集名称。 |
|
|
| volumePath 是标识 vSphere 卷 vmdk 的路径 |
- 描述
- 所有匹配的 WeightedPodAffinityTerm 字段的权重都会被添加，以查找首选节点。
- 类型
-
object - 必填
-
weight -
podAffinityTerm
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 必需。pod 关联性术语，与对应的权重关联。 | |
|
|
| 与对应的 podAffinityTerm 匹配的权重，范围为 1-100。 |
- 描述
- WindowsSecurityContextOptions 包含特定于 Windows 的选项和凭证。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| GMSACredentialSpec 是 GMSA 准入 Webhook (https://github.com/kubernetes-sigs/windows-gmsa)内联 GMSA 凭证规格的内容，由 GMSACredentialSpecName 字段命名。 |
|
|
| GMSACredentialSpecName 是要使用的 GMSA 凭证 spec 的名称。 |
|
|
| HostProcess 确定容器是否应该作为"主机进程"容器运行。此字段是 alpha-level，仅由启用 WindowsHostProcessContainers 功能标记的组件所接受。在没有功能标记的情况下设置此字段将导致验证 Pod 时出现错误。Pod 的容器必须具有相同的有效 HostProcess 值（不允许混合 HostProcess 容器和非主机Process 容器）。另外，如果 HostProcess 为 true，则 HostNetwork 还必须设置为 true。 |
|
|
| Windows 中的 UserName，以运行容器进程的入口点。如果未指定，则默认为镜像元数据中指定的用户。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置，则优先使用 SecurityContext 指定的值。 |
- 描述
- EndpointSliceList 代表端点片段列表
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是端点片段列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。 |
4.1.145. io.k8s.api.events.v1.EventList schema
- 描述
- EventList 是 Event 对象列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 schema 对象列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
- 描述
- FlowSchemaList 是 FlowSchema 对象列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
|
- 描述
- PriorityLevelConfigurationList 是 PriorityLevelConfiguration 对象的列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
|
- 描述
- IngressClassList 是 IngressClasses 的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 IngressClasses 列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。 |
4.1.149. io.k8s.api.networking.v1.IngressList schema
- 描述
- IngressList 是 Ingress 的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 Ingress 列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
- 描述
- NetworkPolicyList 是 NetworkPolicy 对象列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 schema 对象列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
4.1.151. io.k8s.api.node.v1.RuntimeClassList schema
- 描述
- RuntimeClassList 是 RuntimeClass 对象列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 schema 对象列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
- 描述
- PodDisruptionBudgetList 是 PodDisruptionBudgets 的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 PodDisruptionBudgets 列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
- 描述
- ClusterRoleBindingList 是 ClusterRoleBindings 的集合
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 ClusterRoleBindings 列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。 |
4.1.154. io.k8s.api.rbac.v1.ClusterRoleList schema
- 描述
- ClusterRoleList 是 ClusterRole 的集合
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 ClusterRole 列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。 |
4.1.155. io.k8s.api.rbac.v1.RoleBindingList schema
- 描述
- RoleBindingList 是 RoleBindings 的集合
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 RoleBindings 列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。 |
4.1.156. io.k8s.api.rbac.v1.RoleList schema
- 描述
- RoleList 是角色的集合
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是角色列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。 |
- 描述
- PriorityClassList 是优先级类的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 PriorityClasses 列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据更多信息 ：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
4.1.158. io.k8s.api.storage.v1.CSIDriverList schema
- 描述
- CSIDriverList 是 CSIDriver 对象的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 CSIDriver 列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据更多信息 ：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
4.1.159. io.k8s.api.storage.v1.CSINodeList schema
- 描述
- CSINodeList 是 CSINode 对象的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 CSINode 列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据更多信息 ：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
- 描述
- CSIStorageCapacityList 是 CSIStorageCapacity 对象的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 CSIStorageCapacity 对象列表。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据更多信息 ：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
4.1.161. io.k8s.api.storage.v1.StorageClassList schema
- 描述
- StorageClassList 是存储类的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 StorageClasses 列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据更多信息 ：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
- 描述
- VolumeAttachmentList 是 VolumeAttachment 对象的集合。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 VolumeAttachments 列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据更多信息 ：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
- 描述
- CustomResourceDefinitionList 是 CustomResourceDefinition 对象列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 列出单个 CustomResourceDefinition 对象 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象的元数据更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
- 描述
- 外部文档允许引用外部资源以获取扩展文档。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
|
- 描述
- JSON 代表任何有效的 JSON 值。支持这些类型： bool, int64, float64, string, []interface{}, map[string]interface{} 和 nil。
- 类型
- ``
- 描述
- JSONSchemaProps 是符合规范 4 的 JSON 架构(http://json-schema.org/)。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default 是未定义对象字段的默认值。默认是 CustomResourceDefaulting 功能门下的 beta 功能。默认要求 spec.preserveUnknownFields 为 false。 | |
|
| ||
|
| ||
|
|
| |
|
| ||
|
| ||
|
|
| |
|
|
| |
|
| ||
|
|
| 格式是 OpenAPI v3 格式字符串。未知格式将被忽略。验证以下格式： - bsonobjectid: 一个 bson 对象 ID，即 24 个字符十六进制字符串 - uri: 一个 URI 作为 Golang net/url.ParseRequestURI 解析的 - email: 一个电子邮件地址，由 Golang net/mail.ParseAddress - hostname: 一个 Internet 主机名的有效表示，如 RFC 1034, section 3.1 [RFC1034] 所定义。 - ipv4: 一个 IPv4 IP 由 Golang net.ParseIP - ipv6: ipv6: 一个 IPv6 IP 解析，由 Golang net.ParseIP - cidr: 一个 CIDR 作为 Golang net.ParseCIDR - mac: MAC 地址解析，如 Golang net.ParseMAC - uuid: 一个 UUID，允许由 regex (?i)^[0-9a-f]{8}-?[8\}-?[a]{8\}- - uuid3: 一个 UUID3，它允许由 regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: 一个 UUID4，它允许由 regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: 一个 UUID5，它允许由 regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: 一个 ISBN10 或 ISBN13 number 字符串，如 "0321751043" 或 "978-0321751041" - isbn10: a ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string，如 "978-0321751041" - creditcard: 一个信用卡号，由 regex ^（?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6 (?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3 （?[0-5]|[8-5]|[1][1][10-9]} 如果有任何非数字字符混合在 - ssn 中：一个 U.S. social security number after the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: 一个十六进制颜色代码，如 "FFFFFF: following regex ^? （[0-9a-fA-F]{3}[-F]{3}[-F]\{3\$ - rgbcolor: 一个 RGB 颜色代码，如 rgb，如 "rgb （255, 255,2559" - byte: base64 编码的二进制数据 - password: any kind of string - date - date string like "2006-01-02" like "2006-01-02" defined by RFC3339 - duration: 一个持续时间字符串，如 Golang time.ParseDuration 或与 Scala 持续时间格式兼容，如 "2014-12-15T19:30:20.000:30:20.000" |
|
|
| |
|
| ||
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
| ||
|
|
| |
|
| ||
|
|
| |
|
| ||
|
| ||
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| x-kubernetes-embedded-resource 定义值是嵌入式 Kubernetes runtime.Object，带有 TypeMeta 和 ObjectMeta。类型必须是 object。允许进一步限制嵌入式对象。apiVersion 和 metadata 会自动验证。x-kubernetes-preserve-unknown-fields 为 true，但如果对象被完全指定（默认为 apiVersion, metadata）不需要被验证。 |
|
|
| x-kubernetes-int-or-string 指定这个值是一个整数或字符串。如果为 true，则允许一个空类型，如果遵循以下模式之一，则允许作为 anyOf 的子类型： 1）anyOf: - type: integer - type: string 2）allOf: - anyOf: - type: integer - type: string - … zero or more |
|
|
|
x-kubernetes-list-map-keys 通过指定用作 此标签仅应用于将 "x-kubernetes-list-type" 扩展设置为 "map" 的列表。另外，为此属性指定的值必须是子结构的 scalar 类型字段（不支持嵌套）。 指定的属性必须是 required 或具有默认值，以确保所有列表项都存在这些属性。 |
|
|
| x-kubernetes-list-type 注解一个数组来进一步描述其拓扑。这个扩展必须只用于列表，且可能有 3 个可能的值：
1）Atomic : 列表被视为单一实体，如 scalar。 |
|
|
| x-kubernetes-map-type 注解一个对象来进一步描述其拓扑。只有在类型为 object 且可能具有 2 个可能的值时，才使用此扩展：
1） |
|
|
| x-kubernetes-preserve-unknown-fields 会停止 API 服务器解码步骤，从修剪没有在验证 schema 中指定的字段。这会以递归方式影响字段，但如果在 schema 中指定嵌套属性或附加属性，则切换回正常的修剪行为。这可以是 true 或 undefined。false 被禁止。 |
|
|
x-kubernetes-validations 描述使用 CEL 表达式语言编写的验证规则列表。此字段是一个 alpha-level。使用此字段需要启用功能门 |
- 描述
- JSONSchemaPropsOrArray 代表一个值，可以是 JSONSchemaProps 或 JSONSchemaProps 数组。这里主要用于序列化目的。
- 类型
- ``
- 描述
- JSONSchemaPropsOrBool 代表 JSONSchemaProps 或布尔值。对于布尔值属性，默认为 true。
- 类型
- ``
- 描述
- JSONSchemaPropsOrStringArray 代表 JSONSchemaProps 或字符串数组。
- 类型
- ``
- 描述
- ValidationRule 描述了使用 CEL 表达式语言编写的验证规则。
- 类型
-
object - 必填
-
规则
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Message 代表验证失败时显示的消息。如果 Rule 包含换行符，则需要消息。消息不得包含换行符。如果未设置，则消息为 "failed rule: {Rule}"。例如"必须是一个带有主机匹配 spec.host" 的 URL。 |
|
|
| MessageExpression 声明了一个 CEL 表达式，用于评估此规则失败时返回的验证失败消息。由于 messageExpression 被用作失败消息，因此它必须评估为字符串。如果规则中存在 message 和 messageExpression，则在验证失败时将使用 messageExpression。如果 messageExpression 产生运行时错误，则会记录运行时错误，并且生成验证失败消息，就像 messageExpression 字段未设置一样。如果 messageExpression 评估为一个空字符串、仅包含空格的字符串或包含换行符的字符串，则验证失败消息也会生成，就像 messageExpression 字段未设置一样，而 messageExpression 的事实会生成空字符串/字符串，且带有换行符的字符串才会被记录。messageExpression 可以访问所有与规则相同的变量；唯一的区别是返回类型。示例："x 必须小于 max ("string (self.max) ") " |
|
|
|
规则代表 CEL 将评估的表达式。ref: https://github.com/google/cel-spec 规则的范围仅限于架构中 x-kubernetes-validations 扩展的位置。CEL 表达式中的
如果 Rule 限定有属性的对象，则可通过 self.field 和 field presence
CEL 表达式中无法通过 x-kubernetes-preserve-unknown-fields 在自定义资源中保留未知数据。这包括 - Unknown 字段值，由带有 x-kubernetes-preserve-unknown-fields. - 对象属性 schema 为 "unknown type" 的对象模式保留。"未知类型"被递归定义为： - 无类型和 x-kubernetes-preserve-unknown-fields 的模式设置为 true - items 模式是"未知类型"的数组 - additionalProperties 模式是"unknown type"的对象
仅可以访问
在带有 x-kubernetes-list-type 为 'set' 或 'map' ignores 元素顺序的数组中相等，例如 [1, 2] == [2, 1]。带有 x-kubernetes-list-type 的数组上的串联使用列表类型的语义： - 'set': |
- 描述
quantity 是数字的固定点表示。除了 String （）和 AsInt64 （）访问器外，它还在 JSON 和 YAML 中提供方便的 marshaling/unmarshaling。
序列化格式为：
<quantity> ::= <signedNumber><suffix>
(Note that <suffix> may be empty, from the "" case in <decimalSI>.)
(Note that <suffix> may be empty, from the "" case in <decimalSI>.)Copy to Clipboard Copied! Toggle word wrap Toggle overflow <digit> ::= 0 | 1 | … | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei
(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)
(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)Copy to Clipboard Copied! Toggle word wrap Toggle overflow <decimalSI> ::= m | "" | k | M | G | T | P | E
(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)
(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)Copy to Clipboard Copied! Toggle word wrap Toggle overflow <decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber>
无论使用了三种经验，任何数量都不能代表大于 2^63-1 的数字，或者可能有超过 3 个十进制位置。更大或更精确的数字将被上限或舍入。（例如： 0.1m 将向上舍入为 1m.）如果我们需要更大或较小的数量，则这可能会在以后进行扩展。
当从字符串解析 Quantity 时，它会记住它拥有的后缀类型，并在其序列化时再次使用相同的类型。
在序列化之前，数量将置于"规范形式"。这意味着，Exponent/suffix 将调整或缩减（在 Mantissa 中相应的增加或减少），以便：
- Norecision is lost - 不会发出分数数 - exponent （或后缀）会尽可能大。
除非数字为负数，否则将省略该符号。
示例：
- 1.5 将序列化为 "1500m" - 1.5Gi 将序列化为 "1536Mi"
请注意，数量将在内部表示，由浮点数表示。这是整个练习。
非规范值仍会解析，只要它们被编写，但会以规范形式重新提供。（因此始终使用规范形式，或者不 diff。）
这个格式的目的是在不编写一些特殊处理代码的情况下，很难使用这些数字，而希望这样会使实施器也使用固定点实现。
- 类型
-
字符串
- 描述
- condition 包含此 API 资源当前状态的一个方面的详情。
- 类型
-
object - 必填
-
type -
status -
lastTransitionTime -
reason -
message
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。这应该是底层条件变化的时间。如果为未知，则使用 API 字段更改的时间是可以接受的。 | |
|
|
| Message 是人类可读的消息，指示有关转换的详细信息。这可以是空字符串。 |
|
|
| observedGeneration 代表 .metadata.generation，这是条件设置所基于的条件。例如，如果 .metadata.generation 目前为 12，但 .status.conditions[x].observedGeneration 是 9，则代表条件与实例的当前状态已不匹配。 |
|
|
| reason 包含程序标识符，指示条件最后一次转换的原因。特定条件类型的制作者可能会定义预期的值和此字段的含义，以及这些值是否被视为有保证的 API。该值应该是 CamelCase 字符串。此字段不能为空。 |
|
|
| 条件的状态，True, False, Unknown 之一。 |
|
|
| CamelCase 或 foo.example.com/CamelCase 中的条件类型。 |
- 描述
- 删除 API 对象时，可以提供 DeleteOptions。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
| 在执行删除前必须完成。如果不可能，则返回 409 Conflict 状态。 | |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
- 描述
FieldsV1 以 JSON 格式在诸如 Trie 的数据结构中存储一组字段。
每个键可以是代表字段本身的 '.'，始终映射到一个空集，也可以是代表子字段或项的字符串。字符串将遵循以下四种格式之一：'f:<name>'，其中 <name> 是 struct 中的字段名称，或映射 'v:<value>' 中的键，其中 <value> 是列表项 'i:<index>' 的确切 json 格式值，其中 <index> 是列表 'k:<keys>' 中的项位置，其中 <value> 是列表项 'i:<index>' 的确切 json 格式值。 其中 <keys> 是列表项的键字段到其唯一值的映射，如果键映射到空字段值，则键代表的字段是集合的一部分。
确切的格式在 iwl.k8s.io/structured-merge-diff 中定义
- 类型
-
object
- 描述
- 标签选择器，即一组资源的标签查询。matchLabels 和 matchExpressions 的逻辑关系是 AND。空标签选择器匹配所有对象。null 标签选择器不匹配任何对象。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 | |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
- 描述
- 标签选择器要求是一个选择器，其中包含值、键和与键和值关联的操作器。
- 类型
-
object - 必填
-
key -
operator
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
- 描述
- ListMeta 描述了复合资源必须具有的元数据，包括列表和各种状态对象。资源可能只有一个 {ObjectMeta, ListMeta} 之一。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 如果用户对返回的项目数量设置了限制，则可以设置继续，并且表示服务器有更多可用的数据。该值不透明，可用于向提供此列表的端点发出另一个请求，以检索下一个可用对象集合。如果服务器配置已更改或几分钟以上，则无法继续一致的列表。使用此 continue 值时返回的 resourceVersion 字段将与第一个响应中的值相同，除非您从错误消息收到此令牌。 |
|
|
| remainingItemCount 是列表中未包含在此列表响应中的后续项目数量。如果列表请求包含标签或字段选择器，则其余项目的数量为未知，且该字段将保留为未设置，并在序列化过程中省略。如果列表完成（因为不是块或因为这是最后一个块），则没有更多剩余项，且此字段将被取消设置，并在序列化过程中省略并省略。早于 v1.15 的服务器不会设置此字段。remainingItemCount 的预期 使用估计 集合的大小。客户端不应依赖 remainingItemCount 设置或准确。 |
|
|
| 标识此对象的内部版本的字符串，供客户端用来确定对象何时更改。值必须被客户端视为不透明，并将未修改传递回服务器。由系统填充。只读。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| deprecated: selfLink 是一个旧的只读字段，它不再由系统填充。 |
- 描述
- ManagedFieldsEntry 是一个 workflow-id、FieldSet 和 fieldset 应用到的资源的组版本。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| apiVersion 定义此字段应用到的此资源版本。类似于顶级 APIVersion 字段的格式为 "group/version"。需要跟踪字段集的版本，因为它无法自动转换。 |
|
|
| FieldsType 是不同字段格式和版本的差异。当前只有一个可能的值："FieldsV1" |
|
| FieldsV1 包含第一个 JSON 版本格式，如 "FieldsV1" 类型中所述。 | |
|
|
| Manager 是管理这些字段的工作流的标识符。 |
|
|
| 操作是导致创建此 ManagedFieldsEntry 的操作类型。此字段的唯一有效值为 'Apply' 和 'Update'。 |
|
|
| subresource 是用来更新该对象的子资源的名称，如果对象通过主资源更新，则为空字符串。此字段的值用于区分管理器，即使它们共享相同的名称。例如，状态更新将与使用相同的管理器名称的常规更新不同。请注意，APIVersion 字段与 Subresource 字段无关，它始终与主资源的版本对应。 |
|
| Time 是添加 ManagedFields 条目的时间戳。添加了字段时也会更新时间戳，管理器会更改任何拥有的字段值或删除字段。当从条目中删除字段时，时间戳不会更新，因为另一个管理器接管了它。 |
- 描述
- MicroTime 是微秒级精度的时间版本。
- 类型
-
字符串
- 描述
- ObjectMeta 是所有持久的资源必须具有的元数据，其中包括用户必须创建的所有对象。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| annotations 是一个无结构的键值映射，它存储了一个资源，可通过外部工具设置它来存储和检索任意元数据。它们不可查询，在修改对象时应保留。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations |
|
| creationTimestamp 是一个时间戳，代表创建此对象时的服务器时间。无法保证在单独的操作之间按顺序设置。客户端可能不会设置这个值。它以 RFC3339 格式表示，并以 UTC 为单位。 由系统填充。只读。null 表示列表。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| 在将这个对象从系统中删除前，允许此对象安全终止的秒数。仅在同时设置 deletionTimestamp 时设置。只能缩短。只读。 |
|
| deletionTimestamp 是 RFC 3339 日期和时间，将删除此资源。当用户请求安全删除时，服务器会设置此字段，且客户端不会直接设置。当 finalizers 列表为空后，资源应该会被删除（不再在资源列表中可见且名称无法从名称访问）。只要终结器列表包含项目，删除就被阻止。设置 deletionTimestamp 后，这个值可能不会取消设置，或者在以后在以后设置，但它可能会被缩短，或者资源可在此时间删除。例如，用户可以请求在 30 秒内删除 pod。Kubelet 将通过向 pod 中的容器发送安全终止信号来响应。30 秒后，Kubelet 将向容器发送一个硬终止信号(SIGKILL)，并在清理后从 API 中删除 pod。在存在网络分区时，此对象可能仍然存在于此时间戳后，直到管理员或自动进程可以确定资源完全被终止为止。如果没有设置，则不请求删除对象。 当请求安全删除时，系统填充。只读。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| 必须在从 registry 中删除对象前为空。每个条目都是负责的组件的标识符，该组件将从列表中删除该条目。如果对象的 deletionTimestamp 不是非nil，则此列表中的条目只能被删除。结束程序可能会以任何顺序处理和删除。顺序不会被强制，因为它引入了卡住终结器的风险。finalizers 是一个共享字段，任何具有权限的操作都可能会重新排序它。如果按顺序处理了终结器列表，则这可能会导致在列表后面负责第一个终结器（字段值、外部系统或其他）生成的信号（字段值、外部系统或其他）导致问题。如果没有强制排序终结器，可以自由地订购自己，且不会受到列表中排序更改的影响。 |
|
|
| generateName 是一个可选前缀，供服务器用来生成唯一的名称仅 IF，没有提供 Name 字段。如果使用此字段，返回到客户端的名称将与传递的名称不同。这个值也会与唯一的后缀合并。提供的值具有与 Name 字段相同的验证规则，可通过在服务器中使值唯一的后缀长度截断。 如果指定了此字段且生成的名称存在，服务器将返回 409。 仅在未指定 Name 时才应用。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency |
|
|
| 代表所需状态的特定生成状态的序列号。由系统填充。只读。 |
|
|
| 字符串键和值映射，可用于组织和分类（范围并选择）对象。可以与复制控制器和服务的选择器匹配。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/labels |
|
| managedFields 将 workflow-id 和 version 映射到由该工作流管理的字段集合。这主要用于内部内务，用户通常不需要设置或了解此字段。工作流可以是用户名、控制器的名称，也可以是特定应用路径的名称，如 "ci-cd"。字段集始终位于修改对象时使用的工作流的版本。 | |
|
|
| 名称在命名空间内必须是唯一的。在创建资源时，需要一些资源，但有些资源可能允许客户端自动请求生成适当名称。名称主要用于创建 idempotence 和 配置定义。无法更新。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
|
|
| namespace 定义每个名称必须唯一的空间。空命名空间等同于 "default" 命名空间，但 "default" 是规范表示。并非所有对象都需要限定到命名空间 - 这些对象的此字段的值将为空。 必须是 DNS_LABEL。无法更新。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces |
|
| 依赖于此对象的对象列表。如果删除了列表中的所有对象，则此对象将被垃圾回收。如果此对象由控制器管理，则此列表中的条目将指向此控制器，controller 被设置为 true。不能有多个管理控制器。 | |
|
|
| 代表此对象的内部版本的 opaque 值，供客户端用来确定对象何时更改。可用来对资源或一组资源进行最佳并发、更改检测和监视操作。客户端必须将这些值视为不透明，并将未修改的回服务器传递。它们可能仅对特定资源或一组资源有效。 由系统填充。只读。值必须被客户端 和 被视为不透明。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| deprecated: selfLink 是一个旧的只读字段，它不再由系统填充。 |
|
|
| UID 是此对象的时间和空间值的唯一值。它通常由服务器成功创建资源时生成，不允许更改 PUT 操作。 由系统填充。只读。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids |
- 描述
- OwnerReference 包含足够信息，供您识别自己的对象。您自己的对象必须与依赖或集群范围位于同一个命名空间中，因此没有 namespace 字段。
- 类型
-
object - 必填
-
apiVersion -
kind -
name -
uid
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 引用的 API 版本。 |
|
|
| 如果为 true，如果所有者具有 "foregroundDeletion" finalizer，则无法从 key-value 存储中删除所有者，直到此引用被删除为止。有关垃圾收集器如何与此字段交互并强制实施前台删除，请参阅 https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion。默认为false。要设置此字段，用户需要"删除"所有者权限，否则将返回 422 (Unprocessable Entity)。 |
|
|
| 如果为 true，则此引用指向管理控制器。 |
|
|
| 引用的类型。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
|
|
| 引用的 UID。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids |
- 描述
- 提供了补丁来为 Kubernetes PATCH 请求正文提供具体的名称和类型。
- 类型
-
object
- 描述
- 在执行操作（更新、删除等）之前，必须满足 preconditions。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 指定目标 ResourceVersion |
|
|
| 指定目标 UID。 |
- 描述
- status 是不返回其他对象的调用的返回值。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| 此状态的建议 HTTP 返回码 0 （如果未设置）。 |
|
| 扩展与原因相关的数据。每个原因都可以定义自己的扩展详情。此字段是可选的，且返回的数据无法保证符合任何模式，除非 reason 类型定义。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 此操作状态的人类可读描述。 |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | |
|
|
| 此操作处于"Failure"状态的机器可读描述。如果这个值为空，则没有可用的信息。Reason 阐明 HTTP 状态代码，但不会覆盖它。 |
|
|
| 操作的状态。"Success"或"Failure"之一。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
- 描述
- StatusCause 提供有关 api.Status 失败的更多信息，包括在遇到多个错误时。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 导致此错误的资源字段，如 JSON 序列化所命名。可能包含嵌套属性的 dot 和 postfix 表示法。数组是零索引的。由于字段存在多个错误，因此字段可能会出现多次原因。可选。 示例："name" - 当前资源 "items[0].name" 上的字段 "name" - "items" 的第一个数组条目上的字段 "name" |
|
|
| 错误原因的人类可读描述。此字段可能按原样显示给读者。 |
|
|
| 错误原因的机器可读描述。如果这个值为空，则没有可用的信息。 |
- 描述
- StatusDetails 是一组由服务器设置 MAY 的额外属性，以提供有关响应的附加信息。Status 对象的 Reason 字段定义要设置哪些属性。客户端必须忽略与每个属性定义的类型不匹配的字段，并且应假定任何属性可能为空、无效或定义下。
- 类型
-
对象
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| Causes 数组包含与 StatusReason 失败相关的更多详情。并非所有 StatusReasons 都可以提供详细的原因。 | |
|
|
| 与 StatusReason 关联的资源的 group 属性。 |
|
|
| 与 StatusReason 关联的资源的 kind 属性。在某些操作中，一些操作可能与请求的资源 Kind 有所不同。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 与 StatusReason 关联的资源的 name 属性（当有一个可以描述的名称时）。 |
|
|
| 如果指定，则应重试操作前的时间（以秒为单位）。有些错误可能表示客户端必须采取备用操作 - 对于那些错误，此字段可能指示在执行备用操作前等待多久。 |
|
|
| 资源的 UID。（当有一个可以描述的资源时）。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids |
- 描述
- time 是一个围绕 time.Time 的打包程序，它支持对 YAML 和 JSON 进行正确的 marshaling。为时间软件包提供的许多工厂方法提供了打包程序。
- 类型
-
字符串
- 描述
- event 代表一个被监视的资源的一个事件。
- 类型
-
object - 必填
-
type -
对象
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
| object is: * If Type is Added or Modified: 对象的新状态。* 如果 Type 为 Deleted ：删除前对象的状态。* 如果 Type 是 Error: *Status，则根据上下文而推荐使用其它类型。 | |
|
|
|
- 描述
RawExtension 用于保留外部版本中的扩展。
要使用此功能，请创建一个字段，它在您的内部结构的外部、版本化的 struct 和 Object 中带有 RawExtension 的类型。您还需要注册各种插件类型。
type MyAPIObject struct { runtime.TypeMeta `json:",inline"` MyPlugin runtime.Object `json:"myPlugin"` }type MyAPIObject struct { runtime.TypeMeta `json:",inline"` MyPlugin runtime.Object `json:"myPlugin"` }Copy to Clipboard Copied! Toggle word wrap Toggle overflow type PluginA struct { AOption string `json:"aOption"` }type PluginA struct { AOption string `json:"aOption"` }Copy to Clipboard Copied! Toggle word wrap Toggle overflow type MyAPIObject struct { runtime.TypeMeta `json:",inline"` MyPlugin runtime.RawExtension `json:"myPlugin"` }type MyAPIObject struct { runtime.TypeMeta `json:",inline"` MyPlugin runtime.RawExtension `json:"myPlugin"` }Copy to Clipboard Copied! Toggle word wrap Toggle overflow type PluginA struct { AOption string `json:"aOption"` }type PluginA struct { AOption string `json:"aOption"` }Copy to Clipboard Copied! Toggle word wrap Toggle overflow Copy to Clipboard Copied! Toggle word wrap Toggle overflow 那么会发生什么情况？解码使用 json 或 yaml，将序列化数据到外部 MyAPIObject 中。这会导致存储原始 JSON，但不会解包。下一步是将（使用 pkg/conversion）复制到内部结构中。运行时软件包的 DefaultScheme 已安装了转换功能，它将解包存储在 RawExtension 中的 JSON，将其转换为正确的对象类型，并将它存储在对象中。(TODO：在对象是未知类型的情况下，将创建并存储 runtime.Unknown 对象。)
- 类型
-
对象
- 描述
- IntOrString 是一个可存放 int32 或字符串的类型。在 JSON 或 YAML marshalling 和 unmarshalling 中使用时，它会生成或消耗 inner 类型。例如，这允许您具有可以接受名称或数字的 JSON 字段。
- 类型
-
字符串
- 描述
- APIServiceList 是 APIService 对象的列表。
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| items 是 APIService 列表 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据详情 ：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
- 描述
- StorageVersionMigrationList 是一个 StorageVersionMigrationList 列表
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| storageversionmigrations 列表。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
- 描述
- VolumeSnapshotClassList 是 VolumeSnapshotClass 的列表
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| volumesnapshotclasses 列表。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
- 描述
- VolumeSnapshotContentList 是一个 VolumeSnapshotContent 列表
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| volumesnapshotcontents 列表。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
- 描述
- VolumeSnapshotList 是 VolumeSnapshot 列表
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| volumesnapshots 列表。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
- 描述
- RangeAllocationList 是 RangeAllocation 的列表
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| 范围分配列表。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.197. io.openshift.route.v1.RouteList schema
- 描述
- RouteList 是 Route 列表
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| 路由列表。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
- 描述
- SecurityContextConstraintsList 是 SecurityContextConstraints 列表
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| securitycontextconstraints 列表。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
4.1.199. io.topolvm.v1.LogicalVolumeList schema
- 描述
- LogicalVolumeList 是一个 LogicalVolume 列表
- 类型
-
object - 必填
-
items
-
模式
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| logicalvolumes 列表。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
第 5 章 扩展 API
5.1. API 扩展 API
- 描述
- CustomResourceDefinition 代表应在 API 服务器上公开的资源。其名称必须采用 <.spec.name>.<.spec.group> 格式。
- 类型
-
对象
5.2. CustomResourceDefinition [apiextensions.k8s.io/v1]
- 描述
- CustomResourceDefinition 代表应在 API 服务器上公开的资源。其名称必须采用 <.spec.name>.<.spec.group> 格式。
- 类型
-
object - 必填
-
spec
-
5.2.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据更多信息 ：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| CustomResourceDefinitionSpec 描述了用户如何显示其资源 |
|
|
| CustomResourceDefinitionStatus 表示 CustomResourceDefinition 的状态 |
5.2.1.1. .spec
- 描述
- CustomResourceDefinitionSpec 描述了用户如何显示其资源
- 类型
-
object - 必填
-
group -
names -
scope -
版本
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| CustomResourceConversion 描述了如何转换不同版本的 CR。 |
|
|
|
Group 是定义的自定义资源的 API 组。自定义资源 |
|
|
| CustomResourceDefinitionNames 表示为这个 CustomResourceDefinition 提供的名称 |
|
|
|
preserveUnknownFields 表示在保留存储时不应保留 OpenAPI 模式中指定的对象字段。元数据中的元数据、元数据和已知字段总是被保留。此字段已弃用，在 |
|
|
|
Scope 表示定义的自定义资源是 cluster- 或 namespace-scoped。允许的值是 |
|
|
| version 是定义的自定义资源的所有 API 版本列表。版本名称用于计算在 API 发现中列出提供版本的顺序。如果版本字符串为 "kube-like"，它将按字典顺序排序为非类似"kube-like"版本字符串。"类似于kube-like"版本以 "v" 开头，然后跟一个数字（主要版本），然后是字符串 "alpha" 或 "beta" 以及另一个数字（次版本）。它们首先按 GA > beta > alpha 排序（其中 GA 是一个没有后缀的版本，如 beta 或 alpha），然后比较主版本，然后比较次版本。一个排序版本列表示例： v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10。 |
|
|
| CustomResourceDefinitionVersion 描述了 CRD 的版本。 |
5.2.1.2. .spec.conversion
- 描述
- CustomResourceConversion 描述了如何转换不同版本的 CR。
- 类型
-
object - 必填
-
策略
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
|
strategy 指定自定义资源在版本之间转换的方式。允许的值有： - |
|
|
| WebhookConversion 描述了如何调用转换 Webhook |
5.2.1.3. .spec.conversion.webhook
- 描述
- WebhookConversion 描述了如何调用转换 Webhook
- 类型
-
object - 必填
-
conversionReviewVersions
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| WebhookClientConfig 包含用于与 webhook 进行 TLS 连接的信息。 |
|
|
|
conversionReviewVersions 是 Webhook 期望的首选 |
5.2.1.4. .spec.conversion.webhook.clientConfig
- 描述
- WebhookClientConfig 包含用于与 webhook 进行 TLS 连接的信息。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| cabundle 是 PEM 编码的 CA 捆绑包，它将用于验证 webhook 的服务器证书。如果未指定，则使用 apiserver 上的系统信任 root。 |
|
|
| ServiceReference 包含对 Service.legacy.k8s.io 的引用 |
|
|
|
URL 以标准 URL 格式提供 webhook 的位置(
请注意，使用 方案必须是 "https"；URL 必须以 "https://" 开头。 路径是可选的，如果存在可以是 URL 中允许的字符串。您可以使用路径将任意字符串传递给 webhook，例如集群标识符。 不允许使用用户或基本身份验证，如 "user:password@"。不允许 slices ("""…")和查询参数("?…")。 |
5.2.1.5. .spec.conversion.webhook.clientConfig.service
- 描述
- ServiceReference 包含对 Service.legacy.k8s.io 的引用
- 类型
-
object - 必填
-
namespace -
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是服务的名称。必填 |
|
|
| namespace 是服务的命名空间。必填 |
|
|
| path 是要联系 Webhook 的可选 URL 路径。 |
|
|
|
port 是要联系 Webhook 的可选服务端口。 |
5.2.1.6. .spec.names
- 描述
- CustomResourceDefinitionNames 表示为这个 CustomResourceDefinition 提供的名称
- 类型
-
object - 必填
-
plural -
kind
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
|
类别是此自定义资源所属的分组资源列表（如 'all'）。这在 API 发现文档中发布，供客户端用于支持诸如 |
|
|
|
kind 是资源的序列化类型。它通常是 CamelCase 和 singular。自定义资源实例将使用这个值作为 API 调用中的 |
|
|
| listKind 是此资源列表的序列化类型。默认为 "'kind'List"。 |
|
|
|
plural 是要服务的资源的复数名称。自定义资源在 /apis//< |
|
|
|
shortNames 是资源的短名称，在 API 发现文档中公开，供客户端用来支持诸如 |
|
|
|
单数是资源的单数名称。它必须都是小写。默认为小写 |
5.2.1.7. .spec.versions
- 描述
- version 是定义的自定义资源的所有 API 版本列表。版本名称用于计算在 API 发现中列出提供版本的顺序。如果版本字符串为 "kube-like"，它将按字典顺序排序为非类似"kube-like"版本字符串。"类似于kube-like"版本以 "v" 开头，然后跟一个数字（主要版本），然后是字符串 "alpha" 或 "beta" 以及另一个数字（次版本）。它们首先按 GA > beta > alpha 排序（其中 GA 是一个没有后缀的版本，如 beta 或 alpha），然后比较主版本，然后比较次版本。一个排序版本列表示例： v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10。
- 类型
-
array
5.2.1.8. .spec.versions[]
- 描述
- CustomResourceDefinitionVersion 描述了 CRD 的版本。
- 类型
-
object - 必填
-
name -
served -
storage
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| additionalPrinterColumns 指定表输出中返回的额外列。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables。如果没有指定列，则使用一行显示自定义资源的年龄。 |
|
|
| CustomResourceColumnDefinition 为服务器端打印指定一个列。 |
|
|
| 弃用表示自定义资源 API 的这个版本已弃用。当设置为 true 时，对此版本的 API 请求会在服务器响应中接收警告标头。默认为false。 |
|
|
|
deprecationWarning 覆盖返回到 API 客户端的默认警告。只有在 |
|
|
|
name 是版本名称，如 "v1", "v2beta1" 等。如果提供为 true，则自定义资源在此版本 |
|
|
| CustomResourceValidation 是 CustomResources 的验证方法列表。 |
|
|
| 服务是一个标志，启用/禁用此版本通过 REST API 提供 |
|
|
| Storage 表示在将自定义资源持久化到存储时应使用此版本。必须只有一个带有 storage=true 版本。 |
|
|
| CustomResourceSubresources 为 CustomResources 定义 status 和 scale 子资源。 |
5.2.1.9. .spec.versions[].additionalPrinterColumns
- 描述
- additionalPrinterColumns 指定表输出中返回的额外列。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables。如果没有指定列，则使用一行显示自定义资源的年龄。
- 类型
-
array
5.2.1.10. .spec.versions[].additionalPrinterColumns[]
- 描述
- CustomResourceColumnDefinition 为服务器端打印指定一个列。
- 类型
-
object - 必填
-
name -
type -
jsonPath
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| description 是此列的人类可读描述。 |
|
|
| Format 是此列的可选 OpenAPI 类型定义。'name' 格式应用于主标识符列，以帮助客户端识别列是资源名称。详情请查看 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types。 |
|
|
| jsonpath 是一个一个简单的 JSON 路径（例如，使用数组表示法），它会针对每个自定义资源进行评估，以便为此列生成值。 |
|
|
| name 是该列的人类可读名称。 |
|
|
| 优先级是一个整数，定义此列的相对重要性，与其他列相比。较低数字被视为优先级更高。在有限空间场景中可能会省略的列应赋予优先级大于 0。 |
|
|
| type 是此列的 OpenAPI 类型定义。详情请查看 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types。 |
5.2.1.11. .spec.versions[].schema
- 描述
- CustomResourceValidation 是 CustomResources 的验证方法列表。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
| openAPIV3Schema 是 OpenAPI v3 模式，用于验证和修剪。 |
5.2.1.12. .spec.versions[].subresources
- 描述
- CustomResourceSubresources 为 CustomResources 定义 status 和 scale 子资源。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| CustomResourceSubresourceScale 定义如何为 CustomResource 提供 scale 子资源。 |
|
|
|
CustomResourceSubresourceStatus 定义如何为 CustomResources 提供 status 子资源。状态由 CustomResource 中的 |
5.2.1.13. .spec.versions[].subresources.scale
- 描述
- CustomResourceSubresourceScale 定义如何为 CustomResource 提供 scale 子资源。
- 类型
-
object - 必填
-
specReplicasPath -
statusReplicasPath
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
|
labelSelectorPath 在自定义资源中定义与 Scale |
|
|
|
specReplicasPath 定义自定义资源中的 JSON 路径，该路径对应于 Scale |
|
|
|
statusReplicasPath 定义自定义资源中的 JSON 路径，对应于 Scale |
5.2.1.14. .spec.versions[].subresources.status
- 描述
-
CustomResourceSubresourceStatus 定义如何为 CustomResources 提供 status 子资源。状态由 CustomResource 中的
.statusJSON 路径表示。设置后，Ceph 会公开自定义资源 * PUT 请求到 /status 子资源的 /status 子资源获取自定义资源对象，并忽略除 status 小节之外的任何状态片段更改的 /status 子资源忽略对 status 小节的更改。 - 类型
-
对象
5.2.1.15. .status
- 描述
- CustomResourceDefinitionStatus 表示 CustomResourceDefinition 的状态
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| CustomResourceDefinitionNames 表示为这个 CustomResourceDefinition 提供的名称 |
|
|
| conditions 表示 CustomResourceDefinition 的特定方面的状态 |
|
|
| CustomResourceDefinitionCondition 包含此 pod 的当前条件的详情。 |
|
|
|
storedVersions 列出之前保留的所有 CustomResource 版本。跟踪这些版本允许 etcd 中保存版本的迁移路径。该字段是可变的，因此迁移控制器可以完成到另一个版本的迁移（确保存储中没有保留旧对象），然后从此列表中删除其余版本。在此列表中存在时，可能无法从 |
5.2.1.16. .status.acceptedNames
- 描述
- CustomResourceDefinitionNames 表示为这个 CustomResourceDefinition 提供的名称
- 类型
-
object - 必填
-
plural -
kind
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
|
类别是此自定义资源所属的分组资源列表（如 'all'）。这在 API 发现文档中发布，供客户端用于支持诸如 |
|
|
|
kind 是资源的序列化类型。它通常是 CamelCase 和 singular。自定义资源实例将使用这个值作为 API 调用中的 |
|
|
| listKind 是此资源列表的序列化类型。默认为 "'kind'List"。 |
|
|
|
plural 是要服务的资源的复数名称。自定义资源在 /apis//< |
|
|
|
shortNames 是资源的短名称，在 API 发现文档中公开，供客户端用来支持诸如 |
|
|
|
单数是资源的单数名称。它必须都是小写。默认为小写 |
5.2.1.17. .status.conditions
- 描述
- conditions 表示 CustomResourceDefinition 的特定方面的状态
- 类型
-
array
5.2.1.18. .status.conditions[]
- 描述
- CustomResourceDefinitionCondition 包含此 pod 的当前条件的详情。
- 类型
-
object - 必填
-
type -
status
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
| lastTransitionTime 时间，条件从一个状态转换到另一个状态。 | |
|
|
| Message 是人类可读的消息，表示有关最后一次转换的详细信息。 |
|
|
| reason 是条件最后一次转换的唯一一词 CamelCase 原因。 |
|
|
| status 是条件的状态。可以是 True, False, Unknown。 |
|
|
| type 是条件的类型。类型包括 Established、NamesAccepted 和 Terminating。 |
5.2.2. API 端点
可用的 API 端点如下：
/apis/apiextensions.k8s.io/v1/customresourcedefinitions-
DELETE: 删除 CustomResourceDefinition 集合 -
GET: 列出或监视类型为 CustomResourceDefinition 的对象 -
POST：创建 CustomResourceDefinition
-
/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions-
GET: 观察单个对 CustomResourceDefinition 列表的更改。已弃用：改为使用 'watch' 参数及列表操作。
-
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}-
DELETE：删除 CustomResourceDefinition -
GET：读取指定的 CustomResourceDefinition -
PATCH: 部分更新指定的 CustomResourceDefinition -
PUT：替换指定的 CustomResourceDefinition
-
/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}-
GET: 观察对类型为 CustomResourceDefinition 的对象的更改。已弃用：使用带有 list 操作的 'watch' 参数，而是过滤为带有 'fieldSelector' 参数的单个项目。
-
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status-
GET：指定 CustomResourceDefinition 的读取状态 -
PATCH: 部分更新指定 CustomResourceDefinition 的状态 -
PUT：替换指定 CustomResourceDefinition 的状态
-
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 CustomResourceDefinition 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值，以检索下一组结果。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。 当设置 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签 事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion'，这会被解释为 "consistent read"，当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。 如果 'resourceVersion=""' 或 'resourceVersion="0"' （出于向后兼容原因）和 false，则默认为 true。 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 CustomResourceDefinition 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 CustomResourceDefinition
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 CustomResourceDefinition 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| CustomResourceDefinition 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 CustomResourceDefinition
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 阅读指定的 CustomResourceDefinition
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 CustomResourceDefinition
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 CustomResourceDefinition
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| CustomResourceDefinition 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察对 kind CustomResourceDefinition. deprecated 的对象更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| CustomResourceDefinition 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定的 CustomResourceDefinition 的读取状态
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 指定 CustomResourceDefinition 的部分更新状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 CustomResourceDefinition 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
第 6 章 registration APIs
6.1. API 注册 API
6.1.1. APIService [apiregistration.k8s.io/v1]
- 描述
- APIService 代表特定 GroupVersion 的服务器。名称必须是 "version.group"。
- 类型
-
对象
6.2. APIService [apiregistration.k8s.io/v1]
- 描述
- APIService 代表特定 GroupVersion 的服务器。名称必须是 "version.group"。
- 类型
-
对象
6.2.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| APIServiceSpec 包含用于查找和与服务器通信的信息。仅支持 https，但您可以禁用证书验证。 |
|
|
| APIServiceStatus 包含有关 API 服务器的派生信息 |
6.2.1.1. .spec
- 描述
- APIServiceSpec 包含用于查找和与服务器通信的信息。仅支持 https，但您可以禁用证书验证。
- 类型
-
object - 必填
-
groupPriorityMinimum -
versionPriority
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| cabundle 是一个 PEM 编码的 CA 捆绑包，用于验证 API 服务器的服务证书。如果未指定，则使用 apiserver 中的系统信任 root。 |
|
|
| group 是此服务器主机的 API 组名称 |
|
|
| GroupPriorityMininum 是这个组应至少具有的优先级。优先级更高的意味着客户端优先于较低优先级的组。请注意，此组的其它版本可能会指定更高的 GroupPriorityMininum 值，以便整个组获得更高的优先级。主要排序基于 GroupPriorityMinimum，按最高数字排序为最低值(10 之前的 20 个)。辅助排序基于对象名称的字母顺序比较。(v1.foo 之前的 v1.bar)我们推荐使用如下内容：*.k8s.io （扩展除外） 18000 和 PaaSes (OpenShift、Deis)在 2000s 中。 |
|
|
| insecureSkipTLSVerify 在与此服务器通信时禁用 TLS 证书验证。强烈建议您这样做。您应该使用 CABundle。 |
|
|
| ServiceReference 包含对 Service.legacy.k8s.io 的引用 |
|
|
| version 是这个服务器主机的 API 版本。例如："v1" |
|
|
| VersionPriority 控制其组内此 API 版本的顺序。必须大于零。主要排序基于 VersionPriority，最高排序为最低(10 之前的 20 个)。由于它是组内部，因此数字可能比较小，可能在 10s 中。如果优先级相等，则版本字符串将用于计算组内的顺序。如果版本字符串是"kube-like"，它将按字典顺序排序在非"kube 类似"版本字符串上。"kube-like"版本以"v"开头，后跟一个数字（主版本），然后可以选择字符串"alpha"或"beta"，另一个数字（次版本）。它们首先按 GA > beta > alpha 排序（其中 GA 是没有后缀（如 beta 或 alpha）的版本，然后比较主版本，然后是次版本。版本排序列表示例： v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10。 |
6.2.1.2. .spec.service
- 描述
- ServiceReference 包含对 Service.legacy.k8s.io 的引用
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是服务的名称 |
|
|
| namespace 是服务的命名空间 |
|
|
|
如果指定，托管 Webhook 的服务上的端口。默认为 443，以便向后兼容。 |
6.2.1.3. .status
- 描述
- APIServiceStatus 包含有关 API 服务器的派生信息
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| apiService 的当前服务状态。 |
|
|
| APIServiceCondition 描述了 APIService 在特定点的状态 |
6.2.1.4. .status.conditions
- 描述
- apiService 的当前服务状态。
- 类型
-
array
6.2.1.5. .status.conditions[]
- 描述
- APIServiceCondition 描述了 APIService 在特定点的状态
- 类型
-
object - 必填
-
type -
status
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 条件从一个状态转换到另一个状态最后一次的时间。 | |
|
|
| 人类可读的消息，指示最后一次转换的详细信息。 |
|
|
| 条件最后一次转换的唯一、一词、CamelCase 原因。 |
|
|
| status 是条件的状态。可以是 True, False, Unknown。 |
|
|
| type 是条件的类型。 |
6.2.2. API 端点
可用的 API 端点如下：
/apis/apiregistration.k8s.io/v1/apiservices-
DELETE：删除 APIService 的集合 -
GET: 列出或监视类型为 APIService 的对象 -
POST：创建 APIService
-
/apis/apiregistration.k8s.io/v1/watch/apiservices-
GET: 观察单个对 APIService 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/apiregistration.k8s.io/v1/apiservices/{name}-
DELETE：删除 APIService -
GET：读取指定的 APIService -
PATCH：部分更新指定的 APIService -
PUT：替换指定的 APIService
-
/apis/apiregistration.k8s.io/v1/watch/apiservices/{name}-
GET: 观察对 APIService 类型的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
/apis/apiregistration.k8s.io/v1/apiservices/{name}/status-
GET：指定 APIService 的读取状态 -
PATCH：部分更新指定 APIService 的状态 -
PUT：替换指定 APIService 的状态
-
6.2.2.1. /apis/apiregistration.k8s.io/v1/apiservices
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 APIService 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 APIService 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 APIService
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 APIService 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| APIService 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 APIService
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 读取指定的 APIService
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 APIService
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 APIService
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| APIService 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察对 kind APIService 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| APIService 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 APIService 的读取状态
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 指定 APIService 的部分更新状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 APIService 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 7 章 apps API
7.1. apps API
7.1.1. ControllerRevision [apps/v1]
- 描述
- ControllerRevision 实现状态数据的不可变快照。客户端负责对包含其内部状态的对象进行序列化和停用。成功创建 ControllerRevision 后，无法更新它。API 服务器将失败，验证尝试修改 Data 字段的所有请求。但是，控制器修订可能会被删除。请注意，由于 DaemonSet 和 StatefulSet 控制器同时使用它进行更新和回滚，所以这个对象是 beta。但是，未来版本中可能会存在名称和表示的变化，并且客户端不应依赖于其稳定性。它主要用于控制器的内部使用。
- 类型
-
object
7.1.2. DaemonSet [apps/v1]
- 描述
- DaemonSet 代表守护进程集的配置。
- 类型
-
object
7.1.3. Deployment [apps/v1]
- 描述
- Deployment 为 Pod 和 ReplicaSet 启用声明更新。
- 类型
-
object
7.1.4. ReplicaSet [apps/v1]
- 描述
- ReplicaSet 确保指定数量的 pod 副本在任意给定时间运行。
- 类型
-
object
7.1.5. StatefulSet [apps/v1]
- 描述
StatefulSet 代表一组具有一致身份的 pod。身份被定义为：- 网络 ：单个稳定的 DNS 和主机名。- Storage: 作为请求的多个 VolumeClaims。
StatefulSet 确保给定网络身份始终映射到同一存储身份。
- 类型
-
对象
7.2. ControllerRevision [apps/v1]
- 描述
- ControllerRevision 实现状态数据的不可变快照。客户端负责对包含其内部状态的对象进行序列化和停用。成功创建 ControllerRevision 后，无法更新它。API 服务器将失败，验证尝试修改 Data 字段的所有请求。但是，控制器修订可能会被删除。请注意，由于 DaemonSet 和 StatefulSet 控制器同时使用它进行更新和回滚，所以这个对象是 beta。但是，未来版本中可能会存在名称和表示的变化，并且客户端不应依赖于其稳定性。它主要用于控制器的内部使用。
- 类型
-
object - 必填
-
revision
-
7.2.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| 数据是状态的序列化表示。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| revision 表示数据代表的状态的修订。 |
7.2.2. API 端点
可用的 API 端点如下：
/apis/apps/v1/controllerrevisions-
GET: 列出或监视类型为 ControllerRevision 的对象
-
/apis/apps/v1/watch/controllerrevisions-
GET: 观察单个对 ControllerRevision 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/apps/v1/namespaces/{namespace}/controllerrevisions-
DELETE：删除 ControllerRevision 的集合 -
GET: 列出或监视类型为 ControllerRevision 的对象 -
POST：创建 ControllerRevision
-
/apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions-
GET: 观察单个对 ControllerRevision 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}-
DELETE：删除 ControllerRevision -
GET：读取指定的 ControllerRevision -
PATCH：部分更新指定的 ControllerRevision -
PUT：替换指定的 ControllerRevision
-
/apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}-
GET: 观察对类型 ControllerRevision. deprecated 的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
7.2.2.1. /apis/apps/v1/controllerrevisions
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 ControllerRevision 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
7.2.2.2. /apis/apps/v1/watch/controllerrevisions
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 ControllerRevision 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 ControllerRevision 的集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 ControllerRevision 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 ControllerRevision
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 ControllerRevision 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ControllerRevision 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 ControllerRevision
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 读取指定的 ControllerRevision
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 ControllerRevision
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 ControllerRevision
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ControllerRevision 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察对 kind ControllerRevision. deprecated 的对象更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
7.3. DaemonSet [apps/v1]
- 描述
- DaemonSet 代表守护进程集的配置。
- 类型
-
对象
7.3.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| DaemonSetSpec 是守护进程集的规格。 |
|
|
| DaemonSetStatus 代表守护进程集的当前状态。 |
7.3.1.1. .spec
- 描述
- DaemonSetSpec 是守护进程集的规格。
- 类型
-
object - 必填
-
selector -
模板
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 新创建的 DaemonSet pod 应该就绪的最小秒数，且没有其容器崩溃，以便它被视为可用。默认为 0 (pod 在就绪后将被视为可用)。 |
|
|
| 要保留的旧历史记录数量，以允许回滚。这是区分显式零而非指定的指针。默认值为 10。 |
|
| 对由守护进程集管理的 pod 的标签查询。必须匹配才能控制。它必须与 pod 模板的标签匹配。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | |
|
| 描述要创建的 pod 的对象。DaemonSet 将在每个节点上创建与模板的节点选择器匹配的一个副本（如果未指定节点选择器，则在每个节点上）。唯一允许的 template.spec.restartPolicy 值是 "Always"。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template | |
|
|
| DaemonSetUpdateStrategy 是一个结构，用于控制 DaemonSet 的更新策略。 |
7.3.1.2. .spec.updateStrategy
- 描述
- DaemonSetUpdateStrategy 是一个结构，用于控制 DaemonSet 的更新策略。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 控制守护进程设置滚动更新所需的行为的 spec。 |
|
|
| 守护进程集更新的类型。可以是 "RollingUpdate" 或 "OnDelete"。默认为 RollingUpdate。
可能枚举值： - |
7.3.1.3. .spec.updateStrategy.rollingUpdate
- 描述
- 控制守护进程设置滚动更新所需的行为的 spec。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 具有现有可用 DaemonSet pod 的最大节点数，这些 pod 在更新过程中可能会具有更新的 DaemonSet pod。值可以是绝对数量（例如： 5）或所需 pod 的百分比（例如： 10%）。如果 MaxUnavailable 为 0，则不能是 0。绝对数从百分比计算，方法是舍入到最小 1。默认值为 0。示例：当它被设置为 30% 时，在运行守护进程 pod 的节点总数最多 30%（如 status.desiredNumberScheduled）可以在旧 pod 标记为已删除前创建它的新 pod。更新首先在 30% 的节点上启动新 pod。当一个更新的 pod 可用(Ready 代表至少 minReadySeconds)后，该节点上的旧 DaemonSet pod 将被标记为已删除。如果旧的 pod 因任何原因(Ready 转换为 false )不可用，或者被驱除或排空，则更新的 pod 会在那个节点上立即创建，而无需考虑激增限制。允许激增意味着，如果就绪度检查失败，则任何给定节点上 daemonset 所消耗的资源可能会加倍，因此资源密集型 daemonset 应该考虑在中断期间可能会导致驱除。 | |
|
| 更新过程中可以无法使用的 DaemonSet pod 的最大数量。值可以是绝对数量（例如： 5）或处于更新开始时的 DaemonSet pod 总数的百分比（例如 10%）。绝对数通过向上舍入来从百分比计算。如果 MaxSurge 为 0 默认值，则不能是 0。示例：当它被设置为 30% 时，在运行守护进程 pod 的节点总数最多 30%（如 status.desiredNumberScheduled）可以在任何给定时间停止其 pod。更新首先停止这些 DaemonSet pod 的 30%，然后启动新的 DaemonSet pod。新 pod 可用后，它会继续其他 DaemonSet pod，从而确保更新过程中始终都提供至少 70% 的原始 DaemonSet pod 数量。 |
7.3.1.4. .status
- 描述
- DaemonSetStatus 代表守护进程集的当前状态。
- 类型
-
object - 必填
-
currentNumberScheduled -
numberMisscheduled -
desiredNumberScheduled -
numberReady
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| DaemonSet 的哈希冲突计数。当需要为最新的 ControllerRevision 创建名称时，DaemonSet 控制器使用此字段作为冲突避免机制。 |
|
|
| 代表 DaemonSet 的当前状态的最新可用影响。 |
|
|
| DaemonSetCondition 描述了 DaemonSet 在特定点的状态。 |
|
|
| 运行至少 1 个守护进程 pod 的节点数量，应该运行守护进程 pod。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
|
|
| 应该运行守护进程 pod 的节点总数（包括正确运行守护进程 pod 的节点）。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
|
|
| 应运行守护进程 pod 的节点数量，并有一个或多个守护进程 pod 正在运行并可用（至少为 spec.minReadySeconds） |
|
|
| 运行守护进程 pod 的节点数量，但不应运行守护进程 pod。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
|
|
| numberReady 是应该运行守护进程 pod 的节点数量，且一个或多个守护进程 pod 使用 Ready Condition 运行。 |
|
|
| 应运行守护进程 pod 的节点数量，且没有守护进程 pod 正在运行并可用（至少为 spec.minReadySeconds） |
|
|
| 守护进程设置控制器观察到的最最近生成。 |
|
|
| 运行更新的守护进程 pod 的节点总数 |
7.3.1.5. .status.conditions
- 描述
- 代表 DaemonSet 的当前状态的最新可用影响。
- 类型
-
array
7.3.1.6. .status.conditions[]
- 描述
- DaemonSetCondition 描述了 DaemonSet 在特定点的状态。
- 类型
-
object - 必填
-
type -
status
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 条件从一个状态转换到另一个状态最后一次的时间。 | |
|
|
| 人类可读的消息，指示有关转换的详细信息。 |
|
|
| 条件最后一次转换的原因。 |
|
|
| 条件的状态，True, False, Unknown 之一。 |
|
|
| DaemonSet 条件的类型。 |
7.3.2. API 端点
可用的 API 端点如下：
/apis/apps/v1/daemonsets-
GET: 列出或监视类型为 DaemonSet 的对象
-
/apis/apps/v1/watch/daemonsets-
GET: 观察单个对 DaemonSet 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/apps/v1/namespaces/{namespace}/daemonsets-
DELETE：删除 DaemonSet 的集合 -
GET: 列出或监视类型为 DaemonSet 的对象 -
POST：创建 DaemonSet
-
/apis/apps/v1/watch/namespaces/{namespace}/daemonsets-
GET: 观察单个对 DaemonSet 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/apps/v1/namespaces/{namespace}/daemonsets/{name}-
DELETE：删除 DaemonSet -
GET: 读取指定的 DaemonSet -
PATCH：部分更新指定的 DaemonSet -
PUT：替换指定的 DaemonSet
-
/apis/apps/v1/watch/namespaces/{namespace}/daemonsets/{name}-
GET: 观察对类型为 DaemonSet 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
/apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status-
GET: 指定 DaemonSet 的读取状态 -
PATCH：部分更新指定 DaemonSet 的状态 -
PUT：替换指定 DaemonSet 的状态
-
7.3.2.1. /apis/apps/v1/daemonsets
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 DaemonSet 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
7.3.2.2. /apis/apps/v1/watch/daemonsets
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 DaemonSet 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
7.3.2.3. /apis/apps/v1/namespaces/{namespace}/daemonsets
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 DaemonSet 的集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 DaemonSet 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
POST - 描述
- 创建 DaemonSet
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 DaemonSet 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| DaemonSet 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 DaemonSet
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 读取指定的 DaemonSet
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 DaemonSet
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
- HTTP 方法
-
PUT - 描述
- 替换指定的 DaemonSet
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| DaemonSet 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察对类型为 DaemonSet 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| DaemonSet 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 DaemonSet 的读取状态
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PATCH - 描述
- 指定 DaemonSet 的部分更新状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
- HTTP 方法
-
PUT - 描述
- 替换指定 DaemonSet 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
7.4. Deployment [apps/v1]
- 描述
- Deployment 为 Pod 和 ReplicaSet 启用声明更新。
- 类型
-
对象
7.4.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| DeploymentSpec 是部署所需的行为的规格。 |
|
|
| DeploymentStatus 是部署的最新观察状态。 |
7.4.1.1. .spec
- 描述
- DeploymentSpec 是部署所需的行为的规格。
- 类型
-
object - 必填
-
selector -
模板
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 新创建的 pod 应该就绪的最少秒数，且没有其容器崩溃，以便它被视为可用。默认为 0 (pod 在就绪后将被视为可用) |
|
|
| 表示部署已暂停。 |
|
|
| 部署在被视为失败前进行进度的最长时间（以秒为单位）。部署控制器将继续处理失败的部署，且具有 ProgressDeadlineExceeded 原因的条件将出现在部署状态中。请注意，部署暂停期间不会估算进度。默认值为 600s。 |
|
|
| 所需 pod 的数量。这是区分显式零而非指定的指针。默认为 1。 |
|
|
| 要保留的旧 ReplicaSet 的数量，以允许回滚。这是区分显式零而非指定的指针。默认值为 10。 |
|
| pod 的标签选择器。Pod 被选择为受此部署影响的现有 ReplicaSet。它必须与 pod 模板的标签匹配。 | |
|
|
| DeploymentStrategy 描述如何将现有 pod 替换为新 pod。 |
|
| template 描述了要创建的 pod。唯一允许的 template.spec.restartPolicy 值是 "Always"。 |
7.4.1.2. .spec.strategy
- 描述
- DeploymentStrategy 描述如何将现有 pod 替换为新 pod。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| spec 来控制滚动更新所需的行为。 |
|
|
| 部署类型。可以是 "Recreate" 或 "RollingUpdate"。默认为 RollingUpdate。
可能枚举值： - |
7.4.1.3. .spec.strategy.rollingUpdate
- 描述
- spec 来控制滚动更新所需的行为。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 可以在所需 pod 数量之上调度的最大 pod 数量。值可以是绝对数量（例如： 5）或所需 pod 的百分比（例如： 10%）。如果 MaxUnavailable 为 0，则不能是 0。绝对数通过向上舍入来从百分比计算。默认值为 25%。示例：当它被设置为 30% 时，可在滚动更新启动时立即扩展新的 ReplicaSet，以便旧 pod 和新 pod 的总数不超过所需 pod 的 130%。旧 pod 被终止后，可以进一步扩展新的 ReplicaSet，确保更新期间随时运行的 pod 总数是所需 pod 的 130%。 | |
|
| 更新过程中可以无法使用的最大 pod 数量。值可以是绝对数量（例如： 5）或所需 pod 的百分比（例如： 10%）。绝对数通过向下舍入来从百分比计算。如果 MaxSurge 为 0，则不能是 0。默认值为 25%。示例：当它被设置为 30% 时，在滚动更新启动时，旧的 ReplicaSet 可以缩减到所需 pod 的 70%。新 pod 就绪后，可以进一步缩减旧的 ReplicaSet，然后扩展新的 ReplicaSet，确保更新期间始终可用的 pod 总数至少为 70% 的所需 pod。 |
7.4.1.4. .status
- 描述
- DeploymentStatus 是部署的最新观察状态。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 此部署的目标可用 pod 的总数（至少 minReadySeconds）目标。 |
|
|
| 部署哈希冲突计数。当需要为最新 ReplicaSet 创建名称时，Deployment 控制器使用此字段作为冲突避免机制。 |
|
|
| 代表部署当前状态的最新可用影响。 |
|
|
| DeploymentCondition 描述了在某个时间点上部署的状态。 |
|
|
| 部署控制器观察到的生成。 |
|
|
| readyReplicas 是此 Deployment 的 pod 数量，并带有 Ready Condition。 |
|
|
| 此部署目标的非终止 pod 的总数（标签与选择器匹配）。 |
|
|
| 此部署目标不可用 pod 的总数。这是部署仍然需要具有 100% 可用容量的 pod 的总数。它们可能是正在运行但还没有创建的 pod。 |
|
|
| 此部署的目标非终止的 pod 总数，具有所需模板规格。 |
7.4.1.5. .status.conditions
- 描述
- 代表部署当前状态的最新可用影响。
- 类型
-
array
7.4.1.6. .status.conditions[]
- 描述
- DeploymentCondition 描述了在某个时间点上部署的状态。
- 类型
-
object - 必填
-
type -
status
-
7.4.2. API 端点
可用的 API 端点如下：
/apis/apps/v1/deployments-
GET: 列出或监视类型为 Deployment 的对象
-
/apis/apps/v1/watch/deployments-
GET: 观察单个对 Deployment 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/apps/v1/namespaces/{namespace}/deployments-
DELETE：删除部署的集合 -
GET: 列出或监视类型为 Deployment 的对象 -
POST：创建部署
-
/apis/apps/v1/watch/namespaces/{namespace}/deployments-
GET: 观察单个对 Deployment 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/apps/v1/namespaces/{namespace}/deployments/{name}-
DELETE：删除部署 -
GET：读取指定的 Deployment -
PATCH：部分更新指定的部署 -
PUT：替换指定的部署
-
/apis/apps/v1/watch/namespaces/{namespace}/deployments/{name}-
GET: 观察对类型为 Deployment 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
/apis/apps/v1/namespaces/{namespace}/deployments/{name}/status-
GET: 指定 Deployment 的读取状态 -
PATCH：部分更新指定部署的状态 -
PUT：替换指定部署的状态
-
7.4.2.1. /apis/apps/v1/deployments
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 Deployment 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - 未授权 | 空 |
7.4.2.2. /apis/apps/v1/watch/deployments
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 Deployment 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除部署集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 Deployment 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - 未授权 | 空 |
- HTTP 方法
-
POST - 描述
- 创建部署
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - 未授权 | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 Deployment 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 部署的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除部署
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 阅读指定的部署
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的部署
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 Deployment
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - 未授权 | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 部署的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察对 kind Deployment. deprecated 的对象更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 部署的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 Deployment 的读取状态
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PATCH - 描述
- 指定部署的部分更新状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定部署的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - 未授权 | 空 |
7.5. ReplicaSet [apps/v1]
- 描述
- ReplicaSet 确保指定数量的 pod 副本在任意给定时间运行。
- 类型
-
对象
7.5.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 如果 ReplicaSet 的 Labels 为空，则默认为与 ReplicaSet 管理的 Pod 相同。标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| ReplicaSetSpec 是 ReplicaSet 的规格。 |
|
|
| ReplicaSetStatus 代表 ReplicaSet 的当前状态。 |
7.5.1.1. .spec
- 描述
- ReplicaSetSpec 是 ReplicaSet 的规格。
- 类型
-
object - 必填
-
selector
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 新创建的 pod 应该就绪的最少秒数，且没有其容器崩溃，以便它被视为可用。默认为 0 (pod 在就绪后将被视为可用) |
|
|
| replicas 是所需副本数量。这是区分显式零和未指定的指针。默认为 1。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
|
| selector 是 pod 的标签查询，应与副本数匹配。标记必须匹配的键和值，以便由此副本集控制。它必须与 pod 模板的标签匹配。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | |
|
| template 是描述在检测到副本不足时创建的 pod 的对象。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
7.5.1.2. .status
- 描述
- ReplicaSetStatus 代表 ReplicaSet 的当前状态。
- 类型
-
object - 必填
-
replicas
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 此副本集的可用副本数（至少为 minReadySeconds）。 |
|
|
| 代表副本集的当前状态的最新可用影响。 |
|
|
| ReplicaSetCondition 描述了特定点上副本集的状态。 |
|
|
| 具有与 replicaset 的 pod 模板标签匹配的标签的 pod 数量。 |
|
|
| observedGeneration 反映了最近观察到的 ReplicaSet 的生成。 |
|
|
| readyReplicas 是此 ReplicaSet 的目标带有 Ready Condition 的 pod 数量。 |
|
|
| replicas 是最近观察到的副本数。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
7.5.1.3. .status.conditions
- 描述
- 代表副本集的当前状态的最新可用影响。
- 类型
-
array
7.5.1.4. .status.conditions[]
- 描述
- ReplicaSetCondition 描述了特定点上副本集的状态。
- 类型
-
object - 必填
-
type -
status
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 条件从一个状态转换到另一个状态最后一次的时间。 | |
|
|
| 人类可读的消息，指示有关转换的详细信息。 |
|
|
| 条件最后一次转换的原因。 |
|
|
| 条件的状态，True, False, Unknown 之一。 |
|
|
| 副本集条件的类型。 |
7.5.2. API 端点
可用的 API 端点如下：
/apis/apps/v1/replicasets-
GET: 列出或监视类型为 ReplicaSet 的对象
-
/apis/apps/v1/watch/replicasets-
GET: 观察单个对 ReplicaSet 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/apps/v1/namespaces/{namespace}/replicasets-
DELETE：删除 ReplicaSet 的集合 -
GET: 列出或监视类型为 ReplicaSet 的对象 -
POST：创建 ReplicaSet
-
/apis/apps/v1/watch/namespaces/{namespace}/replicasets-
GET: 观察单个对 ReplicaSet 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/apps/v1/namespaces/{namespace}/replicasets/{name}-
DELETE：删除 ReplicaSet -
GET: 读取指定的 ReplicaSet -
PATCH：部分更新指定的 ReplicaSet -
PUT：替换指定的 ReplicaSet
-
/apis/apps/v1/watch/namespaces/{namespace}/replicasets/{name}-
GET: 观察对类型为 ReplicaSet 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status-
GET: 指定 ReplicaSet 的读取状态 -
PATCH：部分更新指定 ReplicaSet 的状态 -
PUT：替换指定 ReplicaSet 的状态
-
7.5.2.1. /apis/apps/v1/replicasets
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 ReplicaSet 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - 未授权 | 空 |
7.5.2.2. /apis/apps/v1/watch/replicasets
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 ReplicaSet 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 ReplicaSet 的集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 ReplicaSet 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - 未授权 | 空 |
- HTTP 方法
-
POST - 描述
- 创建 ReplicaSet
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - 未授权 | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 ReplicaSet 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ReplicaSet 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 ReplicaSet
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 读取指定的 ReplicaSet
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 ReplicaSet
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 ReplicaSet
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - 未授权 | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ReplicaSet 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察对 kind ReplicaSet 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ReplicaSet 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 ReplicaSet 的读取状态
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PATCH - 描述
- 指定 ReplicaSet 的部分更新状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 ReplicaSet 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - 未授权 | 空 |
7.6. StatefulSet [apps/v1]
- 描述
StatefulSet 代表一组具有一致身份的 pod。身份被定义为：- 网络 ：单个稳定的 DNS 和主机名。- Storage: 作为请求的多个 VolumeClaims。
StatefulSet 确保给定网络身份始终映射到同一存储身份。
- 类型
-
对象
7.6.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| StatefulSetSpec 是 StatefulSet 的规格。 |
|
|
| StatefulSetStatus 代表 StatefulSet 的当前状态。 |
7.6.1.1. .spec
- 描述
- StatefulSetSpec 是 StatefulSet 的规格。
- 类型
-
object - 必填
-
selector -
模板 -
serviceName
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 新创建的 pod 应该就绪的最少秒数，且没有其任何容器崩溃才被视为可用。默认为 0 (pod 在就绪后将被视为可用) |
|
|
| StatefulSetOrdinals 描述了此 StatefulSet 中副本或内部分配的策略。 |
|
|
| StatefulSetPersistentVolumeClaimRetentionPolicy 描述了从 StatefulSet VolumeClaimTemplates 创建的 PVC 的策略。 |
|
|
|
podManagementPolicy 控制如何在初始扩展、替换节点上的 pod 或缩减时创建 pod。默认策略是
可能枚举值： - |
|
|
| replicas 是给定模板的所需副本数。这些是相同模板的实例化的副本，但单个副本也具有一致的身份。如果未指定，则默认为 1。 |
|
|
| revisionHistoryLimit 是 StatefulSet 的修订历史记录中维护的最大修订版本数。修订历史记录由当前应用的 StatefulSetSpec 版本表示的所有修订版本组成。默认值为 10。 |
|
| selector 是 pod 的标签查询，应与副本数匹配。它必须与 pod 模板的标签匹配。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | |
|
|
| serviceName 是管理此 StatefulSet 的服务名称。此服务必须在 StatefulSet 之前存在，并负责集合的网络身份。Pod 获取遵循特征的 DNS/hostnames: pod-specific-string.serviceName.default.svc.cluster.local，其中 "pod-specific-string" 由 StatefulSet 控制器管理。 |
|
| template 是描述在检测到副本不足时创建的 pod 的对象。StatefulSet 标记的每个 pod 都履行此模板，但具有来自 StatefulSet 的其余部分的唯一身份。每个 pod 将以 <statefulsetname>-<podindex> 格式命名。例如，名为 "web" 的 StatefulSet 中的 pod，索引号为 "3" 将命名为 "web-3"。唯一允许的 template.spec.restartPolicy 值是 "Always"。 | |
|
|
| StatefulSetUpdateStrategy 表示 StatefulSet 控制器用来执行更新的策略。它包括为指定策略执行更新所需的任何其他参数。 |
|
| VolumeClaimTemplates 是一个声明列表，允许 pod 可被引用。StatefulSet 控制器负责映射网络身份以维护 pod 身份的方式进行声明。此列表中的每个声明必须在模板的一个容器中至少有一个匹配（按名称） volumeMount。此列表中的声明优先于模板中的任何卷，其名称相同。 |
7.6.1.2. .spec.ordinals
- 描述
- StatefulSetOrdinals 描述了此 StatefulSet 中副本或内部分配的策略。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| start 是代表第一个副本索引的编号。它可用于通过默认的 0 索引名称来对备用索引（例如：1索引）中的副本数，或编配从一个 StatefulSet 到另一个 StatefulSet 的正向移动。如果设置，副本索引将位于范围： [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas）。如果未设置，则默认为 0。副本索引将位于范围： [0, .spec.replicas）。 |
7.6.1.3. .spec.persistentVolumeClaimRetentionPolicy
- 描述
- StatefulSetPersistentVolumeClaimRetentionPolicy 描述了从 StatefulSet VolumeClaimTemplates 创建的 PVC 的策略。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
|
WhenDeleted 指定在 StatefulSet 被删除时从 StatefulSet VolumeClaimTemplates 创建的 PVC 会发生什么。 |
|
|
|
WhenScaled 指定在 StatefulSet 缩减时从 StatefulSet VolumeClaimTemplates 创建的 PVC 会发生什么。 |
7.6.1.4. .spec.updateStrategy
- 描述
- StatefulSetUpdateStrategy 表示 StatefulSet 控制器用来执行更新的策略。它包括为指定策略执行更新所需的任何其他参数。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| RollingUpdateStatefulSetStrategy 用于为 RollingUpdateStatefulSetStrategyType 通信参数。 |
|
|
| type 表示 StatefulSetUpdateStrategy 的类型。默认为 RollingUpdate。
可能枚举值： - |
7.6.1.5. .spec.updateStrategy.rollingUpdate
- 描述
- RollingUpdateStatefulSetStrategy 用于为 RollingUpdateStatefulSetStrategyType 通信参数。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 更新过程中可以无法使用的最大 pod 数量。值可以是绝对数量（例如： 5）或所需 pod 的百分比（例如： 10%）。绝对数通过向上舍入来从百分比计算。不能是 0。默认为 1。此字段是 alpha-level，仅适用于启用 MaxUnavailableStatefulSet 功能的服务器。该字段适用于范围 0 到 Replicas-1 范围内的所有 pod。这意味着，如果 0 到 Replicas-1 范围内的不可用 pod，它将计为 MaxUnavailable。 | |
|
|
| partition 表示 StatefulSet 应该在其中对更新进行分区。在滚动更新过程中，所有来自 ordinal Replicas-1 到分区的 pod 都会被更新。来自 ordinal Partition-1 到 0 的所有 pod 保持不变。这有助于执行基于 canary 的部署。默认值为 0。 |
7.6.1.6. .status
- 描述
- StatefulSetStatus 代表 StatefulSet 的当前状态。
- 类型
-
object - 必填
-
replicas
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 此 statefulset 的目标可用 pod 的总数（至少 minReadySeconds）目标为 statefulset。 |
|
|
| conflictCount 是 StatefulSet 的哈希冲突计数。StatefulSet 控制器使用此字段作为冲突避免机制，当它需要为最新的 ControllerRevision 创建名称时。 |
|
|
| 代表 statefulset 的当前状态的最新可用影响。 |
|
|
| StatefulSetCondition 描述了 statefulset 在特定点的状态。 |
|
|
| currentReplicas 是 StatefulSet 控制器从 currentRevision 指示的 StatefulSet 版本创建的 Pod 数量。 |
|
|
| currentRevision （如果不是空的），指示用于在 [0,currentReplicas）序列中用于生成 Pod 的 StatefulSet 版本。 |
|
|
| observedGeneration 是此 StatefulSet 观察到的最新生成。它与 StatefulSet 的生成对应，该生成由 API 服务器在变异时进行更新。 |
|
|
| readyReplicas 是为此 StatefulSet 创建的 pod 数量，并带有 Ready Condition。 |
|
|
| replicas 是 StatefulSet 控制器创建的 Pod 数量。 |
|
|
| updateRevision （如果不是空的），指示用于在 [replicas-updatedReplicas,replicas）序列中生成 Pod 的 StatefulSet 版本。 |
|
|
| updatedReplicas 是 StatefulSet 控制器从 updateRevision 指示的 StatefulSet 版本创建的 Pod 数量。 |
7.6.1.7. .status.conditions
- 描述
- 代表 statefulset 的当前状态的最新可用影响。
- 类型
-
array
7.6.1.8. .status.conditions[]
- 描述
- StatefulSetCondition 描述了 statefulset 在特定点的状态。
- 类型
-
object - 必填
-
type -
status
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 条件从一个状态转换到另一个状态最后一次的时间。 | |
|
|
| 人类可读的消息，指示有关转换的详细信息。 |
|
|
| 条件最后一次转换的原因。 |
|
|
| 条件的状态，True, False, Unknown 之一。 |
|
|
| statefulset 条件的类型。 |
7.6.2. API 端点
可用的 API 端点如下：
/apis/apps/v1/statefulsets-
GET: 列出或监视类型为 StatefulSet 的对象
-
/apis/apps/v1/watch/statefulsets-
GET: 观察单个对 StatefulSet 列表的更改。已弃用： 使用 'watch' 参数和 list 操作。
-
/apis/apps/v1/namespaces/{namespace}/statefulsets-
DELETE：删除 StatefulSet 的集合 -
GET: 列出或监视类型为 StatefulSet 的对象 -
POST：创建 StatefulSet
-
/apis/apps/v1/watch/namespaces/{namespace}/statefulsets-
GET: 观察单个对 StatefulSet 列表的更改。已弃用： 使用 'watch' 参数和 list 操作。
-
/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}-
DELETE：删除 StatefulSet -
GET：读取指定的 StatefulSet -
PATCH：部分更新指定的 StatefulSet -
PUT：替换指定的 StatefulSet
-
/apis/apps/v1/watch/namespaces/{namespace}/statefulsets/{name}-
GET: 观察对类型为 StatefulSet 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status-
GET: 指定 StatefulSet 的读取状态 -
PATCH：部分更新指定 StatefulSet 的状态 -
PUT：替换指定 StatefulSet 的状态
-
7.6.2.1. /apis/apps/v1/statefulsets
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 StatefulSet 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - 未授权 | 空 |
7.6.2.2. /apis/apps/v1/watch/statefulsets
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 StatefulSet 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 StatefulSet 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 StatefulSet 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - 未授权 | 空 |
- HTTP 方法
-
POST - 描述
- 创建 StatefulSet
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - 未授权 | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 StatefulSet 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| StatefulSet 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 StatefulSet
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 读取指定的 StatefulSet
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 StatefulSet
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 StatefulSet
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - 未授权 | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| StatefulSet 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察对 kind StatefulSet. deprecated 的对象更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| StatefulSet 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 StatefulSet 的读取状态
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PATCH - 描述
- 指定 StatefulSet 的部分更新状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 StatefulSet 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - 未授权 | 空 |
第 8 章 身份验证 API
8.1. 身份验证 API
8.1.1. TokenRequest [authentication.k8s.io/v1]
- 描述
- TokenRequest 为给定服务帐户请求一个令牌。
- 类型
-
对象
8.1.2. TokenReview [authentication.k8s.io/v1]
- 描述
- TokenReview 会尝试向一个已知用户验证令牌。备注：TokenReview 请求可能会被 kube-apiserver 中的 Webhook 令牌验证器插件缓存。
- 类型
-
对象
8.2. TokenRequest [authentication.k8s.io/v1]
- 描述
- TokenRequest 为给定服务帐户请求一个令牌。
- 类型
-
object - 必填
-
spec
-
8.2.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| TokenRequestSpec 包括由客户端提供的令牌请求的参数。 |
|
|
| TokenRequestStatus 是令牌请求的结果。 |
8.2.1.1. .spec
- 描述
- TokenRequestSpec 包括由客户端提供的令牌请求的参数。
- 类型
-
object - 必填
-
audiences
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| audiences 是令牌的受众对象。令牌的接收者必须使用令牌的 audiences 列表中的一个标识符来识别自己，否则应拒绝令牌。为多个 audiences 发布的令牌可以用于针对列出的 audiences 进行验证，但意味着目标 audiences 之间有高的信任度。 |
|
|
| BoundObjectReference 是对令牌绑定到的一个对象的引用。 |
|
|
| ExpirationSeconds 是请求的有效期。令牌签发者可能会返回具有不同有效期持续时间的令牌，因此客户端需要检查响应中的 'expiration' 字段。 |
8.2.1.2. .spec.boundObjectRef
- 描述
- BoundObjectReference 是对令牌绑定到的一个对象的引用。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 引用的 API 版本。 |
|
|
| 引用的类型。有效类型为 'Pod' 和 'Secret'。 |
|
|
| 引用的名称。 |
|
|
| 引用的 UID。 |
8.2.1.3. .status
- 描述
- TokenRequestStatus 是令牌请求的结果。
- 类型
-
object - 必填
-
token -
expirationTimestamp
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
| ExpirationTimestamp 是返回令牌的过期时间。 | |
|
|
| 令牌是 opaque bearer 令牌。 |
8.2.2. API 端点
可用的 API 端点如下：
/api/v1/namespaces/{namespace}/serviceaccounts/{name}/token-
POST：创建 ServiceAccount 令牌
-
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| TokenRequest 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
POST - 描述
- 创建 ServiceAccount 的令牌
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
8.3. TokenReview [authentication.k8s.io/v1]
- 描述
- TokenReview 会尝试向一个已知用户验证令牌。备注：TokenReview 请求可能会被 kube-apiserver 中的 Webhook 令牌验证器插件缓存。
- 类型
-
object - 必填
-
spec
-
8.3.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| TokenReviewSpec 是令牌身份验证请求的描述。 |
|
|
| TokenReviewStatus 是令牌身份验证请求的结果。 |
8.3.1.1. .spec
- 描述
- TokenReviewSpec 是令牌身份验证请求的描述。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Audiences 是资源服务器通过令牌标识的标识符的列表。支持 Audiences 的令牌验证器将验证至少针对此列表中的一个 audience 的令牌。如果没有提供 audiences，则 audiences 将默认为 Kubernetes apiserver 的 audiences。 |
|
|
| 令牌是 opaque bearer 令牌。 |
8.3.1.2. .status
- 描述
- TokenReviewStatus 是令牌身份验证请求的结果。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| audiences 是由与 TokenReview 和 token 兼容的验证器选择的 audiences 标识符。标识符是 TokenReviewSpec audiences 的交集和令牌的受众中的任何标识符。设置 spec.audiences 字段的 TokenReview API 客户端应该验证 status.audiences 字段中是否返回兼容的受众标识符，以确保 TokenReview 服务器可被受众了解。如果 TokenReview 返回了一个空 status.audience 字段，其中 status.authenticated 为 "true"，则令牌对 Kubernetes API 服务器的受众有效。 |
|
|
| 已验证表示令牌已与一个已知的用户关联。 |
|
|
| Error 表示无法检查令牌 |
|
|
| userinfo 包含有关实现 user.Info 接口所需的用户的信息。 |
8.3.1.3. .status.user
- 描述
- userinfo 包含有关实现 user.Info 接口所需的用户的信息。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 验证器提供的任何额外信息。 |
|
|
| |
|
|
| 此用户所属的组的名称。 |
|
|
| 一次标识此用户的唯一值。如果删除了此用户，并且添加了相同名称的另一个用户，则它们将具有不同的 UID。 |
|
|
| 在所有活跃用户间唯一标识此用户的名称。 |
8.3.1.4. .status.user.extra
- 描述
- 验证器提供的任何额外信息。
- 类型
-
object
8.3.2. API 端点
可用的 API 端点如下：
/apis/authentication.k8s.io/v1/tokenreviews-
POST：创建一个 TokenReview
-
8.3.2.1. /apis/authentication.k8s.io/v1/tokenreviews
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
POST - 描述
- 创建 TokenReview
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
第 9 章 授权 API
9.1. 授权 API
- 描述
- LocalSubjectAccessReview 检查一个用户或组是否可以在给定命名空间中执行操作。使用命名空间范围资源可以更容易授予包含权限检查的命名空间范围策略。
- 类型
-
对象
9.1.2. SelfSubjectAccessReview [authorization.k8s.io/v1]
- 描述
- SelfSubjectAccessReview 检查当前用户是否可以执行一个操作。不填写 spec.namespace 表示"在所有命名空间中"。Self 是一个特殊的情况，因为用户应始终可以检查自己是否可以执行操作
- 类型
-
object
9.1.3. SelfSubjectRulesReview [authorization.k8s.io/v1]
- 描述
- SelfSubjectRulesReview 枚举了当前用户可以在一个命名空间内执行的操作集合。返回的操作列表可能并不完整，具体取决于服务器的授权模式，以及在评估过程中出现的任何错误。UI 应使用 SelfSubjectRulesReview 来显示/隐藏操作，或者快速让最终用户有关其权限的原因。它不应该被外部系统用来驱动授权决策，因为这会导致缓存生命周期/撤销、正确性的混淆SubjectAccessReview 和 LocalAccessReview 是将授权决策延迟到 API 服务器的正确方法。
- 类型
-
object
9.1.4. SubjectAccessReview [authorization.k8s.io/v1]
- 描述
- SubjectAccessReview 检查一个用户或组是否可以执行一个操作。
- 类型
-
对象
9.2. LocalSubjectAccessReview [authorization.k8s.io/v1]
- 描述
- LocalSubjectAccessReview 检查一个用户或组是否可以在给定命名空间中执行操作。使用命名空间范围资源可以更容易授予包含权限检查的命名空间范围策略。
- 类型
-
object - 必填
-
spec
-
9.2.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| SubjectAccessReviewSpec 是访问请求的描述。必须设置 ResourceAuthorizationAttributes 和 NonResourceAuthorizationAttributes 之一 |
|
|
| SubjectAccessReviewStatus |
9.2.1.1. .spec
- 描述
- SubjectAccessReviewSpec 是访问请求的描述。必须设置 ResourceAuthorizationAttributes 和 NonResourceAuthorizationAttributes 之一
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 额外对应于验证器中的 user.Info.GetExtra （）方法。由于这是授权者的输入，因此这里需要反映出来。 |
|
|
| |
|
|
| 组是您正在测试的组。 |
|
|
| nonResourceAttributes 包括可用于对 Authorizer 接口的非资源请求的授权属性 |
|
|
| resourceAttributes 包括可用于向 Authorizer 接口的资源请求的授权属性 |
|
|
| 有关请求用户的 UID 信息。 |
|
|
| 用户是您正在测试的用户。如果您指定了 "User" 而不是 "Groups"，那么它将解释为"如果用户不是任何组的成员 |
9.2.1.2. .spec.extra
- 描述
- 额外对应于验证器中的 user.Info.GetExtra （）方法。由于这是授权者的输入，因此这里需要反映出来。
- 类型
-
object
9.2.1.3. .spec.nonResourceAttributes
- 描述
- nonResourceAttributes 包括可用于对 Authorizer 接口的非资源请求的授权属性
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| path 是请求的 URL 路径 |
|
|
| verb 是标准 HTTP 动词 |
9.2.1.4. .spec.resourceAttributes
- 描述
- resourceAttributes 包括可用于向 Authorizer 接口的资源请求的授权属性
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| group 是资源的 API 组。"*"表示全部。 |
|
|
| name 是为"get"请求的资源的名称，或删除 "delete". "" (empty)表示 all。 |
|
|
| namespace 是所请求操作的命名空间。目前，对于集群范围的资源 "" (empty)，没有命名空间和所有命名空间"" （空）为 LocalSubjectAccessReviews "" (empty)为空，代表来自 SubjectAccessReview 或 SelfSubjectAccessReview 的命名空间范围资源"all" |
|
|
| Resource 是现有资源类型之一。"*"表示全部。 |
|
|
| 子资源是现有资源类型之一。""表示 none。 |
|
|
| verb 是一个 kubernetes 资源 API 动词，如 get, list, watch, create, update, delete, proxy. "*"。 |
|
|
| Version 是资源的 API 版本。"*"表示全部。 |
9.2.1.5. .status
- 描述
- SubjectAccessReviewStatus
- 类型
-
object - 必填
-
allowed
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Allowed 是必需的。True 代表操作被允许，false 代表不允许。 |
|
|
| Denied 是可选的。如果被拒绝，则为 True，否则为 false。如果允许都为 false，并且拒绝为 false，则授权者在是否授权该操作时没有建议。如果允许为 true，则拒绝的可能不是 true。 |
|
|
| EvaluationError 表示在授权检查过程中发生一些错误。完全有可能出错，并且能够继续确定其授权状态。例如，RBAC 可以缺少角色，但仍存在足够的角色并绑定到请求的原因。 |
|
|
| reason 是可选的。它表示为什么允许或拒绝请求。 |
9.2.2. API 端点
可用的 API 端点如下：
/apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews-
POST: 创建一个 LocalSubjectAccessReview
-
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
POST - 描述
- 创建 LocalSubjectAccessReview
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
9.3. SelfSubjectAccessReview [authorization.k8s.io/v1]
- 描述
- SelfSubjectAccessReview 检查当前用户是否可以执行一个操作。不填写 spec.namespace 表示"在所有命名空间中"。Self 是一个特殊的情况，因为用户应始终可以检查自己是否可以执行操作
- 类型
-
object - 必填
-
spec
-
9.3.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| SelfSubjectAccessReviewSpec 是访问请求的描述。必须设置 ResourceAuthorizationAttributes 和 NonResourceAuthorizationAttributes 之一 |
|
|
| SubjectAccessReviewStatus |
9.3.1.1. .spec
- 描述
- SelfSubjectAccessReviewSpec 是访问请求的描述。必须设置 ResourceAuthorizationAttributes 和 NonResourceAuthorizationAttributes 之一
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| nonResourceAttributes 包括可用于对 Authorizer 接口的非资源请求的授权属性 |
|
|
| resourceAttributes 包括可用于向 Authorizer 接口的资源请求的授权属性 |
9.3.1.2. .spec.nonResourceAttributes
- 描述
- nonResourceAttributes 包括可用于对 Authorizer 接口的非资源请求的授权属性
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| path 是请求的 URL 路径 |
|
|
| verb 是标准 HTTP 动词 |
9.3.1.3. .spec.resourceAttributes
- 描述
- resourceAttributes 包括可用于向 Authorizer 接口的资源请求的授权属性
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| group 是资源的 API 组。"*"表示全部。 |
|
|
| name 是为"get"请求的资源的名称，或删除 "delete". "" (empty)表示 all。 |
|
|
| namespace 是所请求操作的命名空间。目前，对于集群范围的资源 "" (empty)，没有命名空间和所有命名空间"" （空）为 LocalSubjectAccessReviews "" (empty)为空，代表来自 SubjectAccessReview 或 SelfSubjectAccessReview 的命名空间范围资源"all" |
|
|
| Resource 是现有资源类型之一。"*"表示全部。 |
|
|
| 子资源是现有资源类型之一。""表示 none。 |
|
|
| verb 是一个 kubernetes 资源 API 动词，如 get, list, watch, create, update, delete, proxy. "*"。 |
|
|
| Version 是资源的 API 版本。"*"表示全部。 |
9.3.1.4. .status
- 描述
- SubjectAccessReviewStatus
- 类型
-
object - 必填
-
allowed
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Allowed 是必需的。True 代表操作被允许，false 代表不允许。 |
|
|
| Denied 是可选的。如果被拒绝，则为 True，否则为 false。如果允许都为 false，并且拒绝为 false，则授权者在是否授权该操作时没有建议。如果允许为 true，则拒绝的可能不是 true。 |
|
|
| EvaluationError 表示在授权检查过程中发生一些错误。完全有可能出错，并且能够继续确定其授权状态。例如，RBAC 可以缺少角色，但仍存在足够的角色并绑定到请求的原因。 |
|
|
| reason 是可选的。它表示为什么允许或拒绝请求。 |
9.3.2. API 端点
可用的 API 端点如下：
/apis/authorization.k8s.io/v1/selfsubjectaccessreviews-
POST：创建一个 SelfSubjectAccessReview
-
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
POST - 描述
- 创建一个 SelfSubjectAccessReview
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
9.4. SelfSubjectRulesReview [authorization.k8s.io/v1]
- 描述
- SelfSubjectRulesReview 枚举了当前用户可以在一个命名空间内执行的操作集合。返回的操作列表可能并不完整，具体取决于服务器的授权模式，以及在评估过程中出现的任何错误。UI 应使用 SelfSubjectRulesReview 来显示/隐藏操作，或者快速让最终用户有关其权限的原因。它不应该被外部系统用来驱动授权决策，因为这会导致缓存生命周期/撤销、正确性的混淆SubjectAccessReview 和 LocalAccessReview 是将授权决策延迟到 API 服务器的正确方法。
- 类型
-
object - 必填
-
spec
-
9.4.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| SelfSubjectRulesReviewSpec 定义 SelfSubjectRulesReview 的规格。 |
|
|
| SubjectRulesReviewStatus 包含规则检查的结果。根据服务器配置的授权程序集以及评估过程中遇到的任何错误，此检查可能不完整。由于授权规则是 additive，因此如果规则出现在列表中，它可以安全地假定主题具有该权限，即使该列表不完整。 |
9.4.1.1. .spec
- 描述
- SelfSubjectRulesReviewSpec 定义 SelfSubjectRulesReview 的规格。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 用于评估规则的命名空间。必需。 |
9.4.1.2. .status
- 描述
- SubjectRulesReviewStatus 包含规则检查的结果。根据服务器配置的授权程序集以及评估过程中遇到的任何错误，此检查可能不完整。由于授权规则是 additive，因此如果规则出现在列表中，它可以安全地假定主题具有该权限，即使该列表不完整。
- 类型
-
object - 必填
-
resourceRules -
nonResourceRules -
incomplete
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| EvaluationError 可以与 Rules 结合使用。它表示在规则评估过程中出现错误，如不支持规则评估的授权器，并且 ResourceRules 和/或 NonResourceRules 可能不完整。 |
|
|
| 当此调用返回的规则不完整时，不完整。当授权者（如外部授权器）不支持规则评估时，这最常遇到。 |
|
|
| nonResourceRules 是主题允许在非资源上执行的操作列表。列表排序不重要，可能包含重复项，可能不完整。 |
|
|
| NonResourceRule 包含描述非资源规则的信息 |
|
|
| resourceRules 是主题允许对资源执行的操作列表。列表排序不重要，可能包含重复项，可能不完整。 |
|
|
| ResourceRule 是主题允许对资源执行的操作列表。列表排序不重要，可能包含重复项，可能不完整。 |
9.4.1.3. .status.nonResourceRules
- 描述
- nonResourceRules 是主题允许在非资源上执行的操作列表。列表排序不重要，可能包含重复项，可能不完整。
- 类型
-
array
9.4.1.4. .status.nonResourceRules[]
- 描述
- NonResourceRule 包含描述非资源规则的信息
- 类型
-
object - 必填
-
verbs
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| NonResourceURLs 是用户应有权访问的一组部分 url。允许 s，但仅作为路径中的最后一步。"表示全部。 |
|
|
| verb 是 kubernetes 非资源 API 动词列表，如 get, post, put, delete, patch, head, options。"*" 表示 all。 |
9.4.1.5. .status.resourceRules
- 描述
- resourceRules 是主题允许对资源执行的操作列表。列表排序不重要，可能包含重复项，可能不完整。
- 类型
-
array
9.4.1.6. .status.resourceRules[]
- 描述
- ResourceRule 是主题允许对资源执行的操作列表。列表排序不重要，可能包含重复项，可能不完整。
- 类型
-
object - 必填
-
verbs
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIGroups 是包含资源的 APIGroup 的名称。如果指定了多个 API 组，则允许针对任何 API 组中的一个枚举的资源请求任何操作。"*"表示全部。 |
|
|
| resourceNames 是一个可选的规则应用到的名称白名单。空集表示允许一切。"*"表示全部。 |
|
|
| resources 是此规则应用到的资源列表。"表示指定的 apiGroups. " /foo" 中的所有资源都代表指定 apiGroups 中所有资源的子资源 'foo'。 |
|
|
| verb 是 kubernetes 资源 API 动词列表，例如： get、list、watch、create、update、delete、proxy. "*"。 |
9.4.2. API 端点
可用的 API 端点如下：
/apis/authorization.k8s.io/v1/selfsubjectrulesreviews-
POST：创建一个 SelfSubjectRulesReview
-
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
POST - 描述
- 创建一个 SelfSubjectRulesReview
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
9.5. SubjectAccessReview [authorization.k8s.io/v1]
- 描述
- SubjectAccessReview 检查一个用户或组是否可以执行一个操作。
- 类型
-
object - 必填
-
spec
-
9.5.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| SubjectAccessReviewSpec 是访问请求的描述。必须设置 ResourceAuthorizationAttributes 和 NonResourceAuthorizationAttributes 之一 |
|
|
| SubjectAccessReviewStatus |
9.5.1.1. .spec
- 描述
- SubjectAccessReviewSpec 是访问请求的描述。必须设置 ResourceAuthorizationAttributes 和 NonResourceAuthorizationAttributes 之一
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 额外对应于验证器中的 user.Info.GetExtra （）方法。由于这是授权者的输入，因此这里需要反映出来。 |
|
|
| |
|
|
| 组是您正在测试的组。 |
|
|
| nonResourceAttributes 包括可用于对 Authorizer 接口的非资源请求的授权属性 |
|
|
| resourceAttributes 包括可用于向 Authorizer 接口的资源请求的授权属性 |
|
|
| 有关请求用户的 UID 信息。 |
|
|
| 用户是您正在测试的用户。如果您指定了 "User" 而不是 "Groups"，那么它将解释为"如果用户不是任何组的成员 |
9.5.1.2. .spec.extra
- 描述
- 额外对应于验证器中的 user.Info.GetExtra （）方法。由于这是授权者的输入，因此这里需要反映出来。
- 类型
-
object
9.5.1.3. .spec.nonResourceAttributes
- 描述
- nonResourceAttributes 包括可用于对 Authorizer 接口的非资源请求的授权属性
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| path 是请求的 URL 路径 |
|
|
| verb 是标准 HTTP 动词 |
9.5.1.4. .spec.resourceAttributes
- 描述
- resourceAttributes 包括可用于向 Authorizer 接口的资源请求的授权属性
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| group 是资源的 API 组。"*"表示全部。 |
|
|
| name 是为"get"请求的资源的名称，或删除 "delete". "" (empty)表示 all。 |
|
|
| namespace 是所请求操作的命名空间。目前，对于集群范围的资源 "" (empty)，没有命名空间和所有命名空间"" （空）为 LocalSubjectAccessReviews "" (empty)为空，代表来自 SubjectAccessReview 或 SelfSubjectAccessReview 的命名空间范围资源"all" |
|
|
| Resource 是现有资源类型之一。"*"表示全部。 |
|
|
| 子资源是现有资源类型之一。""表示 none。 |
|
|
| verb 是一个 kubernetes 资源 API 动词，如 get, list, watch, create, update, delete, proxy. "*"。 |
|
|
| Version 是资源的 API 版本。"*"表示全部。 |
9.5.1.5. .status
- 描述
- SubjectAccessReviewStatus
- 类型
-
object - 必填
-
allowed
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Allowed 是必需的。True 代表操作被允许，false 代表不允许。 |
|
|
| Denied 是可选的。如果被拒绝，则为 True，否则为 false。如果允许都为 false，并且拒绝为 false，则授权者在是否授权该操作时没有建议。如果允许为 true，则拒绝的可能不是 true。 |
|
|
| EvaluationError 表示在授权检查过程中发生一些错误。完全有可能出错，并且能够继续确定其授权状态。例如，RBAC 可以缺少角色，但仍存在足够的角色并绑定到请求的原因。 |
|
|
| reason 是可选的。它表示为什么允许或拒绝请求。 |
9.5.2. API 端点
可用的 API 端点如下：
/apis/authorization.k8s.io/v1/subjectaccessreviews-
POST: 创建一个 SubjectAccessReview
-
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
POST - 描述
- 创建一个 SubjectAccessReview
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
第 10 章 自动缩放 API
10.1. 自动缩放 API
10.1.1. scale [autoscaling/v1]
- 描述
- scale 代表资源的扩展请求。
- 类型
-
object
10.1.2. HorizontalPodAutoscaler [autoscaling/v2]
- 描述
- HorizontalPodAutoscaler 是 pod 横向自动扩展的配置，它根据指定的指标自动管理实施 scale 子资源的任何资源的副本数。
- 类型
-
object
10.2. HorizontalPodAutoscaler [autoscaling/v2]
- 描述
- HorizontalPodAutoscaler 是 pod 横向自动扩展的配置，它根据指定的指标自动管理实施 scale 子资源的任何资源的副本数。
- 类型
-
对象
10.2.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| metadata 是标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| HorizontalPodAutoscalerSpec 描述了 HorizontalPodAutoscaler 的所需功能。 |
|
|
| HorizontalPodAutoscalerStatus 描述了 pod 横向自动扩展的当前状态。 |
10.2.1.1. .spec
- 描述
- HorizontalPodAutoscalerSpec 描述了 HorizontalPodAutoscaler 的所需功能。
- 类型
-
object - 必填
-
scaleTargetRef -
maxReplicas
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| HorizontalPodAutoscalerBehavior 在 Up 和 Down directions (scaleUp 和 scaleDown 字段)中配置目标的扩展行为。 |
|
|
| maxReplicas 是自动扩展可以扩展到的副本数的上限。它不能小于 minReplicas。 |
|
|
| 指标包含用于计算所需副本数（将使用所有指标的最大副本数）的规格。所需的副本数根据当前 pod 数量来计算目标值和当前值之间的比率。Ergo，使用的指标必须减少，因为 pod 数量会增加，反之亦然。如需有关每种指标类型响应的更多信息，请参阅单独的指标源类型。如果没有设置，则默认指标将设置为 80% 平均 CPU 使用率。 |
|
|
|
MetricSpec 指定如何基于单一指标（仅 |
|
|
| minReplicas 是自动扩展可以缩减副本数的较低限制。如果启用了 alpha 功能门 HPAScaleToZero，并且至少配置一个 Object 或 External 指标，则默认为 1 个 pod。minReplicas 被允许为 0。只要至少有一个指标值可用，扩展就会处于活跃状态。 |
|
|
| CrossVersionObjectReference 包含足够信息，供您识别引用的资源。 |
10.2.1.2. .spec.behavior
- 描述
- HorizontalPodAutoscalerBehavior 在 Up 和 Down directions (scaleUp 和 scaleDown 字段)中配置目标的扩展行为。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| HPAScalingRules 配置一个方向的扩展行为。在为 HPA 的指标计算 DesiredReplicas 后，会应用这些规则。它们可以通过指定扩展策略来限制扩展速度。它们可以通过指定 stabilization 窗口来防止 flapping，以便不立即设置副本数，而是选择 stabilization 窗口中的安全值。 |
|
|
| HPAScalingRules 配置一个方向的扩展行为。在为 HPA 的指标计算 DesiredReplicas 后，会应用这些规则。它们可以通过指定扩展策略来限制扩展速度。它们可以通过指定 stabilization 窗口来防止 flapping，以便不立即设置副本数，而是选择 stabilization 窗口中的安全值。 |
10.2.1.3. .spec.behavior.scaleDown
- 描述
- HPAScalingRules 配置一个方向的扩展行为。在为 HPA 的指标计算 DesiredReplicas 后，会应用这些规则。它们可以通过指定扩展策略来限制扩展速度。它们可以通过指定 stabilization 窗口来防止 flapping，以便不立即设置副本数，而是选择 stabilization 窗口中的安全值。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 策略(policy)是一个潜在的扩展策略列表，可在扩展过程中使用。必须至少指定一个策略，否则 HPAScalingRules 将被丢弃为无效 |
|
|
| HPAScalingPolicy 是一个单一策略，必须为指定过去的时间间隔保存 true。 |
|
|
| selectPolicy 用于指定应使用哪个策略。如果没有设置，则使用默认值 Max。 |
|
|
| stabilizationWindowSeconds 是扩展或缩减时应考虑过去建议的秒数。stabilizationWindowSeconds 必须大于或等于零，且小于或等于 3600 （一小时）。如果没有设置，使用默认值： - 对于扩展： 0 （不进行稳定）。- 用于缩减：300 （例如，stabilization 窗口为 300 秒）。 |
10.2.1.4. .spec.behavior.scaleDown.policies
- 描述
- 策略(policy)是一个潜在的扩展策略列表，可在扩展过程中使用。必须至少指定一个策略，否则 HPAScalingRules 将被丢弃为无效
- 类型
-
数组
10.2.1.5. .spec.behavior.scaleDown.policies[]
- 描述
- HPAScalingPolicy 是一个单一策略，必须为指定过去的时间间隔保存 true。
- 类型
-
object - 必填
-
type -
value -
periodSeconds
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| periodSeconds 指定策略应满足以下条件的时间窗口。periodSeconds 必须大于零，且小于或等于 1800 (30 分钟)。 |
|
|
| type 用于指定扩展策略。 |
|
|
| value 包含策略允许的更改量。它必须大于零 |
10.2.1.6. .spec.behavior.scaleUp
- 描述
- HPAScalingRules 配置一个方向的扩展行为。在为 HPA 的指标计算 DesiredReplicas 后，会应用这些规则。它们可以通过指定扩展策略来限制扩展速度。它们可以通过指定 stabilization 窗口来防止 flapping，以便不立即设置副本数，而是选择 stabilization 窗口中的安全值。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 策略(policy)是一个潜在的扩展策略列表，可在扩展过程中使用。必须至少指定一个策略，否则 HPAScalingRules 将被丢弃为无效 |
|
|
| HPAScalingPolicy 是一个单一策略，必须为指定过去的时间间隔保存 true。 |
|
|
| selectPolicy 用于指定应使用哪个策略。如果没有设置，则使用默认值 Max。 |
|
|
| stabilizationWindowSeconds 是扩展或缩减时应考虑过去建议的秒数。stabilizationWindowSeconds 必须大于或等于零，且小于或等于 3600 （一小时）。如果没有设置，使用默认值： - 对于扩展： 0 （不进行稳定）。- 用于缩减：300 （例如，stabilization 窗口为 300 秒）。 |
10.2.1.7. .spec.behavior.scaleUp.policies
- 描述
- 策略(policy)是一个潜在的扩展策略列表，可在扩展过程中使用。必须至少指定一个策略，否则 HPAScalingRules 将被丢弃为无效
- 类型
-
数组
10.2.1.8. .spec.behavior.scaleUp.policies[]
- 描述
- HPAScalingPolicy 是一个单一策略，必须为指定过去的时间间隔保存 true。
- 类型
-
object - 必填
-
type -
value -
periodSeconds
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| periodSeconds 指定策略应满足以下条件的时间窗口。periodSeconds 必须大于零，且小于或等于 1800 (30 分钟)。 |
|
|
| type 用于指定扩展策略。 |
|
|
| value 包含策略允许的更改量。它必须大于零 |
10.2.1.9. .spec.metrics
- 描述
- 指标包含用于计算所需副本数（将使用所有指标的最大副本数）的规格。所需的副本数根据当前 pod 数量来计算目标值和当前值之间的比率。Ergo，使用的指标必须减少，因为 pod 数量会增加，反之亦然。如需有关每种指标类型响应的更多信息，请参阅单独的指标源类型。如果没有设置，则默认指标将设置为 80% 平均 CPU 使用率。
- 类型
-
数组
10.2.1.10. .spec.metrics[]
- 描述
-
MetricSpec 指定如何基于单一指标（仅
类型和另一个匹配字段应一次性设置）进行扩展。 - 类型
-
object - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| ContainerResourceMetricSource 指明如何扩展 Kubernetes 的资源指标，如请求和限值中指定的资源指标，描述当前扩展目标中的每个 pod （如 CPU 或内存）。在与目标进行比较前，这些值将平均化在一起。此类指标内置在 Kubernetes 中，并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。应该只设置一个"target"类型。 |
|
|
| ExternalMetricSource 指明如何在不与任何 Kubernetes 对象关联的指标上扩展（例如，云消息传递服务中的队列长度，或者从集群外运行的 loadbalancer 中的 QPS）。 |
|
|
| ObjectMetricSource 指明如何在描述 kubernetes 对象的指标上扩展（例如，Ingress 对象上的 hits-per-second）。 |
|
|
| PodsMetricSource 指明了如何在一个指标上扩展，描述当前扩展目标中的每个 pod （如 transaction-processed-second）。在与目标值进行比较前，这些值将平均化在一起。 |
|
|
| ResourceMetricSource 指示如何扩展 Kubernetes 的资源指标，如请求和限值中指定的资源指标，描述当前扩展目标中的每个 pod （如 CPU 或内存）。在与目标进行比较前，这些值将平均化在一起。此类指标内置在 Kubernetes 中，并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。应该只设置一个"target"类型。 |
|
|
| type 是指标源的类型。它应该是 "ContainerResource", "External", "Object", "Pods" 或 "Resource" 之一，每个映射到对象中的匹配字段。注："ContainerResource" 类型在启用了 feature-gate HPAContainerMetrics 时可用 |
10.2.1.11. .spec.metrics[].containerResource
- 描述
- ContainerResourceMetricSource 指明如何扩展 Kubernetes 的资源指标，如请求和限值中指定的资源指标，描述当前扩展目标中的每个 pod （如 CPU 或内存）。在与目标进行比较前，这些值将平均化在一起。此类指标内置在 Kubernetes 中，并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。应该只设置一个"target"类型。
- 类型
-
object - 必填
-
name -
target -
container
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Container 是扩展目标 pod 中的容器的名称 |
|
|
| name 是问题的资源的名称。 |
|
|
| MetricTarget 定义特定指标的目标值、平均值或平均利用率 |
10.2.1.12. .spec.metrics[].containerResource.target
- 描述
- MetricTarget 定义特定指标的目标值、平均值或平均利用率
- 类型
-
object - 必填
-
type
-
10.2.1.13. .spec.metrics[].external
- 描述
- ExternalMetricSource 指明如何在不与任何 Kubernetes 对象关联的指标上扩展（例如，云消息传递服务中的队列长度，或者从集群外运行的 loadbalancer 中的 QPS）。
- 类型
-
object - 必填
-
metric -
target
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| MetricIdentifier 定义指标的名称和可选选择器 |
|
|
| MetricTarget 定义特定指标的目标值、平均值或平均利用率 |
10.2.1.14. .spec.metrics[].external.metric
- 描述
- MetricIdentifier 定义指标的名称和可选选择器
- 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是给定指标的名称 |
|
| 选择器是给定指标时的标准 kubernetes 标签选择器的字符串编码形式，它将作为额外的参数传递给指标服务器，以获取更具体的指标范围。如果未设置，只需使用 metricName 来收集指标。 |
10.2.1.15. .spec.metrics[].external.target
- 描述
- MetricTarget 定义特定指标的目标值、平均值或平均利用率
- 类型
-
object - 必填
-
type
-
10.2.1.16. .spec.metrics[].object
- 描述
- ObjectMetricSource 指明如何在描述 kubernetes 对象的指标上扩展（例如，Ingress 对象上的 hits-per-second）。
- 类型
-
object - 必填
-
describedObject -
target -
metric
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| CrossVersionObjectReference 包含足够信息，供您识别引用的资源。 |
|
|
| MetricIdentifier 定义指标的名称和可选选择器 |
|
|
| MetricTarget 定义特定指标的目标值、平均值或平均利用率 |
10.2.1.17. .spec.metrics[].object.describedObject
- 描述
- CrossVersionObjectReference 包含足够信息，供您识别引用的资源。
- 类型
-
object - 必填
-
kind -
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| apiVersion 是引用的 API 版本 |
|
|
| kind 是引用的类型；更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| name 是引用的名称 ; 更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
10.2.1.18. .spec.metrics[].object.metric
- 描述
- MetricIdentifier 定义指标的名称和可选选择器
- 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是给定指标的名称 |
|
| 选择器是给定指标时的标准 kubernetes 标签选择器的字符串编码形式，它将作为额外的参数传递给指标服务器，以获取更具体的指标范围。如果未设置，只需使用 metricName 来收集指标。 |
10.2.1.19. .spec.metrics[].object.target
- 描述
- MetricTarget 定义特定指标的目标值、平均值或平均利用率
- 类型
-
object - 必填
-
type
-
10.2.1.20. .spec.metrics[].pods
- 描述
- PodsMetricSource 指明了如何在一个指标上扩展，描述当前扩展目标中的每个 pod （如 transaction-processed-second）。在与目标值进行比较前，这些值将平均化在一起。
- 类型
-
object - 必填
-
metric -
target
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| MetricIdentifier 定义指标的名称和可选选择器 |
|
|
| MetricTarget 定义特定指标的目标值、平均值或平均利用率 |
10.2.1.21. .spec.metrics[].pods.metric
- 描述
- MetricIdentifier 定义指标的名称和可选选择器
- 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是给定指标的名称 |
|
| 选择器是给定指标时的标准 kubernetes 标签选择器的字符串编码形式，它将作为额外的参数传递给指标服务器，以获取更具体的指标范围。如果未设置，只需使用 metricName 来收集指标。 |
10.2.1.22. .spec.metrics[].pods.target
- 描述
- MetricTarget 定义特定指标的目标值、平均值或平均利用率
- 类型
-
object - 必填
-
type
-
10.2.1.23. .spec.metrics[].resource
- 描述
- ResourceMetricSource 指示如何扩展 Kubernetes 的资源指标，如请求和限值中指定的资源指标，描述当前扩展目标中的每个 pod （如 CPU 或内存）。在与目标进行比较前，这些值将平均化在一起。此类指标内置在 Kubernetes 中，并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。应该只设置一个"target"类型。
- 类型
-
object - 必填
-
name -
target
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是问题的资源的名称。 |
|
|
| MetricTarget 定义特定指标的目标值、平均值或平均利用率 |
10.2.1.24. .spec.metrics[].resource.target
- 描述
- MetricTarget 定义特定指标的目标值、平均值或平均利用率
- 类型
-
object - 必填
-
type
-
10.2.1.25. .spec.scaleTargetRef
- 描述
- CrossVersionObjectReference 包含足够信息，供您识别引用的资源。
- 类型
-
object - 必填
-
kind -
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| apiVersion 是引用的 API 版本 |
|
|
| kind 是引用的类型；更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| name 是引用的名称 ; 更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
10.2.1.26. .status
- 描述
- HorizontalPodAutoscalerStatus 描述了 pod 横向自动扩展的当前状态。
- 类型
-
object - 必填
-
desiredReplicas
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 条件是此自动扩展扩展其目标所需的条件集合，指示是否满足这些条件。 |
|
|
| HorizontalPodAutoscalerCondition 描述了 HorizontalPodAutoscaler 在特定点的状态。 |
|
|
| currentMetrics 是此自动扩展器使用的指标的最后读取状态。 |
|
|
| MetricStatus 描述了单个指标的最后读取状态。 |
|
|
| currentReplicas 是此自动扩展管理的 pod 副本数，如自动扩展器的最后一个所示。 |
|
|
| desiredReplicas 是此自动扩展管理的 pod 所需的副本数，如自动扩展器计算的最后计算。 |
|
| lastScaleTime 是 HorizontalPodAutoscaler 最后一次扩展 pod 数量的时间，供自动扩展器用于控制 pod 数量更改的频率。 | |
|
|
| observedGeneration 是此自动扩展观察到的最新生成。 |
10.2.1.27. .status.conditions
- 描述
- 条件是此自动扩展扩展其目标所需的条件集合，指示是否满足这些条件。
- 类型
-
array
10.2.1.28. .status.conditions[]
- 描述
- HorizontalPodAutoscalerCondition 描述了 HorizontalPodAutoscaler 在特定点的状态。
- 类型
-
object - 必填
-
type -
status
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
| lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间 | |
|
|
| Message 是人类可读的解释，其中包含有关转换的详细信息 |
|
|
| reason 是条件最后一次转换的原因。 |
|
|
| status 是条件的状态(True, False, Unknown) |
|
|
| type 描述了当前条件 |
10.2.1.29. .status.currentMetrics
- 描述
- currentMetrics 是此自动扩展器使用的指标的最后读取状态。
- 类型
-
数组
10.2.1.30. .status.currentMetrics[]
- 描述
- MetricStatus 描述了单个指标的最后读取状态。
- 类型
-
object - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| ContainerResourceMetricStatus 表示 Kubernetes 已知资源指标的当前值，如请求和限值中指定的资源指标，描述当前扩展目标中的每个 pod 中的单个容器（如 CPU 或内存）。此类指标内置在 Kubernetes 中，并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。 |
|
|
| ExternalMetricStatus 表示没有与任何 Kubernetes 对象关联的全局指标的当前值。 |
|
|
| ObjectMetricStatus 表示指标的当前值，描述 kubernetes 对象（如 Ingress 对象上的 hits-per-second）。 |
|
|
| PodsMetricStatus 表示指标的当前值，用于描述当前 scale 目标中的每个 pod （如 transaction-processed-second）。 |
|
|
| ResourceMetricStatus 表示 Kubernetes 已知的资源指标的当前值，如请求和限值中指定的，描述当前扩展目标中的每个 pod （如 CPU 或内存）。此类指标内置在 Kubernetes 中，并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。 |
|
|
| type 是指标源的类型。它将是 "ContainerResource", "External", "Object", "Pods" 或 "Resource" 之一，每个都对应于对象中的匹配字段。注："ContainerResource" 类型在启用了 feature-gate HPAContainerMetrics 时可用 |
10.2.1.31. .status.currentMetrics[].containerResource
- 描述
- ContainerResourceMetricStatus 表示 Kubernetes 已知资源指标的当前值，如请求和限值中指定的资源指标，描述当前扩展目标中的每个 pod 中的单个容器（如 CPU 或内存）。此类指标内置在 Kubernetes 中，并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。
- 类型
-
object - 必填
-
name -
current -
container
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Container 是扩展目标 pod 中的容器的名称 |
|
|
| MetricValueStatus 包含指标的当前值 |
|
|
| name 是问题的资源的名称。 |
- 描述
- MetricValueStatus 包含指标的当前值
- 类型
-
object
10.2.1.33. .status.currentMetrics[].external
- 描述
- ExternalMetricStatus 表示没有与任何 Kubernetes 对象关联的全局指标的当前值。
- 类型
-
object - 必填
-
metric -
current
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| MetricValueStatus 包含指标的当前值 |
|
|
| MetricIdentifier 定义指标的名称和可选选择器 |
10.2.1.34. .status.currentMetrics[].external.current
- 描述
- MetricValueStatus 包含指标的当前值
- 类型
-
object
10.2.1.35. .status.currentMetrics[].external.metric
- 描述
- MetricIdentifier 定义指标的名称和可选选择器
- 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是给定指标的名称 |
|
| 选择器是给定指标时的标准 kubernetes 标签选择器的字符串编码形式，它将作为额外的参数传递给指标服务器，以获取更具体的指标范围。如果未设置，只需使用 metricName 来收集指标。 |
10.2.1.36. .status.currentMetrics[].object
- 描述
- ObjectMetricStatus 表示指标的当前值，描述 kubernetes 对象（如 Ingress 对象上的 hits-per-second）。
- 类型
-
object - 必填
-
metric -
current -
describedObject
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| MetricValueStatus 包含指标的当前值 |
|
|
| CrossVersionObjectReference 包含足够信息，供您识别引用的资源。 |
|
|
| MetricIdentifier 定义指标的名称和可选选择器 |
10.2.1.37. .status.currentMetrics[].object.current
- 描述
- MetricValueStatus 包含指标的当前值
- 类型
-
object
- 描述
- CrossVersionObjectReference 包含足够信息，供您识别引用的资源。
- 类型
-
object - 必填
-
kind -
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| apiVersion 是引用的 API 版本 |
|
|
| kind 是引用的类型；更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| name 是引用的名称 ; 更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
10.2.1.39. .status.currentMetrics[].object.metric
- 描述
- MetricIdentifier 定义指标的名称和可选选择器
- 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是给定指标的名称 |
|
| 选择器是给定指标时的标准 kubernetes 标签选择器的字符串编码形式，它将作为额外的参数传递给指标服务器，以获取更具体的指标范围。如果未设置，只需使用 metricName 来收集指标。 |
10.2.1.40. .status.currentMetrics[].pods
- 描述
- PodsMetricStatus 表示指标的当前值，用于描述当前 scale 目标中的每个 pod （如 transaction-processed-second）。
- 类型
-
object - 必填
-
metric -
current
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| MetricValueStatus 包含指标的当前值 |
|
|
| MetricIdentifier 定义指标的名称和可选选择器 |
10.2.1.41. .status.currentMetrics[].pods.current
- 描述
- MetricValueStatus 包含指标的当前值
- 类型
-
object
10.2.1.42. .status.currentMetrics[].pods.metric
- 描述
- MetricIdentifier 定义指标的名称和可选选择器
- 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是给定指标的名称 |
|
| 选择器是给定指标时的标准 kubernetes 标签选择器的字符串编码形式，它将作为额外的参数传递给指标服务器，以获取更具体的指标范围。如果未设置，只需使用 metricName 来收集指标。 |
10.2.1.43. .status.currentMetrics[].resource
- 描述
- ResourceMetricStatus 表示 Kubernetes 已知的资源指标的当前值，如请求和限值中指定的，描述当前扩展目标中的每个 pod （如 CPU 或内存）。此类指标内置在 Kubernetes 中，并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。
- 类型
-
object - 必填
-
name -
current
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| MetricValueStatus 包含指标的当前值 |
|
|
| name 是问题的资源的名称。 |
10.2.1.44. .status.currentMetrics[].resource.current
- 描述
- MetricValueStatus 包含指标的当前值
- 类型
-
object
10.2.2. API 端点
可用的 API 端点如下：
/apis/autoscaling/v2/horizontalpodautoscalers-
GET: 列出或监视类型为 HorizontalPodAutoscaler 的对象
-
/apis/autoscaling/v2/watch/horizontalpodautoscalers-
GET: 观察单个对 HorizontalPodAutoscaler 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers-
DELETE：删除 HorizontalPodAutoscaler 的集合 -
GET: 列出或监视类型为 HorizontalPodAutoscaler 的对象 -
POST：创建一个 HorizontalPodAutoscaler
-
/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers-
GET: 观察单个对 HorizontalPodAutoscaler 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}-
DELETE：删除 HorizontalPodAutoscaler -
GET: 读取指定的 HorizontalPodAutoscaler -
PATCH：部分更新指定的 HorizontalPodAutoscaler -
PUT：替换指定的 HorizontalPodAutoscaler
-
/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}-
GET: 观察对类型为 HorizontalPodAutoscaler 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status-
GET: 指定的 HorizontalPodAutoscaler 的读取状态 -
PATCH：部分更新指定 HorizontalPodAutoscaler 的状态 -
PUT：替换指定 HorizontalPodAutoscaler 的状态
-
10.2.2.1. /apis/autoscaling/v2/horizontalpodautoscalers
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出或监视 HorizontalPodAutoscaler 类型的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 HorizontalPodAutoscaler 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 HorizontalPodAutoscaler 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视 HorizontalPodAutoscaler 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 HorizontalPodAutoscaler
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 HorizontalPodAutoscaler 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HorizontalPodAutoscaler 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- delete a HorizontalPodAutoscaler
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 阅读指定的 HorizontalPodAutoscaler
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 HorizontalPodAutoscaler
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 HorizontalPodAutoscaler
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HorizontalPodAutoscaler 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察对 kind HorizontalPodAutoscaler 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HorizontalPodAutoscaler 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 HorizontalPodAutoscaler 的读取状态
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 指定 HorizontalPodAutoscaler 的部分更新状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 HorizontalPodAutoscaler 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
10.3. scale [autoscaling/v1]
- 描述
- scale 代表资源的扩展请求。
- 类型
-
对象
10.3.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据；更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata。 | |
|
|
| ScaleSpec 描述 scale 子资源的属性。 |
|
|
| ScaleStatus 代表 scale 子资源的当前状态。 |
10.3.1.1. .spec
- 描述
- ScaleSpec 描述 scale 子资源的属性。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| replicas 是扩展对象的所需实例数量。 |
10.3.1.2. .status
- 描述
- ScaleStatus 代表 scale 子资源的当前状态。
- 类型
-
object - 必填
-
replicas
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| replicas 是扩展对象的观察实例的实际数量。 |
|
|
| selector 是 pod 的标签查询，应与副本数匹配。这与标签选择器相同，但使用字符串格式以避免客户端内省。字符串的格式与 query-param 语法相同。有关标签选择器的更多信息 ：https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
10.3.2. API 端点
可用的 API 端点如下：
/apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale-
GET：指定 Deployment 的读取扩展 -
PATCH：部分更新指定的部署扩展 -
PUT：替换指定部署的规模
-
/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale-
GET：指定 ReplicaSet 的读取扩展 -
PATCH：部分更新指定 ReplicaSet 的扩展 -
PUT：替换指定 ReplicaSet 的扩展
-
/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale-
GET：指定 StatefulSet 的读取扩展 -
PATCH：部分更新指定 StatefulSet 的扩展 -
PUT：替换指定 StatefulSet 的扩展
-
/api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale-
GET：指定 ReplicationController 的读取扩展 -
PATCH：部分更新指定的 ReplicationController 的扩展 -
PUT：替换指定 ReplicationController 的扩展
-
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 扩展的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定部署的读取扩展
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 指定部署的部分更新扩展
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
- HTTP 方法
-
PUT - 描述
- 替换指定 Deployment 的扩展
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 扩展的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 ReplicaSet 的读取扩展
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 指定 ReplicaSet 的部分更新扩展
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
- HTTP 方法
-
PUT - 描述
- 替换指定 ReplicaSet 的扩展
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 扩展的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 StatefulSet 的读取扩展
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 指定 StatefulSet 的部分更新扩展
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
- HTTP 方法
-
PUT - 描述
- 替换指定 StatefulSet 的扩展
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 扩展的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 读取指定的 ReplicationController 的扩展
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 ReplicationController 的扩展
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
- HTTP 方法
-
PUT - 描述
- 替换指定 ReplicationController 的规模
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
第 11 章 批处理 API
11.1. 批处理 API
11.1.1. CronJob [batch/v1]
- 描述
- CronJob 代表单个 cron 作业的配置。
- 类型
-
object
11.1.2. 作业 [batch/v1]
- 描述
- Job 代表单个作业的配置。
- 类型
-
object
11.2. CronJob [batch/v1]
- 描述
- CronJob 代表单个 cron 作业的配置。
- 类型
-
对象
11.2.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| CronJobSpec 描述了作业执行如何样子以及实际运行的时间。 |
|
|
| CronJobStatus 代表 cron 作业的当前状态。 |
11.2.1.1. .spec
- 描述
- CronJobSpec 描述了作业执行如何样子以及实际运行的时间。
- 类型
-
object - 必填
-
调度 -
jobTemplate
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 指定如何对待作业的并发执行。有效值为： - "allow" （默认）：允许 CronJob 同时运行； - "Forbid": forbids 并发运行，如果上一个运行尚未完成，则跳过下一个运行；- "Replace": 取消当前运行的作业并将其替换为新作业
可能枚举值： - |
|
|
| 要保留的失败完成作业数量。值必须是非负整数。默认为 1。 |
|
|
| JobTemplateSpec 描述了从模板创建时作业应具有的数据 |
|
|
| Cron 格式的调度，请参阅 https://en.wikipedia.org/wiki/Cron。 |
|
|
| 如果因任何原因而错过调度时间，则启动该作业的可选期限（以秒为单位）。错过的作业执行计为失败的作业。 |
|
|
| 要保留的成功完成作业数量。值必须是非负整数。默认值为 3。 |
|
|
| 此标志告知控制器挂起后续执行，它不适用于已经开始的执行。默认为false。 |
|
|
| 给定调度的时区名称，请参阅 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones。如果没有指定，则默认为 kube-controller-manager 进程的时区。在 CronJob 验证和控制器管理器期间，有效时区名称和时区偏移从 API 服务器的系统范围的时区数据库加载。如果没有系统范围的时区数据库，则可以使用捆绑的数据库版本。如果时区名称在 CronJob 的生命周期内无效，或者因为主机配置中发生了变化，控制器将停止创建新作业，并创建一个原因为 UnknownTimeZone 的系统事件。如需更多信息，请参阅 https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones |
11.2.1.2. .spec.jobTemplate
- 描述
- JobTemplateSpec 描述了从模板创建时作业应具有的数据
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 标准对象从该模板创建的作业元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| JobSpec 描述了作业执行如何。 |
11.2.1.3. .spec.jobTemplate.spec
- 描述
- JobSpec 描述了作业执行如何。
- 类型
-
object - 必填
-
模板
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 指定与 startTime 相对的持续时间（以秒为单位），在系统尝试终止前可以持续激活；值必须是正整数。如果作业被暂停（创建或通过更新），在作业再次恢复时，此计时器将有效停止并重置。 |
|
|
| 指定在标记此作业失败前的重试次数。默认值为 6 |
|
|
|
completionMode 指定 Pod 的完成情况。它可以是
以后可以添加更多完成模式。如果作业控制器观察一个没有识别的模式，则在升级过程中会因为版本偏移而可能，控制器会跳过该作业的更新。
可能的值有： - |
|
|
| 指定作业应使用的成功完成 pod 数量。设置为 null 表示任何 pod 的成功表示所有 pod 的成功，并允许并行具有任何正值。设置为 1 表示并行性仅限于 1，并且该 pod 的成功表示作业成功。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
|
|
|
manualSelector 控制 pod 标签和 pod 选择器的生成。请保留 |
|
|
| 指定作业应在任意给定时间运行的最大 pod 数量。当((.spec.completions - .status.successful)< .spec.parallelism)< .spec.parallelism）时，以 steady 状态运行的 pod 数量将小于这个数字。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
|
|
| PodFailurePolicy 描述了 pod 失败的 pod 如何影响 backoffLimit。 |
|
| 对 pod 数量应该匹配的 pod 的标签查询。通常，系统会为您设置此字段。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | |
|
|
| suspend 指定作业控制器是否应该创建 Pod。如果创建了作业，并将 suspend 设置为 true，则作业控制器不会创建任何 Pod。如果在创建后作业被暂停（例如，标志从 false 变为 true），则作业控制器将删除与此作业关联的所有活跃 Pod。用户必须设计其工作负载才能正常处理此问题。暂停作业将重置作业的 StartTime 字段，从而有效地重置 ActiveDeadlineSeconds 计时器。默认为false。 |
|
| 描述在执行作业时创建的 pod。唯一允许的 template.spec.restartPolicy 值为 "Never" 或 "OnFailure"。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | |
|
|
| ttlSecondsAfterFinished 限制已完成执行的作业的生命周期( Complete 或 Failed)。如果设置了此字段，在作业完成后，ttlSecondsAfterFinished 会被自动删除。当作业被删除时，其生命周期保证（如终结器）将会被遵守。如果此字段未设置，则作业不会被自动删除。如果此字段设为零，则作业在完成后立即被删除。 |
11.2.1.4. .spec.jobTemplate.spec.podFailurePolicy
- 描述
- PodFailurePolicy 描述了 pod 失败的 pod 如何影响 backoffLimit。
- 类型
-
object - 必填
-
rules
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Pod 失败策略规则列表。规则按顺序评估。当规则与 Pod 失败时，会忽略其余的规则。如果没有规则与 Pod 失败匹配，则应用默认处理 - pod 故障计数器会递增，并根据 backoffLimit 检查。最多允许 20 个元素。 |
|
|
| PodFailurePolicyRule 描述了在满足要求时如何处理 pod 失败。每个规则都可以使用 onExitCodes 和 onPodConditions 中的一个。 |
11.2.1.5. .spec.jobTemplate.spec.podFailurePolicy.rules
- 描述
- Pod 失败策略规则列表。规则按顺序评估。当规则与 Pod 失败时，会忽略其余的规则。如果没有规则与 Pod 失败匹配，则应用默认处理 - pod 故障计数器会递增，并根据 backoffLimit 检查。最多允许 20 个元素。
- 类型
-
数组
- 描述
- PodFailurePolicyRule 描述了在满足要求时如何处理 pod 失败。每个规则都可以使用 onExitCodes 和 onPodConditions 中的一个。
- 类型
-
object - 必填
-
action -
onPodConditions
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 指定在满足要求时对 pod 失败执行的操作。可能的值有： - FailJob: 表示 pod 的作业标记为 Failed，所有正在运行的 pod 都被终止。- Ignore: 表示与 .backoffLimit 相关的计数器没有被递增，并创建了替换 pod。- Count: 表示 pod 以默认处理 - .backoffLimit 的计数器递增。以后会考虑添加其他值。客户端应通过跳过规则来响应未知操作。
possible enum value: - |
|
|
| PodFailurePolicyOnExitCodesRequirement 描述了根据容器退出代码处理失败的 pod 的要求。特别是，它会为每个应用程序容器和 init 容器状态查找 .state.terminated.exitCode，分别由 Pod 状态中的 .status.containerStatuses 和 .status.initContainerStatuses 字段表示。使用成功(exit code 0)完成的容器不包括在要求检查中。 |
|
|
| 代表 pod 条件的要求。要求以 pod 条件模式列表表示。如果至少有一个模式匹配实际 pod 条件，则需要满足要求。最多允许 20 个元素。 |
|
|
| PodFailurePolicyOnPodConditionsPattern 描述与实际 pod 条件类型匹配的模式。 |
- 描述
- PodFailurePolicyOnExitCodesRequirement 描述了根据容器退出代码处理失败的 pod 的要求。特别是，它会为每个应用程序容器和 init 容器状态查找 .state.terminated.exitCode，分别由 Pod 状态中的 .status.containerStatuses 和 .status.initContainerStatuses 字段表示。使用成功(exit code 0)完成的容器不包括在要求检查中。
- 类型
-
object - 必填
-
operator -
values
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 使用指定名称将退出代码限制为容器的检查。当 null 时，该规则适用于所有容器。指定后，它应当与 pod 模板中的一个容器或 initContainer 名称匹配。 |
|
|
| 表示容器退出代码和指定的值之间的关系。使用成功(exit code 0)完成的容器不包括在要求检查中。可能的值有： - in: 如果至少有一个容器退出代码（如果多个容器没有由"containerName'字段限制）限制了多个容器，则满足要求。- 如果至少一个容器退出代码（如果多个容器不受"containerName"字段限制），则满足要求。以后会考虑添加其他值。客户端应不满足要求来响应未知操作器。
possible enum 值： - |
|
|
| 指定一组值。每个返回的容器退出代码（如果有多个容器）都会针对与 Operator 相关的这组值进行检查。值列表必须排序，且不得包含重复值。值 '0' 不能用于 In operator。至少需要一个元素。最多允许 255 个元素。 |
- 描述
- 代表 pod 条件的要求。要求以 pod 条件模式列表表示。如果至少有一个模式匹配实际 pod 条件，则需要满足要求。最多允许 20 个元素。
- 类型
-
数组
- 描述
- PodFailurePolicyOnPodConditionsPattern 描述与实际 pod 条件类型匹配的模式。
- 类型
-
object - 必填
-
type -
status
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 指定所需的 Pod 条件状态。要匹配 pod 条件，需要指定状态等于 pod 条件状态。默认值为 True。 |
|
|
| 指定所需的 Pod 条件类型。要匹配 pod 条件，需要指定类型等于 pod 条件类型。 |
11.2.1.10. .status
- 描述
- CronJobStatus 代表 cron 作业的当前状态。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 到当前运行的作业的指针列表。 | |
|
| 当作业最后一次调度作业的时间时的信息。 | |
|
| 作业最后一次完成后的信息。 |
11.2.2. API 端点
可用的 API 端点如下：
/apis/batch/v1/cronjobs-
GET: 列表或监视类型为 CronJob 的对象
-
/apis/batch/v1/watch/cronjobs-
GET: 观察单个对 CronJob 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/batch/v1/namespaces/{namespace}/cronjobs-
DELETE：删除 CronJob 的集合 -
GET: 列表或监视类型为 CronJob 的对象 -
POST：创建 CronJob
-
/apis/batch/v1/watch/namespaces/{namespace}/cronjobs-
GET: 观察单个对 CronJob 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/batch/v1/namespaces/{namespace}/cronjobs/{name}-
DELETE：删除 CronJob -
GET: 读取指定的 CronJob -
PATCH：部分更新指定的 CronJob -
PUT：替换指定的 CronJob
-
/apis/batch/v1/watch/namespaces/{namespace}/cronjobs/{name}-
GET: 观察对类型为 CronJob 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
/apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status-
GET: 指定 CronJob 的读取状态 -
PATCH：部分更新指定 CronJob 的状态 -
PUT：替换指定 CronJob 的状态
-
11.2.2.1. /apis/batch/v1/cronjobs
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 CronJob 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
11.2.2.2. /apis/batch/v1/watch/cronjobs
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 CronJob 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
11.2.2.3. /apis/batch/v1/namespaces/{namespace}/cronjobs
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 CronJob 的集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 CronJob 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
POST - 描述
- 创建 CronJob
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 CronJob 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| CronJob 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 CronJob
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 读取指定的 CronJob
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 CronJob
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
- HTTP 方法
-
PUT - 描述
- 替换指定的 CronJob
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| CronJob 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 监视对类型为 CronJob 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| CronJob 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 CronJob 的读取状态
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PATCH - 描述
- 指定 CronJob 的部分更新状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
- HTTP 方法
-
PUT - 描述
- 替换指定 CronJob 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
11.3. 作业 [batch/v1]
- 描述
- Job 代表单个作业的配置。
- 类型
-
对象
11.3.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| JobSpec 描述了作业执行如何。 |
|
|
| JobStatus 代表作业的当前状态。 |
11.3.1.1. .spec
- 描述
- JobSpec 描述了作业执行如何。
- 类型
-
object - 必填
-
模板
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 指定与 startTime 相对的持续时间（以秒为单位），在系统尝试终止前可以持续激活；值必须是正整数。如果作业被暂停（创建或通过更新），在作业再次恢复时，此计时器将有效停止并重置。 |
|
|
| 指定在标记此作业失败前的重试次数。默认值为 6 |
|
|
|
completionMode 指定 Pod 的完成情况。它可以是
以后可以添加更多完成模式。如果作业控制器观察一个没有识别的模式，则在升级过程中会因为版本偏移而可能，控制器会跳过该作业的更新。
可能的值有： - |
|
|
| 指定作业应使用的成功完成 pod 数量。设置为 null 表示任何 pod 的成功表示所有 pod 的成功，并允许并行具有任何正值。设置为 1 表示并行性仅限于 1，并且该 pod 的成功表示作业成功。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
|
|
|
manualSelector 控制 pod 标签和 pod 选择器的生成。请保留 |
|
|
| 指定作业应在任意给定时间运行的最大 pod 数量。当((.spec.completions - .status.successful)< .spec.parallelism)< .spec.parallelism）时，以 steady 状态运行的 pod 数量将小于这个数字。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
|
|
| PodFailurePolicy 描述了 pod 失败的 pod 如何影响 backoffLimit。 |
|
| 对 pod 数量应该匹配的 pod 的标签查询。通常，系统会为您设置此字段。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | |
|
|
| suspend 指定作业控制器是否应该创建 Pod。如果创建了作业，并将 suspend 设置为 true，则作业控制器不会创建任何 Pod。如果在创建后作业被暂停（例如，标志从 false 变为 true），则作业控制器将删除与此作业关联的所有活跃 Pod。用户必须设计其工作负载才能正常处理此问题。暂停作业将重置作业的 StartTime 字段，从而有效地重置 ActiveDeadlineSeconds 计时器。默认为false。 |
|
| 描述在执行作业时创建的 pod。唯一允许的 template.spec.restartPolicy 值为 "Never" 或 "OnFailure"。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | |
|
|
| ttlSecondsAfterFinished 限制已完成执行的作业的生命周期( Complete 或 Failed)。如果设置了此字段，在作业完成后，ttlSecondsAfterFinished 会被自动删除。当作业被删除时，其生命周期保证（如终结器）将会被遵守。如果此字段未设置，则作业不会被自动删除。如果此字段设为零，则作业在完成后立即被删除。 |
11.3.1.2. .spec.podFailurePolicy
- 描述
- PodFailurePolicy 描述了 pod 失败的 pod 如何影响 backoffLimit。
- 类型
-
object - 必填
-
rules
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Pod 失败策略规则列表。规则按顺序评估。当规则与 Pod 失败时，会忽略其余的规则。如果没有规则与 Pod 失败匹配，则应用默认处理 - pod 故障计数器会递增，并根据 backoffLimit 检查。最多允许 20 个元素。 |
|
|
| PodFailurePolicyRule 描述了在满足要求时如何处理 pod 失败。每个规则都可以使用 onExitCodes 和 onPodConditions 中的一个。 |
11.3.1.3. .spec.podFailurePolicy.rules
- 描述
- Pod 失败策略规则列表。规则按顺序评估。当规则与 Pod 失败时，会忽略其余的规则。如果没有规则与 Pod 失败匹配，则应用默认处理 - pod 故障计数器会递增，并根据 backoffLimit 检查。最多允许 20 个元素。
- 类型
-
数组
11.3.1.4. .spec.podFailurePolicy.rules[]
- 描述
- PodFailurePolicyRule 描述了在满足要求时如何处理 pod 失败。每个规则都可以使用 onExitCodes 和 onPodConditions 中的一个。
- 类型
-
object - 必填
-
action -
onPodConditions
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 指定在满足要求时对 pod 失败执行的操作。可能的值有： - FailJob: 表示 pod 的作业标记为 Failed，所有正在运行的 pod 都被终止。- Ignore: 表示与 .backoffLimit 相关的计数器没有被递增，并创建了替换 pod。- Count: 表示 pod 以默认处理 - .backoffLimit 的计数器递增。以后会考虑添加其他值。客户端应通过跳过规则来响应未知操作。
possible enum value: - |
|
|
| PodFailurePolicyOnExitCodesRequirement 描述了根据容器退出代码处理失败的 pod 的要求。特别是，它会为每个应用程序容器和 init 容器状态查找 .state.terminated.exitCode，分别由 Pod 状态中的 .status.containerStatuses 和 .status.initContainerStatuses 字段表示。使用成功(exit code 0)完成的容器不包括在要求检查中。 |
|
|
| 代表 pod 条件的要求。要求以 pod 条件模式列表表示。如果至少有一个模式匹配实际 pod 条件，则需要满足要求。最多允许 20 个元素。 |
|
|
| PodFailurePolicyOnPodConditionsPattern 描述与实际 pod 条件类型匹配的模式。 |
11.3.1.5. .spec.podFailurePolicy.rules[].onExitCodes
- 描述
- PodFailurePolicyOnExitCodesRequirement 描述了根据容器退出代码处理失败的 pod 的要求。特别是，它会为每个应用程序容器和 init 容器状态查找 .state.terminated.exitCode，分别由 Pod 状态中的 .status.containerStatuses 和 .status.initContainerStatuses 字段表示。使用成功(exit code 0)完成的容器不包括在要求检查中。
- 类型
-
object - 必填
-
operator -
values
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 使用指定名称将退出代码限制为容器的检查。当 null 时，该规则适用于所有容器。指定后，它应当与 pod 模板中的一个容器或 initContainer 名称匹配。 |
|
|
| 表示容器退出代码和指定的值之间的关系。使用成功(exit code 0)完成的容器不包括在要求检查中。可能的值有： - in: 如果至少有一个容器退出代码（如果多个容器没有由"containerName'字段限制）限制了多个容器，则满足要求。- 如果至少一个容器退出代码（如果多个容器不受"containerName"字段限制），则满足要求。以后会考虑添加其他值。客户端应不满足要求来响应未知操作器。
possible enum 值： - |
|
|
| 指定一组值。每个返回的容器退出代码（如果有多个容器）都会针对与 Operator 相关的这组值进行检查。值列表必须排序，且不得包含重复值。值 '0' 不能用于 In operator。至少需要一个元素。最多允许 255 个元素。 |
11.3.1.6. .spec.podFailurePolicy.rules[].onPodConditions
- 描述
- 代表 pod 条件的要求。要求以 pod 条件模式列表表示。如果至少有一个模式匹配实际 pod 条件，则需要满足要求。最多允许 20 个元素。
- 类型
-
数组
- 描述
- PodFailurePolicyOnPodConditionsPattern 描述与实际 pod 条件类型匹配的模式。
- 类型
-
object - 必填
-
type -
status
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 指定所需的 Pod 条件状态。要匹配 pod 条件，需要指定状态等于 pod 条件状态。默认值为 True。 |
|
|
| 指定所需的 Pod 条件类型。要匹配 pod 条件，需要指定类型等于 pod 条件类型。 |
11.3.1.8. .status
- 描述
- JobStatus 代表作业的当前状态。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 待处理的并运行 pod 的数量。 |
|
|
| 当 .spec.completionMode = "Indexed" 以文本格式时，completedIndexes 包含已完成的索引。索引以十进制整数表示，用逗号分开。数字以递增的顺序列出。三个或更多连续的数字由系列的第一个和最后一个元素压缩，以连字符分开。例如，如果已完成的索引为 1、3、4、5 和 7，它们表示为 "1,3-5,7"。 |
|
| 表示作业完成时的时间。无法保证在单独的操作之间按顺序设置。它以 RFC3339 格式表示，并以 UTC 为单位。只有在作业成功完成时才会设置完成时间。 | |
|
|
| 对象当前状态的最新可用影响。当作业失败时，其中一个条件将类型为 "Failed" 和 status true。当作业暂停时，其中一个条件为"Suspended"和状态 true；当作业恢复时，此条件的状态将变为 false。当作业完成后，其中一个条件将键入 "Complete" 和 status true。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
|
|
| JobCondition 描述了作业的当前状态。 |
|
|
| 到达阶段失败的 pod 数量。 |
|
|
| 具有 Ready 条件的 pod 数量。 此字段是 beta 级。当启用功能门 JobReadyPods 时（默认启用）时，作业控制器会填充字段。 |
|
| 代表作业控制器开始处理作业时的时间。当作业以暂停状态创建时，在第一次恢复前不会设置此字段。每次作业从挂起中恢复时，都会重置此字段。它以 RFC3339 格式表示，并以 UTC 为单位。 | |
|
|
| 达到阶段 Succeeded 的 pod 数量。 |
|
|
| UncountedTerminatedPods 包含已终止但没有在作业状态计数器中考虑的 Pod 的 UID。 |
11.3.1.9. .status.conditions
- 描述
- 对象当前状态的最新可用影响。当作业失败时，其中一个条件将类型为 "Failed" 和 status true。当作业暂停时，其中一个条件为"Suspended"和状态 true；当作业恢复时，此条件的状态将变为 false。当作业完成后，其中一个条件将键入 "Complete" 和 status true。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
- 类型
-
array
11.3.1.10. .status.conditions[]
- 描述
- JobCondition 描述了作业的当前状态。
- 类型
-
object - 必填
-
type -
status
-
11.3.1.11. .status.uncountedTerminatedPods
- 描述
- UncountedTerminatedPods 包含已终止但没有在作业状态计数器中考虑的 Pod 的 UID。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 失败包含故障 Pod 的 UID。 |
|
|
| 成功包含成功 Pod 的 UID。 |
11.3.2. API 端点
可用的 API 端点如下：
/apis/batch/v1/jobs-
GET: 列出或监视类型为 Job 的对象
-
/apis/batch/v1/watch/jobs-
GET: 观察单个对作业列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/batch/v1/namespaces/{namespace}/jobs-
DELETE：删除作业集合 -
GET: 列出或监视类型为 Job 的对象 -
POST：创建作业
-
/apis/batch/v1/watch/namespaces/{namespace}/jobs-
GET: 观察单个对作业列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/batch/v1/namespaces/{namespace}/jobs/{name}-
DELETE：删除作业 -
GET: 读取指定的作业 -
PATCH：部分更新指定的作业 -
PUT：替换指定的作业
-
/apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}-
GET: 观察对 kind Job 对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
/apis/batch/v1/namespaces/{namespace}/jobs/{name}/status-
GET: 指定作业的读取状态 -
PATCH：部分更新指定作业的状态 -
PUT：替换指定作业的状态
-
11.3.2.1. /apis/batch/v1/jobs
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 Job 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
11.3.2.2. /apis/batch/v1/watch/jobs
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个作业列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
11.3.2.3. /apis/batch/v1/namespaces/{namespace}/jobs
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除作业集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 Job 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
POST - 描述
- 创建作业
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个作业列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 作业名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除作业
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 读取指定的作业
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的作业
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
- HTTP 方法
-
PUT - 描述
- 替换指定的作业
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 作业名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察对 kind Job 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 作业名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定作业的读取状态
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - 未授权 | 空 |
- HTTP 方法
-
PATCH - 描述
- 指定作业的部分更新状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
- HTTP 方法
-
PUT - 描述
- 替换指定作业的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
第 12 章 证书 API
12.1. 证书 API
- 描述
CertificateSigningRequest 对象提供了一种机制，可通过提交证书签名请求来获取 x509 证书，并使其异步批准并发出。
kubelet 使用此 API 获取： 1. 客户端证书向 kube-apiserver 进行身份验证（使用 "kubernetes.io/kube-apiserver-client-kubelet" signerName）。2. 为 TLS 端点提供证书 kube-apiserver 可以安全地连接到（使用 "kubernetes.io/kubelet-serving" signerName）。
此 API 可用于请求客户端证书向 kube-apiserver 进行身份验证（使用 "kubernetes.io/kube-apiserver-client" signerName），或者从自定义非 Kubernetes 签名器获取证书。
- 类型
-
对象
12.2. CertificateSigningRequest [certificates.k8s.io/v1]
- 描述
CertificateSigningRequest 对象提供了一种机制，可通过提交证书签名请求来获取 x509 证书，并使其异步批准并发出。
kubelet 使用此 API 获取： 1. 客户端证书向 kube-apiserver 进行身份验证（使用 "kubernetes.io/kube-apiserver-client-kubelet" signerName）。2. 为 TLS 端点提供证书 kube-apiserver 可以安全地连接到（使用 "kubernetes.io/kubelet-serving" signerName）。
此 API 可用于请求客户端证书向 kube-apiserver 进行身份验证（使用 "kubernetes.io/kube-apiserver-client" signerName），或者从自定义非 Kubernetes 签名器获取证书。
- 类型
-
object - 必填
-
spec
-
12.2.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| ||
|
|
| CertificateSigningRequestSpec 包含证书请求。 |
|
|
| CertificateSigningRequestStatus 包含用于指示请求批准/拒绝/失败状态的条件，以及发布的证书。 |
12.2.1.1. .spec
- 描述
- CertificateSigningRequestSpec 包含证书请求。
- 类型
-
object - 必填
-
Request （请求） -
signerName
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| expirationSeconds 是签发证书的请求的有效期。证书签名者可能会发布具有不同有效期持续时间的证书，因此客户端必须检查发布证书中的 notBefore 和 notAfter 字段之间的 delta，以确定实际持续时间。 只要请求的持续时间不超过 Kubernetes 控制器管理器的 --cluster-signing-duration CLI 标记，则 v1.22+ 的树内实现将遵循这个字段。 由于各种原因，证书签名者可能无法遵守此字段： 1. 在 v1.22）2 之前，旧的 signer 不知道字段（如 in-tree 实现）。配置的最大值小于请求持续时间 3 的签名者。配置最小值超过请求持续时间的签名者 expirationSeconds 的有效值为 600，即 10 分钟。 |
|
|
| extra 包含创建 CertificateSigningRequest 的用户的额外属性。在创建和不可变时由 API 服务器填充。 |
|
|
| |
|
|
| 组包含创建 CertificateSigningRequest 的用户的组成员资格。在创建和不可变时由 API 服务器填充。 |
|
|
| 请求包含以 "CERTIFICATE REQUEST" PEM 块中编码的 x509 证书签名请求。当序列化为 JSON 或 YAML 时，数据会额外采用 base64 编码。 |
|
|
| signerName 表示请求的签名者，是合格的名称。 list/watch 对 CertificateSigningRequests 的请求可以使用 "spec.signerName=NAME" fieldSelector 在此字段上过滤。 知名的 Kubernetes 符号是： 1. "kubernetes.io/kube-apiserver-client": 签发可用于向 kube-apiserver 进行身份验证的客户端证书。对这个 signer 的请求永远不会由 kube-controller-manager 自动批准，由 kube-controller-manager 中的 "csrsigning" 控制器发出。2. "Kubernetes.io/kube-apiserver-client-kubelet": 签发 kubelet 用来向 kube-apiserver 进行身份验证的客户端证书。对这个签名者的请求可由 kube-controller-manager 中的 "csrapproving" 控制器自动批准，并可以被 kube-controller-manager 中的 "csrsigning" 控制器发出。3. "Kubernetes.io/kubelet-serving" 问题为 kubelet 用来为 TLS 端点提供服务的证书，kube-apiserver 可以安全地连接。对这个 signer 的请求永远不会由 kube-controller-manager 自动批准，并可由 kube-controller-manager 中的 "csrsigning" 控制器发出。 详情请参考 https://k8s.io/docs/reference/access-authn-authz/certificate-signing-requests/#kubernetes-signers 也可以指定自定义 signerNames。签名人定义：1.信任分发：信任(CA 捆绑包)的分布方式。2.允许的主题：请求禁止的主题时的行为。3.请求中的必需、允许或禁止的 x509 扩展（包括是否允许 subjectAltNames，对允许的值的限制）以及请求禁止的扩展时的行为。4.必需、允许或禁止的密钥使用/扩展密钥使用情况。5.expiration/certificate 生命周期：它是否被签名者修复，由管理员进行配置。6.是否允许请求 CA 证书。 |
|
|
| UID 包含创建 CertificateSigningRequest 的用户的 uid。在创建和不可变时由 API 服务器填充。 |
|
|
| usages 指定在签发的证书中请求的一组密钥用法。 对 TLS 客户端证书的请求通常会请求："数字签名", "key encipherment", "client auth"。 对 TLS 服务证书的请求通常会请求："密钥加密", "数字签名", "server auth"。 有效值为："signing", "digital signature", "content commitment", "content commitment", "key encipherment", "key encipherment", "cert sign", "crl sign", "encipher only", "decipher only", "any", "server auth", "client auth", "code signing", "code signing", "电子邮件保护", "s/mime", "ipsec end system", "ipsec tunnel", "ipsec user", "timestamping", "ocsp signing", "microsoft sgc", "netscape sgc" |
|
|
| username 包含创建 CertificateSigningRequest 的用户的名称。在创建和不可变时由 API 服务器填充。 |
12.2.1.2. .spec.extra
- 描述
- extra 包含创建 CertificateSigningRequest 的用户的额外属性。在创建和不可变时由 API 服务器填充。
- 类型
-
对象
12.2.1.3. .status
- 描述
- CertificateSigningRequestStatus 包含用于指示请求批准/拒绝/失败状态的条件，以及发布的证书。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 在存在 Approved 条件后，证书由 signer 填充。此字段通过 /status 子资源设置。填充后，此字段不可变。 如果证书签名请求被拒绝，则会添加类型为 "Denied" 的条件，且此字段为空。如果签名者无法发布证书，则会添加类型为 "Failed" 的条件，且此字段为空。 验证要求： 1. 证书必须包含一个或多个 PEM 块。2.所有 PEM 块都必须具有"CERTIFICATE"标签，不包含标头，编码的数据必须是 BER 编码的 ASN.1 证书结构，如 RFC5280 节 4 所述。3.非PEM 内容可能会在 "CERTIFICATE" PEM 块之前或之后出现，且未验证，以允许解释的文本，如 RFC7468 的第 5.2 节中所述。 如果存在多个 PEM 块，并且请求的 spec.signerName 的定义没有指定，则第一个块是签发的证书，后续块应被视为中间证书，并在 TLS 握手中呈现。 证书以 PEM 格式编码。 当序列化为 JSON 或 YAML 时，数据会额外进行 base64 编码，因此它由以下组成： base64( -----BEGIN CERTIFICATE----- … -----END CERTIFICATE----- ) |
|
|
| 应用到请求的条件。已知条件为 "Approved", "Denied" 和 "Failed"。 |
|
|
| CertificateSigningRequestCondition 描述了 CertificateSigningRequest 对象的条件 |
12.2.1.4. .status.conditions
- 描述
- 应用到请求的条件。已知条件为 "Approved", "Denied" 和 "Failed"。
- 类型
-
array
12.2.1.5. .status.conditions[]
- 描述
- CertificateSigningRequestCondition 描述了 CertificateSigningRequest 对象的条件
- 类型
-
object - 必填
-
type -
status
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
| lastTransitionTime 是条件最后一次从一个状态转换到另一个状态的时间。如果未设置，当添加新条件类型或更改现有条件类型时，服务器会默认使用当前时间。 | |
|
| lastUpdateTime 是最后一次更新到此条件的时间 | |
|
|
| 消息包含人类可读的消息，其中包含有关请求状态的详细信息 |
|
|
| reason 表示请求状态的简短原因 |
|
|
| 条件的状态，True, False, Unknown 之一。批准、拒绝和失败条件可能不是"False"或"Unknown"。 |
|
|
| 条件的类型。已知条件为 "Approved", "Denied" 和 "Failed"。 通过 /approval 子资源添加"Approved"条件，表示请求已批准，并应由签名者发出。 通过 /approval 子资源添加"Denied"条件，表示请求被拒绝，不应由签名者发出。 通过 /status 子资源添加 "Failed" 条件，表示签名者无法发布证书。 批准和拒绝条件是互斥的。添加后，无法删除批准、拒绝和失败条件。 只允许给定类型的一个条件。 |
12.2.2. API 端点
可用的 API 端点如下：
/apis/certificates.k8s.io/v1/certificatesigningrequests-
DELETE：删除 CertificateSigningRequest 的集合 -
GET: 列出或监视类型为 CertificateSigningRequest 的对象 -
POST：创建一个 CertificateSigningRequest
-
/apis/certificates.k8s.io/v1/watch/certificatesigningrequests-
GET: 观察单个对 CertificateSigningRequest. deprecated 列表的更改。已弃用：使用 'watch' 参数和 list 操作。
-
/apis/certificates.k8s.io/v1/certificatesigningrequests/{name}-
DELETE：删除 CertificateSigningRequest -
GET：读取指定的 CertificateSigningRequest -
PATCH: 部分更新指定的 CertificateSigningRequest -
PUT：替换指定的 CertificateSigningRequest
-
/apis/certificates.k8s.io/v1/watch/certificatesigningrequests/{name}-
GET: 观察对类型为 CertificateSigningRequest. deprecated 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
/apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status-
GET: 指定的 CertificateSigningRequest 的读取状态 -
PATCH: 部分更新指定 CertificateSigningRequest 的状态 -
PUT：替换指定 CertificateSigningRequest 的状态
-
/apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval-
GET：读取指定 CertificateSigningRequest 的批准 -
PATCH：部分更新指定的 CertificateSigningRequest 的批准 -
PUT：替换指定 CertificateSigningRequest 的批准
-
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 CertificateSigningRequest 的集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 CertificateSigningRequest 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 CertificateSigningRequest
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个更改对 CertificateSigningRequest. deprecated 的列表：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| CertificateSigningRequest 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 CertificateSigningRequest
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 读取指定的 CertificateSigningRequest
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 CertificateSigningRequest
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 CertificateSigningRequest
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| CertificateSigningRequest 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察对 kind CertificateSigningRequest. deprecated 的对象更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| CertificateSigningRequest 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 CertificateSigningRequest 的读取状态
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 指定 CertificateSigningRequest 的部分更新状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 CertificateSigningRequest 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| CertificateSigningRequest 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 读取指定 CertificateSigningRequest 的批准
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 CertificateSigningRequest 的批准
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 CertificateSigningRequest 的批准
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
第 13 章 协调 API
13.1. 协调 API
13.1.1. lease [coordination.k8s.io/v1]
- 描述
- 租期定义了租期概念。
- 类型
-
对象
13.2. lease [coordination.k8s.io/v1]
- 描述
- 租期定义了租期概念。
- 类型
-
对象
13.2.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| LeaseSpec 是租用的规范。 |
13.2.1.1. .spec
- 描述
- LeaseSpec 是租用的规范。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
| acquireTime 是获取当前租期的时间。 | |
|
|
| holderIdentity 包含当前租期的拥有者的身份。 |
|
|
| leaseDurationSeconds 是租期的候选者需要等待强制获取它的时间。这是根据最后观察到的 renewTime 的时间进行测量。 |
|
|
| leaseTransitions 是拥有者之间租期的转换数量。 |
|
| renewTime 是租期的当前拥有者最近更新租期的时间。 |
13.2.2. API 端点
可用的 API 端点如下：
/apis/coordination.k8s.io/v1/leases-
GET: 列出或监视类型为 Lease 的对象
-
/apis/coordination.k8s.io/v1/watch/leases-
GET: 观察单个对 Lease 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/coordination.k8s.io/v1/namespaces/{namespace}/leases-
DELETE：删除 Lease 集合 -
GET: 列出或监视类型为 Lease 的对象 -
POST：创建一个 Lease
-
/apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases-
GET: 观察单个对 Lease 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}-
DELETE：删除 Lease -
GET：读取指定的 Lease -
PATCH：部分更新指定的 Lease -
PUT：替换指定的 Lease
-
/apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}-
GET: 观察对类型为 Lease 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
13.2.2.1. /apis/coordination.k8s.io/v1/leases
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 Lease 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
13.2.2.2. /apis/coordination.k8s.io/v1/watch/leases
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 Lease 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 Lease 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 Lease 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 Lease
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 Lease 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| Lease 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除一个 Lease
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 读取指定的 Lease
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 Lease
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
- HTTP 方法
-
PUT - 描述
- 替换指定的 Lease
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| Lease 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察对 kind Lease. deprecated 的对象更改：使用 'watch' 参数和 list 操作，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
第 14 章 核心 API
14.1. 核心 API
14.1.1. 绑定 [v1]
- 描述
- 绑定将一个对象绑定到另一个对象；例如，pod 由调度程序绑定到节点。在 1.7 中弃用了，请使用 pods 的 bindings 子资源。
- 类型
-
对象
14.1.2. ComponentStatus [v1]
- 描述
- ComponentStatus （和 ComponentStatusList）包含集群验证信息。弃用：此 API 在 v1.19+ 中弃用
- 类型
-
对象
14.1.3. ConfigMap [v1]
- 描述
- ConfigMap 包含要使用的 pod 的配置数据。
- 类型
-
对象
14.1.4. Endpoints [v1]
- 描述
端点是实现实际服务的端点集合。Example:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 类型
-
对象
14.1.5. Event [v1]
- 描述
- 事件是集群中某一位置的事件报告。事件具有有限的保留时间和触发器，消息可能会随时间而演进。事件消费者不应依赖给定 Reason 反映一致的底层触发器的事件的时间，或者该 Reason 持续存在事件的时间。事件应被视为 informative, best-effort, supplemental 数据。
- 类型
-
对象
14.1.6. LimitRange [v1]
- 描述
- LimitRange 为命名空间中的每种资源设置资源使用量限制。
- 类型
-
对象
14.1.7. 命名空间 [v1]
- 描述
- namespace 为 Names 提供范围。使用多个命名空间是可选的。
- 类型
-
对象
14.1.8. 节点 [v1]
- 描述
- 节点是 Kubernetes 中的 worker 节点。每个节点在缓存中都有一个唯一标识符（例如在 etcd 中）。
- 类型
-
object
14.1.9. PersistentVolume [v1]
- 描述
- PersistentVolume (PV)是管理员置备的存储资源。它类似于节点。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes
- 类型
-
object
14.1.10. PersistentVolumeClaim [v1]
- 描述
- PersistentVolumeClaim 是用户对持久性卷的请求并声明
- 类型
-
object
14.1.11. Pod [v1]
- 描述
- Pod 是可以在主机上运行的容器的集合。此资源由客户端创建，并调度到主机上。
- 类型
-
object
14.1.12. PodTemplate [v1]
- 描述
- PodTemplate 描述用于创建预定义 pod 副本的模板。
- 类型
-
object
14.1.13. ReplicationController [v1]
- 描述
- ReplicationController 代表复制控制器的配置。
- 类型
-
对象
14.1.14. ResourceQuota [v1]
- 描述
- ResourceQuota 设置每个命名空间强制的聚合配额限制
- 类型
-
对象
14.1.15. Secret [v1]
- 描述
- secret 包含特定类型的 secret 数据。Data 字段中值的总字节数必须小于 MaxSecretSize 字节。
- 类型
-
对象
14.1.16. Service [v1]
- 描述
- 服务是软件服务的命名抽象（例如，mysql）由本地端口（如 3306）组成，以及代理侦听的选择器，决定哪些 pod 将回答通过代理发送的请求。
- 类型
-
对象
14.1.17. ServiceAccount [v1]
- 描述
- ServiceAccount 将一个名称绑定在一起：一个名称，用户理解，可能由外部系统理解，对于一个身份，可以验证并授权了一组 secret 的主体。
- 类型
-
对象
14.2. 绑定 [v1]
- 描述
- 绑定将一个对象绑定到另一个对象；例如，pod 由调度程序绑定到节点。在 1.7 中弃用了，请使用 pods 的 bindings 子资源。
- 类型
-
object - 必填
-
target
-
14.2.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| ObjectReference 包含足够信息供您检查或修改引用的对象。 |
14.2.1.1. .target
- 描述
- ObjectReference 包含足够信息供您检查或修改引用的对象。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 引用的 API 版本。 |
|
|
| 如果引用的是对象的一部分而非整个对象，则该字符串应包含有效的 JSON/Go 字段访问声明，如 desiredState.manifest.containers[2]。例如，如果对象引用是一个 pod 中的容器，它应该还以下类似： "spec.containers{name}"（其中 "name" 是指触发事件的容器的名称）,如果不使用容器名称，则应类似于 "spec.containers[2]"（使用此 pod 中索引值为 2 的容器）。选择这个语法的原因是，为了有一些指向对象部分的正确定义方法。 |
|
|
| 引用的类型。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 引用的命名空间。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| 指定构成这个引用的 resourceVersion（如果存在）。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| 引用的 UID。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
14.2.2. API 端点
可用的 API 端点如下：
/api/v1/namespaces/{namespace}/bindings-
POST：创建绑定
-
/api/v1/namespaces/{namespace}/pods/{name}/binding-
POST：创建 Pod 的绑定
-
14.2.2.1. /api/v1/namespaces/{namespace}/bindings
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
POST - 描述
- 创建绑定
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 绑定的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
POST - 描述
- 创建 Pod 的绑定
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
14.3. ComponentStatus [v1]
- 描述
- ComponentStatus （和 ComponentStatusList）包含集群验证信息。弃用：此 API 在 v1.19+ 中弃用
- 类型
-
对象
14.3.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| 观察到的组件条件列表 |
|
|
| 有关组件条件的信息。 |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
14.3.1.1. .conditions
- 描述
- 观察到的组件条件列表
- 类型
-
array
14.3.1.2. .conditions[]
- 描述
- 有关组件条件的信息。
- 类型
-
object - 必填
-
type -
status
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组件的错误代码。例如，健康检查错误代码。 |
|
|
| 有关组件条件的信息。例如，关于健康检查的信息。 |
|
|
| 组件条件的状态。"Healthy": "True", "False", 或 "Unknown" 的有效值。 |
|
|
| 组件的条件类型。有效值："Healthy" |
14.3.2. API 端点
可用的 API 端点如下：
/api/v1/componentstatuses-
GET: 列出 kind ComponentStatus 的对象
-
/api/v1/componentstatuses/{name}-
GET: 读取指定的 ComponentStatus
-
14.3.2.1. /api/v1/componentstatuses
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出 kind componentStatus 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
14.3.2.2. /api/v1/componentstatuses/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 组件状态的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 读取指定的 componentStatus
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
14.4. ConfigMap [v1]
- 描述
- ConfigMap 包含要使用的 pod 的配置数据。
- 类型
-
对象
14.4.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| binaryData 包含二进制数据。每个键都必须包含字母数字字符、'-'、'_' 或 '.'。binaryData 可以包含不在 UTF-8 范围内的字节序列。存储在 BinaryData 中的密钥不得与 Data 字段中的重叠，这在验证过程中强制执行。使用此字段将需要 1.10+ apiserver 和 kubelet。 |
|
|
| 数据包含配置数据。每个键都必须包含字母数字字符、'-'、'_' 或 '.'。具有非 UTF-8 字节序列的值必须使用 BinaryData 字段。存储在 Data 中的密钥不得与 BinaryData 字段中的密钥重叠，这在验证过程中强制执行。 |
|
|
| immutable，如果设为 true，则确保 ConfigMap 中存储的数据无法更新（只能修改对象元数据）。如果没有设置 true，则可以随时修改该字段。默认为 nil。 |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
14.4.2. API 端点
可用的 API 端点如下：
/api/v1/configmaps-
GET: 列出或监视类型为 ConfigMap 的对象
-
/api/v1/watch/configmaps-
GET: 观察单个对 ConfigMap 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/api/v1/namespaces/{namespace}/configmaps-
DELETE：删除 ConfigMap 的集合 -
GET: 列出或监视类型为 ConfigMap 的对象 -
POST：创建 ConfigMap
-
/api/v1/watch/namespaces/{namespace}/configmaps-
GET: 观察单个对 ConfigMap 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/api/v1/namespaces/{namespace}/configmaps/{name}-
DELETE：删除 ConfigMap -
GET: 读取指定的 ConfigMap -
PATCH：部分更新指定的 ConfigMap -
PUT：替换指定的 ConfigMap
-
/api/v1/watch/namespaces/{namespace}/configmaps/{name}-
GET: 观察对类型为 ConfigMap 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
14.4.2.1. /api/v1/configmaps
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 ConfigMap 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
14.4.2.2. /api/v1/watch/configmaps
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 ConfigMap 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
14.4.2.3. /api/v1/namespaces/{namespace}/configmaps
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 ConfigMap 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 ConfigMap 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 ConfigMap
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 ConfigMap 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ConfigMap 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 ConfigMap
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 读取指定的 ConfigMap
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 ConfigMap
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 ConfigMap
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ConfigMap 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察对类型为 ConfigMap 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
14.5. Endpoints [v1]
- 描述
端点是实现实际服务的端点集合。Example:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 类型
-
对象
14.5.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| 所有端点的集合都是所有子集的合并。地址按照其共享的 IP 放入子集中。具有多个端口的单个地址，其中一些已就绪，并且其中一些未就绪（因为它们来自不同的容器）将导致地址显示在不同端口的不同子集中。没有地址出现在同一子集中的 Addresses 和 NotReadyAddresses 中。组成服务的地址和端口集合。 |
|
|
| EndpointSubset 是一组带有一组常用端口的地址。扩展的端点集合是 Cartesian 产品，即 Addresses x Ports。例如，给定： { address: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] } 生成的端点集可视为： 答： [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ] |
14.5.1.1. .subsets
- 描述
- 所有端点的集合都是所有子集的合并。地址按照其共享的 IP 放入子集中。具有多个端口的单个地址，其中一些已就绪，并且其中一些未就绪（因为它们来自不同的容器）将导致地址显示在不同端口的不同子集中。没有地址出现在同一子集中的 Addresses 和 NotReadyAddresses 中。组成服务的地址和端口集合。
- 类型
-
array
14.5.1.2. .subsets[]
- 描述
EndpointSubset 是一组带有一组常用端口的地址。扩展的端点集合是 Cartesian 产品，即 Addresses x Ports。例如，给定：
{ Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }{ Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }Copy to Clipboard Copied! Toggle word wrap Toggle overflow 生成的端点集可视为：
a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ]
a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ]Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 提供标记为就绪的相关端口的 IP 地址。这些端点应该被视为安全供负载均衡器和客户端使用。 |
|
|
| EndpointAddress 是一个描述单个 IP 地址的元组。 |
|
|
| 提供相关端口但当前未标记为就绪的 IP 地址，因为它们尚未开始，最近失败了就绪度检查，或者最近失败了存活度检查。 |
|
|
| EndpointAddress 是一个描述单个 IP 地址的元组。 |
|
|
| 相关 IP 地址上可用的端口号。 |
|
|
| EndpointPort 是一个描述单个端口的元组。 |
14.5.1.3. .subsets[].addresses
- 描述
- 提供标记为就绪的相关端口的 IP 地址。这些端点应该被视为安全供负载均衡器和客户端使用。
- 类型
-
array
14.5.1.4. .subsets[].addresses[]
- 描述
- EndpointAddress 是一个描述单个 IP 地址的元组。
- 类型
-
object - 必填
-
ip
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 此端点的主机名 |
|
|
| 此端点的 IP。可能不是 loopback (127.0.0.0/8 或 ::1), link-local (169.254.0.0/16 or fe80::/10)或 link-local multicast (224.0.0.0/24 或 ff02::/16)。 |
|
|
| 可选：托管此端点的节点。这可用于确定节点本地的端点。 |
|
|
| ObjectReference 包含足够信息供您检查或修改引用的对象。 |
14.5.1.5. .subsets[].addresses[].targetRef
- 描述
- ObjectReference 包含足够信息供您检查或修改引用的对象。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 引用的 API 版本。 |
|
|
| 如果引用的是对象的一部分而非整个对象，则该字符串应包含有效的 JSON/Go 字段访问声明，如 desiredState.manifest.containers[2]。例如，如果对象引用是一个 pod 中的容器，它应该还以下类似： "spec.containers{name}"（其中 "name" 是指触发事件的容器的名称）,如果不使用容器名称，则应类似于 "spec.containers[2]"（使用此 pod 中索引值为 2 的容器）。选择这个语法的原因是，为了有一些指向对象部分的正确定义方法。 |
|
|
| 引用的类型。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 引用的命名空间。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| 指定构成这个引用的 resourceVersion（如果存在）。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| 引用的 UID。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
14.5.1.6. .subsets[].notReadyAddresses
- 描述
- 提供相关端口但当前未标记为就绪的 IP 地址，因为它们尚未开始，最近失败了就绪度检查，或者最近失败了存活度检查。
- 类型
-
array
14.5.1.7. .subsets[].notReadyAddresses[]
- 描述
- EndpointAddress 是一个描述单个 IP 地址的元组。
- 类型
-
object - 必填
-
ip
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 此端点的主机名 |
|
|
| 此端点的 IP。可能不是 loopback (127.0.0.0/8 或 ::1), link-local (169.254.0.0/16 or fe80::/10)或 link-local multicast (224.0.0.0/24 或 ff02::/16)。 |
|
|
| 可选：托管此端点的节点。这可用于确定节点本地的端点。 |
|
|
| ObjectReference 包含足够信息供您检查或修改引用的对象。 |
14.5.1.8. .subsets[].notReadyAddresses[].targetRef
- 描述
- ObjectReference 包含足够信息供您检查或修改引用的对象。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 引用的 API 版本。 |
|
|
| 如果引用的是对象的一部分而非整个对象，则该字符串应包含有效的 JSON/Go 字段访问声明，如 desiredState.manifest.containers[2]。例如，如果对象引用是一个 pod 中的容器，它应该还以下类似： "spec.containers{name}"（其中 "name" 是指触发事件的容器的名称）,如果不使用容器名称，则应类似于 "spec.containers[2]"（使用此 pod 中索引值为 2 的容器）。选择这个语法的原因是，为了有一些指向对象部分的正确定义方法。 |
|
|
| 引用的类型。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 引用的命名空间。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| 指定构成这个引用的 resourceVersion（如果存在）。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| 引用的 UID。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
14.5.1.9. .subsets[].ports
- 描述
- 相关 IP 地址上可用的端口号。
- 类型
-
array
14.5.1.10. .subsets[].ports[]
- 描述
- EndpointPort 是一个描述单个端口的元组。
- 类型
-
object - 必填
-
port
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 此端口的应用程序协议。这用作实现的提示，以便为他们理解的协议提供更丰富的行为。此字段遵循标准 Kubernetes 标签语法。有效值为： * 无前缀协议名称 - 为 IANA 标准服务名称保留（根据 RFC-6335 和 https://www.iana.org/assignments/service-names保留）。 * Kubernetes-defined prefixed name: * 'kubernetes.io/h2c' - HTTP/2 over cleartext，如 https://www.rfc-editor.org/rfc/rfc7540所述 * 其他协议应使用实现定义的前缀名称，如 mycompany.com/my-custom-protocol。 |
|
|
| 此端口的名称。这必须与对应 ServicePort 中的 'name' 字段匹配。必须是 DNS_LABEL。仅在定义一个端口时可选。 |
|
|
| 端点的端口号。 |
|
|
| 此端口的 IP 协议。必须是 UDP、TCP 或 SCTP。默认为 TCP。
可能的值有： - |
14.5.2. API 端点
可用的 API 端点如下：
/api/v1/endpoints-
GET: 列出或监视类型为 Endpoints 的对象
-
/api/v1/watch/endpoints-
GET: 观察单个对 Endpoints 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/api/v1/namespaces/{namespace}/endpoints-
DELETE：删除端点的集合 -
GET: 列出或监视类型为 Endpoints 的对象 -
POST：创建端点
-
/api/v1/watch/namespaces/{namespace}/endpoints-
GET: 观察单个对 Endpoints 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/api/v1/namespaces/{namespace}/endpoints/{name}-
DELETE：删除端点 -
GET：读取指定的端点 -
PATCH：部分更新指定的端点 -
PUT：替换指定的端点
-
/api/v1/watch/namespaces/{namespace}/endpoints/{name}-
GET: 观察对类型为 Endpoints 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
14.5.2.1. /api/v1/endpoints
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 Endpoints 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
14.5.2.2. /api/v1/watch/endpoints
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 Endpoints 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
14.5.2.3. /api/v1/namespaces/{namespace}/endpoints
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除端点集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 Endpoints 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建端点
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
14.5.2.4. /api/v1/watch/namespaces/{namespace}/endpoints
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对 Endpoints 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 端点的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除端点
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 阅读指定的端点
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的端点
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的端点
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 端点的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察对 kind Endpoints 的对象更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
14.6. Event [v1]
- 描述
- 事件是集群中某一位置的事件报告。事件具有有限的保留时间和触发器，消息可能会随时间而演进。事件消费者不应依赖给定 Reason 反映一致的底层触发器的事件的时间，或者该 Reason 持续存在事件的时间。事件应被视为 informative, best-effort, supplemental 数据。
- 类型
-
object - 必填
-
metadata -
involvedObject
-
14.6.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 关于 Regarding 对象采取哪些操作/失败。 |
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| 发生此事件的次数。 |
|
| 首次观察此事件的时间。 | |
|
| 事件首次记录的时间。（服务器接收的时间为 TypeMeta.） | |
|
|
| ObjectReference 包含足够信息供您检查或修改引用的对象。 |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 记录此事件最近发生的时间。 | |
|
|
| 此操作状态的人类可读描述。 |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| 这应该是一个简短的、可理解的字符串，使转换至对象的当前状态的原因。 |
|
|
| ObjectReference 包含足够信息供您检查或修改引用的对象。 |
|
|
|
发送此事件的控制器的名称，如 |
|
|
|
控制器实例的 ID，如 |
|
|
| EventSeries 包含有关一系列事件的信息，即在一段时间内持续发生/发生的内容。 |
|
|
| EventSource 包含事件的信息。 |
|
|
| 此事件类型(Normal, Warning)，将来可能会添加新类型 |
14.6.1.1. .involvedObject
- 描述
- ObjectReference 包含足够信息供您检查或修改引用的对象。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 引用的 API 版本。 |
|
|
| 如果引用的是对象的一部分而非整个对象，则该字符串应包含有效的 JSON/Go 字段访问声明，如 desiredState.manifest.containers[2]。例如，如果对象引用是一个 pod 中的容器，它应该还以下类似： "spec.containers{name}"（其中 "name" 是指触发事件的容器的名称）,如果不使用容器名称，则应类似于 "spec.containers[2]"（使用此 pod 中索引值为 2 的容器）。选择这个语法的原因是，为了有一些指向对象部分的正确定义方法。 |
|
|
| 引用的类型。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 引用的命名空间。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| 指定构成这个引用的 resourceVersion（如果存在）。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| 引用的 UID。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
14.6.1.3. .series
- 描述
- EventSeries 包含有关一系列事件的信息，即在一段时间内持续发生/发生的内容。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 此系列中发生次数最高到最后的心跳时间 |
|
| 最后一次观察到的时间 |
14.6.1.4. .source
- 描述
- EventSource 包含事件的信息。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 生成事件的组件。 |
|
|
| 生成事件的节点名称。 |
14.6.2. API 端点
可用的 API 端点如下：
/api/v1/events-
GET: 列出或监视类型为 Event 的对象
-
/api/v1/watch/events-
GET: 观察单个对事件列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/api/v1/namespaces/{namespace}/events-
DELETE：删除事件集合 -
GET: 列出或监视类型为 Event 的对象 -
POST：创建事件
-
/api/v1/watch/namespaces/{namespace}/events-
GET: 观察单个对事件列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/api/v1/namespaces/{namespace}/events/{name}-
DELETE：删除事件 -
GET：读取指定的事件 -
PATCH：部分更新指定的事件 -
PUT：替换指定的事件
-
/api/v1/watch/namespaces/{namespace}/events/{name}-
GET: 观察对类型为 Event 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
14.6.2.1. /api/v1/events
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 Event 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
14.6.2.2. /api/v1/watch/events
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对事件列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
14.6.2.3. /api/v1/namespaces/{namespace}/events
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除事件集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 Event 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建事件
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
14.6.2.4. /api/v1/watch/namespaces/{namespace}/events
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察单个对事件列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
14.6.2.5. /api/v1/namespaces/{namespace}/events/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 事件名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除事件
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。 |
|
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
- HTTP 方法
-
GET - 描述
- 读取指定的事件
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的事件
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
|
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
- HTTP 方法
-
PUT - 描述
- 替换指定的事件
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 事件名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 观察对 kind Event. deprecated 的对象更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
14.7. LimitRange [v1]
- 描述
- LimitRange 为命名空间中的每种资源设置资源使用量限制。
- 类型
-
对象
14.7.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| LimitRangeSpec 为与 kind 上匹配的资源定义 min/max 用量限制。 |
14.7.1.1. .spec
- 描述
- LimitRangeSpec 为与 kind 上匹配的资源定义 min/max 用量限制。
- 类型
-
object - 必填
-
limits
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 限制是强制的 LimitRangeItem 对象列表。 |
|
|
| LimitRangeItem 为 kind 上匹配的任何资源定义一个 min/max 用量限制。 |
14.7.1.2. .spec.limits
- 描述
- 限制是强制的 LimitRangeItem 对象列表。
- 类型
-
array
14.7.1.3. .spec.limits[]
- 描述
- LimitRangeItem 为 kind 上匹配的任何资源定义一个 min/max 用量限制。
- 类型
-
object - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
| 如果省略了资源限值，则资源名称的默认资源要求限制值。 | |
|
| 如果省略了资源请求，defaultRequest 是由资源名称的默认资源要求请求值。 | |
|
| 按资源名称对此类型的最大使用限制。 | |
|
| 如果指定了 maxLimitRequestRatio，则指定资源必须具有非零的请求和限制，其中限制除请求小于或等于枚举的值；这代表指定资源的最大突发。 | |
|
| 根据资源名称，对这个类型的最小使用限制。 | |
|
|
| 此限制应用到的资源类型。 |
14.7.2. API 端点
可用的 API 端点如下：
/api/v1/limitranges-
GET: 列出或监视类型为 LimitRange 的对象
-
/api/v1/watch/limitranges-
GET: 观察单个对 LimitRange 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/api/v1/namespaces/{namespace}/limitranges-
DELETE：删除 LimitRange 集合 -
GET: 列出或监视类型为 LimitRange 的对象 -
POST：创建一个 LimitRange
-
/api/v1/watch/namespaces/{namespace}/limitranges-
GET: 观察单个对 LimitRange 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
-
/api/v1/namespaces/{namespace}/limitranges/{name}-
DELETE：删除 LimitRange -
GET：读取指定的 LimitRange -
PATCH：部分更新指定的 LimitRange -
PUT：替换指定的 LimitRange
-
/api/v1/watch/namespaces/{namespace}/limitranges/{name}-
GET: 观察对类型为 LimitRange 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
-
14.7.2.1. /api/v1/limitranges
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出或监视 LimitRange 类型的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
14.7.2.2. /api/v1/watch/limitranges
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch |