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

OperatorHub [config.openshift.io/v1]

描述

OperatorHub 是 operatorhubs API 的模式。它可用于将集群上 OperatorHub 的默认中心源的状态从启用更改为禁用，反之亦然。兼容性级别 1：在主要版本中至少稳定 12 个月或 3 个次要版本（以较长者为准）。

类型

对象

规范

属性 类型 描述

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

对象

OperatorHubSpec 定义 OperatorHub 的期望状态

status

对象

OperatorHubStatus 定义 OperatorHub 的观察状态。默认中心源的当前状态将始终在此处反映。

.spec

描述

OperatorHubSpec 定义 OperatorHub 的期望状态

类型

对象

属性 类型 描述

disableAllDefaultSources

布尔值

disableAllDefaultSources 允许您禁用所有默认中心源。如果为真，则可以使用 sources 中的特定条目启用默认源。如果为假，则可以使用 sources 中的特定条目禁用或启用默认源。

sources

数组

sources 是默认中心源及其配置的列表。如果列表为空，则表示除非 disableAllDefaultSources 为真，否则集群上启用了默认中心源。如果 disableAllDefaultSources 为真且 sources 不为空，则 sources 中的配置将优先。默认中心源及其当前状态的列表将始终反映在状态块中。

sources[]

对象

HubSource 用于指定中心源及其配置

.spec.sources

描述

sources 是默认中心源及其配置的列表。如果列表为空，则表示除非 disableAllDefaultSources 为真，否则集群上启用了默认中心源。如果 disableAllDefaultSources 为真且 sources 不为空，则 sources 中的配置将优先。默认中心源及其当前状态的列表将始终反映在状态块中。

类型

数组

.spec.sources[]

描述

HubSource 用于指定中心源及其配置

类型

对象

属性 类型 描述

disabled

布尔值

disabled 用于在集群上禁用默认中心源

name

字符串

name 是默认中心源之一的名称

.status

描述

OperatorHubStatus 定义 OperatorHub 的观察状态。默认中心源的当前状态将始终在此处反映。

类型

对象

属性 类型 描述

sources

数组

sources 封装了为每个中心源应用配置的结果

sources[]

对象

HubSourceStatus 用于反映将配置应用于默认源的当前状态

.status.sources

描述

sources 封装了为每个中心源应用配置的结果

类型

数组

.status.sources[]

描述

HubSourceStatus 用于反映将配置应用于默认源的当前状态

类型

对象

属性 类型 描述

disabled

布尔值

disabled 用于在集群上禁用默认中心源

message

字符串

message 提供有关故障的更多信息

name

字符串

name 是默认中心源之一的名称

status

字符串

status 指示应用配置的成功或失败

API 端点

提供以下 API 端点

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

    • DELETE：删除 OperatorHub 集合

    • GET：列出 OperatorHub 类型的对象

    • POST：创建 OperatorHub

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

    • DELETE：删除 OperatorHub

    • GET：读取指定的 OperatorHub

    • PATCH：部分更新指定的 OperatorHub

    • PUT：替换指定的 OperatorHub

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

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

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

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

/apis/config.openshift.io/v1/operatorhubs

HTTP 方法

DELETE

描述

删除 OperatorHub 集合

表 1. HTTP 响应
HTTP 代码 响应正文

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 OperatorHub 类型的对象

表 2. HTTP 响应
HTTP 代码 响应正文

200 - OK

OperatorHubList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 OperatorHub

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

dryRun

字符串

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

fieldValidation

字符串

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

body

OperatorHub 模式
表 5. HTTP 响应
HTTP 代码 响应正文

200 - OK

OperatorHub 模式

201 - 已创建

OperatorHub 模式

202 - 已接受

OperatorHub 模式

401 - 未授权

空

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

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

name

字符串

OperatorHub 的名称
HTTP 方法

DELETE

描述

删除 OperatorHub

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 OperatorHub

表 9. HTTP 响应
HTTP 代码 响应正文

200 - OK

OperatorHub 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 OperatorHub

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

OperatorHub 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 OperatorHub

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

dryRun

字符串

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

fieldValidation

字符串

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

body

OperatorHub 模式
表 14. HTTP 响应
HTTP 代码 响应正文

200 - OK

OperatorHub 模式

201 - 已创建

OperatorHub 模式

401 - 未授权

空

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

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

name

字符串

OperatorHub 的名称
HTTP 方法

GET

描述

读取指定的 OperatorHub 的状态

表 16. HTTP 响应
HTTP 代码 响应正文

200 - OK

OperatorHub 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 OperatorHub 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

OperatorHub 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 OperatorHub 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

body

OperatorHub 模式
表 21. HTTP 响应
HTTP 代码 响应正文

200 - OK

OperatorHub 模式

201 - 已创建

OperatorHub 模式

401 - 未授权

空