OLMConfig [operators.coreos.com/v1] - OperatorHub APIs | API 参考 | OpenShift Container Platform 4.17

规范
API 端点

描述

OLMConfig 是负责配置 OLM 的资源。

类型

对象

必需

元数据

规范

属性类型描述

属性	类型	描述
`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`	`对象`	OLMConfigSpec 是 OLMConfig 资源的规范。
`status`	`对象`	OLMConfigStatus 是 OLMConfig 资源的状态。

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

对象

OLMConfigSpec 是 OLMConfig 资源的规范。

status

对象

OLMConfigStatus 是 OLMConfig 资源的状态。

.spec

描述: OLMConfigSpec 是 OLMConfig 资源的规范。
类型: 对象

属性类型描述

属性	类型	描述
`features`	`对象`	Features 包含可配置的 OLM 功能列表。

features

对象

Features 包含可配置的 OLM 功能列表。

.spec.features

描述: Features 包含可配置的 OLM 功能列表。
类型: 对象

属性类型描述

属性	类型	描述
`disableCopiedCSVs`	`布尔值`	DisableCopiedCSVs 用于禁用 OLM 的“已复制 CSV”功能，该功能适用于在集群范围内安装的运算符，其中集群范围的运算符是指已安装在目标为所有命名空间的 OperatorGroup 中的运算符。重新启用后，OLM 将为每个集群范围的运算符重新创建“已复制 CSV”。
`packageServerSyncInterval`	`字符串`	PackageServerSyncInterval 用于定义 packagerserver pod 的同步间隔。Packageserver pod 定期检查 CatalogSources 的状态；这使用持续时间格式指定周期（例如，“60m”）。对于此参数，只能指定小时（“h”）、分钟（“m”）和秒（“s”）。未指定时，周期默认为 packageserver 中指定的值。

disableCopiedCSVs

布尔值

DisableCopiedCSVs 用于禁用 OLM 的“已复制 CSV”功能，该功能适用于在集群范围内安装的运算符，其中集群范围的运算符是指已安装在目标为所有命名空间的 OperatorGroup 中的运算符。重新启用后，OLM 将为每个集群范围的运算符重新创建“已复制 CSV”。

packageServerSyncInterval

字符串

PackageServerSyncInterval 用于定义 packagerserver pod 的同步间隔。Packageserver pod 定期检查 CatalogSources 的状态；这使用持续时间格式指定周期（例如，“60m”）。对于此参数，只能指定小时（“h”）、分钟（“m”）和秒（“s”）。未指定时，周期默认为 packageserver 中指定的值。

.status

描述: OLMConfigStatus 是 OLMConfig 资源的状态。
类型: 对象

属性类型描述

属性	类型	描述
`conditions`	`数组`
`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"` // 其他字段 }

conditions

数组

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"

// 其他字段 }

.status.conditions

描述
类型: 数组

.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)

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)

API 端点

提供以下 API 端点：

/apis/operators.coreos.com/v1/olmconfigs
- DELETE：删除 OLMConfig 集合
- GET：列出 OLMConfig 对象
- POST：创建 OLMConfig
/apis/operators.coreos.com/v1/olmconfigs/{name}
- DELETE：删除 OLMConfig
- GET：读取指定的 OLMConfig
- PATCH：部分更新指定的 OLMConfig
- PUT：替换指定的 OLMConfig
/apis/operators.coreos.com/v1/olmconfigs/{name}/status
- GET：读取指定的 OLMConfig 的状态
- PATCH：部分更新指定的 OLMConfig 的状态
- PUT：替换指定的 OLMConfig 的状态

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

HTTP 方法: DELETE
描述: 删除 OLMConfig 集合

表 1. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` schema
401 - 未授权	空

HTTP 方法: GET
描述: 列出 OLMConfig 对象

表 2. HTTP 响应
HTTP 代码	响应体
200 - OK	`OLMConfigList` schema
401 - 未授权	空

HTTP 方法: POST
描述: 创建 OLMConfig

表 3. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个字段。这是 v1.23 及更高版本的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 4. 请求体参数
参数	类型	描述
`body`	`OLMConfig` schema

表 5. HTTP 响应
HTTP 代码	响应体
200 - OK	`OLMConfig` schema
201 - 已创建	`OLMConfig` schema
202 - 已接受	`OLMConfig` schema
401 - 未授权	空

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

表 6. 全局路径参数
参数	类型	描述
`name`	`字符串`	OLMConfig 的名称

HTTP 方法: DELETE
描述: 删除 OLMConfig

表 7. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 8. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` schema
202 - 已接受	`Status` schema
401 - 未授权	空

HTTP 方法: GET
描述: 读取指定的 OLMConfig

表 9. HTTP 响应
HTTP 代码	响应体
200 - OK	`OLMConfig` schema
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定的 OLMConfig

表 10. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个字段。这是 v1.23 及更高版本的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 11. HTTP 响应
HTTP 代码	响应体
200 - OK	`OLMConfig` schema
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 OLMConfig

表 12. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个字段。这是 v1.23 及更高版本的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 13. 请求体参数
参数	类型	描述
`body`	`OLMConfig` schema

表 14. HTTP 响应
HTTP 代码	响应体
200 - OK	`OLMConfig` schema
201 - 已创建	`OLMConfig` schema
401 - 未授权	空

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

表 15. 全局路径参数
参数	类型	描述
`name`	`字符串`	OLMConfig 的名称

HTTP 方法: GET
描述: 读取指定的 OLMConfig 的状态

表 16. HTTP 响应
HTTP 代码	响应体
200 - OK	`OLMConfig` schema
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定的 OLMConfig 的状态

表 17. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个字段。这是 v1.23 及更高版本的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 18. HTTP 响应
HTTP 代码	响应体
200 - OK	`OLMConfig` schema
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 OLMConfig 的状态

表 19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个字段。这是 v1.23 及更高版本的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 20. 请求体参数
参数	类型	描述
`body`	`OLMConfig` schema

表 21. HTTP 响应
HTTP 代码	响应体
200 - OK	`OLMConfig` schema
201 - 已创建	`OLMConfig` schema
401 - 未授权	空