MachineConfig [machineconfiguration.openshift.io/v1] - 机器 API | API 参考 | OpenShift Container Platform 4.17

规格
- .spec
API端点
- /apis/machineconfiguration.openshift.io/v1/machineconfigs
- /apis/machineconfiguration.openshift.io/v1/machineconfigs/{name}

描述: MachineConfig定义了机器的配置兼容性级别1：在主要版本内稳定至少12个月或3个次要版本（以较长者为准）。
类型: 对象

规格

属性类型描述

属性	类型	描述
`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`	`对象`	MachineConfigSpec是MachineConfig的规范

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

对象

MachineConfigSpec是MachineConfig的规范

.spec

描述: MachineConfigSpec是MachineConfig的规范
类型: 对象

属性类型描述

属性	类型	描述
`baseOSExtensionsContainerImage`	`字符串`	BaseOSExtensionsContainerImage指定将用于获取与新格式操作系统映像匹配的扩展容器的远程位置
`config`	``	Config是一个Ignition配置对象。
`扩展`	`数组 (字符串)`	extensions 包含可在主机上启用的附加功能列表。
`fips`	`布尔值`	fips 控制 FIPS 模式。
`内核参数`	``	kernelArguments 包含要添加的内核参数列表。
`内核类型`	`字符串`	kernelType 指定我们希望运行的内核类型，例如默认 (传统)、实时、64k-pages（仅限 aarch64）。
`操作系统镜像URL`	`字符串`	OSImageURL 指定用于获取操作系统的远程位置。

baseOSExtensionsContainerImage

字符串

BaseOSExtensionsContainerImage指定将用于获取与新格式操作系统映像匹配的扩展容器的远程位置

config

Config是一个Ignition配置对象。

扩展

数组 (字符串)

extensions 包含可在主机上启用的附加功能列表。

fips

布尔值

fips 控制 FIPS 模式。

内核参数

kernelArguments 包含要添加的内核参数列表。

内核类型

字符串

kernelType 指定我们希望运行的内核类型，例如默认 (传统)、实时、64k-pages（仅限 aarch64）。

操作系统镜像URL

字符串

OSImageURL 指定用于获取操作系统的远程位置。

API 端点

提供以下 API 端点：

/apis/machineconfiguration.openshift.io/v1/machineconfigs
- DELETE: 删除 MachineConfig 集合
- GET: 列出 MachineConfig 对象
- POST: 创建 MachineConfig
/apis/machineconfiguration.openshift.io/v1/machineconfigs/{name}
- DELETE: 删除 MachineConfig
- GET: 读取指定的 MachineConfig
- PATCH: 部分更新指定的 MachineConfig
- PUT: 替换指定的 MachineConfig

/apis/machineconfiguration.openshift.io/v1/machineconfigs

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

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

HTTP 方法: GET
描述: 列出 MachineConfig 对象

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

HTTP 方法: POST
描述: 创建 MachineConfig

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

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

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

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

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

HTTP 方法: DELETE
描述: 删除 MachineConfig

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

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

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

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

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

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

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

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

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

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

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