第 3 章 BareMetalHost [metal3.io/v1alpha1]

架构

string

主机的 CPU 架构，如 "x86_64" 或 "aarch64"。如果未设置，则最终由检查填充。

automatedCleaningMode

string

当设置为 disabled 时，会在置备和取消置备过程中跳过自动清理。

bmc

object

如何连接到主机上的 BMC （基板管理控制器）？

bootMACAddress

string

用于置备主机的 NIC 的 MAC 地址。如果是网络引导，这是 PXE 启动接口的 MAC 地址。不得在此处使用 BMC 的 MAC 地址！

bootMode

字符串

选择在引导过程中初始化硬件的方法。默认为 UEFI。旧引导应该只用于不支持 UEFI 的硬件。设置为 UEFISecureBoot，以在置备后自动打开安全引导。

consumerRef

对象

consumerRef 可用于存储使用主机的内容的信息。如果主机不为空，则主机被视为"使用"。当主机被 Cluster API 使用时，常见的用例是 Machine 资源的链接。

customDeploy

对象

自定义部署流程。这是一个高级功能，允许使用由站点特定部署 ramdisk 提供的自定义部署步骤。大多数用户都将改用"镜像"。设置此字段会触发置备。

description

string

description 是人类可读的文本，用于帮助识别主机。

disablePowerOff

布尔值

当设置为 true 时，将禁用关闭节点电源，而是使用重新引导来代替电源/关闭

externallyProvisioned

布尔值

externallyProvisioned 意味着其他置备了主机上运行的镜像，Operator 应该仅管理电源状态。此字段用于与已置备的主机集成，并在集群间修改主机时。如果不确定，请将此字段保留为 false。

firmware

object

裸机服务器的固件(BIOS)配置。如果设置，则在置备主机前应用请求的设置。只有一些厂商驱动程序支持此字段。另一种方法是使用 HostFirmwareSettings 资源，允许更改任意值并支持基于 Redfish 的通用驱动程序。

hardwareProfile

字符串

此主机的硬件配置文件的名称是什么？硬件配置集已弃用，不应使用。改为使用单独的字段 Architecture 和 RootDeviceHints。设置为"空"，以在没有硬件配置集的情况下为 API 的未来版本做准备。

image

对象

image 包含要调配的镜像的详细信息。填充镜像将导致主机开始调配。

metaData

object

元数据包含对包含传递给 Config Drive 的主机元数据的 Secret 的引用。默认情况下，会为主机生成元数据，因此大多数用户都不需要设置此字段。

networkData

object

networkData 包含对包含网络配置的 Secret 的引用，该配置传递给 Config Drive，并由第一个引导软件（如 cloud-init）进行解释。

online

布尔值

主机是否应开机？如果主机当前处于稳定状态（如 provisioned），则强制其电源状态与这个值匹配。

preprovisioningNetworkDataName

string

preprovisioningNetworkDataName 是本地命名空间中的 Secret 名称，其中包含网络配置，该配置被传递给预置备镜像，如果未指定 NetworkData，则映射到 Config Drive。

raid

object

裸机服务器的 RAID 配置。如果设置，则在置备主机前应用 RAID 设置。如果没有，则不会修改当前的设置。可以同时设置其中一个子字段 hardwareRAIDVolumes 和 softwareRAIDVolumes。

rootDeviceHints

对象

提供有关如何为所调配镜像选择设备的说明。默认值是使用 /dev/sda 作为 root 设备。

污点

array

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

taints[]

对象

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

userData

object

userData 包含对包含用户数据的 Secret 的引用，这些数据被传递给 Config Drive，并由 cloud-init 等首次启动软件进行解释。用户数据的格式特定于第一次引导软件。

address

字符串

address 包含用于访问网络上控制器的 URL。方案部分指定要与主机一起使用的驱动程序。

credentialsName

字符串

包含 BMC 凭证的 secret 名称（需要密钥 "username" 和 "password"）。

disableCertificateVerification

布尔值

disableCertificateVerification 在使用 HTTPS 连接到 BMC 时禁用服务器证书验证。当服务器证书是自签名的但不安全时，这是必需的，因为它允许 man-in-the-middle 截获连接。

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.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

method

字符串

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

simultaneousMultithreadingEnabled

布尔值

允许单个物理处理器内核显示为多个逻辑处理器。

sriovEnabled

布尔值

SR-IOV 支持可让虚拟机监控程序创建 PCI-express 设备的虚拟实例，这可能会提高性能。

virtualizationEnabled

布尔值

支持平台硬件的虚拟化。

checksum

字符串

checksum 是镜像的 checksum。除 "live-iso" 以外的所有格式都需要。

checksumType

string

checksumType 是镜像的校验和算法，如 md5、sha256 或 sha512。特殊值 "auto" 可以用来检测校验和中的算法。如果缺少，则使用 MD5。如果不确定，请使用 "auto"。

格式

string

格式包含镜像的格式(raw, qcow2, …​)。当设置为 "live-iso" 时，由 url 引用的 ISO 9660 镜像将会被实时引导，而不是部署到磁盘。

url

字符串

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

name

string

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

namespace

string

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

name

string

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

namespace

string

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

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 将始终被删除。

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 必须与实际值完全匹配。

effect

字符串

必需。污点对不容许该污点的 pod 的影响。有效效果为 NoSchedule、PreferNoSchedule 和 NoExecute。

key

字符串

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

timeAdded

字符串

TimeAdded 代表添加污点的时间。它仅针对 NoExecute 污点编写。

value

字符串

与污点键对应的污点值。

name

string

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

namespace

string

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

errorCount

整数

ErrorCount 记录主机在上一次成功操作后出现错误的次数

errorMessage

string

provisioning 子系统报告的最后一个错误消息。

errorType

字符串

ErrorType 表示在 OperationalStatus 是 OperationalStatus 是 OperationalStatusError 时遇到的故障类型

goodCredentials

object

我们能够验证为工作的最后一个凭证。

硬件

对象

主机上存在发现的硬件。此字段将在单独 HardwareData 资源的下一个 API 版本中删除。

hardwareProfile

字符串

与硬件详情匹配的配置集的名称。硬件配置集已弃用，不应依赖于。

lastUpdated

字符串

lastUpdated 标识此状态最后观察到的时间。

operationHistory

对象

operationHistory 包含有关在此主机上执行的操作的信息。

operationalStatus

字符串

OperationalStatus 保存主机的状态

poweredOn

布尔值

主机当前检测到的电源状态。在置备进程运行时，此字段可能会短暂地与硬件的实际状态同步。

provisioning

对象

置备程序跟踪的信息。

triedCredentials

object

我们发送到置备后端的最后一个凭证。

credentials

对象

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

credentialsVersion

字符串

name

string

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

namespace

string

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

cpu

object

系统中 CPU 的详情。

firmware

object

系统固件信息。

hostname

字符串

NIC

数组

主机的网络接口列表。

nics[]

对象

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

ramMebibytes

整数

主机的内存量（以兆字节为单位）。

storage

数组

主机可用的存储（磁盘、SSD 等）列表。

storage[]

对象

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

systemVendor

object

系统厂商信息。

arch

字符串

clockMegahertz

number

ClockSpeed 是 MHz 中的时钟速度

数量

整数

标记

数组（字符串）

model

字符串

BIOS

对象

此固件的 BIOS

date

字符串

此 BIOS 的发行版本/构建日期

vendor

字符串

此 BIOS 的供应商名称

version

字符串

BIOS 的版本

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。

id

整数

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

name

字符串

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

制造商

字符串

productName

字符串

serialNumber

字符串

取消置备

对象

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

inspect

对象

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

置备

对象

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

register

对象

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

end

``

start

``

end

``

start

``

end

``

start

``

end

``

start

``

ID

string

来自底层调配工具（如 Ironic 节点 UUID）的主机 ID。

bootMode

string

bootMode 表示用于置备主机的引导模式。

customDeploy

对象

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

firmware

object

已应用的固件设置。

image

对象

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

raid

object

已应用的 RAID 配置。

rootDeviceHints

object

用于置备主机的 root 设备提示。

state

string

指示置备程序使用主机执行的操作。

method

字符串

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

simultaneousMultithreadingEnabled

布尔值

允许单个物理处理器内核显示为多个逻辑处理器。

sriovEnabled

布尔值

SR-IOV 支持可让虚拟机监控程序创建 PCI-express 设备的虚拟实例，这可能会提高性能。

virtualizationEnabled

布尔值

支持平台硬件的虚拟化。

checksum

字符串

checksum 是镜像的 checksum。除 "live-iso" 以外的所有格式都需要。

checksumType

string

checksumType 是镜像的校验和算法，如 md5、sha256 或 sha512。特殊值 "auto" 可以用来检测校验和中的算法。如果缺少，则使用 MD5。如果不确定，请使用 "auto"。

格式

string

格式包含镜像的格式(raw, qcow2, …​)。当设置为 "live-iso" 时，由 url 引用的 ISO 9660 镜像将会被实时引导，而不是部署到磁盘。

url

字符串

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

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 将始终被删除。

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 必须与实际值完全匹配。

credentials

对象

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

credentialsVersion

字符串

name

string

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

namespace

string

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