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

配置 [operator.openshift.io/v1]

描述

Config 指定负责创建集群上其他组件的初始配置的配置运算符的行为。该运算符还处理基于 AWS 和 Azure 云的集群的云配置的安装、迁移或同步。兼容性级别 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

metadata

ObjectMeta

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

spec

对象

spec 是 Config Operator 的所需行为的规范。

status

对象

status 定义 Config Operator 的观察到的状态。

.spec

描述

spec 是 Config Operator 的所需行为的规范。

类型

对象

属性 类型 描述

logLevel

字符串

logLevel 是基于意图的整体组件日志记录。它没有提供细粒度的控制，但它是一种管理操作员必须为其操作数解释的粗粒度日志记录选择的简单方法。有效值为：“Normal”、“Debug”、“Trace”、“TraceAll”。默认为“Normal”。

managementState

字符串

managementState 指示运算符是否以及如何管理组件

observedConfig

``

observedConfig 保存控制器从集群状态观察到的稀疏配置。它存在于规范中，因为它是操作符级别的一个输入。

operatorLogLevel

字符串

operatorLogLevel 是操作符本身的基于意图的日志记录。它不提供细粒度的控制，但它是一种简单的方法来管理操作符必须自行解释的粗粒度日志记录选择。“Normal”、“Debug”、“Trace”、“TraceAll”为有效值。默认为“Normal”。

unsupportedConfigOverrides

``

unsupportedConfigOverrides 覆盖了操作符计算的最终配置。Red Hat 不支持使用此字段。误用此字段可能导致意外行为或与其他配置选项冲突。在使用此字段之前，请寻求 Red Hat 支持的指导。使用此属性会阻止集群升级，必须在升级集群之前将其删除。

.status

描述

status 定义 Config Operator 的观察到的状态。

类型

对象

属性 类型 描述

conditions

数组

conditions 是条件及其状态的列表。

conditions[]

对象

OperatorCondition 只是标准的条件字段。

generations

数组

generations 用于确定何时需要协调某个项目，或者项目以需要做出反应的方式发生了更改。

generations[]

对象

GenerationStatus 跟踪给定资源的代数，以便可以做出关于强制更新的决策。

observedGeneration

整数

observedGeneration 是您已处理的最后一代更改。

readyReplicas

整数

readyReplicas 指示有多少个副本已准备就绪并处于所需状态。

version

字符串

version 是此可用性适用的级别。

.status.conditions

描述

conditions 是条件及其状态的列表。

类型

数组

.status.conditions[]

描述

OperatorCondition 只是标准的条件字段。

类型

对象

必需

  • 类型

属性 类型 描述

lastTransitionTime

字符串

消息

字符串

原因

字符串

status

字符串

类型

字符串

.status.generations

描述

generations 用于确定何时需要协调某个项目，或者项目以需要做出反应的方式发生了更改。

类型

数组

.status.generations[]

描述

GenerationStatus 跟踪给定资源的代数，以便可以做出关于强制更新的决策。

类型

对象

属性 类型 描述

组

字符串

group 是您正在跟踪的对象的组。

哈希值

字符串

hash 是为没有代数且对内容敏感的资源（如密钥和配置映射）设置的可选字段。

lastGeneration

整数

lastGeneration 是所涉及的工作负载控制器的最后一代。

名称

字符串

name 是您正在跟踪的对象的名称。

命名空间

字符串

namespace 是您正在跟踪的对象所在的命名空间。

资源

字符串

resource 是您正在跟踪的对象的资源类型。

API 端点

提供以下 API 端点：

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

    • DELETE：删除 Config 集合

    • GET：列出 Config 类型的对象

    • POST：创建 Config

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

    • DELETE：删除 Config

    • GET：读取指定的 Config

    • PATCH：部分更新指定的 Config

    • PUT：替换指定的 Config

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

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

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

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

/apis/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. 请求体参数
参数 类型 描述

请求体

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

200 - OK

Config 模式

201 - 已创建

Config 模式

202 - 已接受

Config 模式

401 - 未授权

空

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

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

名称

字符串

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. 请求体参数
参数 类型 描述

请求体

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

200 - OK

Config 模式

201 - 已创建

Config 模式

401 - 未授权

空

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

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

名称

字符串

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. 请求体参数
参数 类型 描述

请求体

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

200 - OK

Config 模式

201 - 已创建

Config 模式

401 - 未授权

空