第3章 BareMetalHost [metal3.io/v1alpha1]

architecture

string

ホストの CPU アーキテクチャー (例: "x86_64" または "aarch64")。設定されていない場合は、最終的には検査によって設定されます。

automatedCleaningMode

string

無効に設定すると、プロビジョニングおよびプロビジョニング解除中に自動クリーニングがスキップされます。

bmc

object

ホスト上の BMC (Baseboard Management Controller) に接続する方法。

bootMACAddress

string

ホストのプロビジョニングに使用する NIC の MAC アドレス。ネットワークブートの場合、これは PXE ブートインターフェイスの MAC アドレスです。ここでは BMC の MAC アドレスは絶対に使用しないでください。

bootMode

string

起動時にハードウェアを初期化する方法を選択します。デフォルトは UEFI です。レガシーブートは、UEFI を正しくサポートしていないハードウェアにのみ使用してください。プロビジョニング後にセキュアブートを自動的にオンにするには、UEFISecureBoot に設定します。

consumerRef

object

consumerRef は、ホストを使用しているものに関する情報を格納するために使用できます。空でない場合、ホストは "使用中" と見なされます。一般的なユースケースは、Cluster API がホストを使用する場合における Machine リソースへのリンクです。

customDeploy

object

カスタムデプロイの手順。これは、サイト固有のデプロイメント ramdisk が提供するカスタムデプロイステップの使用を許可する高度な機能です。ほとんどのユーザーは、代わりに "image" を使用します。このフィールドを設定するとプロビジョニングがトリガーされます。

description

string

description は、ホストを識別するために使用される人間が入力したテキストです。

externallyProvisioned

boolean

externallyProvisioned は、ホスト上で実行されているイメージが他の何かによってプロビジョニングされており、Operator は電源ステータスのみを管理する必要があることを意味します。このフィールドは、すでにプロビジョニングされたホストとの統合や、クラスター間でのホストのピボットに使用されます。不明な場合は、このフィールドを false にしておきます。

firmware

object

ベアメタルサーバーのファームウェア (BIOS) 設定。設定されている場合、ホストがプロビジョニングされる前に要求された設定が適用されます。一部のベンダードライバーのみがこのフィールドをサポートしています。他にも、任意の値を変更でき、Redfish ベースの汎用ドライバーをサポートする HostFirmwareSettings リソースを使用する方法があります。

hardwareProfile

string

このホストのハードウェアプロファイルの名前は何ですか ?ハードウェアプロファイルは非推奨となったため、使用しないでください。代わりに、Architecture と RootDeviceHints という別々のフィールドを使用してください。ハードウェアプロファイルのない API の将来のバージョンに備えるには、"empty" に設定します。

image

object

image は、プロビジョニングされるイメージの詳細を保持します。イメージを入力すると、ホストはプロビジョニングを開始します。

metaData

object

metaData は、Config Drive に渡されるホストメタデータを含む Secret への参照を保持します。デフォルトでホストのメタデータが生成されるため、ほとんどのユーザーはこのフィールドを設定する必要はありません。

networkData

object

networkData は、ネットワーク設定を含む Secret への参照を保持します。これは、Config Drive に渡され、cloud-init などの最初のブートソフトウェアによって解釈されます。

online

boolean

ホストの電源をオンにする必要があるかどうか。ホストが現在安定した状態 (プロビジョニング済みなど) にある場合、その電源状態はこの値と一致するように強制されます。

preprovisioningNetworkDataName

string

preprovisioningNetworkDataName は、ネットワーク設定を含むローカル namespace 内の Secret の名前です。これは、preprovisioning イメージに渡され、networkData を指定してオーバーライドされていない場合は Config Drive にも渡されます。

raid

object

ベアメタルサーバーの RAID 設定。設定されている場合、ホストがプロビジョニングされる前に RAID 設定が適用されます。そうでない場合、現在の設定は変更されません。hardwareRAIDVolumes と softwareRAIDVolumes のいずれか 1 つのサブフィールドのみ同時に設定できます。

rootDeviceHints

object

プロビジョニングするイメージのデバイスを選択する方法に関するガイダンスを提供します。現在、デフォルトで /dev/sda がルートデバイスとして使用されます。

taints

array

taints は、対応するマシンに適用する taints の完全で信頼できるリストです。このリストは、継続的にマシンに加えられた変更を上書きします。

taints[]

object

この Taint が接続されているノードは、Taint を許容しない Pod に "影響を及ぼし" ます。

userData

object

UserData は、ユーザーデータを含む Secret への参照を保持します。これは、Config Drive に渡され、cloud-init など first-boot ソフトウェアによって解釈されます。ユーザーデータの形式は、first-boot ソフトウェアに固有の形式です。

address

string

address は、ネットワーク上のコントローラーにアクセスするための URL を保持します。スキーム部分は、ホストで使用するドライバーを指定します。

credentialsName

string

BMC クレデンシャルを含むシークレットの名前 (キー "username" および "password" が必要)。

disableCertificateVerification

boolean

disableCertificateVerification は、HTTPS を使用して BMC に接続するときに、サーバー証明書の検証を無効にします。これは、サーバー証明書が自己署名されている場合に必要ですが、中間者が接続を傍受できるため、安全ではありません。

apiVersion

string

参照先の API バージョン。

fieldPath

string

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。

kind

string

参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

method

string

カスタムデプロイメソッド名。この名前は、使用されるデプロイ RAM ディスクに固有です。カスタムデプロイ RAM ディスクがない場合は、CustomDeploy を使用しないでください。

simultaneousMultithreadingEnabled

boolean

単一の物理プロセッサーコアを複数の論理プロセッサーとして表示できるようにします。

sriovEnabled

boolean

SR-IOV のサポートにより、ハイパーバイザーは PCI-express デバイスの仮想インスタンスを作成することができ、潜在的に性能を向上させることができます。

virtualizationEnabled

boolean

プラットフォームハードウェアの仮想化をサポートします。

checksum

string

checksum はイメージのチェックサム。"live-iso" を除くすべての形式で必要です。

checksumType

string

checksumType は、イメージのチェックサムアルゴリズムです (例: md5、sha256 または sha512)。特別な値 "auto" を使用すると、チェックサムからアルゴリズムを検出できます。存在しない場合は、MD5 が使用されます。疑問がある場合は、"auto" を使用してください。

format

string

format には、イメージのフォーマット (raw、qcow2、…) が含まれています。"live-iso" に設定すると、URL によって参照される ISO 9660 イメージのライブブートが実行され、ディスクはデプロイされません。

url

string

url は、デプロイするイメージのロケーション。

name

string

name は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

name

string

name は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

hardwareRAIDVolumes

``

ハードウェア RAID の論理ディスクのリスト。rootDeviceHints が使用されていない場合、最初のボリュームはルートボリュームです。このフィールドの値を [] に設定して、すべてのハードウェア RAID 設定をクリアできます。

softwareRAIDVolumes

``

ソフトウェア RAID の論理ディスクのリスト。rootDeviceHints が使用されていない場合、最初のボリュームはルートボリュームです。HardwareRAIDVolumes が設定されている場合、この項目は無効になります。作成されるソフトウェア RAID デバイスの数は、1 または 2 である必要があります。ソフトウェア RAID デバイスが 1 つしかない場合は、RAID-1 である必要があります。2 つある場合、最初の 1 つは RAID-1 である必要があり、2 番目の RAID レベルは 0、1、または 1+0 にすることができます。最初の RAID デバイスがデプロイメントデバイスになるため、RAID-1 を適用すると、ディスク障害が発生した場合にホストが起動しない状態になるリスクが軽減されます。ソフトウェア RAID は常に削除されます。

deviceName

string

"/dev/vda" のような Linux デバイス名、またはこのデバイス名への "/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0" のようなバイパスリンク。ヒントは、実際の値と完全に一致する必要があります。

hctl

string

0:0:0:0 のような SCSI バスアドレス。ヒントは、実際の値と完全に一致する必要があります。

minSizeGigabytes

integer

デバイスの最小サイズ (ギガバイト単位)。

model

string

ベンダー固有のデバイス識別子。ヒントは、実際の値のサブ文字列になります。

rotational

boolean

デバイスが回転メディアを使用する必要がある場合は true、それ以外の場合は false。

serialNumber

string

デバイスのシリアル番号。ヒントは、実際の値と完全に一致する必要があります。

vendor

string

デバイスのベンダーまたはメーカーの名前。ヒントは、実際の値のサブ文字列になります。

wwn

string

一意のストレージ ID。ヒントは、実際の値と完全に一致する必要があります。

wwnVendorExtension

string

一意のベンダーストレージ ID。ヒントは、実際の値と完全に一致する必要があります。

wwnWithExtension

string

ベンダーエクステンションを追加した一意のストレージ ID。ヒントは、実際の値と完全に一致する必要があります。

effect

string

必須。テイントを許容しない Pod に対するテイントの影響。有効な効果は、NoSchedule、PreferNoSchedule、および NoExecute です。

key

string

必須。ノードに適用されるテイントキー。

timeAdded

string

timeAdded は、テイントが追加された時刻を表します。NoExecute テイントにのみ作成されます。

value

string

テイントキーに対応するテイント値。

name

string

name は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

errorCount

integer

errorCount は、最後に成功した操作以降にホストがエラーを発生させた回数を記録します。

errorMessage

string

プロビジョニングサブシステムによって報告された最後のエラーメッセージ。

errorType

string

errorType は、OperationalStatus が OperationalStatusError のときに発生した障害のタイプを示します。

goodCredentials

object

機能していることが検証できた最後のクレデンシャル。

ハードウェア

object

ホスト上に存在することが検出されたハードウェア。このフィールドは、別の HardwareData リソースが使用されるため、次の API バージョンで削除されます。

hardwareProfile

string

ハードウェアの詳細に一致するプロファイルの名前。ハードウェアプロファイルは非推奨であり、依存すべきではありません。

lastUpdated

string

lastUpdated は、このステータスが最後に観測された日時を識別します。

operationHistory

object

operationHistory は、このホストで実行された操作に関する情報を保持します。

operationalStatus

string

operationalStatus は、ホストのステータスを保持します。

poweredOn

boolean

現在検出されているホストの電源状態。プロビジョニングプロセスの実行中、このフィールドはハードウェアの実際の状態と一時的に同期しなくなる場合があります。

provisioning

object

プロビジョニング担当者が追跡する情報。

triedCredentials

object

プロビジョニングバックエンドに送信した最後のクレデンシャル。

credentials

object

SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。

credentialsVersion

string

name

string

name は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

cpu

object

システム内の CPU の詳細。

firmware

object

システムファームウェア情報。

hostname

string

nics

array

ホストのネットワークインターフェイスのリスト。

nics[]

object

nic は、ホスト上の 1 つのネットワークインターフェイスを記述します。

ramMebibytes

integer

ホストのメモリー容量 (メビバイト単位)。

storage

array

ホストで使用可能なストレージ (ディスク、SSD など) のリスト。

storage[]

object

storage は、ホスト上の 1 つのストレージデバイス (ディスク、SSD など) を表します。

systemVendor

object

システムベンダー情報。

arch

string

clockMegahertz

number

ClockSpeed は MHz 単位のクロック速度。

count

integer

flags

array (string)

model

string

bios

object

このファームウェアの BIOS

date

string

この BIOS のリリース/ビルド日

vendor

string

この BIOS のベンダー名

version

string

BIOS のバージョン

ip

string

インターフェイスの IP アドレス。存在する場合、これは IPv4 または IPv6 アドレスになります。IPv4 アドレスと IPv6 アドレスの両方がデュアルスタック環境に存在する場合、各 IP に 1 つずつ、合計 2 つの NIC が出力されます。

mac

string

デバイスの MAC アドレス

model

string

NIC のベンダー ID と製品 ID、例:"0x8086 0x1572"

name

string

ネットワークインターフェイスの名前 (例:"en0")

pxe

boolean

NIC が PXE ブータブルかどうか

speedGbps

integer

デバイスの速度 (ギガビット/秒)

vlanId

integer

タグなし VLAN ID

vlans

array

利用可能な VLAN

vlans[]

object

VLAN は、VLAN の名前と ID を表します。

id

integer

VLANID は、12 ビットの 802.1QVLAN 識別子です。

name

string

alternateNames

array (string)

ディスクの代替 Linux デバイス名のリスト (例: "/dev/sda")。このリストは包括的なものではなく、再起動すると名前が安定しない可能性があることに注意してください。

hctl

string

デバイスの SCSI ロケーション

model

string

ハードウェアモデル

name

string

ディスクの Linux デバイス名 (例: "/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0")。使用可能な場合は、再起動後も安定した名前になります。

rotational

boolean

このディスクが回転ストレージを表すかどうか。このフィールドの使用は推奨されていません。代わりに 'Type' フィールドを使用することを推奨します。このフィールドは最終的に非推奨になります。

serialNumber

string

デバイスのシリアル番号

sizeBytes

integer

ディスクのサイズ (バイト単位)

type

string

デバイスタイプ、HDD、SSD、NVME のいずれか。

vendor

string

デバイスのベンダーの名前

wwn

string

デバイスの WWN

wwnVendorExtension

string

デバイスの WWN ベンダー拡張

wwnWithExtension

string

拡張子が付いた WWN

manufacturer

string

productName

string

serialNumber

string

deprovision (プロビジョニング解除)

object

OperationMetric には、メトリクスの追跡に使用される操作 (検査、プロビジョニングなど) に関するメタデータが含まれています。

inspect

object

OperationMetric には、メトリクスの追跡に使用される操作 (検査、プロビジョニングなど) に関するメタデータが含まれています。

provision (プロビジョニング)

object

OperationMetric には、メトリクスの追跡に使用される操作 (検査、プロビジョニングなど) に関するメタデータが含まれています。

register

object

OperationMetric には、メトリクスの追跡に使用される操作 (検査、プロビジョニングなど) に関するメタデータが含まれています。

end

``

start

``

end

``

start

``

end

``

start

``

end

``

start

``

ID

string

基盤となるプロビジョニングツールからのホストの ID (例: Ironic ノード UUID)。

bootMode

string

bootMode は、ホストのプロビジョニングに使用されるブートモードを示します。

customDeploy

object

ホストに適用されるカスタムデプロイ手順。

firmware

object

適用されたファームウェア設定。

image

object

イメージは、ホストに正常にプロビジョニングされた最後のイメージの詳細を保持します。

raid

object

適用された RAID 設定。

rootDeviceHints

object

ホストのプロビジョニングに使用されるルートデバイスのヒント。

state

string

プロビジョナーがホストに対して何を実行しているかの指標。

method

string

カスタムデプロイメソッド名。この名前は、使用されるデプロイ RAM ディスクに固有です。カスタムデプロイ RAM ディスクがない場合は、CustomDeploy を使用しないでください。

simultaneousMultithreadingEnabled

boolean

単一の物理プロセッサーコアを複数の論理プロセッサーとして表示できるようにします。

sriovEnabled

boolean

SR-IOV のサポートにより、ハイパーバイザーは PCI-express デバイスの仮想インスタンスを作成することができ、潜在的に性能を向上させることができます。

virtualizationEnabled

boolean

プラットフォームハードウェアの仮想化をサポートします。

checksum

string

checksum はイメージのチェックサム。"live-iso" を除くすべての形式で必要です。

checksumType

string

checksumType は、イメージのチェックサムアルゴリズムです (例: md5、sha256 または sha512)。特別な値 "auto" を使用すると、チェックサムからアルゴリズムを検出できます。存在しない場合は、MD5 が使用されます。疑問がある場合は、"auto" を使用してください。

format

string

format には、イメージのフォーマット (raw、qcow2、…) が含まれています。"live-iso" に設定すると、URL によって参照される ISO 9660 イメージのライブブートが実行され、ディスクはデプロイされません。

url

string

url は、デプロイするイメージのロケーション。

hardwareRAIDVolumes

``

ハードウェア RAID の論理ディスクのリスト。rootDeviceHints が使用されていない場合、最初のボリュームはルートボリュームです。このフィールドの値を [] に設定して、すべてのハードウェア RAID 設定をクリアできます。

softwareRAIDVolumes

``

ソフトウェア RAID の論理ディスクのリスト。rootDeviceHints が使用されていない場合、最初のボリュームはルートボリュームです。HardwareRAIDVolumes が設定されている場合、この項目は無効になります。作成されるソフトウェア RAID デバイスの数は、1 または 2 である必要があります。ソフトウェア RAID デバイスが 1 つしかない場合は、RAID-1 である必要があります。2 つある場合、最初の 1 つは RAID-1 である必要があり、2 番目の RAID レベルは 0、1、または 1+0 にすることができます。最初の RAID デバイスがデプロイメントデバイスになるため、RAID-1 を適用すると、ディスク障害が発生した場合にホストが起動しない状態になるリスクが軽減されます。ソフトウェア RAID は常に削除されます。

deviceName

string

"/dev/vda" のような Linux デバイス名、またはこのデバイス名への "/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0" のようなバイパスリンク。ヒントは、実際の値と完全に一致する必要があります。

hctl

string

0:0:0:0 のような SCSI バスアドレス。ヒントは、実際の値と完全に一致する必要があります。

minSizeGigabytes

integer

デバイスの最小サイズ (ギガバイト単位)。

model

string

ベンダー固有のデバイス識別子。ヒントは、実際の値のサブ文字列になります。

rotational

boolean

デバイスが回転メディアを使用する必要がある場合は true、それ以外の場合は false。

serialNumber

string

デバイスのシリアル番号。ヒントは、実際の値と完全に一致する必要があります。

vendor

string

デバイスのベンダーまたはメーカーの名前。ヒントは、実際の値のサブ文字列になります。

wwn

string

一意のストレージ ID。ヒントは、実際の値と完全に一致する必要があります。

wwnVendorExtension

string

一意のベンダーストレージ ID。ヒントは、実際の値と完全に一致する必要があります。

wwnWithExtension

string

ベンダーエクステンションを追加した一意のストレージ ID。ヒントは、実際の値と完全に一致する必要があります。

credentials

object

SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。

credentialsVersion

string

name

string

name は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。