OpenShift 文档正在迁移，很快将只能在 docs.redhat.com（所有 Red Hat 产品文档的中心）访问。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

ClusterOperator [config.openshift.io/v1]

描述

ClusterOperator 是一个自定义资源对象，它保存操作符的当前状态。操作符使用此对象将其状态传达给集群的其余部分。兼容性级别 1：在主要版本中稳定至少 12 个月或 3 个次要版本（以较长者为准）。

类型

对象

必需

  • spec

规范

属性 类型 描述

apiVersion

字符串

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

kind

字符串

Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。不能更新。采用驼峰式命名法。更多信息：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

对象

spec 包含可应用于任何操作符的配置。

status

对象

status 包含有关操作符状态的信息。它与 Kubernetes 生态系统中的状态信息一致。

.spec

描述

spec 包含可应用于任何操作符的配置。

类型

对象

.status

描述

status 包含有关操作符状态的信息。它与 Kubernetes 生态系统中的状态信息一致。

类型

对象

属性 类型 描述

conditions

数组

conditions 描述操作符的已管理和已监控组件的状态。

conditions[]

对象

ClusterOperatorStatusCondition 表示操作符的已管理和已监控组件的状态。

extension

``

extension 包含任何特定于拥有此状态对象的 operator 的其他状态信息。

relatedObjects

数组

relatedObjects 是“有趣”或与该操作符相关的对象的列表。常见用途包括：1. 驱动操作符的详细资源 2. 操作符命名空间 3. 被操作的命名空间

relatedObjects[]

对象

ObjectReference 包含足够的信息，允许您检查或修改引用的对象。

versions

数组

versions 是操作符和被操作对象版本元组的切片。管理多个被操作对象的 operator 将在数组中有多个被操作对象条目。可用的 operator 必须使用名称“operator”报告 operator 本身版本。当 operator 已将其新版本推广到所有被操作对象时，它会报告新的“operator”版本。

versions[]

对象

.status.conditions

描述

conditions 描述操作符的已管理和已监控组件的状态。

类型

数组

.status.conditions[]

描述

ClusterOperatorStatusCondition 表示操作符的已管理和已监控组件的状态。

类型

对象

必需

  • lastTransitionTime

  • status

  • type

属性 类型 描述

lastTransitionTime

字符串

lastTransitionTime 是对当前状态属性的最后一次更新的时间。

message

字符串

message 提供有关当前条件的附加信息。这仅供人类使用。它可能包含换行符 (U+000A)，应将其呈现为新行。

reason

字符串

reason 是条件当前状态的驼峰式命名法原因。

status

字符串

条件的状态，True、False、Unknown 之一。

type

字符串

type 指定此条件报告的方面。

.status.relatedObjects

描述

relatedObjects 是“有趣”或与该操作符相关的对象的列表。常见用途包括：1. 驱动操作符的详细资源 2. 操作符命名空间 3. 被操作的命名空间

类型

数组

.status.relatedObjects[]

描述

ObjectReference 包含足够的信息，允许您检查或修改引用的对象。

类型

对象

必需

  • 分组

  • 名称

  • 资源

属性 类型 描述

分组

字符串

引用的分组。

名称

字符串

引用的名称。

命名空间

字符串

引用的命名空间。

资源

字符串

引用的资源。

.status.versions

描述

versions 是操作符和被操作对象版本元组的切片。管理多个被操作对象的 operator 将在数组中有多个被操作对象条目。可用的 operator 必须使用名称“operator”报告 operator 本身版本。当 operator 已将其新版本推广到所有被操作对象时，它会报告新的“operator”版本。

类型

数组

.status.versions[]

描述
类型

对象

必需

  • 名称

  • 版本

属性 类型 描述

名称

字符串

名称是此版本所属特定操作数的名称。它通常与容器镜像匹配，而不是与操作符匹配。

版本

字符串

版本指示当前正在管理的特定操作数的哪个版本。它必须始终与可用的操作数匹配。如果可用版本为 1.0.0，则即使操作符正在尝试推出 1.1.0，这也必须指示 1.0.0。

API 端点

提供以下 API 端点：

  • /apis/config.openshift.io/v1/clusteroperators

    • DELETE：删除 ClusterOperator 集合

    • GET：列出 ClusterOperator 类型的对象

    • POST：创建 ClusterOperator

  • /apis/config.openshift.io/v1/clusteroperators/{name}

    • DELETE：删除 ClusterOperator

    • GET：读取指定的 ClusterOperator

    • PATCH：部分更新指定的 ClusterOperator

    • PUT：替换指定的 ClusterOperator

  • /apis/config.openshift.io/v1/clusteroperators/{name}/status

    • GET：读取指定的 ClusterOperator 的状态

    • PATCH：部分更新指定的 ClusterOperator 的状态

    • PUT：替换指定的 ClusterOperator 的状态

/apis/config.openshift.io/v1/clusteroperators

HTTP 方法

DELETE

描述

删除 ClusterOperator 集合

表 1. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 ClusterOperator 类型的对象

表 2. HTTP 响应
HTTP 代码 响应体

200 - OK

ClusterOperatorList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 ClusterOperator

表 3. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 4. 请求体参数
参数 类型 描述

请求体

ClusterOperator 模式
表 5. HTTP 响应
HTTP 代码 响应体

200 - OK

ClusterOperator 模式

201 - 已创建

ClusterOperator 模式

202 - 已接受

ClusterOperator 模式

401 - 未授权

空

/apis/config.openshift.io/v1/clusteroperators/{name}

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

名称

字符串

ClusterOperator 的名称
HTTP 方法

DELETE

描述

删除 ClusterOperator

表 7. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
表 8. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 ClusterOperator

表 9. HTTP 响应
HTTP 代码 响应体

200 - OK

ClusterOperator 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 ClusterOperator

表 10. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 11. HTTP 响应
HTTP 代码 响应体

200 - OK

ClusterOperator 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 ClusterOperator

表 12. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 13. 请求体参数
参数 类型 描述

请求体

ClusterOperator 模式
表 14. HTTP 响应
HTTP 代码 响应体

200 - OK

ClusterOperator 模式

201 - 已创建

ClusterOperator 模式

401 - 未授权

空

/apis/config.openshift.io/v1/clusteroperators/{name}/status

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

名称

字符串

ClusterOperator 的名称
HTTP 方法

GET

描述

读取指定的 ClusterOperator 的状态

表 16. HTTP 响应
HTTP 代码 响应体

200 - OK

ClusterOperator 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 ClusterOperator 的状态

表 17. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 18. HTTP 响应
HTTP 代码 响应体

200 - OK

ClusterOperator 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 ClusterOperator 的状态

表 19. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 20. 请求体参数
参数 类型 描述

请求体

ClusterOperator 模式
表 21. HTTP 响应
HTTP 代码 响应体

200 - OK

ClusterOperator 模式

201 - 已创建

ClusterOperator 模式

401 - 未授权

空