置备 API

OpenShift Container Platform 4.17

置备 API 的参考指南

Red Hat OpenShift Documentation Team

法律通告

摘要

本文档描述了 OpenShift Container Platform 置备 API 对象及其详细规格。

第 1 章置备 API

1.1. BMCEventSubscription [metal3.io/v1alpha1]

描述: BMCEventSubscription 是快速事件 API 的 Schema
类型: 对象

1.2. BareMetalHost [metal3.io/v1alpha1]

描述: BareMetalHost 是 baremetalhosts API 的 Schema
类型: object

1.3. DataImage [metal3.io/v1alpha1]

描述: DataImage 是 dataimages API 的 Schema。
类型: 对象

1.4. FirmwareSchema [metal3.io/v1alpha1]

描述: FirmwareSchema 是 firmwareschemas API 的 Schema。
类型: object

1.5. HardwareData [metal3.io/v1alpha1]

描述: HardwareData 是 hardwaredata API 的 Schema。
类型: object

1.6. HostFirmwareComponents [metal3.io/v1alpha1]

描述: HostFirmwareComponents 是 hostfirmwarecomponents API 的 Schema。
类型: 对象

1.7. HostFirmwareSettings [metal3.io/v1alpha1]

描述: HostFirmwareSettings 是 hostfirmwaresettings API 的 Schema。
类型: object

1.8. Metal3Remediation [infrastructure.cluster.x-k8s.io/v1beta1]

描述: Metal3Remediation 是 metal3remediations API 的 Schema。
类型: object

1.9. Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]

描述: Metal3RemediationTemplate 是 metal3remediationtemplates API 的 Schema。
类型: object

1.10. PreprovisioningImage [metal3.io/v1alpha1]

描述: PreprovisioningImage 是预置备镜像 API 的 Schema。
类型: 对象

1.11. Provisioning [metal3.io/v1alpha1]

描述: Provisioning 包含由 Provisioning 服务(Ironic)来置备裸机主机的配置。调配由 OpenShift 安装程序使用 admin 或用户提供的有关调配网络和可用 PXE 引导的 NIC 的信息来创建。此 CR 是安装程序创建的单例，目前仅由 cluster-baremetal-operator 使用，以便在 metal3 集群中启动和更新容器。
类型: object

第 2 章 BMCEventSubscription [metal3.io/v1alpha1]

描述: BMCEventSubscription 是快速事件 API 的 Schema
类型: 对象

2.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`对象`
`status`	`对象`

2.1.1. .spec

描述
类型: object

属性	类型	描述
`context`	`string`	事件的任意用户提供的上下文
`目的地`	`string`	将事件发送到的 Webhook URL
`hostName`	`string`	对 BareMetalHost 的引用
`httpHeadersRef`	`object`	包含 HTTP 标头的 secret，该 secret 在发出请求时应一起传递给 Destination

2.1.2. .spec.httpHeadersRef

描述: 包含 HTTP 标头的 secret，该 secret 在发出请求时应一起传递给 Destination
类型: object

属性	类型	描述
`name`	`string`	name 在命名空间中是唯一的，用于引用 secret 资源。
`namespace`	`string`	namespace 定义 secret 名称必须是唯一的的空间。

2.1.3. .status

描述
类型: object

属性	类型	描述
`错误`	`string`
`subscriptionID`	`string`

2.2. API 端点

可用的 API 端点如下：

/apis/metal3.io/v1alpha1/bmceventsubscriptions
- GET: 列出 BMCEventSubscription 类型的对象
/apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions
- DELETE ：删除 BMCEventSubscription 的集合
- GET: 列出 BMCEventSubscription 类型的对象
- POST ：创建一个 BMCEventSubscription
/apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}
- DELETE ：删除 BMCEventSubscription
- GET ：读取指定的 BMCEventSubscription
- PATCH: 部分更新指定的 BMCEventSubscription
- PUT ：替换指定的 BMCEventSubscription
/apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}/status
- GET ：指定 BMCEventSubscription 的读取状态
- PATCH: 部分更新指定 BMCEventSubscription 的状态
- PUT ：替换指定 BMCEventSubscription 的状态

2.2.1. /apis/metal3.io/v1alpha1/bmceventsubscriptions

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

表 2.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BMCEventSubscriptionList` schema
401 - Unauthorized	空

2.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions

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

表 2.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 2.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BMCEventSubscriptionList` schema
401 - Unauthorized	空

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

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

表 2.5. 主体参数
参数	类型	描述
`正文（body）`	`BMCEventSubscription` schema

表 2.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BMCEventSubscription` schema
201 - Created	`BMCEventSubscription` schema
202 - Accepted	`BMCEventSubscription` schema
401 - Unauthorized	空

2.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}

表 2.7. 全局路径参数
参数	类型	描述
`name`	`string`	BMCEventSubscription 的名称

HTTP 方法: DELETE
描述: delete a BMCEventSubscription

表 2.8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 2.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 BMCEventSubscription

表 2.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BMCEventSubscription` schema
401 - Unauthorized	空

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

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

表 2.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BMCEventSubscription` schema
401 - Unauthorized	空

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

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

表 2.14. 主体参数
参数	类型	描述
`正文（body）`	`BMCEventSubscription` schema

表 2.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BMCEventSubscription` schema
201 - Created	`BMCEventSubscription` schema
401 - Unauthorized	空

2.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}/status

表 2.16. 全局路径参数
参数	类型	描述
`name`	`string`	BMCEventSubscription 的名称

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

表 2.17. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BMCEventSubscription` schema
401 - Unauthorized	空

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

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

表 2.19. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BMCEventSubscription` schema
401 - Unauthorized	空

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

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

表 2.21. 主体参数
参数	类型	描述
`正文（body）`	`BMCEventSubscription` schema

表 2.22. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BMCEventSubscription` schema
201 - Created	`BMCEventSubscription` schema
401 - Unauthorized	空

第 3 章 BareMetalHost [metal3.io/v1alpha1]

描述: BareMetalHost 是 baremetalhosts API 的 Schema
类型: 对象

3.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`object`	BareMetalHostSpec 定义 BareMetalHost 的所需状态。
`status`	`object`	BareMetalHostStatus 定义 BareMetalHost 的观察状态。

3.1.1. .spec

描述

BareMetalHostSpec 定义 BareMetalHost 的所需状态。

类型

object

必填

online

属性	类型	描述
`架构`	`string`	主机的 CPU 架构，如 "x86_64" 或 "aarch64"。如果未设置，则最终由检查填充。
`automatedCleaningMode`	`字符串`	当设置为 disabled 时，会在置备和取消置备过程中避免自动清理。
`bmc`	`对象`	如何连接到 BMC？
`bootMACAddress`	`字符串`	哪个 MAC 地址将 PXE 引导？对于某些类型，这是可选的，但 vbmc 驱动的 libvirt 虚拟机是必需的。
`bootMode`	`字符串`	选择在引导过程中初始化硬件的方法。默认为 UEFI。
`consumerRef`	`对象`	consumerRef 可用于存储使用主机的内容的信息。如果主机不为空，则主机被视为"使用"。
`customDeploy`	`对象`	自定义部署流程。
`description`	`字符串`	description 是人类可读的文本，用于帮助识别主机
`externallyProvisioned`	`布尔值`	externallyProvisioned 表示其他管理主机上运行的镜像，Operator 应该仅管理电源状态和硬件清单检查。如果填写了 Image 字段，则忽略此字段。
`firmware`	`对象`	裸机服务器的 BIOS 配置
`hardwareProfile`	`字符串`	此主机的硬件配置文件的名称是什么？硬件配置集已弃用，不应使用。改为使用单独的字段 Architecture 和 RootDeviceHints。设置为"空"，以在没有硬件配置集的情况下为 API 的未来版本做准备。
`image`	`对象`	image 包含要调配的镜像的详细信息。
`metaData`	`object`	元数据包含对包含主机元数据（如 meta_data.json）的 Secret 的引用，后者被传递给 Config Drive。
`networkData`	`object`	networkData 包含对包含网络配置（如 network_data.json）的 Secret 的引用，该 secret 传递给 Config Drive。
`online`	`布尔值`	服务器是否应在线？
`preprovisioningNetworkDataName`	`string`	preprovisioningNetworkDataName 是本地命名空间中的 Secret 名称，其中包含网络配置（例如 network_data.json 的内容），该配置传递到预置备镜像，如果没有通过指定 NetworkData 覆盖到 Config Drive。
`raid`	`对象`	裸机服务器的 RAID 配置
`rootDeviceHints`	`对象`	提供有关如何为所调配镜像选择设备的说明。
`污点`	`array`	污点是要应用到对应机器的完整、权威污点列表。此列表将持续覆盖对机器所做的任何修改。
`taints[]`	`对象`	此 Taint 附加到任何不容许 Taint 的 pod 上的"effect"的节点。
`userData`	`对象`	userData 包含对包含要传递给主机的用户数据的 Secret 的引用。

3.1.2. .spec.bmc

描述

如何连接到 BMC？

类型

object

必填

address
credentialsName

属性	类型	描述
`address`	`字符串`	address 包含用于访问网络上控制器的 URL。
`credentialsName`	`字符串`	包含 BMC 凭证的 secret 名称（需要密钥 "username" 和 "password"）。
`disableCertificateVerification`	`布尔值`	disableCertificateVerification 在使用 HTTPS 连接到 BMC 时禁用服务器证书验证。当服务器证书是自签名的但不安全时，这是必需的，因为它允许 man-in-the-middle 截获连接。

3.1.3. .spec.consumerRef

描述: consumerRef 可用于存储使用主机的内容的信息。如果主机不为空，则主机被视为"使用"。
类型: object

属性	类型	描述
`apiVersion`	`字符串`	引用的 API 版本。
`fieldPath`	`字符串`	如果引用的是对象的一部分而非整个对象，则该字符串应包含有效的 JSON/Go 字段访问声明，如 desiredState.manifest.containers[2]。例如，如果对象引用是一个 pod 中的容器，它应该还以下类似： "spec.containers{name}"（其中 "name" 是指触发事件的容器的名称）,如果不使用容器名称，则应类似于 "spec.containers[2]"（使用此 pod 中索引值为 2 的容器）。选择这个语法的原因是，为了有一些指向对象部分的正确定义方法。Todo: 这个设计不是最终设计的，且该字段在将来会有所改变。
`kind`	`字符串`	引用的类型。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`name`	`字符串`	引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`namespace`	`字符串`	引用的命名空间。更多信息： https://kubernetes.io/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.io/docs/concepts/overview/working-with-objects/names/#uids

3.1.4. .spec.customDeploy

描述

自定义部署流程。

类型

object

必填

method

属性	类型	描述
`method`	`字符串`	自定义部署方法名称。此名称特定于使用的部署 ramdisk。如果您没有自定义部署 ramdisk，则不应使用自定义部署。

3.1.5. .spec.firmware

描述: 裸机服务器的 BIOS 配置
类型: object

属性	类型	描述
`simultaneousMultithreadingEnabled`	`布尔值`	允许单个物理处理器内核显示为多个逻辑处理器。这支持以下选项： true，false。
`sriovEnabled`	`布尔值`	SR-IOV 支持可让虚拟机监控程序创建 PCI-express 设备的虚拟实例，这可能会提高性能。这支持以下选项： true，false。
`virtualizationEnabled`	`布尔值`	支持平台硬件的虚拟化。这支持以下选项： true，false。

3.1.6. .spec.image

描述

image 包含要调配的镜像的详细信息。

类型

object

必填

url

属性	类型	描述
`checksum`	`字符串`	checksum 是镜像的 checksum。
`checksumType`	`string`	checksumType 是镜像的校验和算法，如 md5、sha256 或 sha512。特殊值 "auto" 可以用来检测校验和中的算法。如果缺少，则使用 MD5。如果不确定，请使用 "auto"。
`格式`	`字符串`	DiskFormat 包含镜像的格式(raw, qcow2, …)。需要设置为 raw 用于原始镜像流。请注意 live-iso 意味着 url 引用的 iso 将会被实时引导，而不是部署到磁盘，在这种情况下，不需要校验和选项，如果指定，则忽略。
`url`	`字符串`	URL 是要部署的镜像的位置。

3.1.7. .spec.metaData

描述: 元数据包含对包含主机元数据（如 meta_data.json）的 Secret 的引用，后者被传递给 Config Drive。
类型: object

属性	类型	描述
`name`	`string`	name 在命名空间中是唯一的，用于引用 secret 资源。
`namespace`	`string`	namespace 定义 secret 名称必须是唯一的的空间。

3.1.8. .spec.networkData

描述: networkData 包含对包含网络配置（如 network_data.json）的 Secret 的引用，该 secret 传递给 Config Drive。
类型: object

属性	类型	描述
`name`	`string`	name 在命名空间中是唯一的，用于引用 secret 资源。
`namespace`	`string`	namespace 定义 secret 名称必须是唯一的的空间。

3.1.9. .spec.raid

描述: 裸机服务器的 RAID 配置
类型: object

属性	类型	描述
`hardwareRAIDVolumes`	``	硬件 RAID 的逻辑卷列表（如果 rootDeviceHints 没有使用），则第一个卷是 root 卷。您可以将此字段的值设置为 `[]` 来清除所有硬件 RAID 配置。
`softwareRAIDVolumes`	``	软件 RAID 的逻辑卷列表（如果 rootDeviceHints 没有使用），则第一个卷是 root 卷。如果设置了 HardwareRAIDVolumes，则此项将无效。创建的软件 RAID 设备的数量必须是 1 或 2。如果只有一个软件 RAID 设备，它必须是 RAID-1。如果有两个，则第一个必须是 RAID-1，而第二个的 RAID 级别可以是 0、1 或 1+0。因为第一个 RAID 设备将是部署设备，所以强制 RAID-1 会在磁盘失败时降低以非引导节点结束的风险。软件 RAID 将始终被删除。

3.1.10. .spec.rootDeviceHints

描述: 提供有关如何为所调配镜像选择设备的说明。
类型: object

属性	类型	描述
`deviceName`	`string`	比如 "/dev/vda" 的 Linux 设备名称，或指向它的一个 by-path 链接，如 "/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0"。hint 必须与实际值完全匹配。
`hctl`	`字符串`	SCSI 总线地址，如 0:0:0:0。hint 必须与实际值完全匹配。
`minSizeGigabytes`	`整数`	以 Gigabytes 为单位的设备的最小大小。
`model`	`字符串`	特定于厂商的设备标识符。hint 可以是实际值的子字符串。
`rotational`	`布尔值`	如果设备应使用旋转介质，则为 true，否则为 false。
`serialNumber`	`字符串`	设备序列号。hint 必须与实际值完全匹配。
`vendor`	`字符串`	设备的厂商或制造商的名称。hint 可以是实际值的子字符串。
`wwn`	`字符串`	唯一的存储标识符。hint 必须与实际值完全匹配。
`wwnVendorExtension`	`字符串`	唯一的厂商存储标识符。hint 必须与实际值完全匹配。
`wwnWithExtension`	`字符串`	附加厂商扩展的唯一存储标识符。hint 必须与实际值完全匹配。

3.1.11. .spec.taints

描述: 污点是要应用到对应机器的完整、权威污点列表。此列表将持续覆盖对机器所做的任何修改。
类型: array

3.1.12. .spec.taints[]

描述

此 Taint 附加到任何不容许 Taint 的 pod 上的"effect"的节点。

类型

object

必填

effect
key

属性	类型	描述
`effect`	`字符串`	必需。污点对不容许该污点的 pod 的影响。有效效果为 NoSchedule、PreferNoSchedule 和 NoExecute。
`key`	`字符串`	必需。要应用到节点的污点键。
`timeAdded`	`字符串`	TimeAdded 代表添加污点的时间。它仅针对 NoExecute 污点编写。
`value`	`字符串`	与污点键对应的污点值。

3.1.13. .spec.userData

描述: userData 包含对包含要传递给主机的用户数据的 Secret 的引用。
类型: object

属性	类型	描述
`name`	`string`	name 在命名空间中是唯一的，用于引用 secret 资源。
`namespace`	`string`	namespace 定义 secret 名称必须是唯一的的空间。

3.1.14. .status

描述

BareMetalHostStatus 定义 BareMetalHost 的观察状态。

类型

object

必填

errorCount
errorMessage
hardwareProfile
operationalStatus
poweredOn
provisioning

属性	类型	描述
`errorCount`	`整数`	ErrorCount 记录主机在上一次成功操作后出现错误的次数
`errorMessage`	`字符串`	provisioning 子系统报告的最后一个错误消息
`errorType`	`字符串`	ErrorType 表示在 OperationalStatus 是 OperationalStatus 是 OperationalStatusError 时遇到的故障类型
`goodCredentials`	`对象`	我们能够验证为工作的最后一个凭证
`hardware`	`对象`	主机上存在发现的硬件。
`hardwareProfile`	`字符串`	与硬件详情匹配的配置集的名称。
`lastUpdated`	`字符串`	lastUpdated 标识此状态最后观察到的时间。
`operationHistory`	`对象`	operationHistory 包含有关在此主机上执行的操作的信息。
`operationalStatus`	`字符串`	OperationalStatus 保存主机的状态
`poweredOn`	`布尔值`	主机是否开机的指示器
`provisioning`	`对象`	置备程序跟踪的信息。
`triedCredentials`	`对象`	我们发送到置备后端的最后一个凭证

3.1.15. .status.goodCredentials

描述: 我们能够验证为工作的最后一个凭证
类型: object

属性	类型	描述
`credentials`	`对象`	secretReference 代表 Secret 引用。它有足够的信息来检索任何命名空间中的 secret
`credentialsVersion`	`字符串`

3.1.16. .status.goodCredentials.credentials

描述: secretReference 代表 Secret 引用。它有足够的信息来检索任何命名空间中的 secret
类型: object

属性	类型	描述
`name`	`string`	name 在命名空间中是唯一的，用于引用 secret 资源。
`namespace`	`string`	namespace 定义 secret 名称必须是唯一的的空间。

3.1.17. .status.hardware

描述: 主机上存在发现的硬件。
类型: object

属性	类型	描述
`cpu`	`对象`	CPU 描述了主机上的一个处理器。
`firmware`	`对象`	固件描述了主机上的固件。
`主机名`	`字符串`
`NIC`	`array`
`nics[]`	`对象`	NIC 描述主机上的一个网络接口。
`ramMebibytes`	`整数`
`storage`	`array`
`storage[]`	`对象`	Storage 描述了主机上的一个存储设备（磁盘、SSD 等）。
`systemVendor`	`对象`	HardwareSystemVendor 存储整个硬件系统的详细信息。

3.1.18. .status.hardware.cpu

描述: CPU 描述了主机上的一个处理器。
类型: object

属性	类型	描述
`arch`	`字符串`
`clockMegahertz`	`number`	ClockSpeed 是 MHz 中的时钟速度
`数量`	`整数`
`标记`	`数组（字符串）`
`model`	`字符串`

3.1.19. .status.hardware.firmware

描述: 固件描述了主机上的固件。
类型: object

属性	类型	描述
`BIOS`	`对象`	此固件的 BIOS

3.1.20. .status.hardware.firmware.bios

描述: 此固件的 BIOS
类型: object

属性	类型	描述
`date`	`字符串`	此 BIOS 的发行版本/构建日期
`vendor`	`字符串`	此 BIOS 的供应商名称
`version`	`字符串`	BIOS 的版本

3.1.21. .status.hardware.nics

描述
类型: array

3.1.22. .status.hardware.nics[]

描述: NIC 描述主机上的一个网络接口。
类型: object

属性	类型	描述
`ip`	`字符串`	接口的 IP 地址。如果存在 IPv4 或 IPv6 地址，这将是 IPv4 或 IPv6 地址。如果双栈环境中同时存在 IPv4 和 IPv6 地址，则两个 nics 为输出，每个 IP 都有一个。
`mac`	`字符串`	设备 MAC 地址
`model`	`字符串`	NIC 的供应商和产品 ID，例如："0x8086 0x1572"
`name`	`字符串`	网络接口的名称，如 "en0"
`pxe`	`布尔值`	NIC 是否可以引导
`speedGbps`	`整数`	设备每秒千兆位的速度
`vlanId`	`整数`	未标记的 VLAN ID
`vlans`	`array`	可用的 VLAN
`vlans[]`	`object`	VLAN 代表 VLAN 的名称和 ID。

3.1.23. .status.hardware.nics[].vlans

描述: 可用的 VLAN
类型: array

3.1.24. .status.hardware.nics[].vlans[]

描述: VLAN 代表 VLAN 的名称和 ID。
类型: object

属性	类型	描述
`id`	`整数`	VLANID 是一个 12 位 802.1Q VLAN 标识符
`name`	`字符串`

3.1.25. .status.hardware.storage

描述
类型: array

3.1.26. .status.hardware.storage[]

描述: Storage 描述了主机上的一个存储设备（磁盘、SSD 等）。
类型: object

属性	类型	描述
`alternateNames`	`数组（字符串）`	磁盘的备用 Linux 设备名称列表，例如"/dev/sda"。请注意，此列表并不完整，并且系统重启后名称可能不稳定。
`hctl`	`字符串`	设备的 SCSI 位置
`model`	`字符串`	硬件模型
`name`	`string`	磁盘的 Linux 设备名称，如 "/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0"。如果一个名称可用，它将在重启后保持稳定。
`rotational`	`布尔值`	这个磁盘是否代表轮转存储。不建议使用此字段，首选使用 'Type' 字段，此字段最终将被弃用。
`serialNumber`	`字符串`	设备的序列号
`sizeBytes`	`整数`	Bytes 中磁盘大小
`type`	`字符串`	设备类型，其中之一： HDD、SSD、NVME。
`vendor`	`字符串`	设备的厂商名称
`wwn`	`字符串`	设备的 WWN
`wwnVendorExtension`	`字符串`	设备的 WWN 供应商扩展
`wwnWithExtension`	`字符串`	带有扩展名的 WWN

3.1.27. .status.hardware.systemVendor

描述: HardwareSystemVendor 存储整个硬件系统的详细信息。
类型: object

属性	类型	描述
`manufacturer`	`字符串`
`productName`	`字符串`
`serialNumber`	`字符串`

3.1.28. .status.operationHistory

描述: operationHistory 包含有关在此主机上执行的操作的信息。
类型: object

属性	类型	描述
`取消置备`	`对象`	OperationMetric 包含有关操作的元数据（检查、调配等），用于跟踪指标。
`inspect`	`对象`	OperationMetric 包含有关操作的元数据（检查、调配等），用于跟踪指标。
`置备`	`对象`	OperationMetric 包含有关操作的元数据（检查、调配等），用于跟踪指标。
`register`	`对象`	OperationMetric 包含有关操作的元数据（检查、调配等），用于跟踪指标。

3.1.29. .status.operationHistory.deprovision

描述: OperationMetric 包含有关操作的元数据（检查、调配等），用于跟踪指标。
类型: object

属性	类型	描述
`end`	``
`start`	``

3.1.30. .status.operationHistory.inspect

描述: OperationMetric 包含有关操作的元数据（检查、调配等），用于跟踪指标。
类型: object

属性	类型	描述
`end`	``
`start`	``

3.1.31. .status.operationHistory.provision

描述: OperationMetric 包含有关操作的元数据（检查、调配等），用于跟踪指标。
类型: object

属性	类型	描述
`end`	``
`start`	``

3.1.32. .status.operationHistory.register

描述: OperationMetric 包含有关操作的元数据（检查、调配等），用于跟踪指标。
类型: object

属性	类型	描述
`end`	``
`start`	``

3.1.33. .status.provisioning

描述

置备程序跟踪的信息。

类型

object

必填

ID
state

属性	类型	描述
`ID`	`字符串`	来自底层调配工具的机器 UUID
`bootMode`	`字符串`	bootMode 表示用于置备节点的引导模式
`customDeploy`	`对象`	应用到主机的自定义部署流程。
`firmware`	`对象`	用户设置的 Bios
`image`	`对象`	镜像包含成功调配到主机的最后一个镜像的详细信息。
`raid`	`对象`	用户设置的 Raid
`rootDeviceHints`	`对象`	用户设置的 RootDevicehints
`state`	`字符串`	用于置备程序使用主机进行的操作的信息。

3.1.34. .status.provisioning.customDeploy

描述

应用到主机的自定义部署流程。

类型

object

必填

method

属性	类型	描述
`method`	`字符串`	自定义部署方法名称。此名称特定于使用的部署 ramdisk。如果您没有自定义部署 ramdisk，则不应使用自定义部署。

3.1.35. .status.provisioning.firmware

描述: 用户设置的 Bios
类型: object

属性	类型	描述
`simultaneousMultithreadingEnabled`	`布尔值`	允许单个物理处理器内核显示为多个逻辑处理器。这支持以下选项： true，false。
`sriovEnabled`	`布尔值`	SR-IOV 支持可让虚拟机监控程序创建 PCI-express 设备的虚拟实例，这可能会提高性能。这支持以下选项： true，false。
`virtualizationEnabled`	`布尔值`	支持平台硬件的虚拟化。这支持以下选项： true，false。

3.1.36. .status.provisioning.image

描述

镜像包含成功调配到主机的最后一个镜像的详细信息。

类型

object

必填

url

属性	类型	描述
`checksum`	`字符串`	checksum 是镜像的 checksum。
`checksumType`	`string`	checksumType 是镜像的校验和算法，如 md5、sha256 或 sha512。特殊值 "auto" 可以用来检测校验和中的算法。如果缺少，则使用 MD5。如果不确定，请使用 "auto"。
`格式`	`字符串`	DiskFormat 包含镜像的格式(raw, qcow2, …)。需要设置为 raw 用于原始镜像流。请注意 live-iso 意味着 url 引用的 iso 将会被实时引导，而不是部署到磁盘，在这种情况下，不需要校验和选项，如果指定，则忽略。
`url`	`字符串`	URL 是要部署的镜像的位置。

3.1.37. .status.provisioning.raid

描述: 用户设置的 Raid
类型: object

属性	类型	描述
`hardwareRAIDVolumes`	``	硬件 RAID 的逻辑卷列表（如果 rootDeviceHints 没有使用），则第一个卷是 root 卷。您可以将此字段的值设置为 `[]` 来清除所有硬件 RAID 配置。
`softwareRAIDVolumes`	``	软件 RAID 的逻辑卷列表（如果 rootDeviceHints 没有使用），则第一个卷是 root 卷。如果设置了 HardwareRAIDVolumes，则此项将无效。创建的软件 RAID 设备的数量必须是 1 或 2。如果只有一个软件 RAID 设备，它必须是 RAID-1。如果有两个，则第一个必须是 RAID-1，而第二个的 RAID 级别可以是 0、1 或 1+0。因为第一个 RAID 设备将是部署设备，所以强制 RAID-1 会在磁盘失败时降低以非引导节点结束的风险。软件 RAID 将始终被删除。

3.1.38. .status.provisioning.rootDeviceHints

描述: 用户设置的 RootDevicehints
类型: object

属性	类型	描述
`deviceName`	`string`	比如 "/dev/vda" 的 Linux 设备名称，或指向它的一个 by-path 链接，如 "/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0"。hint 必须与实际值完全匹配。
`hctl`	`字符串`	SCSI 总线地址，如 0:0:0:0。hint 必须与实际值完全匹配。
`minSizeGigabytes`	`整数`	以 Gigabytes 为单位的设备的最小大小。
`model`	`字符串`	特定于厂商的设备标识符。hint 可以是实际值的子字符串。
`rotational`	`布尔值`	如果设备应使用旋转介质，则为 true，否则为 false。
`serialNumber`	`字符串`	设备序列号。hint 必须与实际值完全匹配。
`vendor`	`字符串`	设备的厂商或制造商的名称。hint 可以是实际值的子字符串。
`wwn`	`字符串`	唯一的存储标识符。hint 必须与实际值完全匹配。
`wwnVendorExtension`	`字符串`	唯一的厂商存储标识符。hint 必须与实际值完全匹配。
`wwnWithExtension`	`字符串`	附加厂商扩展的唯一存储标识符。hint 必须与实际值完全匹配。

3.1.39. .status.triedCredentials

描述: 我们发送到置备后端的最后一个凭证
类型: object

属性	类型	描述
`credentials`	`对象`	secretReference 代表 Secret 引用。它有足够的信息来检索任何命名空间中的 secret
`credentialsVersion`	`字符串`

3.1.40. .status.triedCredentials.credentials

描述: secretReference 代表 Secret 引用。它有足够的信息来检索任何命名空间中的 secret
类型: object

属性	类型	描述
`name`	`string`	name 在命名空间中是唯一的，用于引用 secret 资源。
`namespace`	`string`	namespace 定义 secret 名称必须是唯一的的空间。

3.2. API 端点

可用的 API 端点如下：

/apis/metal3.io/v1alpha1/baremetalhosts
- GET: 列出 BareMetalHost 类型的对象
/apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts
- DELETE: 删除 BareMetalHost 集合
- GET: 列出 BareMetalHost 类型的对象
- POST ：创建 BareMetalHost
/apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}
- DELETE ：删除 BareMetalHost
- GET ：读取指定的 BareMetalHost
- PATCH: 部分更新指定的 BareMetalHost
- PUT ：替换指定的 BareMetalHost
/apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}/status
- GET ：指定 BareMetalHost 的读取状态
- PATCH: 部分更新指定 BareMetalHost 的状态
- PUT ：替换指定 BareMetalHost 的状态

3.2.1. /apis/metal3.io/v1alpha1/baremetalhosts

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

表 3.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BareMetalHostList` schema
401 - Unauthorized	空

3.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts

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

表 3.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 3.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BareMetalHostList` schema
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 BareMetalHost

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

表 3.5. 主体参数
参数	类型	描述
`正文（body）`	`BareMetalHost` 模式

表 3.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BareMetalHost` 模式
201 - Created	`BareMetalHost` 模式
202 - Accepted	`BareMetalHost` 模式
401 - Unauthorized	空

3.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}

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

HTTP 方法: DELETE
描述: 删除 BareMetalHost

表 3.8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 3.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

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

表 3.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BareMetalHost` 模式
401 - Unauthorized	空

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

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

表 3.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BareMetalHost` 模式
401 - Unauthorized	空

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

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

表 3.14. 主体参数
参数	类型	描述
`正文（body）`	`BareMetalHost` 模式

表 3.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BareMetalHost` 模式
201 - Created	`BareMetalHost` 模式
401 - Unauthorized	空

3.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}/status

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

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

表 3.17. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BareMetalHost` 模式
401 - Unauthorized	空

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

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

表 3.19. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BareMetalHost` 模式
401 - Unauthorized	空

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

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

表 3.21. 主体参数
参数	类型	描述
`正文（body）`	`BareMetalHost` 模式

表 3.22. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BareMetalHost` 模式
201 - Created	`BareMetalHost` 模式
401 - Unauthorized	空

第 4 章 DataImage [metal3.io/v1alpha1]

描述: DataImage 是 dataimages API 的 Schema。
类型: 对象

4.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`object`	DataImageSpec 定义所需的 DataImage 状态。
`status`	`object`	DataImageStatus 定义 DataImage 的观察状态。

4.1.1. .spec

描述

DataImageSpec 定义所需的 DataImage 状态。

类型

object

必填

url

属性	类型	描述
`url`	`string`	URL 是您要附加到 BareMetalHost 的 dataImage 地址

4.1.2. .status

描述: DataImageStatus 定义 DataImage 的观察状态。
类型: object

属性	类型	描述
`attachedImage`	`object`	当前附加的 DataImage
`错误`	`object`	Attach/detaching 时错误计数和消息
`lastReconciled`	`string`	最后协调的时间

4.1.3. .status.attachedImage

描述

当前附加的 DataImage

类型

object

必填

url

属性	类型	描述
`url`	`string`

4.1.4. .status.error

描述

Attach/detaching 时错误计数和消息

类型

object

必填

æ•°é‡�
message

属性	类型	描述
`数量`	`整数`
`message`	`string`

4.2. API 端点

可用的 API 端点如下：

/apis/metal3.io/v1alpha1/dataimages
- GET: 列出类型为 DataImage 的对象
/apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages
- DELETE ：删除 DataImage 集合
- GET: 列出类型为 DataImage 的对象
- POST ：创建 DataImage
/apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}
- DELETE ：删除 DataImage
- GET ：读取指定的 DataImage
- PATCH: 部分更新指定的 DataImage
- PUT ：替换指定的 DataImage
/apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}/status
- GET ：指定 DataImage 的读取状态
- PATCH: 部分更新指定 DataImage 的状态
- PUT ：替换指定 DataImage 的状态

4.2.1. /apis/metal3.io/v1alpha1/dataimages

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

表 4.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DataImageList` 模式
401 - Unauthorized	空

4.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages

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

表 4.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 4.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DataImageList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 DataImage

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

表 4.5. 主体参数
参数	类型	描述
`正文（body）`	`DataImage` 模式

表 4.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DataImage` 模式
201 - Created	`DataImage` 模式
202 - Accepted	`DataImage` 模式
401 - Unauthorized	空

4.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}

表 4.7. 全局路径参数
参数	类型	描述
`name`	`string`	DataImage 的名称

HTTP 方法: DELETE
描述: 删除 DataImage

表 4.8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 4.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

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

表 4.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DataImage` 模式
401 - Unauthorized	空

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

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

表 4.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DataImage` 模式
401 - Unauthorized	空

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

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

表 4.14. 主体参数
参数	类型	描述
`正文（body）`	`DataImage` 模式

表 4.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DataImage` 模式
201 - Created	`DataImage` 模式
401 - Unauthorized	空

4.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}/status

表 4.16. 全局路径参数
参数	类型	描述
`name`	`string`	DataImage 的名称

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

表 4.17. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DataImage` 模式
401 - Unauthorized	空

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

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

表 4.19. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DataImage` 模式
401 - Unauthorized	空

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

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

表 4.21. 主体参数
参数	类型	描述
`正文（body）`	`DataImage` 模式

表 4.22. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DataImage` 模式
201 - Created	`DataImage` 模式
401 - Unauthorized	空

第 5 章 FirmwareSchema [metal3.io/v1alpha1]

描述: FirmwareSchema 是 firmwareschemas API 的 Schema。
类型: 对象

5.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`object`	FirmwareSchemaSpec 定义所需的 FirmwareSchema 状态。

5.1.1. .spec

描述

FirmwareSchemaSpec 定义所需的 FirmwareSchema 状态。

类型

object

必填

schema

属性	类型	描述
`hardwareModel`	`字符串`	与此模式关联的硬件模型
`hardwareVendor`	`字符串`	与此模式关联的硬件供应商
`schema`	`对象`	固件名称映射到模式
`schema{}`	`object`	描述固件设置的其他数据。

5.1.2. .spec.schema

描述: 固件名称映射到模式
类型: 对象

5.1.3. .spec.schema{}

描述: 描述固件设置的其他数据。
类型: object

属性	类型	描述
`allowable_values`	`数组（字符串）`	Enumeration type 设置的允许值。
`attribute_type`	`字符串`	设置类型。
`lower_bound`	`整数`	Integer 类型设置的最低值。
`max_length`	`整数`	String 类型设置的最大长度。
`min_length`	`整数`	String 类型设置的最小长度。
`read_only`	`布尔值`	此设置是否为只读。
`unique`	`布尔值`	此设置的值是否对这个节点是唯一的，例如序列号。
`upper_bound`	`整数`	Integer 类型设置的最大值。

5.2. API 端点

可用的 API 端点如下：

/apis/metal3.io/v1alpha1/firmwareschemas
- GET: 列出类型为 FirmwareSchema 的对象
/apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas
- DELETE ：删除 FirmwareSchema 集合
- GET: 列出类型为 FirmwareSchema 的对象
- POST ：创建 FirmwareSchema
/apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas/{name}
- DELETE ：删除 FirmwareSchema
- GET ：读取指定的 FirmwareSchema
- PATCH: 部分更新指定的 FirmwareSchema
- PUT ：替换指定的 FirmwareSchema

5.2.1. /apis/metal3.io/v1alpha1/firmwareschemas

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

表 5.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`FirmwareSchemaList` 模式
401 - Unauthorized	空

5.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas

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

表 5.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 5.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`FirmwareSchemaList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 FirmwareSchema

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

表 5.5. 主体参数
参数	类型	描述
`正文（body）`	`FirmwareSchema` 模式

表 5.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`FirmwareSchema` 模式
201 - Created	`FirmwareSchema` 模式
202 - Accepted	`FirmwareSchema` 模式
401 - Unauthorized	空

5.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas/{name}

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

HTTP 方法: DELETE
描述: 删除 FirmwareSchema

表 5.8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 5.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 FirmwareSchema

表 5.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`FirmwareSchema` 模式
401 - Unauthorized	空

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

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

表 5.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`FirmwareSchema` 模式
401 - Unauthorized	空

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

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

表 5.14. 主体参数
参数	类型	描述
`正文（body）`	`FirmwareSchema` 模式

表 5.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`FirmwareSchema` 模式
201 - Created	`FirmwareSchema` 模式
401 - Unauthorized	空

第 6 章 HardwareData [metal3.io/v1alpha1]

描述: HardwareData 是 hardwaredata API 的 Schema。
类型: 对象

6.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`object`	HardwareDataSpec 定义 HardwareData 的所需状态。

6.1.1. .spec

描述: HardwareDataSpec 定义 HardwareData 的所需状态。
类型: object

属性	类型	描述
`hardware`	`object`	检查过程中在主机上发现的硬件。

6.1.2. .spec.hardware

描述: 检查过程中在主机上发现的硬件。
类型: object

属性	类型	描述
`cpu`	`对象`	CPU 描述了主机上的一个处理器。
`firmware`	`对象`	固件描述了主机上的固件。
`主机名`	`字符串`
`NIC`	`array`
`nics[]`	`对象`	NIC 描述主机上的一个网络接口。
`ramMebibytes`	`整数`
`storage`	`array`
`storage[]`	`对象`	Storage 描述了主机上的一个存储设备（磁盘、SSD 等）。
`systemVendor`	`对象`	HardwareSystemVendor 存储整个硬件系统的详细信息。

6.1.3. .spec.hardware.cpu

描述: CPU 描述了主机上的一个处理器。
类型: object

属性	类型	描述
`arch`	`字符串`
`clockMegahertz`	`number`	ClockSpeed 是 MHz 中的时钟速度
`数量`	`整数`
`标记`	`数组（字符串）`
`model`	`string`

6.1.4. .spec.hardware.firmware

描述: 固件描述了主机上的固件。
类型: object

属性	类型	描述
`BIOS`	`对象`	此固件的 BIOS

6.1.5. .spec.hardware.firmware.bios

描述: 此固件的 BIOS
类型: object

属性	类型	描述
`date`	`字符串`	此 BIOS 的发行版本/构建日期
`vendor`	`字符串`	此 BIOS 的供应商名称
`version`	`字符串`	BIOS 的版本

6.1.6. .spec.hardware.nics

描述
类型: 数组

6.1.7. .spec.hardware.nics[]

描述: NIC 描述主机上的一个网络接口。
类型: object

属性	类型	描述
`ip`	`字符串`	接口的 IP 地址。如果存在 IPv4 或 IPv6 地址，这将是 IPv4 或 IPv6 地址。如果双栈环境中同时存在 IPv4 和 IPv6 地址，则两个 nics 为输出，每个 IP 都有一个。
`mac`	`字符串`	设备 MAC 地址
`model`	`字符串`	NIC 的供应商和产品 ID，例如："0x8086 0x1572"
`name`	`字符串`	网络接口的名称，如 "en0"
`pxe`	`布尔值`	NIC 是否可以引导
`speedGbps`	`整数`	设备每秒千兆位的速度
`vlanId`	`整数`	未标记的 VLAN ID
`vlans`	`array`	可用的 VLAN
`vlans[]`	`object`	VLAN 代表 VLAN 的名称和 ID。

6.1.8. .spec.hardware.nics[].vlans

描述: 可用的 VLAN
类型: 数组

6.1.9. .spec.hardware.nics[].vlans[]

描述: VLAN 代表 VLAN 的名称和 ID。
类型: object

属性	类型	描述
`id`	`整数`	VLANID 是一个 12 位 802.1Q VLAN 标识符
`name`	`string`

6.1.10. .spec.hardware.storage

描述
类型: 数组

6.1.11. .spec.hardware.storage[]

描述: Storage 描述了主机上的一个存储设备（磁盘、SSD 等）。
类型: object

属性	类型	描述
`alternateNames`	`数组（字符串）`	磁盘的备用 Linux 设备名称列表，例如"/dev/sda"。请注意，此列表并不完整，并且系统重启后名称可能不稳定。
`hctl`	`字符串`	设备的 SCSI 位置
`model`	`字符串`	硬件模型
`name`	`string`	磁盘的 Linux 设备名称，如 "/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0"。如果一个名称可用，它将在重启后保持稳定。
`rotational`	`布尔值`	这个磁盘是否代表轮转存储。不建议使用此字段，首选使用 'Type' 字段，此字段最终将被弃用。
`serialNumber`	`字符串`	设备的序列号
`sizeBytes`	`整数`	Bytes 中磁盘大小
`type`	`字符串`	设备类型，其中之一： HDD、SSD、NVME。
`vendor`	`字符串`	设备的厂商名称
`wwn`	`字符串`	设备的 WWN
`wwnVendorExtension`	`字符串`	设备的 WWN 供应商扩展
`wwnWithExtension`	`字符串`	带有扩展名的 WWN

6.1.12. .spec.hardware.systemVendor

描述: HardwareSystemVendor 存储整个硬件系统的详细信息。
类型: object

属性	类型	描述
`manufacturer`	`字符串`
`productName`	`字符串`
`serialNumber`	`string`

6.2. API 端点

可用的 API 端点如下：

/apis/metal3.io/v1alpha1/hardwaredata
- GET: 列出类型为 HardwareData 的对象
/apis/metal3.io/v1alpha1/namespaces/{namespace}/hardwaredata
- DELETE ：删除 HardwareData 集合
- GET: 列出类型为 HardwareData 的对象
- POST ：创建 HardwareData
/apis/metal3.io/v1alpha1/namespaces/{namespace}/hardwaredata/{name}
- DELETE ：删除 HardwareData
- GET ：读取指定的 HardwareData
- PATCH: 部分更新指定的 HardwareData
- PUT ：替换指定的 HardwareData

6.2.1. /apis/metal3.io/v1alpha1/hardwaredata

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

表 6.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HardwareDataList` schema
401 - Unauthorized	空

6.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hardwaredata

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

表 6.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 6.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HardwareDataList` schema
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 HardwareData

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

表 6.5. 主体参数
参数	类型	描述
`正文（body）`	`HardwareData` schema

表 6.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HardwareData` schema
201 - Created	`HardwareData` schema
202 - Accepted	`HardwareData` schema
401 - Unauthorized	空

6.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hardwaredata/{name}

表 6.7. 全局路径参数
参数	类型	描述
`name`	`string`	HardwareData 的名称

HTTP 方法: DELETE
描述: delete a HardwareData

表 6.8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 6.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

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

表 6.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HardwareData` schema
401 - Unauthorized	空

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

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

表 6.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HardwareData` schema
401 - Unauthorized	空

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

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

表 6.14. 主体参数
参数	类型	描述
`正文（body）`	`HardwareData` schema

表 6.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HardwareData` schema
201 - Created	`HardwareData` schema
401 - Unauthorized	空

第 7 章 HostFirmwareComponents [metal3.io/v1alpha1]

描述: HostFirmwareComponents 是 hostfirmwarecomponents API 的 Schema。
类型: 对象

7.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`object`	HostFirmwareComponentsSpec 定义 HostFirmwareComponents 所需的状态。
`status`	`object`	HostFirmwareComponentsStatus 定义 HostFirmwareComponents 的观察状态。

7.1.1. .spec

描述

HostFirmwareComponentsSpec 定义 HostFirmwareComponents 所需的状态。

类型

object

必填

updates

属性	类型	描述
`updates`	`数组`
`updates[]`	`object`	FirmwareUpdate 定义了一个固件更新规格。

7.1.2. .spec.updates

描述
类型: 数组

7.1.3. .spec.updates[]

描述

FirmwareUpdate 定义了一个固件更新规格。

类型

object

必填

component
url

属性	类型	描述
`component`	`string`
`url`	`string`

7.1.4. .status

描述: HostFirmwareComponentsStatus 定义 HostFirmwareComponents 的观察状态。
类型: object

属性	类型	描述
`components`	`数组`	组件是所有可用固件组件及其信息的列表。
`components[]`	`object`	FirmwareComponentStatus 定义固件组件的状态。
`conditions`	`数组`	根据 schema，跟踪存储在 spec 中的更新是否有效
`conditions[]`	`对象`	条件包含此 API 资源当前状态的一个方面的详情。--- 这个结构旨在直接用作字段路径 .status.conditions 中的数组。例如，输入 FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` // other fields }
`lastUpdated`	`string`	状态最后一次更新的时间
`updates`	`数组`	updates 是应该通过 name 和 url 字段指定的所有固件组件的列表。
`updates[]`	`object`	FirmwareUpdate 定义了一个固件更新规格。

7.1.5. .status.components

描述: 组件是所有可用固件组件及其信息的列表。
类型: 数组

7.1.6. .status.components[]

描述

FirmwareComponentStatus 定义固件组件的状态。

类型

object

必填

component
initialVersion

属性	类型	描述
`component`	`string`
`currentVersion`	`string`
`initialVersion`	`string`
`lastVersionFlashed`	`string`
`updatedAt`	`string`

7.1.7. .status.conditions

描述: 根据 schema，跟踪存储在 spec 中的更新是否有效
类型: array

7.1.8. .status.conditions[]

描述

条件包含此 API 资源当前状态的一个方面的详情。--- 这个结构旨在直接用作字段路径 .status.conditions 中的数组。例如，输入 FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

类型

object

必填

lastTransitionTime
message
reason
status
type

属性	类型	描述
`lastTransitionTime`	`字符串`	lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。这应该是底层条件变化的时间。如果为未知，则使用 API 字段更改的时间是可以接受的。
`message`	`字符串`	Message 是人类可读的消息，指示有关转换的详细信息。这可能是一个空字符串。
`observedGeneration`	`整数`	observedGeneration 代表 .metadata.generation，这是条件设置所基于的条件。例如，如果 .metadata.generation 目前为 12，但 .status.conditions[x].observedGeneration 是 9，则代表条件与实例的当前状态已不匹配。
`reason`	`字符串`	reason 包含程序标识符，指示条件最后一次转换的原因。特定条件类型的制作者可能会定义预期的值和此字段的含义，以及这些值是否被视为有保证的 API。该值应该是 CamelCase 字符串。此字段可能不是空的。
`status`	`字符串`	条件的状态，True, False, Unknown 之一。
`type`	`字符串`	CamelCase 或 foo.example.com/CamelCase 中的条件类型。-- Many .condition.type 值在资源间是一致的，但因为任意条件可能很有用（请参阅 .node.status.conditions），deconflict 的能力非常重要。它匹配的正则表达式是 (dns1123SubdomainFmt/)? (qualifiedNameFmt)

7.1.9. .status.updates

描述: updates 是应该通过 name 和 url 字段指定的所有固件组件的列表。
类型: 数组

7.1.10. .status.updates[]

描述

FirmwareUpdate 定义了一个固件更新规格。

类型

object

必填

component
url

属性	类型	描述
`component`	`string`
`url`	`字符串`

7.2. API 端点

可用的 API 端点如下：

/apis/metal3.io/v1alpha1/hostfirmwarecomponents
- GET: 列出 HostFirmwareComponents 类型的对象
/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents
- DELETE: 删除 HostFirmwareComponents 集合
- GET: 列出 HostFirmwareComponents 类型的对象
- POST ：创建 HostFirmwareComponents
/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}
- DELETE: 删除 HostFirmwareComponents
- GET ：读取指定的 HostFirmwareComponents
- PATCH: 部分更新指定的 HostFirmwareComponents
- PUT ：替换指定的 HostFirmwareComponents
/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}/status
- GET ：指定 HostFirmwareComponents 的读取状态
- PATCH: 部分更新指定 HostFirmwareComponents 的状态
- PUT ：替换指定 HostFirmwareComponents 的状态

7.2.1. /apis/metal3.io/v1alpha1/hostfirmwarecomponents

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

表 7.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareComponentsList` 模式
401 - Unauthorized	空

7.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents

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

表 7.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 7.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareComponentsList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 HostFirmwareComponents

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

表 7.5. 主体参数
参数	类型	描述
`正文（body）`	`HostFirmwareComponents` 模式

表 7.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareComponents` 模式
201 - Created	`HostFirmwareComponents` 模式
202 - Accepted	`HostFirmwareComponents` 模式
401 - Unauthorized	空

7.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}

表 7.7. 全局路径参数
参数	类型	描述
`name`	`string`	HostFirmwareComponents 的名称

HTTP 方法: DELETE
描述: delete HostFirmwareComponents

表 7.8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 7.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 HostFirmwareComponents

表 7.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareComponents` 模式
401 - Unauthorized	空

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

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

表 7.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareComponents` 模式
401 - Unauthorized	空

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

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

表 7.14. 主体参数
参数	类型	描述
`正文（body）`	`HostFirmwareComponents` 模式

表 7.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareComponents` 模式
201 - Created	`HostFirmwareComponents` 模式
401 - Unauthorized	空

7.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}/status

表 7.16. 全局路径参数
参数	类型	描述
`name`	`string`	HostFirmwareComponents 的名称

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

表 7.17. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareComponents` 模式
401 - Unauthorized	空

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

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

表 7.19. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareComponents` 模式
401 - Unauthorized	空

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

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

表 7.21. 主体参数
参数	类型	描述
`正文（body）`	`HostFirmwareComponents` 模式

表 7.22. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareComponents` 模式
201 - Created	`HostFirmwareComponents` 模式
401 - Unauthorized	空

第 8 章 HostFirmwareSettings [metal3.io/v1alpha1]

描述: HostFirmwareSettings 是 hostfirmwaresettings API 的 Schema。
类型: 对象

8.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`object`	HostFirmwareSettingsSpec 定义 HostFirmwareSettings 的所需状态。
`status`	`object`	HostFirmwareSettingsStatus 定义 HostFirmwareSettings 的观察状态。

8.1.1. .spec

描述

HostFirmwareSettingsSpec 定义 HostFirmwareSettings 的所需状态。

类型

object

必填

设置

属性	类型	描述
`设置`	`integer-or-string`	设置是所需的固件设置，存储为名称/值对。

8.1.2. .status

描述

HostFirmwareSettingsStatus 定义 HostFirmwareSettings 的观察状态。

类型

object

必填

设置

属性	类型	描述
`conditions`	`array`	根据 schema，跟踪存储在 spec 中的设置是否有效
`conditions[]`	`对象`	条件包含此 API 资源当前状态的一个方面的详情。--- 这个结构旨在直接用作字段路径 .status.conditions 中的数组。例如，输入 FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` // other fields }
`lastUpdated`	`string`	状态最后一次更新的时间
`schema`	`对象`	FirmwareSchema 是用于描述每个 FirmwareSetting 的 Schema 的引用。默认情况下，这将是与设置相同的命名空间中的一个 Schema，但可以在 Spec 中被覆盖
`设置`	`对象（字符串）`	设置是存储为名称/值对的固件设置

8.1.3. .status.conditions

描述: 根据 schema，跟踪存储在 spec 中的设置是否有效
类型: array

8.1.4. .status.conditions[]

描述

类型

object

必填

lastTransitionTime
message
reason
status
type

属性	类型	描述
`lastTransitionTime`	`字符串`	lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。这应该是底层条件变化的时间。如果为未知，则使用 API 字段更改的时间是可以接受的。
`message`	`字符串`	Message 是人类可读的消息，指示有关转换的详细信息。这可能是一个空字符串。
`observedGeneration`	`整数`	observedGeneration 代表 .metadata.generation，这是条件设置所基于的条件。例如，如果 .metadata.generation 目前为 12，但 .status.conditions[x].observedGeneration 是 9，则代表条件与实例的当前状态已不匹配。
`reason`	`字符串`	reason 包含程序标识符，指示条件最后一次转换的原因。特定条件类型的制作者可能会定义预期的值和此字段的含义，以及这些值是否被视为有保证的 API。该值应该是 CamelCase 字符串。此字段可能不是空的。
`status`	`字符串`	条件的状态，True, False, Unknown 之一。
`type`	`字符串`	CamelCase 或 foo.example.com/CamelCase 中的条件类型。-- Many .condition.type 值在资源间是一致的，但因为任意条件可能很有用（请参阅 .node.status.conditions），deconflict 的能力非常重要。它匹配的正则表达式是 (dns1123SubdomainFmt/)? (qualifiedNameFmt)

8.1.5. .status.schema

描述

FirmwareSchema 是用于描述每个 FirmwareSetting 的 Schema 的引用。默认情况下，这将是与设置相同的命名空间中的一个 Schema，但可以在 Spec 中被覆盖

类型

object

必填

name
namespace

属性	类型	描述
`name`	`字符串`	`name` 是对 schema 的引用。
`namespace`	`字符串`	`namespace` 是存储 schema 的命名空间。

8.2. API 端点

可用的 API 端点如下：

/apis/metal3.io/v1alpha1/hostfirmwaresettings
- GET: 列出 HostFirmwareSettings 类型的对象
/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings
- DELETE: 删除 HostFirmwareSettings 集合
- GET: 列出 HostFirmwareSettings 类型的对象
- POST: 创建 HostFirmwareSettings
/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}
- DELETE: delete HostFirmwareSettings
- GET ：读取指定的 HostFirmwareSettings
- PATCH: 部分更新指定的 HostFirmwareSettings
- PUT ：替换指定的 HostFirmwareSettings
/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}/status
- GET ：指定 HostFirmwareSettings 的读取状态
- PATCH: 部分更新指定 HostFirmwareSettings 的状态
- PUT ：替换指定 HostFirmwareSettings 的状态

8.2.1. /apis/metal3.io/v1alpha1/hostfirmwaresettings

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

表 8.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareSettingsList` 模式
401 - Unauthorized	空

8.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings

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

表 8.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 8.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareSettingsList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 HostFirmwareSettings

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

表 8.5. 主体参数
参数	类型	描述
`正文（body）`	`HostFirmwareSettings` 模式

表 8.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareSettings` 模式
201 - Created	`HostFirmwareSettings` 模式
202 - Accepted	`HostFirmwareSettings` 模式
401 - Unauthorized	空

8.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}

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

HTTP 方法: DELETE
描述: delete HostFirmwareSettings

表 8.8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 8.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 HostFirmwareSettings

表 8.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareSettings` 模式
401 - Unauthorized	空

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

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

表 8.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareSettings` 模式
401 - Unauthorized	空

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

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

表 8.14. 主体参数
参数	类型	描述
`正文（body）`	`HostFirmwareSettings` 模式

表 8.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareSettings` 模式
201 - Created	`HostFirmwareSettings` 模式
401 - Unauthorized	空

8.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}/status

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

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

表 8.17. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareSettings` 模式
401 - Unauthorized	空

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

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

表 8.19. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareSettings` 模式
401 - Unauthorized	空

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

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

表 8.21. 主体参数
参数	类型	描述
`正文（body）`	`HostFirmwareSettings` 模式

表 8.22. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HostFirmwareSettings` 模式
201 - Created	`HostFirmwareSettings` 模式
401 - Unauthorized	空

第 9 章 Metal3Remediation [infrastructure.cluster.x-k8s.io/v1beta1]

描述: Metal3Remediation 是 metal3remediations API 的 Schema。
类型: 对象

9.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`object`	Metal3RemediationSpec 定义所需的 Metal3Remediation 状态。
`status`	`object`	Metal3RemediationStatus 定义 Metal3Remediation 的观察状态。

9.1.1. .spec

描述: Metal3RemediationSpec 定义所需的 Metal3Remediation 状态。
类型: object

属性	类型	描述
`策略`	`object`	strategy 字段定义补救策略。

9.1.2. .spec.strategy

描述: strategy 字段定义补救策略。
类型: object

属性	类型	描述
`retryLimit`	`整数`	设置重试的最大补救次数。
`timeout`	`string`	设置补救重试之间超时。
`type`	`string`	补救类型。

9.1.3. .status

描述: Metal3RemediationStatus 定义 Metal3Remediation 的观察状态。
类型: object

属性	类型	描述
`lastRemediated`	`string`	LastRemediated 标识主机最后修复的时间
`phase`	`string`	phase 代表机器补救的当前阶段。例如待定、运行、完成等.
`retryCount`	`整数`	在补救过程中，RetryCount 可用作计数器。字段可以保存重启数量等。

9.2. API 端点

可用的 API 端点如下：

/apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediations
- GET: 列出类型为 Metal3Remediation 的对象
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations
- DELETE: 删除 Metal3Remediation 集合
- GET: 列出类型为 Metal3Remediation 的对象
- POST ：创建 Metal3Remediation
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations/{name}
- DELETE ：删除 Metal3Remediation
- GET ：读取指定的 Metal3Remediation
- PATCH: 部分更新指定的 Metal3Remediation
- PUT ：替换指定的 Metal3Remediation
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations/{name}/status
- GET ：指定 Metal3Remediation 的读取状态
- PATCH: 部分更新指定 Metal3Remediation 的状态
- PUT ：替换指定 Metal3Remediation 的状态

9.2.1. /apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediations

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

表 9.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3RemediationList` 模式
401 - Unauthorized	空

9.2.2. /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations

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

表 9.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 9.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3RemediationList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 Metal3Remediation

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

表 9.5. 主体参数
参数	类型	描述
`正文（body）`	`Metal3Remediation` 模式

表 9.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3Remediation` 模式
201 - Created	`Metal3Remediation` 模式
202 - Accepted	`Metal3Remediation` 模式
401 - Unauthorized	空

9.2.3. /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations/{name}

表 9.7. 全局路径参数
参数	类型	描述
`name`	`string`	Metal3Remediation 的名称

HTTP 方法: DELETE
描述: 删除 Metal3Remediation

表 9.8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 9.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 Metal3Remediation

表 9.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3Remediation` 模式
401 - Unauthorized	空

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

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

表 9.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3Remediation` 模式
401 - Unauthorized	空

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

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

表 9.14. 主体参数
参数	类型	描述
`正文（body）`	`Metal3Remediation` 模式

表 9.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3Remediation` 模式
201 - Created	`Metal3Remediation` 模式
401 - Unauthorized	空

9.2.4. /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations/{name}/status

表 9.16. 全局路径参数
参数	类型	描述
`name`	`string`	Metal3Remediation 的名称

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

表 9.17. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3Remediation` 模式
401 - Unauthorized	空

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

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

表 9.19. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3Remediation` 模式
401 - Unauthorized	空

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

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

表 9.21. 主体参数
参数	类型	描述
`正文（body）`	`Metal3Remediation` 模式

表 9.22. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3Remediation` 模式
201 - Created	`Metal3Remediation` 模式
401 - Unauthorized	空

第 10 章 Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]

描述: Metal3RemediationTemplate 是 metal3remediationtemplates API 的 Schema。
类型: 对象

10.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`object`	Metal3RemediationTemplateSpec 定义所需的 Metal3RemediationTemplate 状态。
`status`	`object`	Metal3RemediationTemplateStatus 定义 Metal3RemediationTemplate 的观察状态。

10.1.1. .spec

描述

Metal3RemediationTemplateSpec 定义所需的 Metal3RemediationTemplate 状态。

类型

object

必填

模板

属性	类型	描述
`模板`	`object`	Metal3RemediationTemplateResource 描述了从模板创建 Metal3Remediation 所需的数据。

10.1.2. .spec.template

描述

Metal3RemediationTemplateResource 描述了从模板创建 Metal3Remediation 所需的数据。

类型

object

必填

spec

属性	类型	描述
`spec`	`object`	spec 是 Metal3Remediation 所需的行为的规格。

10.1.3. .spec.template.spec

描述: spec 是 Metal3Remediation 所需的行为的规格。
类型: object

属性	类型	描述
`策略`	`object`	strategy 字段定义补救策略。

10.1.4. .spec.template.spec.strategy

描述: strategy 字段定义补救策略。
类型: object

属性	类型	描述
`retryLimit`	`整数`	设置重试的最大补救次数。
`timeout`	`string`	设置补救重试之间超时。
`type`	`string`	补救类型。

10.1.5. .status

描述

Metal3RemediationTemplateStatus 定义 Metal3RemediationTemplate 的观察状态。

类型

object

必填

status

属性	类型	描述
`status`	`object`	Metal3RemediationStatus 定义 Metal3Remediation 的观察状态

10.1.6. .status.status

描述: Metal3RemediationStatus 定义 Metal3Remediation 的观察状态
类型: object

属性	类型	描述
`lastRemediated`	`string`	LastRemediated 标识主机最后修复的时间
`phase`	`string`	phase 代表机器补救的当前阶段。例如待定、运行、完成等.
`retryCount`	`整数`	在补救过程中，RetryCount 可用作计数器。字段可以保存重启数量等。

10.2. API 端点

可用的 API 端点如下：

/apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediationtemplates
- GET: 列出类型为 Metal3RemediationTemplate 的对象
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates
- DELETE: 删除 Metal3RemediationTemplate 集合
- GET: 列出类型为 Metal3RemediationTemplate 的对象
- POST ：创建 Metal3RemediationTemplate
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}
- DELETE ：删除 Metal3RemediationTemplate
- GET ：读取指定的 Metal3RemediationTemplate
- PATCH: 部分更新指定的 Metal3RemediationTemplate
- PUT ：替换指定的 Metal3RemediationTemplate
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}/status
- GET ：指定 Metal3RemediationTemplate 的读取状态
- PATCH: 部分更新指定 Metal3RemediationTemplate 的状态
- PUT ：替换指定 Metal3RemediationTemplate 的状态

10.2.1. /apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediationtemplates

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

表 10.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3RemediationTemplateList` 模式
401 - Unauthorized	空

10.2.2. /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates

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

表 10.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 10.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3RemediationTemplateList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 Metal3RemediationTemplate

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

表 10.5. 主体参数
参数	类型	描述
`正文（body）`	`Metal3RemediationTemplate` 模式

表 10.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3RemediationTemplate` 模式
201 - Created	`Metal3RemediationTemplate` 模式
202 - Accepted	`Metal3RemediationTemplate` 模式
401 - Unauthorized	空

10.2.3. /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}

表 10.7. 全局路径参数
参数	类型	描述
`name`	`string`	Metal3RemediationTemplate 的名称

HTTP 方法: DELETE
描述: 删除 Metal3RemediationTemplate

表 10.8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 10.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 Metal3RemediationTemplate

表 10.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3RemediationTemplate` 模式
401 - Unauthorized	空

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

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

表 10.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3RemediationTemplate` 模式
401 - Unauthorized	空

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

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

表 10.14. 主体参数
参数	类型	描述
`正文（body）`	`Metal3RemediationTemplate` 模式

表 10.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3RemediationTemplate` 模式
201 - Created	`Metal3RemediationTemplate` 模式
401 - Unauthorized	空

10.2.4. /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}/status

表 10.16. 全局路径参数
参数	类型	描述
`name`	`string`	Metal3RemediationTemplate 的名称

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

表 10.17. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3RemediationTemplate` 模式
401 - Unauthorized	空

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

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

表 10.19. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3RemediationTemplate` 模式
401 - Unauthorized	空

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

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

表 10.21. 主体参数
参数	类型	描述
`正文（body）`	`Metal3RemediationTemplate` 模式

表 10.22. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Metal3RemediationTemplate` 模式
201 - Created	`Metal3RemediationTemplate` 模式
401 - Unauthorized	空

第 11 章 PreprovisioningImage [metal3.io/v1alpha1]

描述: PreprovisioningImage 是预置备镜像 API 的 Schema。
类型: 对象

11.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`object`	PreprovisioningImageSpec 定义所需的 PreprovisioningImage 状态。
`status`	`object`	PreprovisioningImageStatus 定义 PreprovisioningImage 的观察状态。

11.1.1. .spec

描述: PreprovisioningImageSpec 定义所需的 PreprovisioningImage 状态。
类型: object

属性	类型	描述
`acceptFormats`	`数组（字符串）`	acceptFormats 是可接受的镜像格式列表。
`架构`	`string`	架构是构建镜像的处理器架构。
`networkDataName`	`string`	networkDataName 是本地命名空间中的 Secret 名称，其中包含要构建到镜像的网络数据。

11.1.2. .status

描述: PreprovisioningImageStatus 定义 PreprovisioningImage 的观察状态。
类型: object

属性	类型	描述
`架构`	`string`	架构是构建镜像的处理器架构
`conditions`	`数组`	条件描述了构建镜像的状态
`conditions[]`	`对象`	条件包含此 API 资源当前状态的一个方面的详情。--- 这个结构旨在直接用作字段路径 .status.conditions 中的数组。例如，输入 FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` // other fields }
`extraKernelParams`	`string`	extraKernelParams 是一个带有额外参数的字符串，用于在通过网络引导镜像时传递给内核。仅对 initrd 镜像有意义。
`格式`	`string`	Format 是位于下载 url 中的镜像的类型： iso 或 initrd。
`imageUrl`	`string`	imageURL 是可以从中下载构建镜像的 URL。
`kernelUrl`	`string`	kernelUrl 是可以从中下载镜像内核的 URL。仅对 initrd 镜像有意义。
`networkData`	`object`	networkData 是对包含用于构建镜像的网络数据的 Secret 版本的引用。

11.1.3. .status.conditions

描述: 条件描述了构建镜像的状态
类型: array

11.1.4. .status.conditions[]

描述

类型

object

必填

lastTransitionTime
message
reason
status
type

属性	类型	描述
`lastTransitionTime`	`字符串`	lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。这应该是底层条件变化的时间。如果为未知，则使用 API 字段更改的时间是可以接受的。
`message`	`字符串`	Message 是人类可读的消息，指示有关转换的详细信息。这可能是一个空字符串。
`observedGeneration`	`整数`	observedGeneration 代表 .metadata.generation，这是条件设置所基于的条件。例如，如果 .metadata.generation 目前为 12，但 .status.conditions[x].observedGeneration 是 9，则代表条件与实例的当前状态已不匹配。
`reason`	`字符串`	reason 包含程序标识符，指示条件最后一次转换的原因。特定条件类型的制作者可能会定义预期的值和此字段的含义，以及这些值是否被视为有保证的 API。该值应该是 CamelCase 字符串。此字段可能不是空的。
`status`	`字符串`	条件的状态，True, False, Unknown 之一。
`type`	`字符串`	CamelCase 或 foo.example.com/CamelCase 中的条件类型。-- Many .condition.type 值在资源间是一致的，但因为任意条件可能很有用（请参阅 .node.status.conditions），deconflict 的能力非常重要。它匹配的正则表达式是 (dns1123SubdomainFmt/)? (qualifiedNameFmt)

11.1.5. .status.networkData

描述: networkData 是对包含用于构建镜像的网络数据的 Secret 版本的引用。
类型: object

属性	类型	描述
`name`	`字符串`
`version`	`字符串`

11.2. API 端点

可用的 API 端点如下：

/apis/metal3.io/v1alpha1/preprovisioningimages
- GET: 列出类型为 PreprovisioningImage 的对象
/apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages
- DELETE: 删除 PreprovisioningImage 集合
- GET: 列出类型为 PreprovisioningImage 的对象
- POST ：创建 PreprovisioningImage
/apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}
- DELETE ：删除 PreprovisioningImage
- GET ：读取指定的 PreprovisioningImage
- PATCH: 部分更新指定的 PreprovisioningImage
- PUT ：替换指定的 PreprovisioningImage
/apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}/status
- GET: 指定 PreprovisioningImage 的读取状态
- PATCH: 部分更新指定 PreprovisioningImage 的状态
- PUT ：替换指定 PreprovisioningImage 的状态

11.2.1. /apis/metal3.io/v1alpha1/preprovisioningimages

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

表 11.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PreprovisioningImageList` 模式
401 - Unauthorized	空

11.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages

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

表 11.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 11.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PreprovisioningImageList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 PreprovisioningImage

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

表 11.5. 主体参数
参数	类型	描述
`正文（body）`	`PreprovisioningImage` 模式

表 11.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PreprovisioningImage` 模式
201 - Created	`PreprovisioningImage` 模式
202 - Accepted	`PreprovisioningImage` 模式
401 - Unauthorized	空

11.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}

表 11.7. 全局路径参数
参数	类型	描述
`name`	`string`	PreprovisioningImage 的名称

HTTP 方法: DELETE
描述: 删除 PreprovisioningImage

表 11.8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 11.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 PreprovisioningImage

表 11.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PreprovisioningImage` 模式
401 - Unauthorized	空

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

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

表 11.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PreprovisioningImage` 模式
401 - Unauthorized	空

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

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

表 11.14. 主体参数
参数	类型	描述
`正文（body）`	`PreprovisioningImage` 模式

表 11.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PreprovisioningImage` 模式
201 - Created	`PreprovisioningImage` 模式
401 - Unauthorized	空

11.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}/status

表 11.16. 全局路径参数
参数	类型	描述
`name`	`string`	PreprovisioningImage 的名称

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

表 11.17. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PreprovisioningImage` 模式
401 - Unauthorized	空

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

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

表 11.19. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PreprovisioningImage` 模式
401 - Unauthorized	空

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

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

表 11.21. 主体参数
参数	类型	描述
`正文（body）`	`PreprovisioningImage` 模式

表 11.22. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PreprovisioningImage` 模式
201 - Created	`PreprovisioningImage` 模式
401 - Unauthorized	空

第 12 章 Provisioning [metal3.io/v1alpha1]

描述: Provisioning 包含由 Provisioning 服务(Ironic)来置备裸机主机的配置。调配由 OpenShift 安装程序使用 admin 或用户提供的有关调配网络和可用 PXE 引导的 NIC 的信息来创建。此 CR 是安装程序创建的单例，目前仅由 cluster-baremetal-operator 使用，以便在 metal3 集群中启动和更新容器。
类型: 对象

12.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`对象`	ProvisioningSpec 定义所需的置备状态
`status`	`对象`	ProvisioningStatus 定义 Provisioning 的观察状态

12.1.1. .spec

描述: ProvisioningSpec 定义所需的置备状态
类型: object

属性	类型	描述
`bootIsoSource`	`字符串`	BootIsoSource 提供了一种设置要引导节点的位置的方法。默认情况下，boot iso 镜像在本地缓存，并使用辅助 httpd 服务器从 Provisioning 服务(Ironic)节点提供。如果 httpd 服务器已经提供 boot iso 镜像，将此选项设置为 http 允许从那里直接提供镜像；在这种情况下，网络（内部或外部）需要被 metal3 pod 访问引导 iso 的网络。
`disableVirtualMediaTLS`	`布尔值`	DisableVirtualMediaTLS 在虚拟介质服务器上关闭 TLS，对于无法接受 HTTPS 链接的硬件可能需要该 TLS。
`preProvisioningOSDownloadURLs`	`对象`	preProvisioningOSDownloadURLs 是一组 CoreOS Live URL，需要使用虚拟介质或 PXE 置备 worker。
`provisioningDHCPExternal`	`布尔值`	ProvisioningDHCPExternal 表示置备 DHCP 范围内的 IP 地址的 DHCP 服务器是否存在于 metal3 集群中，还是外部。此字段已弃用，而是使用 provisioningNetwork。
`provisioningDHCPRange`	`字符串`	provisioningDHCPRange 需要与 ProvisioningDHCPExternal 进行解释。如果 provisioningDHCPExternal 的值设置为 False，则 ProvisioningDHCPRange 代表在 metal3 集群中运行的 DHCP 服务器可以使用的 IP 地址范围。如果 ProvisioningDHCPExternal 的值设为 True，则 ProvisioningDHCPRange 的值将被忽略。当 ProvisioningDHCPExternal 的值设置为 False 时，表示内部 DHCP 服务器和未设置 ProvisioningDHCPRange 的值，则 DHCP 范围将被视为 ProvisioningNetworkCIDR 的 .10 到 .100 的默认范围。这是所有 Provisioning 配置中的唯一值，可在安装程序创建 CR 后更改。这个值需要是 ProvisioningNetworkCIDR 中的两个逗号分隔 IP 地址，其中 1st 地址代表范围的开头，第二地址代表范围内的最后一个可用地址。
`provisioningDNS`	`布尔值`	ProvisioningDNS 允许通过 provisionig 网络上的 DHCP 发送 DNS 信息。默认情况下，它处于 off 状态，因为 Provisioning 服务本身(Ironic)不需要 DNS，但可能对分层产品（如 ZTP）有用。
`provisioningIP`	`字符串`	provisioningIP 是分配给 baremetal 服务器的 provisioningInterface 的 IP 地址。此 IP 地址应位于 provisioning 子网内，且在 DHCP 范围之外。
`provisioningInterface`	`字符串`	provisioningInterface 是 baremetal 服务器上的网络接口的名称，到 provisioning 网络。它可以具有 eth1 或 ens3 等值。
`provisioningMacAddresses`	`数组（字符串）`	provisioningMacAddresses 是 baremetal 服务器上网络接口的 mac 地址列表到 provisioning 网络。使用这个而不是 ProvisioningInterface 来允许不同名称的接口。如果没有提供，它将由每个 master 的 BMH.Spec.BootMacAddress 填充。
`provisioningNetwork`	`字符串`	provisioningNetwork 提供了指示置备网络的底层网络配置状态的方法。当 provisioning 网络完全由 Baremetal IPI 解决方案管理时，此字段可以有以下值之一。unmanaged- 当提供网络存在并使用，但该用户负责管理 DHCP。建议进行虚拟介质调配，但在需要时仍可使用 PXE。`disabled`- 当 provisioning 网络被完全禁用时。用户可以使用虚拟介质或辅助安装启动 baremetal 集群。如果使用 metal3 进行电源管理，则必须可从机器网络访问 BMC。用户应在外部网络上提供两个用于调配服务的 IP。
`provisioningNetworkCIDR`	`字符串`	provisioningNetworkCIDR 是置备 baremetal 节点的网络。dhcpRange 中的 provisioningIP 和 IP 都来自这个网络。当使用 IPv6 和由 Baremetal IPI 解决方案管理的网络时，这不能是一个大于 /64 的网络。
`provisioningOSDownloadURL`	`字符串`	provisioningOSDownloadURL 是用来引导 baremetal 主机的操作系统镜像可以被 metal3 集群下载的位置。
`virtualMediaViaExternalNetwork`	`布尔值`	当设置为 "true" 时，VirtualMediaViaExternalNetwork 标志允许 worker 通过 Virtual Media 引导，并通过 External Network 联系 metal3。当标志设置为 "false" （默认），虚拟介质部署仍然可以根据 ProvisioningNetwork 中指定的配置进行，例如在 Disabled 模式下，通过 External Network 和 Provisioning Network （在 Managed 模式时通过 Provisioning Network）。PXE 部署将始终使用 Provisioning 网络，且不受此标志的影响。
`watchAllNamespaces`	`布尔值`	watchAllNameSpaces 提供了在所有命名空间中明确允许使用此置备配置的方法。这是一个可选配置，默认为 false，在该状态将仅用于置备 openshift-machine-api 命名空间中的 baremetal 主机。当设置为 true 时，这个置备配置将用于所有命名空间中的 baremetal 主机。

12.1.2. .spec.preProvisioningOSDownloadURLs

描述: preProvisioningOSDownloadURLs 是一组 CoreOS Live URL，需要使用虚拟介质或 PXE 置备 worker。
类型: object

属性	类型	描述
`initramfsURL`	`字符串`	用于 PXE 部署的 InitramfsURL 镜像 URL
`isoURL`	`字符串`	用于实时 ISO 部署的 IsoURL 镜像 URL
`kernelURL`	`字符串`	KernelURL 是一个用于 PXE 部署的镜像 URL
`rootfsURL`	`字符串`	用于 PXE 部署的 rootFSUrl 镜像 URL

12.1.3. .status

描述: ProvisioningStatus 定义 Provisioning 的观察状态
类型: object

属性	类型	描述
`conditions`	`array`	conditions 是条件及其状态列表
`conditions[]`	`对象`	OperatorCondition 只是标准条件字段。
`generations`	`array`	生成用于确定项目是否需要协调或更改是否需要反应。
`generations[]`	`对象`	GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
`observedGeneration`	`整数`	observedGeneration 是您处理的最后生成更改
`readyReplicas`	`整数`	readyReplicas 表示有多少副本就绪并处于所需的状态
`version`	`字符串`	版本是此可用性适用的级别

12.1.4. .status.conditions

描述: conditions 是条件及其状态列表
类型: array

12.1.5. .status.conditions[]

描述

OperatorCondition 只是标准条件字段。

类型

object

必填

type

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

12.1.6. .status.generations

描述: 生成用于确定项目是否需要协调或更改是否需要反应。
类型: array

12.1.7. .status.generations[]

描述: GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
类型: object

属性	类型	描述
`group`	`字符串`	组是您要跟踪的内容组
`hash`	`字符串`	hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps
`lastGeneration`	`整数`	lastGeneration 是涉及的工作负载控制器的最后生成
`name`	`字符串`	name 是您要跟踪的内容的名称
`namespace`	`字符串`	命名空间(namespace)是您要跟踪的事情
`resource`	`字符串`	资源是您要跟踪的资源类型

12.2. API 端点

可用的 API 端点如下：

/apis/metal3.io/v1alpha1/provisionings
- DELETE ：删除置备集合
- GET ：列出类型为 Provisioning 的对象
- POST ：创建置备
/apis/metal3.io/v1alpha1/provisionings/{name}
- DELETE ：删除置备
- GET ：读取指定的置备
- PATCH: 部分更新指定的置备
- PUT ：替换指定的 Provisioning
/apis/metal3.io/v1alpha1/provisionings/{name}/status
- GET ：指定 Provisioning 的读取状态
- PATCH: 部分更新指定置备的状态
- PUT ：替换指定置备的状态

12.2.1. /apis/metal3.io/v1alpha1/provisionings

HTTP 方法: DELETE
描述: 删除置备集合

表 12.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 12.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ProvisioningList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建置备

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

表 12.4. 主体参数
参数	类型	描述
`正文（body）`	`Provisioning` 模式

表 12.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Provisioning` 模式
201 - Created	`Provisioning` 模式
202 - Accepted	`Provisioning` 模式
401 - Unauthorized	空

12.2.2. /apis/metal3.io/v1alpha1/provisionings/{name}

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

HTTP 方法: DELETE
描述: 删除置备

表 12.7. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 12.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

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

表 12.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Provisioning` 模式
401 - Unauthorized	空

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

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

表 12.11. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Provisioning` 模式
401 - Unauthorized	空

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

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

表 12.13. 主体参数
参数	类型	描述
`正文（body）`	`Provisioning` 模式

表 12.14. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Provisioning` 模式
201 - Created	`Provisioning` 模式
401 - Unauthorized	空

12.2.3. /apis/metal3.io/v1alpha1/provisionings/{name}/status

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

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

表 12.16. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Provisioning` 模式
401 - Unauthorized	空

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

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

表 12.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Provisioning` 模式
401 - Unauthorized	空

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

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

表 12.20. 主体参数
参数	类型	描述
`正文（body）`	`Provisioning` 模式

表 12.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Provisioning` 模式
201 - Created	`Provisioning` 模式
401 - Unauthorized	空

Legal Notice

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

置备 API

置备 API 的参考指南

第 1 章 置备 API

1.1. BMCEventSubscription [metal3.io/v1alpha1]

1.2. BareMetalHost [metal3.io/v1alpha1]

1.3. DataImage [metal3.io/v1alpha1]

1.4. FirmwareSchema [metal3.io/v1alpha1]

1.5. HardwareData [metal3.io/v1alpha1]

1.6. HostFirmwareComponents [metal3.io/v1alpha1]

1.7. HostFirmwareSettings [metal3.io/v1alpha1]

1.8. Metal3Remediation [infrastructure.cluster.x-k8s.io/v1beta1]

1.9. Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]

1.10. PreprovisioningImage [metal3.io/v1alpha1]

1.11. Provisioning [metal3.io/v1alpha1]

第 2 章 BMCEventSubscription [metal3.io/v1alpha1]

2.1. 规格

2.1.1. .spec

2.1.2. .spec.httpHeadersRef

2.1.3. .status

2.2. API 端点

2.2.1. /apis/metal3.io/v1alpha1/bmceventsubscriptions

2.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions

2.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}

2.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}/status

第 3 章 BareMetalHost [metal3.io/v1alpha1]

3.1. 规格

3.1.1. .spec

3.1.2. .spec.bmc

3.1.3. .spec.consumerRef

3.1.4. .spec.customDeploy

3.1.5. .spec.firmware

3.1.6. .spec.image

3.1.7. .spec.metaData

3.1.8. .spec.networkData

3.1.9. .spec.raid

3.1.10. .spec.rootDeviceHints

3.1.11. .spec.taints

3.1.12. .spec.taints[]

3.1.13. .spec.userData

3.1.14. .status

3.1.15. .status.goodCredentials

3.1.16. .status.goodCredentials.credentials

3.1.17. .status.hardware

3.1.18. .status.hardware.cpu

3.1.19. .status.hardware.firmware

3.1.20. .status.hardware.firmware.bios

3.1.21. .status.hardware.nics

3.1.22. .status.hardware.nics[]

3.1.23. .status.hardware.nics[].vlans

3.1.24. .status.hardware.nics[].vlans[]

3.1.25. .status.hardware.storage

3.1.26. .status.hardware.storage[]

3.1.27. .status.hardware.systemVendor

3.1.28. .status.operationHistory

3.1.29. .status.operationHistory.deprovision

3.1.30. .status.operationHistory.inspect

3.1.31. .status.operationHistory.provision

3.1.32. .status.operationHistory.register

3.1.33. .status.provisioning

3.1.34. .status.provisioning.customDeploy

3.1.35. .status.provisioning.firmware

3.1.36. .status.provisioning.image

3.1.37. .status.provisioning.raid

3.1.38. .status.provisioning.rootDeviceHints

3.1.39. .status.triedCredentials

3.1.40. .status.triedCredentials.credentials

3.2. API 端点

3.2.1. /apis/metal3.io/v1alpha1/baremetalhosts

3.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts

3.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}

3.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}/status

第 4 章 DataImage [metal3.io/v1alpha1]

4.1. 规格

4.1.1. .spec

4.1.2. .status

4.1.3. .status.attachedImage

4.1.4. .status.error

4.2. API 端点

4.2.1. /apis/metal3.io/v1alpha1/dataimages

4.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages

第 1 章置备 API