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

配置 [samples.operator.openshift.io/v1]

描述

Config 包含样本运算符的配置和详细条件状态。兼容性级别 1：在主要版本中稳定至少 12 个月或 3 个次要版本（以较长者为准）。

类型

对象

必需

  • 元数据

  • spec

规范

属性 类型 描述

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

对象

ConfigSpec 包含样本运算符所需的配置和状态，控制其在 openshift 命名空间中创建/更新镜像流和模板的各种行为。

status

对象

ConfigStatus 包含实际生效的配置，以及描述样本运算符状态的各种详细信息。

.spec

描述

ConfigSpec 包含样本运算符所需的配置和状态，控制其在 openshift 命名空间中创建/更新镜像流和模板的各种行为。

类型

对象

属性 类型 描述

architectures

数组（字符串）

architectures 确定要安装的哪些硬件架构，目前仅支持 x86_64、ppc64le 和 s390x。

managementState

字符串

managementState 是所有运算符的顶级开关。当为“Managed”时，此运算符会处理配置并相应地操作样本。当为“Unmanaged”时，此运算符会忽略对其监视的资源的任何更新。当为“Removed”时，它的反应方式与删除 Config 对象时相同，这意味着它管理的任何 ImageStreams 或 Templates（即它遵守跳过的列表）和注册表密钥都将被删除，以及运算符命名空间中表示上次用于操作样本的配置的 ConfigMap。

samplesRegistry

字符串

samplesRegistry 允许指定 ImageStreams 访问其镜像内容的注册表。默认为 https://github.com/openshift/library 中的内容，这些内容被拉取到此 github 存储库中，但基于我们仅拉取 ocp 内容，它通常默认为 registry.redhat.io。

skippedImagestreams

数组（字符串）

skippedImagestreams 指定不应创建/更新的镜像流的名称。管理员可以使用此功能来删除他们不需要的内容。他们仍然必须手动删除内容，但运算符不会重新创建（或更新）此处列出的任何内容。

skippedTemplates

数组（字符串）

skippedTemplates 指定不应创建/更新的模板的名称。管理员可以使用此功能来删除他们不需要的内容。他们仍然必须手动删除内容，但运算符不会重新创建（或更新）此处列出的任何内容。

.status

描述

ConfigStatus 包含实际生效的配置，以及描述样本运算符状态的各种详细信息。

类型

对象

属性 类型 描述

architectures

数组（字符串）

architectures 确定要安装的哪些硬件架构，支持 x86_64 和 ppc64le。

conditions

数组

conditions 表示样本镜像流和模板的可用维护状态。

conditions[]

对象

ConfigCondition 将 Config 的各种条件捕获为处理条目。

managementState

字符串

managementState 反映运算符开关的当前运行状态。此运算符将 ManagementState 作为确定我们正在重新打开运算符（即“Managed”）的一部分进行比较，而之前它是“Unmanaged”。

samplesRegistry

字符串

samplesRegistry 允许指定 ImageStreams 访问其镜像内容的注册表。默认为 https://github.com/openshift/library 中的内容，这些内容被拉取到此 github 存储库中，但基于我们仅拉取 ocp 内容，它通常默认为 registry.redhat.io。

skippedImagestreams

数组（字符串）

skippedImagestreams 指定不应创建/更新的镜像流的名称。管理员可以使用此功能来删除他们不需要的内容。他们仍然必须手动删除内容，但运算符不会重新创建（或更新）此处列出的任何内容。

skippedTemplates

数组（字符串）

skippedTemplates 指定不应创建/更新的模板的名称。管理员可以使用此功能来删除他们不需要的内容。他们仍然必须手动删除内容，但运算符不会重新创建（或更新）此处列出的任何内容。

版本

字符串

version 表示上次成功处理操作符有效负载时基于版本的指示器的值。

.status.conditions

描述

conditions 表示样本镜像流和模板的可用维护状态。

类型

数组

.status.conditions[]

描述

ConfigCondition 将 Config 的各种条件捕获为处理条目。

类型

对象

必需

  • status

  • 类型

属性 类型 描述

最后转换时间

字符串

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

最后更新时间

字符串

lastUpdateTime 指的是最后一次更新此条件的时间。

消息

字符串

message 是一个易于理解的消息，指示有关转换的详细信息。

原因

字符串

reason 是导致条件最后一次转换的原因。

status

字符串

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

类型

字符串

条件的类型。

API 端点

提供以下 API 端点：

  • /apis/samples.operator.openshift.io/v1/configs

    • DELETE：删除 Config 集合

    • GET：列出 Config 类型的对象

    • POST：创建一个 Config

  • /apis/samples.operator.openshift.io/v1/configs/{name}

    • DELETE：删除一个 Config

    • GET：读取指定的 Config

    • PATCH：部分更新指定的 Config

    • PUT：替换指定的 Config

  • /apis/samples.operator.openshift.io/v1/configs/{name}/status

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

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

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

/apis/samples.operator.openshift.io/v1/configs

HTTP 方法

DELETE

描述

删除 Config 集合

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

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 Config 类型的对象

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

200 - OK

ConfigList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建一个 Config

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

Config 模式

201 - 已创建

Config 模式

202 - 已接受

Config 模式

401 - 未授权

空

/apis/samples.operator.openshift.io/v1/configs/{name}

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

name

字符串

Config 的名称
HTTP 方法

DELETE

描述

删除一个 Config

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 Config

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

200 - OK

Config 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 Config

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

Config 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 Config

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

Config 模式

201 - 已创建

Config 模式

401 - 未授权

空

/apis/samples.operator.openshift.io/v1/configs/{name}/status

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

name

字符串

Config 的名称
HTTP 方法

GET

描述

读取指定的 Config 的状态

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

200 - OK

Config 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 Config 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

Config 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 Config 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

Config 模式

201 - 已创建

Config 模式

401 - 未授权

空