×

规格

属性 类型 描述

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

对象

ControllerConfigSpec 是 ControllerConfig 资源的规范。

status

对象

ControllerConfigStatus 是 ControllerConfig 的状态

.spec

描述

ControllerConfigSpec 是 ControllerConfig 资源的规范。

类型

对象

必需
  • baseOSContainerImage

  • cloudProviderConfig

  • clusterDNSIP

  • images

  • ipFamilies

  • kubeAPIServerServingCAData

  • releaseImage

  • rootCAData

属性 类型 描述

additionalTrustBundle

``

additionalTrustBundle 是一个证书包,它将添加到节点可信证书存储中。

baseOSContainerImage

字符串

BaseOSContainerImage 是用于操作系统更新的新格式容器镜像。

baseOSExtensionsContainerImage

字符串

BaseOSExtensionsContainerImage 是新格式容器的匹配扩展容器

cloudProviderCAData

``

cloudProvider 指定云提供商 CA 数据

cloudProviderConfig

字符串

cloudProviderConfig 是给定云提供商的配置

clusterDNSIP

字符串

clusterDNSIP 是集群 DNS IP 地址

dns

对象

dns 包含集群 dns 详细信息

etcdDiscoveryDomain

字符串

etcdDiscoveryDomain 已弃用,请改用 Infra.Status.EtcdDiscoveryDomain

imageRegistryBundleData

数组

imageRegistryBundleData 是 ImageRegistryData

imageRegistryBundleData[]

对象

ImageRegistryBundle 包含写入镜像注册表证书的信息

imageRegistryBundleUserData

数组

imageRegistryBundleUserData 是用户提供 的镜像注册表数据

imageRegistryBundleUserData[]

对象

ImageRegistryBundle 包含写入镜像注册表证书的信息

images

对象(字符串)

images 是控制器用于在 ./templates/ 下呈现模板的镜像映射。

infra

对象

infra 包含基础设施详细信息

internalRegistryPullSecret

``

internalRegistryPullSecret 是内部注册表的拉取密钥,如果存在,则由 rpm-ostree 用于从内部注册表拉取镜像

ipFamilies

字符串

ipFamilies 指示集群网络中使用的 IP 族

kubeAPIServerServingCAData

字符串

kubeAPIServerServingCAData 管理的 Kubelet 到 API 服务器 Cert……自动轮换

network

``

Network 包含其他网络相关信息

networkType

字符串

networkType 字段保存集群使用的网络类型 XXX:这是临时的,将尽快弃用,以便更好地支持以正确的方式启动网络相关服务。集群首次启动并运行后,没有人会更改此字段,因此,如果此字段发生更改,则不允许重新生成。

osImageURL

字符串

OSImageURL 是包含操作系统更新有效负载的旧格式容器镜像。

platform

字符串

platform 已弃用,请使用 Infra.Status.PlatformStatus.Type 代替。

proxy

``

proxy 保存节点当前的代理配置。

pullSecret

对象

pullSecret 是需要安装在所有机器上的默认拉取密钥。

releaseImage

字符串

releaseImage 是安装集群时使用的镜像。

rootCAData

字符串

rootCAData 指定根 CA 数据。

.spec.dns

描述

dns 包含集群 dns 详细信息

类型

对象

必需
  • spec

  • kind

  • apiVersion

属性 类型 描述

apiVersion

字符串

apiVersion 定义此对象表示的版本化模式。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是表示此对象类型的字符串值,采用驼峰命名法。更多信息: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.imageRegistryBundleData

描述

imageRegistryBundleData 是 ImageRegistryData

类型

数组

.spec.imageRegistryBundleData[]

描述

ImageRegistryBundle 包含写入镜像注册表证书的信息

类型

对象

必需
  • data

  • file

属性 类型 描述

data

字符串

data 保存将写入文件位置的捆绑包的内容。

file

字符串

file 保存将捆绑包写入磁盘的文件名。

.spec.imageRegistryBundleUserData

描述

imageRegistryBundleUserData 是用户提供 的镜像注册表数据

类型

数组

.spec.imageRegistryBundleUserData[]

描述

ImageRegistryBundle 包含写入镜像注册表证书的信息

类型

对象

必需
  • data

  • file

属性 类型 描述

data

字符串

data 保存将写入文件位置的捆绑包的内容。

file

字符串

file 保存将捆绑包写入磁盘的文件名。

.spec.infra

描述

infra 包含基础设施详细信息

类型

对象

必需
  • spec

  • kind

  • apiVersion

属性 类型 描述

apiVersion

字符串

apiVersion 定义此对象表示的版本化模式。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是表示此对象类型的字符串值,采用驼峰命名法。更多信息: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.pullSecret

描述

pullSecret 是需要安装在所有机器上的默认拉取密钥。

类型

对象

属性 类型 描述

apiVersion

字符串

引用的 API 版本。

fieldPath

字符串

如果引用的是对象的一部分而不是整个对象,则此字符串应包含有效的 JSON/Go 字段访问语句,例如 desiredState.manifest.containers[2]。例如,如果对象引用指向 Pod 中的容器,则其值将类似于:“spec.containers{name}”(其中“name”指的是触发事件的容器名称)或者如果未指定容器名称则为“spec.containers[2]”(此 Pod 中索引为 2 的容器)。选择此语法只是为了有一种明确定义的方法来引用对象的一部分。待办事项:此设计尚未最终确定,此字段将来可能会更改。

kind

字符串

引用的 Kind。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

字符串

引用的名称。更多信息:https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names

namespace

字符串

引用的命名空间。更多信息:https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

字符串

此引用的特定 resourceVersion(如果存在)。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

字符串

引用的 UID。更多信息:https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#uids

.status

描述

ControllerConfigStatus 是 ControllerConfig 的状态

类型

对象

属性 类型 描述

conditions

数组

conditions 表示当前状态的最新可用观察结果。

conditions[]

对象

ControllerConfigStatusCondition 包含 ControllerConfigStatus 的条件信息。

controllerCertificates

数组

controllerCertificates 表示 MCO 中自动轮换的证书的最新可用观察结果。

controllerCertificates[]

对象

ControllerCertificate 包含有关特定证书的信息。

observedGeneration

整数

observedGeneration 表示控制器观察到的世代。

.status.conditions

描述

conditions 表示当前状态的最新可用观察结果。

类型

数组

.status.conditions[]

描述

ControllerConfigStatusCondition 包含 ControllerConfigStatus 的条件信息。

类型

对象

必需
  • status

  • type

属性 类型 描述

lastTransitionTime

``

lastTransitionTime 是上次更新当前状态对象的日期和时间。

message

字符串

message 提供有关当前条件的附加信息。这仅供人类使用。

reason

字符串

reason 是条件上次转换的原因。原因使用帕斯卡命名法。

status

字符串

条件的状态,True、False 或 Unknown 之一。

type

字符串

type 指定操作符协调功能的状态。

.status.controllerCertificates

描述

controllerCertificates 表示 MCO 中自动轮换的证书的最新可用观察结果。

类型

数组

.status.controllerCertificates[]

描述

ControllerCertificate 包含有关特定证书的信息。

类型

对象

必需
  • bundleFile

  • signer

  • subject

属性 类型 描述

bundleFile

字符串

bundleFile 是证书来源的较大捆绑包。

notAfter

字符串

notAfter 是有效性的上限。

notBefore

字符串

notBefore 是有效性的下限。

signer

字符串

signer 是证书颁发者。

subject

字符串

subject 是证书主题。

API 端点

提供以下 API 端点

  • /apis/machineconfiguration.openshift.io/v1/controllerconfigs

    • DELETE:删除 ControllerConfig 集合

    • GET:列出 ControllerConfig 类型的对象

    • POST:创建一个 ControllerConfig

  • /apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}

    • DELETE:删除一个 ControllerConfig

    • GET:读取指定的 ControllerConfig

    • PATCH:部分更新指定的 ControllerConfig

    • PUT:替换指定的 ControllerConfig

  • /apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}/status

    • GET:读取指定的 ControllerConfig 的状态

    • PATCH:部分更新指定的 ControllerConfig 的状态

    • PUT:替换指定的 ControllerConfig 的状态

/apis/machineconfiguration.openshift.io/v1/controllerconfigs

HTTP 方法

DELETE

描述

删除 ControllerConfig 集合

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

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法

GET

描述

列出 ControllerConfig 类型的对象

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

200 - OK

ControllerConfigList 模式

401 - Unauthorized

HTTP 方法

POST

描述

创建一个 ControllerConfig

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

dryRun

字符串

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

fieldValidation

字符串

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

表 4. 请求体参数
参数 类型 描述

body

ControllerConfig 模式

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

200 - OK

ControllerConfig 模式

201 - Created

ControllerConfig 模式

202 - Accepted

ControllerConfig 模式

401 - Unauthorized

/apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}

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

name

字符串

ControllerConfig 的名称

HTTP 方法

DELETE

描述

删除一个 ControllerConfig

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

dryRun

字符串

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

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

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法

GET

描述

读取指定的 ControllerConfig

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

200 - OK

ControllerConfig 模式

401 - Unauthorized

HTTP 方法

PATCH

描述

部分更新指定的 ControllerConfig

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

dryRun

字符串

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

fieldValidation

字符串

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

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

200 - OK

ControllerConfig 模式

401 - Unauthorized

HTTP 方法

PUT

描述

替换指定的 ControllerConfig

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

dryRun

字符串

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

fieldValidation

字符串

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

表 13. 请求体参数
参数 类型 描述

body

ControllerConfig 模式

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

200 - OK

ControllerConfig 模式

201 - Created

ControllerConfig 模式

401 - Unauthorized

/apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}/status

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

name

字符串

ControllerConfig 的名称

HTTP 方法

GET

描述

读取指定 ControllerConfig 的状态

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

200 - OK

ControllerConfig 模式

401 - Unauthorized

HTTP 方法

PATCH

描述

部分更新指定 ControllerConfig 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

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

200 - OK

ControllerConfig 模式

401 - Unauthorized

HTTP 方法

PUT

描述

替换指定 ControllerConfig 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

表 20. 请求体参数
参数 类型 描述

body

ControllerConfig 模式

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

200 - OK

ControllerConfig 模式

201 - Created

ControllerConfig 模式

401 - Unauthorized