策略 API


OpenShift Container Platform 4.15

策略 API 的参考指南

Red Hat OpenShift Documentation Team

摘要

本文档描述了 OpenShift Container Platform 策略 API 对象及其详细规格。

第 1 章 策略 API

1.1. 驱除 [policy/v1]

描述
驱除从其节点驱除 pod 会受到某些策略和安全限制。这是 Pod 的子资源。通过 POSTing to …​/pods/<pod name>/evictions 来创建导致此类驱除的请求。
类型
对象

1.2. PodDisruptionBudget [policy/v1]

描述
PodDisruptionBudget 是一个对象,用于定义可能导致 pod 集合的最大中断
类型
对象

第 2 章 驱除 [policy/v1]

描述
驱除从其节点驱除 pod 会受到某些策略和安全限制。这是 Pod 的子资源。通过 POSTing to …​/pods/<pod name>/evictions 来创建导致此类驱除的请求。
类型
object

2.1. 规格

Expand
属性类型描述

apiVersion

string

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

deleteOptions

DeleteOptions

可以提供 DeleteOptions

kind

string

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

ObjectMeta 描述要被驱除的 pod。

2.2. API 端点

可用的 API 端点如下:

  • /api/v1/namespaces/{namespace}/pods/{name}/eviction

    • POST :创建 Pod 的驱除

2.2.1. /api/v1/namespaces/{namespace}/pods/{name}/eviction

Expand
表 2.1. 全局路径参数
参数类型描述

name

字符串

Eviction 的名称

Expand
表 2.2. 全局查询参数
参数类型描述

dryRun

string

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

HTTP 方法
POST
描述
创建 pod 的驱除
Expand
表 2.3. 主体参数
参数类型描述

正文(body)

驱除 模式

 
Expand
表 2.4. HTTP 响应
HTTP 代码响应正文

200 - OK

驱除 模式

201 - Created

驱除 模式

202 - Accepted

驱除 模式

401 - Unauthorized

第 3 章 PodDisruptionBudget [policy/v1]

描述
PodDisruptionBudget 是一个对象,用于定义可能导致 pod 集合的最大中断
类型
object

3.1. 规格

Expand
属性类型描述

apiVersion

string

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

PodDisruptionBudgetSpec 是 PodDisruptionBudget 的描述。

status

对象

PodDisruptionBudgetStatus 代表 PodDisruptionBudget 的状态的信息。状态可能会跟踪系统的实际状态。

3.1.1. .spec

描述
PodDisruptionBudgetSpec 是 PodDisruptionBudget 的描述。
类型
object
Expand
属性类型描述

maxUnavailable

IntOrString

如果在驱除后没有 "selector" 后选择的 "maxUnavailable" pod 时,允许驱除驱除,如没有被驱除的 pod。例如,可以通过指定 0 来防止所有自愿驱除。这是一个带有 "minAvailable" 的相互排斥的设置。

minAvailable

IntOrString

如果 "selector" 选择的最小"minAvailable" pod 在驱除后仍可用,则允许使用驱除功能,即没有被驱除的 pod。例如,您可以通过指定 "100%" 来防止所有自愿驱除。

selector

LabelSelector

对其驱除由中断预算管理的 pod 的标签查询。null 选择器不匹配任何 pod,而空({})选择器将选择命名空间中的所有 pod。

unhealthyPodEvictionPolicy

string

unhealthyPodEvictionPolicy 定义应考虑驱除不健康的 pod 的条件。当前实现将健康的 pod 视为具有 type="Ready",status="True" 的 status.conditions 项的 pod。

有效策略为 IfHealthyBudget 和 AlwaysAllow。如果没有指定策略,则使用默认行为,对应于 IfHealthyBudget 策略。

IfHealthyBudget 策略意味着运行的 pod (status.phase="Running"),但只有在保护的应用程序没有中断时,才会被驱除(status.currentHealthy 至少等于 status.desiredHealthy)。健康的 pod 将受 PDB 进行驱除。

AlwaysAllow policy 意味着所有正在运行的 pod (status.phase="Running"),但还没有处于健康状态,无论是否满足 PDB 中的条件,都可被驱除。这意味着,对中断的应用程序运行的 pod 可能无法成为健康的几率。健康的 pod 将受 PDB 进行驱除。

以后可能会添加额外的策略。如果客户端在此字段中遇到未识别的策略,则进行驱除决策应禁止驱除不健康的 pod。

此字段是 beta 级别。当启用了功能门 PDBUnhealthyPodEvictionPolicy (默认启用)时,驱除 API 会使用此字段。

可能枚举值: - "AlwaysAllow" 策略意味着所有运行的 pod (status.phase="Running"),但还没有处于健康状态,无论是否满足 PDB 中的条件,都可被驱除。这意味着,对中断的应用程序运行的 pod 可能无法成为健康的几率。健康的 pod 会受到用于驱除的 PDB 限制。- "IfHealthyBudget" 策略意味着运行 pod (status.phase="Running"),但只有在保护的应用程序没有中断(status.currentHealthy 至少等于 status.desiredHealthy)时,才会被驱除。健康的 pod 将受 PDB 进行驱除。

3.1.2. .status

描述
PodDisruptionBudgetStatus 代表 PodDisruptionBudget 的状态的信息。状态可能会跟踪系统的实际状态。
类型
object
必填
  • disruptionsAllowed
  • currentHealthy
  • desiredHealthy
  • expectedPods
Expand
属性类型描述

conditions

数组(条件)

条件包含 PDB 的条件。disruption 控制器设置 DisruptionAllowed 条件。以下是原因字段的已知值(将来可能会添加其他原因):- SyncFailed: 控制器遇到错误,且无法计算允许的中断数量。因此,不允许中断,并且条件的状态将是 False。- InsufficientPods: pod 的数量位于 或低于 PodDisruptionBudget 需要的数量。不允许中断,并且条件的状态为 False。- SufficientPods: PodDisruptionBudget 需要超过 pod。条件为 True,允许的中断数量由 disruptionsAllowed 属性提供。

currentHealthy

整数

当前健康的 pod 数量

desiredHealthy

整数

最低健康 pod 数量

disruptedPods

对象(时间)

DisruptedPods 包含有关 pod 的信息,其驱除由 API 服务器驱除子资源处理程序处理,但还没有被 PodDisruptionBudget 控制器观察到。当 API 服务器处理驱除请求时,pod 将处于这个映射中,当 PDB 控制器认为 pod 被标记为删除(或超时后)时,pod 会被标记为要删除的时间。映射中的键是 pod 的名称,值是 API 服务器处理驱除请求的时间。如果没有进行删除,并且 PodDisruptionBudget 控制器将在一段时间后自动删除 pod。如果一切顺利,此映射在大部分时间都应为空。映射中的大量条目可能会表示 pod 删除的问题。

disruptionsAllowed

整数

当前允许的 pod 中断预算数量。

expectedPods

整数

此中断预算计算的 pod 总数

observedGeneration

整数

更新此 PDB 状态时观察到的最新生成。只有观察到 PDB 的对象生成时,DisruptionsAllowed 和其他状态信息才有效。

3.2. API 端点

可用的 API 端点如下:

  • /apis/policy/v1/poddisruptionbudgets

    • GET: 列出或监视类型为 PodDisruptionBudget 的对象
  • /apis/policy/v1/watch/poddisruptionbudgets

    • GET: 观察单个更改 PodDisruptionBudget。已弃用:改为使用 'watch' 参数及列表操作。
  • /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets

    • DELETE: 删除 PodDisruptionBudget 集合
    • GET: 列出或监视类型为 PodDisruptionBudget 的对象
    • POST :创建 PodDisruptionBudget
  • /apis/policy/v1/watch/namespaces/{namespace}/poddisruptionbudgets

    • GET: 观察单个更改 PodDisruptionBudget。已弃用:改为使用 'watch' 参数及列表操作。
  • /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}

    • DELETE :删除 PodDisruptionBudget
    • GET :读取指定的 PodDisruptionBudget
    • PATCH: 部分更新指定的 PodDisruptionBudget
    • PUT :替换指定的 PodDisruptionBudget
  • /apis/policy/v1/watch/namespaces/{namespace}/poddisruptionbudgets/{name}

    • GET: 观察对类型为 PodDisruptionBudget 的对象的更改。已弃用:使用带有 list 操作的 'watch' 参数,而是过滤为带有 'fieldSelector' 参数的单个项目。
  • /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status

    • GET :指定 PodDisruptionBudget 的读取状态
    • PATCH: 部分更新指定 PodDisruptionBudget 的状态
    • PUT :替换指定 PodDisruptionBudget 的状态

3.2.1. /apis/policy/v1/poddisruptionbudgets

HTTP 方法
GET
描述
列出或监视类型为 PodDisruptionBudget 的对象
Expand
表 3.1. HTTP 响应
HTTP 代码响应正文

200 - OK

PodDisruptionBudgetList schema

401 - Unauthorized

3.2.2. /apis/policy/v1/watch/poddisruptionbudgets

HTTP 方法
GET
描述
观察单个对 PodDisruptionBudget 列表中的更改。已弃用:改为使用 'watch' 参数及列表操作。
Expand
表 3.2. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

HTTP 方法
DELETE
描述
删除 PodDisruptionBudget 集合
Expand
表 3.3. 查询参数
参数类型描述

dryRun

string

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

Expand
表 3.4. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出或监视类型为 PodDisruptionBudget 的对象
Expand
表 3.5. HTTP 响应
HTTP 代码响应正文

200 - OK

PodDisruptionBudgetList schema

401 - Unauthorized

HTTP 方法
POST
描述
创建 PodDisruptionBudget
Expand
表 3.6. 查询参数
参数类型描述

dryRun

string

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

Expand
表 3.7. 主体参数
参数类型描述

正文(body)

PodDisruptionBudget 模式

 
Expand
表 3.8. HTTP 响应
HTTP 代码响应正文

200 - OK

PodDisruptionBudget 模式

201 - Created

PodDisruptionBudget 模式

202 - Accepted

PodDisruptionBudget 模式

401 - Unauthorized

HTTP 方法
GET
描述
观察单个对 PodDisruptionBudget 列表中的更改。已弃用:改为使用 'watch' 参数及列表操作。
Expand
表 3.9. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

Expand
表 3.10. 全局路径参数
参数类型描述

name

字符串

PodDisruptionBudget 的名称

HTTP 方法
DELETE
描述
删除 PodDisruptionBudget
Expand
表 3.11. 查询参数
参数类型描述

dryRun

string

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

Expand
表 3.12. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
阅读指定的 PodDisruptionBudget
Expand
表 3.13. HTTP 响应
HTTP 代码响应正文

200 - OK

PodDisruptionBudget 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 PodDisruptionBudget
Expand
表 3.14. 查询参数
参数类型描述

dryRun

string

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

Expand
表 3.15. HTTP 响应
HTTP 代码响应正文

200 - OK

PodDisruptionBudget 模式

201 - Created

PodDisruptionBudget 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 PodDisruptionBudget
Expand
表 3.16. 查询参数
参数类型描述

dryRun

string

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

Expand
表 3.17. 主体参数
参数类型描述

正文(body)

PodDisruptionBudget 模式

 
Expand
表 3.18. HTTP 响应
HTTP 代码响应正文

200 - OK

PodDisruptionBudget 模式

201 - Created

PodDisruptionBudget 模式

401 - Unauthorized

Expand
表 3.19. 全局路径参数
参数类型描述

name

字符串

PodDisruptionBudget 的名称

HTTP 方法
GET
描述
观察对类型为 PodDisruptionBudget 的对象的更改。已弃用:使用带列表操作的 'watch' 参数,而是过滤成带有 'fieldSelector' 参数的单个项目。
Expand
表 3.20. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

Expand
表 3.21. 全局路径参数
参数类型描述

name

字符串

PodDisruptionBudget 的名称

HTTP 方法
GET
描述
指定 PodDisruptionBudget 的读取状态
Expand
表 3.22. HTTP 响应
HTTP 代码响应正文

200 - OK

PodDisruptionBudget 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定 PodDisruptionBudget 的状态
Expand
表 3.23. 查询参数
参数类型描述

dryRun

string

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

Expand
表 3.24. HTTP 响应
HTTP 代码响应正文

200 - OK

PodDisruptionBudget 模式

201 - Created

PodDisruptionBudget 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 PodDisruptionBudget 的状态
Expand
表 3.25. 查询参数
参数类型描述

dryRun

string

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

Expand
表 3.26. 主体参数
参数类型描述

正文(body)

PodDisruptionBudget 模式

 
Expand
表 3.27. HTTP 响应
HTTP 代码响应正文

200 - OK

PodDisruptionBudget 模式

201 - Created

PodDisruptionBudget 模式

401 - Unauthorized

Legal Notice

Copyright © 2025 Red Hat

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat