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

规格
API 端点

描述

KubeAPIServer 提供信息来配置运算符以管理 kube-apiserver。兼容性级别 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 API Server 期望行为的规范
`status`	`对象`	status 为 Kubernetes API Server 最近观察到的状态

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 API Server 期望行为的规范

status

对象

status 为 Kubernetes API Server 最近观察到的状态

.spec

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

属性类型描述

属性	类型	描述
`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 支持的指导。使用此属性会阻止集群升级，必须在升级集群之前将其删除。

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 支持的指导。使用此属性会阻止集群升级，必须在升级集群之前将其删除。

.status

描述: status 为 Kubernetes API Server 最近观察到的状态
类型: 对象

属性类型描述

属性	类型	描述
`conditions`	`数组`	conditions 是条件及其状态的列表
`conditions[]`	`对象`	OperatorCondition 只是标准的条件字段。
`generations`	`数组`	generations 用于确定何时需要协调某个项目或项目以某种需要反应的方式发生了更改。
`generations[]`	`对象`	GenerationStatus 跟踪给定资源的 generation，以便可以做出关于强制更新的决策。
`latestAvailableRevision`	`整数`	latestAvailableRevision 是最近部署的 deploymentID
`latestAvailableRevisionReason`	`字符串`	latestAvailableRevisionReason 描述了最近部署的详细原因
`nodeStatuses`	`数组`	nodeStatuses 跟踪各个节点上的部署值和错误
`nodeStatuses[]`	`对象`	NodeStatus 提供有关此操作员管理的特定节点的当前状态的信息。
`observedGeneration`	`整数`	observedGeneration 是您已处理的最后一代更改
`readyReplicas`	`整数`	readyReplicas 指示有多少副本已准备好并处于所需状态
`serviceAccountIssuers`	`数组`	serviceAccountIssuers 跟踪已使用的服务帐户颁发者的历史记录。没有过期时间的项目代表当前使用的服务帐户颁发者。其他项目代表以前使用过并且仍在被信任的服务帐户颁发者。项目的默认过期时间由平台设置，默认为 24 小时。参见：https://kubernetes.ac.cn/docs/tasks/configure-pod-container/configure-service-account/#service-account-token-volume-projection
`serviceAccountIssuers[]`	`对象`
`version`	`字符串`	version 是此可用性适用的级别

conditions

数组

conditions 是条件及其状态的列表

conditions[]

对象

OperatorCondition 只是标准的条件字段。

generations

数组

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

generations[]

对象

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

latestAvailableRevision

整数

latestAvailableRevision 是最近部署的 deploymentID

latestAvailableRevisionReason

字符串

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

nodeStatuses

数组

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

nodeStatuses[]

对象

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

observedGeneration

整数

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

readyReplicas

整数

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

serviceAccountIssuers

数组

serviceAccountIssuers 跟踪已使用的服务帐户颁发者的历史记录。没有过期时间的项目代表当前使用的服务帐户颁发者。其他项目代表以前使用过并且仍在被信任的服务帐户颁发者。项目的默认过期时间由平台设置，默认为 24 小时。参见：https://kubernetes.ac.cn/docs/tasks/configure-pod-container/configure-service-account/#service-account-token-volume-projection

serviceAccountIssuers[]

对象

version

字符串

version 是此可用性适用的级别

.status.conditions

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

.status.conditions[]

描述

OperatorCondition 只是标准的条件字段。

类型

对象

必需

type

属性类型描述

属性	类型	描述
`lastTransitionTime`	`字符串`
`message`	`字符串`
`reason`	`字符串`
`status`	`字符串`
`type`	`字符串`

lastTransitionTime

字符串

message

字符串

reason

字符串

status

字符串

type

字符串

.status.generations

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

.status.generations[]

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

属性类型描述

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

group

字符串

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

hash

字符串

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

lastGeneration

整数

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

name

字符串

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

namespace

字符串

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

resource

字符串

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

.status.nodeStatuses

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

.status.nodeStatuses[]

描述

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

类型

对象

必需

nodeName

属性类型描述

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

currentRevision

整数

currentRevision 是最近一次成功部署的 generation

lastFailedCount

整数

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

lastFailedReason

字符串

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

lastFailedRevision

整数

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

lastFailedRevisionErrors

数组 (字符串)

lastFailedRevisionErrors 是上次失败的部署（在 lastFailedRevision 中引用）期间出现的人类可读错误列表。

lastFailedTime

字符串

lastFailedTime 是上次失败的修订版上次失败的时间。

lastFallbackCount

整数

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

nodeName

字符串

nodeName 是节点的名称

targetRevision

整数

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

.status.serviceAccountIssuers

描述: serviceAccountIssuers 跟踪已使用的服务帐户颁发者的历史记录。没有过期时间的项目代表当前使用的服务帐户颁发者。其他项目代表以前使用过并且仍在被信任的服务帐户颁发者。项目的默认过期时间由平台设置，默认为 24 小时。参见：https://kubernetes.ac.cn/docs/tasks/configure-pod-container/configure-service-account/#service-account-token-volume-projection
类型: 数组

.status.serviceAccountIssuers[]

描述
类型: 对象

属性类型描述

属性	类型	描述
`expirationTime`	`字符串`	expirationTime 是此服务帐户颁发者将被修剪并从受信任的服务帐户颁发者列表中删除的时间。
`name`	`字符串`	name 是服务帐户颁发者的名称 ---

expirationTime

字符串

expirationTime 是此服务帐户颁发者将被修剪并从受信任的服务帐户颁发者列表中删除的时间。

name

字符串

name 是服务帐户颁发者的名称 ---

API 端点

提供以下 API 端点

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

/apis/operator.openshift.io/v1/kubeapiservers

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

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

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

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

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

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

表 4. 请求体参数
参数	类型	描述
`body`	`KubeAPIServer` 模式

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

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

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

HTTP 方法: DELETE
描述: 删除 KubeAPIServer

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

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

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

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

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

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

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

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

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

表 13. 请求体参数
参数	类型	描述
`body`	`KubeAPIServer` 模式

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

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

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

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

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

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

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

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

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

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

表 20. 请求体参数
参数	类型	描述
`body`	`KubeAPIServer` 模式

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