22.2. BareMetalHost [metal3.io/v1alpha1]
- 描述
- BareMetalHost 是 baremetalhosts API 的 Schema
- 类型
-
对象
22.2.1. 规格 复制链接链接已复制到粘贴板!
属性 | 类型 | 描述 |
---|---|---|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| BareMetalHostSpec 定义 BareMetalHost 的所需状态 |
|
| BareMetalHostStatus 定义 BareMetalHost 的观察状态 |
22.2.1.1. .spec 复制链接链接已复制到粘贴板!
- 描述
- BareMetalHostSpec 定义 BareMetalHost 的所需状态
- 类型
-
对象
- 必填
-
online
-
属性 | 类型 | 描述 |
---|---|---|
|
| 当设置为 disabled 时,会在置备和取消置备过程中避免自动清理。 |
|
| 如何连接到 BMC? |
|
| 哪个 MAC 地址将 PXE 引导?对于某些类型来说,这是可选的,但 libvirt 虚拟机需要 vbmc 驱动。 |
|
| 选择在启动过程中初始化硬件的方法。默认为 UEFI。 |
|
| consumerRef 可用于存储有关使用主机的内容的信息。如果它不为空,则主机被视为"使用"。 |
|
| 自定义部署流程。 |
|
| description 是一个人工输入的文本,用于帮助识别主机 |
|
| externallyProvisioned 意味着其他管理主机上运行的镜像,Operator 应该只管理电源状态和硬件清单检查。如果填写了 Image 字段,则忽略此字段。 |
|
| 裸机服务器的 BIOS 配置 |
|
| 此主机的硬件配置文件的名称是什么?只有在检查无法自动决定配置集时,才需要设置此设置。 |
|
| image 包含要置备的镜像的详细信息。 |
|
| 元数据包含对包含主机元数据的 Secret 的引用(如 meta_data.json 传递至 Config Drive)。 |
|
| networkData 包含对包含网络配置的 Secret 的引用(如 network_data.json 的内容,后者传递到 Config Drive)。 |
|
| 服务器是否应该在线? |
|
| 裸机服务器的 RAID 配置 |
|
| 提供有关如何为要置备的镜像选择设备的指导。 |
|
| taint 是应用到相应机器的完整、权威的污点列表。此列表将永久覆盖对机器所做的任何修改。 |
|
| 此污点的节点附加到不容许 Taint 的 pod 上具有 "effect" 的节点。 |
|
| userData 包含对包含要传递给主机的用户数据的 Secret 的引用,然后再引导。 |
22.2.1.2. .spec.bmc 复制链接链接已复制到粘贴板!
- 描述
- 如何连接到 BMC?
- 类型
-
对象
- 必填
-
address
-
credentialsName
-
属性 | 类型 | 描述 |
---|---|---|
|
| address 包含用于访问网络上的控制器的 URL。 |
|
| 包含 BMC 凭证的 secret 名称(需要键 "username" 和 "password")。 |
|
| disableCertificateVerification 在使用 HTTPS 连接到 BMC 时禁用服务器证书验证。当服务器证书是自签名但不安全时是必需的,因为它允许中间人截获连接。 |
22.2.1.3. .spec.consumerRef 复制链接链接已复制到粘贴板!
- 描述
- consumerRef 可用于存储有关使用主机的内容的信息。如果它不为空,则主机被视为"使用"。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 引用的 API 版本。 |
|
| 如果引用的是对象的一部分而非整个对象,则该字符串应包含有效的 JSON/Go 字段访问声明,如 desiredState.manifest.containers[2]。例如,如果对象引用是一个 pod 中的容器,它应该还以下类似: "spec.containers{name}"(其中 "name" 是指触发事件的容器的名称),如果不使用容器名称,则应类似于 "spec.containers[2]"(使用此 pod 中索引值为 2 的容器)。选择这个语法的原因是,为了有一些指向对象部分的正确定义方法。Todo: 这个设计不是最终设计的,且该字段在将来会有所改变。 |
|
| 引用的类型。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 引用的命名空间。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| 指定构成这个引用的 resourceVersion(如果存在)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 引用的 UID。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
22.2.1.4. .spec.customDeploy 复制链接链接已复制到粘贴板!
- 描述
- 自定义部署流程。
- 类型
-
对象
- 必填
-
method
-
属性 | 类型 | 描述 |
---|---|---|
|
| 自定义部署方法名称。此名称特定于使用的 deploy ramdisk。如果您没有自定义部署 ramdisk,则不应使用自定义Deploy。 |
22.2.1.5. .spec.firmware 复制链接链接已复制到粘贴板!
- 描述
- 裸机服务器的 BIOS 配置
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 允许单个物理处理器内核显示为多个逻辑处理器。这支持以下选项: true、false。 |
|
| SR-IOV 支持可让虚拟机监控程序创建 PCI-express 设备的虚拟实例,这可能会提高性能。这支持以下选项: true、false。 |
|
| 支持平台硬件的虚拟化。这支持以下选项: true、false。 |
22.2.1.6. .spec.image 复制链接链接已复制到粘贴板!
- 描述
- image 包含要置备的镜像的详细信息。
- 类型
-
对象
- 必填
-
url
-
属性 | 类型 | 描述 |
---|---|---|
|
| checksum 是镜像的校验和。 |
|
| checksumType 是镜像的校验和算法。例如 md5、sha256、sha512 |
|
| DiskFormat 包含镜像的格式(raw, qcow2, …)。对于原始镜像流,需要将 raw 设置为 raw。注意 live-iso 表示 url 引用的 iso 将启动且未部署到磁盘,在这种情况下,不需要 checksum 选项,如果指定,将被忽略。 |
|
| URL 是要部署的镜像的位置。 |
22.2.1.7. .spec.metaData 复制链接链接已复制到粘贴板!
- 描述
- 元数据包含对包含主机元数据的 Secret 的引用(如 meta_data.json 传递至 Config Drive)。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
22.2.1.8. .spec.networkData 复制链接链接已复制到粘贴板!
- 描述
- networkData 包含对包含网络配置的 Secret 的引用(如 network_data.json 的内容,后者传递到 Config Drive)。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
22.2.1.9. .spec.raid 复制链接链接已复制到粘贴板!
- 描述
- 裸机服务器的 RAID 配置
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
| `` |
硬件 RAID 的逻辑磁盘列表(如果没有使用 rootDeviceHints),第一个卷是 root 卷。您可以将此字段的值设置为 |
| `` | 软件 RAID 的逻辑磁盘列表(如果没有使用 rootDeviceHints),第一个卷是 root 卷。如果设置了 HardwareRAIDVolumes,则此项目将无效。创建的软件 RAID 设备的数量必须是 1 或 2。如果只有一个软件 RAID 设备,它必须是 RAID-1。如果有两个,则第一个必须是 RAID-1,第二个 RAID 级别为 0、1 或 1+0。因为第一个 RAID 设备将是部署设备,因此强制 RAID-1 降低了在磁盘失败时以非引导节点结束的风险。软件 RAID 将始终被删除。 |
22.2.1.10. .spec.rootDeviceHints 复制链接链接已复制到粘贴板!
- 描述
- 提供有关如何为要置备的镜像选择设备的指导。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| Linux 设备名称,如 "/dev/vda"。hint 必须与实际值完全匹配。 |
|
| SCSI 总线地址,如 0:0:0:0。hint 必须与实际值完全匹配。 |
|
| 设备的最小大小(以 Gigabytes 为单位)。 |
|
| 特定于供应商的设备标识符。hint 可以是实际值的子字符串。 |
|
| 如果设备应使用旋转介质,则为 true,否则为 false。 |
|
| 设备序列号。hint 必须与实际值完全匹配。 |
|
| 设备的厂商或制造商的名称。hint 可以是实际值的子字符串。 |
|
| 唯一的存储标识符。hint 必须与实际值完全匹配。 |
|
| 唯一的厂商存储标识符。hint 必须与实际值完全匹配。 |
|
| 附加厂商扩展的唯一存储标识符。hint 必须与实际值完全匹配。 |
22.2.1.11. .spec.taints 复制链接链接已复制到粘贴板!
- 描述
- taint 是应用到相应机器的完整、权威的污点列表。此列表将永久覆盖对机器所做的任何修改。
- 类型
-
array
22.2.1.12. .spec.taints[] 复制链接链接已复制到粘贴板!
- 描述
- 此污点的节点附加到不容许 Taint 的 pod 上具有 "effect" 的节点。
- 类型
-
对象
- 必填
-
effect
-
key
-
属性 | 类型 | 描述 |
---|---|---|
|
| 必需。污点对不容许污点的 pod 的影响。有效效果为 NoSchedule、PreferNoSchedule 和 NoExecute。 |
|
| 必需。要应用到节点的污点键。 |
|
| TimeAdded 代表添加污点的时间。它只适用于 NoExecute 污点。 |
|
| 与污点键对应的污点值。 |
22.2.1.13. .spec.userData 复制链接链接已复制到粘贴板!
- 描述
- userData 包含对包含要传递给主机的用户数据的 Secret 的引用,然后再引导。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
22.2.1.14. .status 复制链接链接已复制到粘贴板!
- 描述
- BareMetalHostStatus 定义 BareMetalHost 的观察状态
- 类型
-
对象
- 必填
-
errorCount
-
errorMessage
-
hardwareProfile
-
operationalStatus
-
poweredOn
-
provisioning
-
属性 | 类型 | 描述 |
---|---|---|
|
| ErrorCount 记录了主机自上次成功操作以来失败的次数 |
|
| provisioning 子系统报告的最后错误消息 |
|
| ErrorType 指示当 defineStatus 为\":\"StatusError 时遇到的故障类型 |
|
| 我们能够验证的最后一个凭证正常工作 |
|
| 主机上发现的硬件已存在。 |
|
| 与硬件详情匹配的配置集名称。 |
|
| lastUpdated 标识最后一次观察此状态的时间。 |
|
| operationHistory 包含有关此主机上执行的操作的信息。 |
|
| theStatus 包含主机的状态 |
|
| 是否开机主机的指示器 |
|
| 置备程序跟踪的信息。 |
|
| 我们发送到置备后端的最后凭证 |
22.2.1.15. .status.goodCredentials 复制链接链接已复制到粘贴板!
- 描述
- 我们能够验证的最后一个凭证正常工作
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret |
|
|
22.2.1.16. .status.goodCredentials.credentials 复制链接链接已复制到粘贴板!
- 描述
- secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
22.2.1.17. .status.hardware 复制链接链接已复制到粘贴板!
- 描述
- 主机上发现的硬件已存在。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| CPU 描述了主机上的一个处理器。 |
|
| 固件描述了主机上的固件。 |
|
| |
|
| |
|
| NIC 描述主机上的一个网络接口。 |
|
| |
|
| |
|
| Storage 描述了主机上的一个存储设备(磁盘、SSD 等)。 |
|
| HardwareSystemVendor 存储有关整个硬件系统的详细信息。 |
22.2.1.18. .status.hardware.cpu 复制链接链接已复制到粘贴板!
- 描述
- CPU 描述了主机上的一个处理器。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| |
|
| ClockSpeed 是 MHz 中的时钟速度 |
|
| |
|
| |
|
|
22.2.1.19. .status.hardware.firmware 复制链接链接已复制到粘贴板!
- 描述
- 固件描述了主机上的固件。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 这个固件的 BIOS |
22.2.1.20. .status.hardware.firmware.bios 复制链接链接已复制到粘贴板!
- 描述
- 这个固件的 BIOS
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 此 BIOS 的发行版本/构建日期 |
|
| 此 BIOS 的供应商名称 |
|
| BIOS 的版本 |
22.2.1.21. .status.hardware.nics 复制链接链接已复制到粘贴板!
- 描述
- 类型
-
array
22.2.1.22. .status.hardware.nics[] 复制链接链接已复制到粘贴板!
- 描述
- NIC 描述主机上的一个网络接口。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 接口的 IP 地址。如果存在 IPv4 或 IPv6 地址,这将是 IPv4 或 IPv6 地址。如果双栈环境中同时存在 IPv4 和 IPv6 地址,则会输出两个 nics,每个 IP 都有一个。 |
|
| 设备 MAC 地址 |
|
| NIC 的供应商和产品 ID,例如:"0x8086 0x1572" |
|
| 网络接口的名称,如 "en0" |
|
| NIC 是否 PXE 引导 |
|
| 设备的速度(以 Gigabits/秒为单位) |
|
| 未标记的 VLAN ID |
|
| 可用的 VLAN |
|
| vlan 代表 VLAN 的名称和 ID |
22.2.1.23. .status.hardware.nics[].vlans 复制链接链接已复制到粘贴板!
- 描述
- 可用的 VLAN
- 类型
-
array
22.2.1.24. .status.hardware.nics[].vlans[] 复制链接链接已复制到粘贴板!
- 描述
- vlan 代表 VLAN 的名称和 ID
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| VLANID 是一个 12 位 802.1Q VLAN 标识符 |
|
|
22.2.1.25. .status.hardware.storage 复制链接链接已复制到粘贴板!
- 描述
- 类型
-
array
22.2.1.26. .status.hardware.storage[] 复制链接链接已复制到粘贴板!
- 描述
- Storage 描述了主机上的一个存储设备(磁盘、SSD 等)。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 设备的 SCSI 位置 |
|
| 硬件模型 |
|
| 磁盘的 Linux 设备名称,例如 "/dev/sda"。请注意,这可能会在重启后不稳定。 |
|
| 此磁盘是否代表轮转存储。不建议使用此字段,首选使用 'Type' 字段,此字段最终将被弃用。 |
|
| 设备的序列号 |
|
| Bytes 中磁盘大小 |
|
| 设备类型,其中一个: HDD、SSD、NVME。 |
|
| 设备的厂商名称 |
|
| 设备的 WWN |
|
| 设备的 WWN 供应商扩展 |
|
| 带有扩展的 WWN |
22.2.1.27. .status.hardware.systemVendor 复制链接链接已复制到粘贴板!
- 描述
- HardwareSystemVendor 存储有关整个硬件系统的详细信息。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| |
|
| |
|
|
22.2.1.28. .status.operationHistory 复制链接链接已复制到粘贴板!
- 描述
- operationHistory 包含有关此主机上执行的操作的信息。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| OperationMetric 包含有关用于跟踪指标的操作(检查、置备等)的元数据。 |
|
| OperationMetric 包含有关用于跟踪指标的操作(检查、置备等)的元数据。 |
|
| OperationMetric 包含有关用于跟踪指标的操作(检查、置备等)的元数据。 |
|
| OperationMetric 包含有关用于跟踪指标的操作(检查、置备等)的元数据。 |
22.2.1.29. .status.operationHistory.deprovision 复制链接链接已复制到粘贴板!
- 描述
- OperationMetric 包含有关用于跟踪指标的操作(检查、置备等)的元数据。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
| `` | |
| `` |
22.2.1.30. .status.operationHistory.inspect 复制链接链接已复制到粘贴板!
- 描述
- OperationMetric 包含有关用于跟踪指标的操作(检查、置备等)的元数据。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
| `` | |
| `` |
22.2.1.31. .status.operationHistory.provision 复制链接链接已复制到粘贴板!
- 描述
- OperationMetric 包含有关用于跟踪指标的操作(检查、置备等)的元数据。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
| `` | |
| `` |
22.2.1.32. .status.operationHistory.register 复制链接链接已复制到粘贴板!
- 描述
- OperationMetric 包含有关用于跟踪指标的操作(检查、置备等)的元数据。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
| `` | |
| `` |
22.2.1.33. .status.provisioning 复制链接链接已复制到粘贴板!
- 描述
- 置备程序跟踪的信息。
- 类型
-
对象
- 必填
-
ID
-
state
-
属性 | 类型 | 描述 |
---|---|---|
|
| 底层调配工具的机器 UUID |
|
| bootMode 表示用于置备节点的引导模式 |
|
| 应用到主机的自定义部署过程。 |
|
| 用户设置的 Bios |
|
| 镜像包含成功部署到主机的最后一个镜像的详细信息。 |
|
| 用户设置的 Raid |
|
| 用户设置的 RootDevicehints |
|
| 一个用于置备程序处理主机的操作。 |
22.2.1.34. .status.provisioning.customDeploy 复制链接链接已复制到粘贴板!
- 描述
- 应用到主机的自定义部署过程。
- 类型
-
对象
- 必填
-
method
-
属性 | 类型 | 描述 |
---|---|---|
|
| 自定义部署方法名称。此名称特定于使用的 deploy ramdisk。如果您没有自定义部署 ramdisk,则不应使用自定义Deploy。 |
22.2.1.35. .status.provisioning.firmware 复制链接链接已复制到粘贴板!
- 描述
- 用户设置的 Bios
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 允许单个物理处理器内核显示为多个逻辑处理器。这支持以下选项: true、false。 |
|
| SR-IOV 支持可让虚拟机监控程序创建 PCI-express 设备的虚拟实例,这可能会提高性能。这支持以下选项: true、false。 |
|
| 支持平台硬件的虚拟化。这支持以下选项: true、false。 |
22.2.1.36. .status.provisioning.image 复制链接链接已复制到粘贴板!
- 描述
- 镜像包含成功部署到主机的最后一个镜像的详细信息。
- 类型
-
对象
- 必填
-
url
-
属性 | 类型 | 描述 |
---|---|---|
|
| checksum 是镜像的校验和。 |
|
| checksumType 是镜像的校验和算法。例如 md5、sha256、sha512 |
|
| DiskFormat 包含镜像的格式(raw, qcow2, …)。对于原始镜像流,需要将 raw 设置为 raw。注意 live-iso 表示 url 引用的 iso 将启动且未部署到磁盘,在这种情况下,不需要 checksum 选项,如果指定,将被忽略。 |
|
| URL 是要部署的镜像的位置。 |
22.2.1.37. .status.provisioning.raid 复制链接链接已复制到粘贴板!
- 描述
- 用户设置的 Raid
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
| `` |
硬件 RAID 的逻辑磁盘列表(如果没有使用 rootDeviceHints),第一个卷是 root 卷。您可以将此字段的值设置为 |
| `` | 软件 RAID 的逻辑磁盘列表(如果没有使用 rootDeviceHints),第一个卷是 root 卷。如果设置了 HardwareRAIDVolumes,则此项目将无效。创建的软件 RAID 设备的数量必须是 1 或 2。如果只有一个软件 RAID 设备,它必须是 RAID-1。如果有两个,则第一个必须是 RAID-1,第二个 RAID 级别为 0、1 或 1+0。因为第一个 RAID 设备将是部署设备,因此强制 RAID-1 降低了在磁盘失败时以非引导节点结束的风险。软件 RAID 将始终被删除。 |
22.2.1.38. .status.provisioning.rootDeviceHints 复制链接链接已复制到粘贴板!
- 描述
- 用户设置的 RootDevicehints
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| Linux 设备名称,如 "/dev/vda"。hint 必须与实际值完全匹配。 |
|
| SCSI 总线地址,如 0:0:0:0。hint 必须与实际值完全匹配。 |
|
| 设备的最小大小(以 Gigabytes 为单位)。 |
|
| 特定于供应商的设备标识符。hint 可以是实际值的子字符串。 |
|
| 如果设备应使用旋转介质,则为 true,否则为 false。 |
|
| 设备序列号。hint 必须与实际值完全匹配。 |
|
| 设备的厂商或制造商的名称。hint 可以是实际值的子字符串。 |
|
| 唯一的存储标识符。hint 必须与实际值完全匹配。 |
|
| 唯一的厂商存储标识符。hint 必须与实际值完全匹配。 |
|
| 附加厂商扩展的唯一存储标识符。hint 必须与实际值完全匹配。 |
22.2.1.39. .status.triedCredentials 复制链接链接已复制到粘贴板!
- 描述
- 我们发送到置备后端的最后凭证
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret |
|
|
22.2.1.40. .status.triedCredentials.credentials 复制链接链接已复制到粘贴板!
- 描述
- secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
22.2.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 的状态
-
22.2.2.1. /apis/metal3.io/v1alpha1/baremetalhosts 复制链接链接已复制到粘贴板!
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。 |
|
| 如果 'true',则输出被用户友善。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
- HTTP 方法
-
GET
- 描述
- 列出 BareMetalHost 类型的对象
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
参数 | 类型 | 描述 |
---|---|---|
|
| 对象名称和身份验证范围,如团队和项目 |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出被用户友善。 |
- HTTP 方法
-
DELETE
- 描述
- 删除 BareMetalHost 的集合
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
GET
- 描述
- 列出 BareMetalHost 类型的对象
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
POST
- 描述
- 创建 BareMetalHost
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空 |
参数 | 类型 | 描述 |
---|---|---|
|
| BareMetalHost 的名称 |
|
| 对象名称和身份验证范围,如团队和项目 |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出被用户友善。 |
- HTTP 方法
-
DELETE
- 描述
- 删除 BareMetalHost
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| 应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值是 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。 |
|
| 弃用:请使用 PropagationPolicy,此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false,"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置两者。 |
|
| 是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为: 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系; 'Foreground' - 一个删除前台所有依赖的级联策略。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
GET
- 描述
- 读取指定的 BareMetalHost
参数 | 类型 | 描述 |
---|---|---|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH
- 描述
- 部分更新指定的 BareMetalHost
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
PUT
- 描述
- 替换指定的 BareMetalHost
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空 |
参数 | 类型 | 描述 |
---|---|---|
|
| BareMetalHost 的名称 |
|
| 对象名称和身份验证范围,如团队和项目 |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出被用户友善。 |
- HTTP 方法
-
GET
- 描述
- 指定 BareMetalHost 的读取状态
参数 | 类型 | 描述 |
---|---|---|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH
- 描述
- 指定 BareMetalHost 的部分更新状态
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
PUT
- 描述
- 替换指定 BareMetalHost 的状态
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空 |