×

规格

属性 类型 描述

apiVersion

字符串

APIVersion 定义了对象的此表示的版本化模式。服务器应将识别的模式转换为最新的内部值,并可能拒绝无法识别的值。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

Kind 是一个字符串值,表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。不能更新。使用驼峰命名法。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象的元数据。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

HardwareDataSpec 定义了 HardwareData 的期望状态。

.spec

描述

HardwareDataSpec 定义了 HardwareData 的期望状态。

类型

对象

属性 类型 描述

hardware

对象

在主机检查期间在其上发现的硬件。

.spec.hardware

描述

在主机检查期间在其上发现的硬件。

类型

对象

属性 类型 描述

cpu

对象

CPU 描述主机上的一个处理器。

firmware

对象

Firmware 描述主机上的固件。

hostname

字符串

nics

数组

nics[]

对象

NIC 描述主机上的一个网络接口。

ramMebibytes

整数

storage

数组

storage[]

对象

Storage 描述主机上的一个存储设备(磁盘、SSD 等)。

systemVendor

对象

HardwareSystemVendor 存储有关整个硬件系统的详细信息。

.spec.hardware.cpu

描述

CPU 描述主机上的一个处理器。

类型

对象

属性 类型 描述

arch

字符串

clockMegahertz

数字

ClockSpeed 是以 MHz 为单位的时钟速度。

count

整数

flags

数组 (字符串)

model

字符串

.spec.hardware.firmware

描述

Firmware 描述主机上的固件。

类型

对象

属性 类型 描述

bios

对象

此固件的 BIOS

.spec.hardware.firmware.bios

描述

此固件的 BIOS

类型

对象

属性 类型 描述

日期

字符串

此 BIOS 的发布/构建日期

厂商

字符串

此 BIOS 的厂商名称

版本

字符串

BIOS 的版本

.spec.hardware.nics

描述
类型

数组

.spec.hardware.nics[]

描述

NIC 描述主机上的一个网络接口。

类型

对象

属性 类型 描述

IP 地址

字符串

接口的 IP 地址。如果存在,则为 IPv4 或 IPv6 地址。如果在双栈环境中同时存在 IPv4 和 IPv6 地址,则将输出两个 nic,每个 nic 使用一个 IP。

MAC 地址

字符串

设备 MAC 地址

model

字符串

NIC 的厂商和产品 ID,例如“0x8086 0x1572”

名称

字符串

网络接口的名称,例如“en0”

PXE

布尔值

NIC 是否支持 PXE 启动

速度 (Gbps)

整数

设备的速度,以千兆位每秒为单位

VLAN ID

整数

未标记的 VLAN ID

VLANs

数组

可用的 VLAN

vlans[]

对象

VLAN 代表 VLAN 的名称和 ID。

.spec.hardware.nics[].vlans

描述

可用的 VLAN

类型

数组

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

描述

VLAN 代表 VLAN 的名称和 ID。

类型

对象

属性 类型 描述

ID

整数

VLAN ID 是一个 12 位 802.1Q VLAN 标识符

名称

字符串

.spec.hardware.storage

描述
类型

数组

.spec.hardware.storage[]

描述

Storage 描述主机上的一个存储设备(磁盘、SSD 等)。

类型

对象

属性 类型 描述

备用名称

数组 (字符串)

磁盘的备用 Linux 设备名称列表,例如“/dev/sda”。请注意,此列表并非详尽无遗,并且名称在重新启动后可能不稳定。

HCTL

字符串

设备的 SCSI 位置

model

字符串

硬件型号

名称

字符串

磁盘的 Linux 设备名称,例如“/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0”。如果可用,则此名称在重新启动后将保持稳定。

旋转式

布尔值

此磁盘是否代表旋转存储。不建议使用此字段,请改用“类型”字段,此字段最终将被弃用。

序列号

字符串

设备的序列号

大小 (字节)

整数

磁盘的大小(以字节为单位)

类型

字符串

设备类型,其中之一:HDD、SSD、NVME。

厂商

字符串

设备厂商的名称

WWN

字符串

设备的 WWN

WWN 厂商扩展

字符串

设备的 WWN 厂商扩展

带扩展的 WWN

字符串

带扩展的 WWN

.spec.hardware.systemVendor

描述

HardwareSystemVendor 存储有关整个硬件系统的详细信息。

类型

对象

属性 类型 描述

制造商

字符串

产品名称

字符串

序列号

字符串

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

/apis/metal3.io/v1alpha1/hardwaredata

HTTP 方法

GET

描述

列出 HardwareData 类型的对象

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

200 - OK

HardwareDataList 模式

401 - 未授权

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

HTTP 方法

DELETE

描述

删除 HardwareData 集合

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

200 - OK

Status 模式

401 - 未授权

HTTP 方法

GET

描述

列出 HardwareData 类型的对象

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

200 - OK

HardwareDataList 模式

401 - 未授权

HTTP 方法

POST

描述

创建 HardwareData

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

dryRun

字符串

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

fieldValidation

字符串

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

表 5. 主体参数
参数 类型 描述

主体

HardwareData 模式

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

200 - OK

HardwareData 模式

201 - 已创建

HardwareData 模式

202 - 已接受

HardwareData 模式

401 - 未授权

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

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

名称

字符串

HardwareData 的名称

HTTP 方法

DELETE

描述

删除 HardwareData

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

dryRun

字符串

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

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

HTTP 方法

GET

描述

读取指定的 HardwareData

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

200 - OK

HardwareData 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 HardwareData

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

dryRun

字符串

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

fieldValidation

字符串

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

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

200 - OK

HardwareData 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 HardwareData

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

dryRun

字符串

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

fieldValidation

字符串

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

表 14. 主体参数
参数 类型 描述

主体

HardwareData 模式

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

200 - OK

HardwareData 模式

201 - 已创建

HardwareData 模式

401 - 未授权