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

OperatorGroup [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

元数据

ObjectMeta

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

spec

对象

OperatorGroupSpec 是 OperatorGroup 资源的规范。

status

对象

OperatorGroupStatus 是 OperatorGroupResource 的状态。

.spec

描述

OperatorGroupSpec 是 OperatorGroup 资源的规范。

类型

对象

属性 类型 描述

selector

对象

Selector 选择 OperatorGroup 的目标命名空间。

serviceAccountName

字符串

ServiceAccountName 是管理员指定的将用于在此 OperatorGroup 中部署运算符的服务帐户。

staticProvidedAPIs

布尔值

Static 告诉 OLM 不要更新 OperatorGroup 的 providedAPIs 注解

targetNamespaces

数组 (字符串)

TargetNamespaces 是要定位的目标命名空间的显式集合。如果设置了它，则忽略 Selector。

upgradeStrategy

字符串

UpgradeStrategy 定义了命名空间中操作符的升级策略。目前支持两种升级策略。

默认：OLM 只允许 ClusterServiceVersions 从 succeeded 阶段移动到 replacing 阶段。这实际上意味着，如果安装或升级失败，OLM 将不允许操作符移动到下一个版本。

TechPreviewUnsafeFailForward：OLM 将允许 ClusterServiceVersions 从 succeeded 阶段或 failed 阶段移动到 replacing 阶段。此外，当订阅引用失败的 installPlan 并且目录已更新为现有操作符集的新升级时，OLM 将生成新的 installPlans。

警告：TechPreviewUnsafeFailForward 升级策略是不安全的，除非您深入了解命名空间中正在管理的操作符集，否则可能会导致意外行为或无法恢复的数据丢失。

.spec.selector

描述

Selector 选择 OperatorGroup 的目标命名空间。

类型

对象

属性 类型 描述

matchExpressions

数组

matchExpressions 是标签选择器要求的列表。这些要求是 ANDed 的。

matchExpressions[]

对象

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

matchLabels

对象 (字符串)

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

.spec.selector.matchExpressions

描述

matchExpressions 是标签选择器要求的列表。这些要求是 ANDed 的。

类型

数组

.spec.selector.matchExpressions[]

描述

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

类型

对象

必需

  • key

  • operator

属性 类型 描述

key

字符串

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

operator

字符串

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

values

数组 (字符串)

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

.status

描述

OperatorGroupStatus 是 OperatorGroupResource 的状态。

类型

对象

必需

  • lastUpdated

属性 类型 描述

conditions

数组

Conditions 是 OperatorGroup 条件的数组。

conditions[]

对象

Condition 包含此 API 资源当前状态的一个方面的详细信息。--- 此结构旨在直接用作字段路径 .status.conditions 中的数组。例如：

type FooStatus struct{ // 表示 foo 当前状态的观察结果。 // 已知的 .status.conditions.type 为：“Available”、“Progressing”和“Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"

// 其他字段 }

lastUpdated

字符串

LastUpdated 是上次更新 OperatorGroup 状态的时间戳。

namespaces

数组 (字符串)

Namespaces 是 OperatorGroup 的目标命名空间集。

serviceAccountRef

对象

ServiceAccountRef 引用指定的 ServiceAccount 对象。

.status.conditions

描述

Conditions 是 OperatorGroup 条件的数组。

类型

数组

.status.conditions[]

描述

Condition 包含此 API 资源当前状态的一个方面的详细信息。--- 此结构旨在直接用作字段路径 .status.conditions 中的数组。例如：

type FooStatus struct{
    // Represents the observations of a foo's current state.
    // Known .status.conditions.type are: "Available", "Progressing", and "Degraded"
    // +patchMergeKey=type
    // +patchStrategy=merge
    // +listType=map
    // +listMapKey=type
    Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
    // other fields
}
类型

对象

必需

  • lastTransitionTime

  • message

  • reason

  • status

  • type

属性 类型 描述

lastTransitionTime

字符串

lastTransitionTime 是条件从一种状态转换到另一种状态的最后时间。这应该是底层条件改变的时间。如果不知道，则可以使用 API 字段改变的时间。

message

字符串

message 是一个易于理解的消息，指示有关转换的详细信息。这可能是一个空字符串。

observedGeneration

整数

observedGeneration 表示设置条件的 .metadata.generation。例如，如果 .metadata.generation 当前为 12，但 .status.conditions[x].observedGeneration 为 9，则该条件相对于实例的当前状态已过期。

reason

字符串

reason 包含一个程序化标识符，指示条件最后转换的原因。特定条件类型的生产者可以为此字段定义预期的值和含义，以及是否将这些值视为保证的 API。该值应为驼峰式字符串。此字段不能为空。

status

字符串

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

type

字符串

条件的类型，采用驼峰式大小写或 foo.example.com/CamelCase。--- 许多 .condition.type 值在资源中是一致的，例如 Available，但由于任意条件可能很有用（参见 .node.status.conditions），因此消除冲突的能力很重要。它匹配的正则表达式是 (dns1123SubdomainFmt/)?(qualifiedNameFmt)

.status.serviceAccountRef

描述

ServiceAccountRef 引用指定的 ServiceAccount 对象。

类型

对象

属性 类型 描述

apiVersion

字符串

引用的 API 版本。

fieldPath

字符串

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

kind

字符串

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

name

字符串

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

namespace

字符串

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

resourceVersion

字符串

对此引用进行的特定 resourceVersion（如果有的話）。更多信息：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

API 端点

提供以下 API 端点

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

    • GET：列出 OperatorGroup 类型的对象

  • /apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups

    • DELETE：删除 OperatorGroup 集合

    • GET：列出 OperatorGroup 类型的对象

    • POST：创建 OperatorGroup

  • /apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups/{name}

    • DELETE：删除 OperatorGroup

    • GET：读取指定的 OperatorGroup

    • PATCH：部分更新指定的 OperatorGroup

    • PUT：替换指定的 OperatorGroup

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

    • GET：读取指定 OperatorGroup 的状态

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

    • PUT：替换指定 OperatorGroup 的状态

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

HTTP 方法

GET

描述

列出 OperatorGroup 类型的对象

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

200 - OK

OperatorGroupList 模式

401 - 未授权

空

/apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups

HTTP 方法

DELETE

描述

删除 OperatorGroup 集合

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

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 OperatorGroup 类型的对象

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

200 - OK

OperatorGroupList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 OperatorGroup

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

dryRun

字符串

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

fieldValidation

字符串

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

body

OperatorGroup 模式
表 6. HTTP 响应
HTTP 代码 响应体

200 - OK

OperatorGroup 模式

201 - 已创建

OperatorGroup 模式

202 - 已接受

OperatorGroup 模式

401 - 未授权

空

/apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups/{name}

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

name

字符串

OperatorGroup 的名称
HTTP 方法

DELETE

描述

删除 OperatorGroup

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 OperatorGroup

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

200 - OK

OperatorGroup 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 OperatorGroup

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

OperatorGroup 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 OperatorGroup

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

dryRun

字符串

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

fieldValidation

字符串

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

body

OperatorGroup 模式
表 15. HTTP 响应
HTTP 代码 响应体

200 - OK

OperatorGroup 模式

201 - 已创建

OperatorGroup 模式

401 - 未授权

空

/apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups/{name}/status

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

name

字符串

OperatorGroup 的名称
HTTP 方法

GET

描述

读取指定 OperatorGroup 的状态

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

200 - OK

OperatorGroup 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定 OperatorGroup 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

OperatorGroup 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定 OperatorGroup 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

body

OperatorGroup 模式
表 22. HTTP 响应
HTTP 代码 响应体

200 - OK

OperatorGroup 模式

201 - 已创建

OperatorGroup 模式

401 - 未授权

空