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

操作符 [operators.coreos.com/v1]

规范

属性 类型 描述

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

对象

OperatorSpec 定义了 Operator 的期望状态

status

对象

OperatorStatus 定义了 Operator 及其组件的观察状态

.spec

描述

OperatorSpec 定义了 Operator 的期望状态

类型

对象

.status

描述

OperatorStatus 定义了 Operator 及其组件的观察状态

类型

对象

属性 类型 描述

components

对象

Components 描述构成操作符的资源。

.status.components

描述

Components 描述构成操作符的资源。

类型

对象

必需

  • labelSelector

属性 类型 描述

labelSelector

对象

LabelSelector 是对一组资源的标签查询，用于选择操作符的组件

refs

数组

Refs 是一组对操作符组件资源的引用，使用 LabelSelector 选择。

refs[]

对象

RichReference 是对资源的引用，并用其状态条件进行了丰富。

.status.components.labelSelector

描述

LabelSelector 是对一组资源的标签查询，用于选择操作符的组件

类型

对象

属性 类型 描述

matchExpressions

数组

matchExpressions 是标签选择器要求的列表。这些要求是 AND 关系。

matchExpressions[]

对象

标签选择器要求是一个选择器，它包含值、键和一个关联键和值的运算符。

matchLabels

对象（字符串）

matchLabels 是 {key,value} 对的映射。matchLabels 映射中的单个 {key,value} 等效于 matchExpressions 的一个元素，其 key 字段为“key”，运算符为“In”，而 values 数组仅包含“value”。这些要求是 AND 关系。

.status.components.labelSelector.matchExpressions

描述

matchExpressions 是标签选择器要求的列表。这些要求是 AND 关系。

类型

数组

.status.components.labelSelector.matchExpressions[]

描述

标签选择器要求是一个选择器，它包含值、键和一个关联键和值的运算符。

类型

对象

必需

  • key

  • operator

属性 类型 描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

operator 表示键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

values

数组（字符串）

values 是字符串值的数组。如果运算符是 In 或 NotIn，则 values 数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则 values 数组必须为空。此数组在策略性合并补丁期间会被替换。

.status.components.refs

描述

Refs 是一组对操作符组件资源的引用，使用 LabelSelector 选择。

类型

数组

.status.components.refs[]

描述

RichReference 是对资源的引用，并用其状态条件进行了丰富。

类型

对象

属性 类型 描述

apiVersion

字符串

引用的 API 版本。

conditions

数组

Conditions 表示组件的最新状态。

conditions[]

对象

Condition 表示组件状态的最新可用观察结果。

fieldPath

字符串

如果引用的是对象的一部分而不是整个对象，则此字符串应包含有效的 JSON/Go 字段访问语句，例如 desiredState.manifest.containers[2]。例如，如果对象引用是指 Pod 中的容器，则其值将类似于：“spec.containers{name}”（其中“name”指的是触发事件的容器名称）或者如果未指定容器名称，则为“spec.containers[2]”（此 Pod 中索引为 2 的容器）。选择此语法只是为了有一种明确定义的方式来引用对象的一部分。待办事项：此设计并非最终版本，此字段将来可能会更改。

kind

字符串

引用的种类。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

名称

字符串

引用的名称。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names

命名空间

字符串

引用的命名空间。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/namespaces/

资源版本

字符串

此引用的特定资源版本（如果存在）。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

UID

字符串

引用的 UID。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#uids

.status.components.refs[].conditions

描述

Conditions 表示组件的最新状态。

类型

数组

.status.components.refs[].conditions[]

描述

Condition 表示组件状态的最新可用观察结果。

类型

对象

必需

  • status

  • 类型

属性 类型 描述

最后一次状态转换时间

字符串

条件从一种状态转换到另一种状态的最后时间。

最后更新时间

字符串

最后一次探测条件的时间

消息

字符串

指示状态转换详细信息的人类可读消息。

原因

字符串

条件最后一次转换的原因。

status

字符串

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

类型

字符串

条件的类型。

API 端点

提供以下 API 端点

  • /apis/operators.coreos.com/v1/operators

    • DELETE：删除 Operator 集合

    • GET：列出 Operator 类型的对象

    • POST：创建 Operator

  • /apis/operators.coreos.com/v1/operators/{name}

    • DELETE：删除 Operator

    • GET：读取指定的 Operator

    • PATCH：部分更新指定的 Operator

    • PUT：替换指定的 Operator

  • /apis/operators.coreos.com/v1/operators/{name}/status

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

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

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

/apis/operators.coreos.com/v1/operators

HTTP 方法

DELETE

描述

删除 Operator 集合

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

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 Operator 类型的对象

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

200 - OK

OperatorList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 Operator

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

Operator 模式

201 - 已创建

Operator 模式

202 - 已接受

Operator 模式

401 - 未授权

空

/apis/operators.coreos.com/v1/operators/{name}

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

名称

字符串

Operator 的名称
HTTP 方法

DELETE

描述

删除 Operator

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 Operator

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

200 - OK

Operator 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 Operator

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

Operator 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 Operator

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

Operator 模式

201 - 已创建

Operator 模式

401 - 未授权

空

/apis/operators.coreos.com/v1/operators/{name}/status

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

名称

字符串

Operator 的名称
HTTP 方法

GET

描述

读取指定的 Operator 的状态

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

200 - OK

Operator 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 Operator 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

Operator 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 Operator 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

Operator 模式

201 - 已创建

Operator 模式

401 - 未授权

空