Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

8.5. ClusterOperator [config.openshift.io/v1]

描述
ClusterOperator 是存放 Operator 当前状态的自定义资源对象。Operator 使用这个对象将其状态传递给集群的其余部分。
类型
对象
必填
  • spec

8.5.1. 规格
复制链接

Expand
属性类型描述

apiVersion

字符串

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

kind

字符串

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

metadata

ObjectMeta_v2

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

spec

对象

spec 包含可应用到任何 Operator 的配置。

status

对象

status 包含有关 Operator 状态的信息。它与 Kubernetes 生态系统的状态信息一致。

8.5.1.1. .spec
复制链接

描述
spec 包含可应用到任何 Operator 的配置。
类型
对象

8.5.1.2. .status
复制链接

描述
status 包含有关 Operator 状态的信息。它与 Kubernetes 生态系统的状态信息一致。
类型
对象
Expand
属性类型描述

conditions

array

条件描述了 Operator 管理和监控的组件的状态。

conditions[]

对象

ClusterOperatorStatusCondition 代表 Operator 的管理和监控组件的状态。

extension

``

扩展包含特定于拥有此状态对象的 Operator 的额外状态信息。

relatedObjects

array

relatedObjects 是一个 "interesting" 或与此 Operator 相关的对象列表。常见用途为：1。利用 Operator 2. operator 命名空间 3 的详细资源。操作对象命名空间为：1。

relatedObjects[]

对象

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

版本

array

版本是 operator 和操作对象版本元组片段。管理多个操作对象的 Operator 将在阵列中有多个操作对象条目。可用的操作器必须使用名称 "operator" 报告 Operator 本身的版本。当 Operator 将新版本推出到所有操作对象时，Operator 会报告一个新的 "operator" 版本。

versions[]

对象

 

8.5.1.3. .status.conditions
复制链接

描述
条件描述了 Operator 管理和监控的组件的状态。
类型
array

8.5.1.4. .status.conditions[]
复制链接

描述
ClusterOperatorStatusCondition 代表 Operator 的管理和监控组件的状态。
类型
对象
必填
  • lastTransitionTime
  • status
  • type
Expand
属性类型描述

lastTransitionTime

字符串

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

message

字符串

消息提供有关当前条件的附加信息。这仅由人类使用。它可以包含行 Feed 字符(U+000A)，这些字符应呈现为新行。

reason

字符串

reason 是条件当前状态的 CamelCase 原因。

status

字符串

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

type

字符串

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

8.5.1.5. .status.relatedObjects
复制链接

描述
relatedObjects 是一个 "interesting" 或与此 Operator 相关的对象列表。常见用途为：1。利用 Operator 2. operator 命名空间 3 的详细资源。操作对象命名空间为：1。
类型
array

8.5.1.6. .status.relatedObjects[]
复制链接

描述
ObjectReference 包含足够信息供您检查或修改引用的对象。
类型
对象
必填
  • group
  • name
  • resource
Expand
属性类型描述

group

字符串

引用的组。

name

字符串

引用的名称。

namespace

字符串

引用的命名空间。

resource

字符串

引用的资源。

8.5.1.7. .status.versions
复制链接

描述
版本是 operator 和操作对象版本元组片段。管理多个操作对象的 Operator 将在阵列中有多个操作对象条目。可用的操作器必须使用名称 "operator" 报告 Operator 本身的版本。当 Operator 将新版本推出到所有操作对象时，Operator 会报告一个新的 "operator" 版本。
类型
array

8.5.1.8. .status.versions[]
复制链接

描述
类型
对象
必填
  • name
  • version
Expand
属性类型描述

name

字符串

name 是此版本用于的特定操作对象的名称。它通常与容器镜像匹配，而不是操作符。

version

字符串

version 表示当前管理特定操作对象的版本。它必须始终与 Available operand 匹配。如果 1.0.0 为 Available，则必须指示 1.0.0，即使 Operator 正在尝试推出部署 1.1.0

8.5.2. 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 的状态

8.5.2.1. /apis/config.openshift.io/v1/clusteroperators
复制链接

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

pretty

字符串

如果 'true'，则输出被用户友善。

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

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须在没有 continue 字段的情况下重启其列表。否则，客户端可能会发送另一个列表请求，并带有 410 错误收到的令牌，服务器将通过从下一个密钥开始的列表进行响应，但从最新的快照（从最后一个列表结果中不一致） - 在第一个列表请求后创建、修改或删除的对象将包含在响应中，只要其密钥在"next key"后。

当 watch 为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视，而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值，以检索下一个结果集。在过滤所有请求的对象时，设置限制可能会返回比请求的项目数量少（最多为零项），客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数，并将返回所有可用的结果。如果指定了限制，并且 continue 字段为空，客户端可能会假设没有更多可用的结果。如果 watch 为 true，则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象，则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间，无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改，并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

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

200 - OK

Status_v2 模式

401 - Unauthorized

空

HTTP 方法
GET
描述
列出 ClusterOperator 类型的对象
Expand
表 8.97. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须在没有 continue 字段的情况下重启其列表。否则，客户端可能会发送另一个列表请求，并带有 410 错误收到的令牌，服务器将通过从下一个密钥开始的列表进行响应，但从最新的快照（从最后一个列表结果中不一致） - 在第一个列表请求后创建、修改或删除的对象将包含在响应中，只要其密钥在"next key"后。

当 watch 为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视，而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值，以检索下一个结果集。在过滤所有请求的对象时，设置限制可能会返回比请求的项目数量少（最多为零项），客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数，并将返回所有可用的结果。如果指定了限制，并且 continue 字段为空，客户端可能会假设没有更多可用的结果。如果 watch 为 true，则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象，则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间，无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改，并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

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

200 - OK

ClusterOperatorList 模式

401 - Unauthorized

空

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

dryRun

字符串

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

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

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

正文（body）

ClusterOperator 模式

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

200 - OK

ClusterOperator 模式

201 - Created

ClusterOperator 模式

202 - Accepted

ClusterOperator 模式

401 - Unauthorized

空

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

name

字符串

ClusterOperator 的名称

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

pretty

字符串

如果 'true'，则输出被用户友善。

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

dryRun

字符串

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

gracePeriodSeconds

整数

应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值是 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。

orphanDependents

布尔值

弃用：请使用 PropagationPolicy，此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false，"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置两者。

propagationPolicy

字符串

是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为： 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系； 'Foreground' - 一个删除前台所有依赖的级联策略。

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

正文（body）

DeleteOptions_v2 schema

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

200 - OK

Status_v2 模式

202 - Accepted

Status_v2 模式

401 - Unauthorized

空

HTTP 方法
GET
描述
读取指定的 ClusterOperator
Expand
表 8.107. 查询参数
参数类型描述

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

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

200 - OK

ClusterOperator 模式

401 - Unauthorized

空

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

dryRun

字符串

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

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

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

正文（body）

Patch 模式

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

200 - OK

ClusterOperator 模式

401 - Unauthorized

空

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

dryRun

字符串

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

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

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

正文（body）

ClusterOperator 模式

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

200 - OK

ClusterOperator 模式

201 - Created

ClusterOperator 模式

401 - Unauthorized

空

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

name

字符串

ClusterOperator 的名称

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

pretty

字符串

如果 'true'，则输出被用户友善。

HTTP 方法
GET
描述
指定 ClusterOperator 的读取状态
Expand
表 8.117. 查询参数
参数类型描述

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

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

200 - OK

ClusterOperator 模式

401 - Unauthorized

空

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

dryRun

字符串

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

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

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

正文（body）

Patch 模式

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

200 - OK

ClusterOperator 模式

401 - Unauthorized

空

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

dryRun

字符串

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

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

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

正文（body）

ClusterOperator 模式

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

200 - OK

ClusterOperator 模式

201 - Created

ClusterOperator 模式

401 - Unauthorized

空

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

Theme

© 2025 Red Hat