BareMetalHost [metal3.io/v1alpha1]

architecture

字符串

主机的 CPU 架构，例如“x86_64”或“aarch64”。如果未设置，最终将通过检查填充。

automatedCleaningMode

字符串

设置为 disabled 时，将在配置和取消配置期间避免自动清理。

bmc

对象

我们如何连接到 BMC？

bootMACAddress

字符串

哪个 MAC 地址将进行 PXE 启动？对于某些类型来说，这是可选的，但对于由 vbmc 驱动的 libvirt 虚拟机来说是必需的。

bootMode

字符串

选择启动期间初始化硬件的方法。默认为 UEFI。

consumerRef

对象

ConsumerRef 可用于存储有关正在使用主机的某些信息。当它不为空时，主机被认为是“正在使用”。

customDeploy

对象

自定义部署过程。

description

字符串

Description 是用户输入的文本，用于帮助识别主机

externallyProvisioned

布尔值

ExternallyProvisioned 表示主机上运行的镜像由其他系统管理，操作员只需要管理电源状态和硬件清单检查。如果 Image 字段已填写，则忽略此字段。

firmware

对象

裸机服务器的 BIOS 配置

hardwareProfile

字符串

此主机的硬件配置文件名称是什么？硬件配置文件已弃用，不应使用。请改用单独的字段 Architecture 和 RootDeviceHints。设置为“empty”以准备将来无需硬件配置文件的 API 版本。

image

对象

Image 包含要预配的镜像的详细信息。

metaData

对象

MetaData 包含对包含主机元数据（例如 meta_data.json）的 Secret 的引用，该元数据将传递给配置驱动器。

networkData

对象

NetworkData 包含对包含网络配置（例如 network_data.json 的内容）的 Secret 的引用，该配置将传递给配置驱动器。

online

布尔值

服务器应该在线吗？

preprovisioningNetworkDataName

字符串

PreprovisioningNetworkDataName 是本地命名空间中 Secret 的名称，其中包含要传递给预配镜像以及配置驱动器（除非通过指定 NetworkData 覆盖）的网络配置（例如 network_data.json 的内容）。

raid

对象

裸机服务器的 RAID 配置

rootDeviceHints

对象

提供有关如何为正在预配的镜像选择设备的指导。

taints

数组

Taints 是要应用于相应机器的完整权威污点列表。此列表将持续覆盖对机器所做的任何修改。

taints[]

对象

附加此污点的节点对任何不宽容此污点的 Pod 具有“影响”。

userData

对象

UserData 包含对包含要传递给主机（在其启动之前）的用户数据的 Secret 的引用。

address

字符串

Address 包含用于通过网络访问控制器的 URL。

credentialsName

字符串

包含 BMC 凭据的密钥名称（需要“username”和“password”密钥）。

disableCertificateVerification

布尔值

DisableCertificateVerification 在使用 HTTPS 连接到 BMC 时禁用服务器证书的验证。当服务器证书是自签名的时，需要此选项，但它不安全，因为它允许中间人拦截连接。

apiVersion

字符串

引用的 API 版本。

fieldPath

字符串

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

kind

字符串

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

name

字符串

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

namespace

字符串

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

resourceVersion

字符串

此引用的特定 resourceVersion（如有）。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

字符串

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

method

字符串

自定义部署方法名称。此名称特定于使用的部署 ramdisk。如果您没有自定义部署 ramdisk，则不应使用 CustomDeploy。

simultaneousMultithreadingEnabled

布尔值

允许单个物理处理器内核显示为多个逻辑处理器。支持以下选项：true，false。

sriovEnabled

布尔值

SR-IOV 支持使虚拟机管理程序能够创建 PCI-express 设备的虚拟实例，从而可能提高性能。支持以下选项：true，false。

virtualizationEnabled

布尔值

支持平台硬件的虚拟化。支持以下选项：true，false。

checksum

字符串

Checksum 是镜像的校验和。

checksumType

字符串

ChecksumType 是镜像的校验和算法，例如 md5、sha256 或 sha512。特殊值“auto”可用于从校验和检测算法。如果缺失，则使用 MD5。如有疑问，请使用“auto”。

format

字符串

DiskFormat 包含镜像的格式（raw、qcow2 等）。对于原始镜像流，需要设置为 raw。注意，live-iso 表示 url 引用的 iso 将被实时启动，而不是部署到磁盘，在这种情况下，校验和选项不是必需的，如果指定将被忽略。

url

字符串

URL 是要部署的镜像的位置。

name

字符串

name 在命名空间内唯一，用于引用 secret 资源。

namespace

字符串

namespace 定义 secret 名称必须唯一的空间。

name

字符串

name 在命名空间内唯一，用于引用 secret 资源。

namespace

字符串

namespace 定义 secret 名称必须唯一的空间。

hardwareRAIDVolumes

``

硬件 RAID 的逻辑磁盘列表，如果未使用 rootDeviceHints，则第一个卷是根卷。您可以将此字段的值设置为[]以清除所有硬件 RAID 配置。

softwareRAIDVolumes

``

软件 RAID 的逻辑磁盘列表，如果未使用 rootDeviceHints，则第一个卷是根卷。如果设置了 HardwareRAIDVolumes，则此项无效。创建的软件 RAID 设备的数量必须为 1 或 2。如果只有一个软件 RAID 设备，则它必须是 RAID-1。如果有两个，则第一个必须是 RAID-1，而第二个的 RAID 级别可以是 0、1 或 1+0。由于第一个 RAID 设备将是部署设备，因此强制使用 RAID-1 可以降低在磁盘故障情况下最终导致节点无法启动的风险。软件 RAID 将始终被删除。

deviceName

字符串

类似“/dev/vda”的Linux设备名称，或其类似“/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0”的按路径链接。提示必须与实际值完全匹配。

hctl

字符串

SCSI总线地址，例如0:0:0:0。提示必须与实际值完全匹配。

minSizeGigabytes

整数

设备的最小大小（以GB为单位）。

model

字符串

厂商特定的设备标识符。提示可以是实际值的子字符串。

rotational

布尔值

如果设备应使用旋转介质，则为True；否则为False。

serialNumber

字符串

设备序列号。提示必须与实际值完全匹配。

vendor

字符串

设备的厂商或制造商名称。提示可以是实际值的子字符串。

wwn

字符串

唯一的存储标识符。提示必须与实际值完全匹配。

wwnVendorExtension

字符串

唯一的厂商存储标识符。提示必须与实际值完全匹配。

wwnWithExtension

字符串

带有厂商扩展名附加的唯一存储标识符。提示必须与实际值完全匹配。

effect

字符串

必需。污点对不耐受该污点的Pod的影响。有效的effect包括NoSchedule、PreferNoSchedule和NoExecute。

key

字符串

必需。要应用于节点的污点键。

timeAdded

字符串

timeAdded表示添加污点的时间。仅为NoExecute污点写入。

value

字符串

与污点键对应的污点值。

name

字符串

name 在命名空间内唯一，用于引用 secret 资源。

namespace

字符串

namespace 定义 secret 名称必须唯一的空间。

errorCount

整数

ErrorCount记录自上次成功操作以来主机遇到错误的次数。

errorMessage

字符串

配置子系统报告的最后一条错误消息。

errorType

字符串

当OperationalStatus为OperationalStatusError时，ErrorType指示遇到的故障类型。

goodCredentials

对象

我们最后能够验证有效的凭据。

hardware

对象

在主机上发现存在的硬件。

hardwareProfile

字符串

与硬件详细信息匹配的配置文件名称。

lastUpdated

字符串

LastUpdated标识最后一次观察到此状态的时间。

operationHistory

对象

OperationHistory保存有关在此主机上执行的操作的信息。

operationalStatus

字符串

OperationalStatus保存主机的状态。

poweredOn

布尔值

主机是否已启动的指示器。

provisioning

对象

配置程序跟踪的信息。

triedCredentials

对象

我们发送给配置后端的最后凭据。

credentials

对象

SecretReference表示Secret引用。它包含足够的信息来检索任何命名空间中的secret。

credentialsVersion

字符串

name

字符串

name 在命名空间内唯一，用于引用 secret 资源。

namespace

字符串

namespace 定义 secret 名称必须唯一的空间。

cpu

对象

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

firmware

对象

Firmware描述主机上的固件。

hostname

字符串

nics

数组

nics[]

对象

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

ramMebibytes

整数

storage

数组

storage[]

对象

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

systemVendor

对象

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

arch

字符串

clockMegahertz

number

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

count

整数

flags

数组 (字符串)

model

字符串

bios

对象

此固件的BIOS。

date

字符串

此BIOS的发布/构建日期。

vendor

字符串

此BIOS的厂商名称。

version

字符串

BIOS的版本。

ip

字符串

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

mac

字符串

设备MAC地址。

model

字符串

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

name

字符串

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

pxe

布尔值

NIC是否支持PXE启动。

speedGbps

整数

设备的速度（以千兆位/秒为单位）。

vlanId

整数

未标记的VLAN ID。

vlans

数组

可用的VLAN。

vlans[]

对象

VLAN表示VLAN的名称和ID。

id

整数

VLANID是12位802.1Q VLAN标识符。

name

字符串

alternateNames

数组 (字符串)

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

hctl

字符串

设备的SCSI位置。

model

字符串

硬件型号。

name

字符串

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

rotational

布尔值

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

serialNumber

字符串

设备的序列号。

sizeBytes

整数

磁盘的大小（以字节为单位）。

type

字符串

设备类型，其中之一：HDD、SSD、NVME。

vendor

字符串

设备厂商的名称。

wwn

字符串

设备的WWN。

wwnVendorExtension

字符串

设备的WWN厂商扩展名。

wwnWithExtension

字符串

带有扩展名的WWN。

manufacturer

字符串

productName

字符串

serialNumber

字符串

deprovision

对象

OperationMetric包含有关操作（检查、配置等）的元数据，用于跟踪指标。

inspect

对象

OperationMetric包含有关操作（检查、配置等）的元数据，用于跟踪指标。

provision

对象

OperationMetric包含有关操作（检查、配置等）的元数据，用于跟踪指标。

register

对象

OperationMetric包含有关操作（检查、配置等）的元数据，用于跟踪指标。

end

``

start

``

end

``

start

``

end

``

start

``

end

``

start

``

ID

字符串

来自底层配置工具的机器UUID。

bootMode

字符串

BootMode指示用于配置节点的启动模式。

customDeploy

对象

应用于主机的自定义部署过程。

firmware

对象

用户设置的BIOS。

image

对象

Image保存成功配置到主机的最后一个映像的详细信息。

raid

对象

用户设置的RAID。

rootDeviceHints

对象

用户设置的RootDeviceHints。

state

字符串

配置程序对主机所做操作的指示器。

method

字符串

自定义部署方法名称。此名称特定于使用的部署 ramdisk。如果您没有自定义部署 ramdisk，则不应使用 CustomDeploy。

simultaneousMultithreadingEnabled

布尔值

允许单个物理处理器内核显示为多个逻辑处理器。支持以下选项：true，false。

sriovEnabled

布尔值

SR-IOV 支持使虚拟机管理程序能够创建 PCI-express 设备的虚拟实例，从而可能提高性能。支持以下选项：true，false。

virtualizationEnabled

布尔值

支持平台硬件的虚拟化。支持以下选项：true，false。

checksum

字符串

Checksum 是镜像的校验和。

checksumType

字符串

ChecksumType 是镜像的校验和算法，例如 md5、sha256 或 sha512。特殊值“auto”可用于从校验和检测算法。如果缺失，则使用 MD5。如有疑问，请使用“auto”。

format

字符串

DiskFormat 包含镜像的格式（raw、qcow2 等）。对于原始镜像流，需要设置为 raw。注意，live-iso 表示 url 引用的 iso 将被实时启动，而不是部署到磁盘，在这种情况下，校验和选项不是必需的，如果指定将被忽略。

url

字符串

URL 是要部署的镜像的位置。

hardwareRAIDVolumes

``

硬件 RAID 的逻辑磁盘列表，如果未使用 rootDeviceHints，则第一个卷是根卷。您可以将此字段的值设置为[]以清除所有硬件 RAID 配置。

softwareRAIDVolumes

``

软件 RAID 的逻辑磁盘列表，如果未使用 rootDeviceHints，则第一个卷是根卷。如果设置了 HardwareRAIDVolumes，则此项无效。创建的软件 RAID 设备的数量必须为 1 或 2。如果只有一个软件 RAID 设备，则它必须是 RAID-1。如果有两个，则第一个必须是 RAID-1，而第二个的 RAID 级别可以是 0、1 或 1+0。由于第一个 RAID 设备将是部署设备，因此强制使用 RAID-1 可以降低在磁盘故障情况下最终导致节点无法启动的风险。软件 RAID 将始终被删除。

deviceName

字符串

类似“/dev/vda”的Linux设备名称，或其类似“/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0”的按路径链接。提示必须与实际值完全匹配。

hctl

字符串

SCSI总线地址，例如0:0:0:0。提示必须与实际值完全匹配。

minSizeGigabytes

整数

设备的最小大小（以GB为单位）。

model

字符串

厂商特定的设备标识符。提示可以是实际值的子字符串。

rotational

布尔值

如果设备应使用旋转介质，则为True；否则为False。

serialNumber

字符串

设备序列号。提示必须与实际值完全匹配。

vendor

字符串

设备的厂商或制造商名称。提示可以是实际值的子字符串。

wwn

字符串

唯一的存储标识符。提示必须与实际值完全匹配。

wwnVendorExtension

字符串

唯一的厂商存储标识符。提示必须与实际值完全匹配。

wwnWithExtension

字符串

带有厂商扩展名附加的唯一存储标识符。提示必须与实际值完全匹配。

credentials

对象

SecretReference表示Secret引用。它包含足够的信息来检索任何命名空间中的secret。

credentialsVersion

字符串

name

字符串

name 在命名空间内唯一，用于引用 secret 资源。

namespace

字符串

namespace 定义 secret 名称必须唯一的空间。

200 - OK

BareMetalHostList 模式

401 - 未授权

空

200 - OK

Status 模式

401 - 未授权

空

200 - OK

BareMetalHostList 模式

401 - 未授权

空

dryRun

字符串

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

fieldValidation

字符串

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

body

BareMetalHost 模式

200 - OK

BareMetalHost 模式

201 - 已创建

BareMetalHost 模式

202 - 已接受

BareMetalHost 模式

401 - 未授权

空

name

字符串

BareMetalHost 的名称

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空

200 - OK

BareMetalHost 模式

401 - 未授权

空

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

BareMetalHost 模式

401 - 未授权

空

dryRun

字符串

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

fieldValidation

字符串

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

body

BareMetalHost 模式

200 - OK

BareMetalHost 模式

201 - 已创建

BareMetalHost 模式

401 - 未授权

空

name

字符串

BareMetalHost 的名称

200 - OK

BareMetalHost 模式

401 - 未授权

空

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

BareMetalHost 模式

401 - 未授权

空

dryRun

字符串

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

fieldValidation

字符串

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

body

BareMetalHost 模式

200 - OK

BareMetalHost 模式

201 - 已创建

BareMetalHost 模式

401 - 未授权

空