KubeControllerManager [operator.openshift.io/v1] - 运营商 API | API 参考 | OpenShift Container Platform 4.17

规格
API 端点

描述

KubeControllerManager 提供信息来配置一个运算符以管理 kube-controller-manager。兼容性级别 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 是 Kubernetes Controller Manager 期望行为的规范
`status`	`对象`	status 是 Kubernetes Controller Manager 最近观察到的状态

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 是 Kubernetes Controller Manager 期望行为的规范

status

对象

status 是 Kubernetes Controller Manager 最近观察到的状态

.spec

描述: spec 是 Kubernetes Controller Manager 期望行为的规范
类型: 对象

属性类型描述

属性	类型	描述
`failedRevisionLimit`	`整数`	failedRevisionLimit 是要在磁盘和 api 中保留的失败静态 pod 安装程序修订版的数量 -1 = 无限，0 或未设置 = 5（默认值）
`forceRedeploymentReason`	`字符串`	forceRedeploymentReason 可用于通过提供唯一字符串来强制重新部署操作数。这提供了一种机制来启动先前失败的部署，并说明为什么您认为这次会成功而不是再次在相同的配置上失败。
`logLevel`	`字符串`	logLevel 是基于意图的整体组件日志记录。它没有提供细粒度的控制，但它是一种简单的方法来管理运算符必须为其操作数解释的粗粒度日志记录选择。有效值为：“Normal”、“Debug”、“Trace”、“TraceAll”。默认为“Normal”。
`managementState`	`字符串`	managementState 指示运算符是否以及如何管理组件
`observedConfig`	``	observedConfig 保存控制器从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是对运算符级别的输入
`operatorLogLevel`	`字符串`	operatorLogLevel 是运算符本身的基于意图的日志记录。它没有提供细粒度的控制，但它是一种简单的方法来管理运算符必须为自身解释的粗粒度日志记录选择。有效值为：“Normal”、“Debug”、“Trace”、“TraceAll”。默认为“Normal”。
`succeededRevisionLimit`	`整数`	succeededRevisionLimit 是要在磁盘和 api 中保留的成功静态 pod 安装程序修订版的数量 -1 = 无限，0 或未设置 = 5（默认值）
`unsupportedConfigOverrides`	``	unsupportedConfigOverrides 覆盖由运算符计算的最终配置。Red Hat 不支持使用此字段。误用此字段可能导致意外行为或与其他配置选项冲突。在使用此字段之前，请寻求 Red Hat 支持的指导。使用此属性会阻止集群升级，必须在升级集群之前将其删除。
`useMoreSecureServiceCA`	`布尔值`	`useMoreSecureServiceCA` 指示在 SA 令牌卷中提供的 service-ca.crt 应该只包含验证服务证书所需的证书。一旦设置为 true，就不能再设置为 false。即使有人找到方法将其改回 false，之前存在的 service-ca.crt 文件也只会包含更安全的內容。

failedRevisionLimit

整数

failedRevisionLimit 是要在磁盘和 api 中保留的失败静态 pod 安装程序修订版的数量 -1 = 无限，0 或未设置 = 5（默认值）

forceRedeploymentReason

字符串

forceRedeploymentReason 可用于通过提供唯一字符串来强制重新部署操作数。这提供了一种机制来启动先前失败的部署，并说明为什么您认为这次会成功而不是再次在相同的配置上失败。

logLevel

字符串

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

managementState

字符串

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

observedConfig

observedConfig 保存控制器从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是对运算符级别的输入

operatorLogLevel

字符串

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

succeededRevisionLimit

整数

succeededRevisionLimit 是要在磁盘和 api 中保留的成功静态 pod 安装程序修订版的数量 -1 = 无限，0 或未设置 = 5（默认值）

unsupportedConfigOverrides

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

useMoreSecureServiceCA

布尔值

useMoreSecureServiceCA 指示在 SA 令牌卷中提供的 service-ca.crt 应该只包含验证服务证书所需的证书。一旦设置为 true，就不能再设置为 false。即使有人找到方法将其改回 false，之前存在的 service-ca.crt 文件也只会包含更安全的內容。

.status

描述: status 是 Kubernetes Controller Manager 最近观察到的状态
类型: 对象

属性类型描述

属性	类型	描述
`条件`	`数组`	conditions 是一个条件及其状态的列表
`conditions[]`	`对象`	OperatorCondition 只是标准的条件字段。
`代`	`数组`	generations 用于确定何时需要协调某个项目，或者项目以需要做出反应的方式发生了更改。
`generations[]`	`对象`	GenerationStatus 跟踪给定资源的代数，以便可以做出关于强制更新的决策。
`最新可用版本`	`整数`	latestAvailableRevision 是最近部署的 deploymentID
`最新可用版本原因`	`字符串`	latestAvailableRevisionReason 描述最近部署的详细原因
`节点状态`	`数组`	nodeStatuses 跟踪各个节点上的部署值和错误
`nodeStatuses[]`	`对象`	NodeStatus 提供有关此操作符管理的特定节点的当前状态的信息。
`已观察到的代`	`整数`	observedGeneration 是您已处理的最后一代变化
`就绪副本数`	`整数`	readyReplicas 指示有多少个副本已准备就绪并处于所需状态
`版本`	`字符串`	version 是此可用性适用的级别

条件

数组

conditions 是一个条件及其状态的列表

conditions[]

对象

OperatorCondition 只是标准的条件字段。

代

数组

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

generations[]

对象

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

最新可用版本

整数

latestAvailableRevision 是最近部署的 deploymentID

最新可用版本原因

字符串

latestAvailableRevisionReason 描述最近部署的详细原因

节点状态

数组

nodeStatuses 跟踪各个节点上的部署值和错误

nodeStatuses[]

对象

NodeStatus 提供有关此操作符管理的特定节点的当前状态的信息。

已观察到的代

整数

observedGeneration 是您已处理的最后一代变化

就绪副本数

整数

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

版本

字符串

version 是此可用性适用的级别

.status.conditions

描述: conditions 是一个条件及其状态的列表
类型: 数组

.status.conditions[]

描述

OperatorCondition 只是标准的条件字段。

类型

对象

必需

类型

属性类型描述

属性	类型	描述
`最后一次转换时间`	`字符串`
`消息`	`字符串`
`原因`	`字符串`
`status`	`字符串`
`类型`	`字符串`

最后一次转换时间

字符串

消息

字符串

原因

字符串

status

字符串

类型

字符串

.status.generations

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

.status.generations[]

描述: GenerationStatus 跟踪给定资源的代数，以便可以做出关于强制更新的决策。
类型: 对象

属性类型描述

属性	类型	描述
`组`	`字符串`	group 是您正在跟踪的对象的组
`哈希值`	`字符串`	hash 是为没有 generation 但对内容敏感的资源（如密钥和 ConfigMap）设置的可选字段
`最后一代`	`整数`	lastGeneration 是所涉及的工作负载控制器的最后一代
`名称`	`字符串`	name 是您正在跟踪的对象的名称
`命名空间`	`字符串`	namespace 是您正在跟踪的对象所在的命名空间
`资源`	`字符串`	resource 是您正在跟踪的对象的资源类型

组

字符串

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

哈希值

字符串

hash 是为没有 generation 但对内容敏感的资源（如密钥和 ConfigMap）设置的可选字段

最后一代

整数

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

名称

字符串

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

命名空间

字符串

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

资源

字符串

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

.status.nodeStatuses

描述: nodeStatuses 跟踪各个节点上的部署值和错误
类型: 数组

.status.nodeStatuses[]

描述

NodeStatus 提供有关此操作符管理的特定节点的当前状态的信息。

类型

对象

必需

节点名称

属性类型描述

属性	类型	描述
`当前版本`	`整数`	currentRevision 是最近一次成功部署的代数
`上次失败次数`	`整数`	lastFailedCount 是上次失败版本的安装程序 Pod 失败的次数。
`上次失败原因`	`字符串`	lastFailedReason 是一个机器可读的失败原因字符串。
`上次失败版本`	`整数`	lastFailedRevision 是我们尝试部署但失败的部署的代数。
`上次失败版本错误`	`数组 (字符串)`	lastFailedRevisionErrors 是在 lastFailedRevision 中引用的失败部署期间发生的人类可读错误列表。
`上次失败时间`	`字符串`	lastFailedTime 是上次失败版本最后一次失败的时间。
`上次回退次数`	`整数`	lastFallbackCount 是回退到先前版本的次数。
`节点名称`	`字符串`	nodeName 是节点的名称
`目标版本`	`整数`	targetRevision 是我们正在尝试应用的部署的代数

当前版本

整数

currentRevision 是最近一次成功部署的代数

上次失败次数

整数

lastFailedCount 是上次失败版本的安装程序 Pod 失败的次数。

上次失败原因

字符串

lastFailedReason 是一个机器可读的失败原因字符串。

上次失败版本

整数

lastFailedRevision 是我们尝试部署但失败的部署的代数。

上次失败版本错误

数组 (字符串)

lastFailedRevisionErrors 是在 lastFailedRevision 中引用的失败部署期间发生的人类可读错误列表。

上次失败时间

字符串

lastFailedTime 是上次失败版本最后一次失败的时间。

上次回退次数

整数

lastFallbackCount 是回退到先前版本的次数。

节点名称

字符串

nodeName 是节点的名称

目标版本

整数

targetRevision 是我们正在尝试应用的部署的代数

API 端点

提供以下 API 端点

/apis/operator.openshift.io/v1/kubecontrollermanagers
- DELETE: 删除 KubeControllerManager 集合
- GET: 列出 KubeControllerManager 类型的对象
- POST: 创建一个 KubeControllerManager
/apis/operator.openshift.io/v1/kubecontrollermanagers/{name}
- DELETE: 删除一个 KubeControllerManager
- GET: 读取指定的 KubeControllerManager
- PATCH: 部分更新指定的 KubeControllerManager
- PUT: 替换指定的 KubeControllerManager
/apis/operator.openshift.io/v1/kubecontrollermanagers/{name}/status
- GET: 读取指定 KubeControllerManager 的状态
- PATCH: 部分更新指定 KubeControllerManager 的状态
- PUT: 替换指定 KubeControllerManager 的状态

/apis/operator.openshift.io/v1/kubecontrollermanagers

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

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

HTTP 方法: GET
描述: 列出 KubeControllerManager 类型的对象

表 2. HTTP 响应
HTTP 代码	响应体
200 - OK	`KubeControllerManagerList` 模式
401 - 未授权	空

HTTP 方法: POST
描述: 创建一个 KubeControllerManager

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

表 4. 主体参数
参数	类型	描述
`主体`	`KubeControllerManager` 模式

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

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

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

HTTP 方法: DELETE
描述: 删除一个 KubeControllerManager

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

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

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

表 9. HTTP 响应
HTTP 代码	响应体
200 - OK	`KubeControllerManager` 模式
401 - 未授权	空

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

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

表 11. HTTP 响应
HTTP 代码	响应体
200 - OK	`KubeControllerManager` 模式
401 - 未授权	空

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

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

表 13. 主体参数
参数	类型	描述
`主体`	`KubeControllerManager` 模式

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

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

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

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

表 16. HTTP 响应
HTTP 代码	响应体
200 - OK	`KubeControllerManager` 模式
401 - 未授权	空

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

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

表 18. HTTP 响应
HTTP 代码	响应体
200 - OK	`KubeControllerManager` 模式
401 - 未授权	空

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

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

表 20. 主体参数
参数	类型	描述
`主体`	`KubeControllerManager` 模式

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