Provisioning API


OpenShift Container Platform 4.16

Provisioning API のリファレンスガイド

Red Hat OpenShift Documentation Team

概要

このドキュメントでは、OpenShift Container Platform の Provisioning API オブジェクトとその詳細な仕様を説明します。

第1章 Provisioning API

1.1. BMCEventSubscription [metal3.io/v1alpha1]

説明
BMCEventSubscription は高速イベント API のスキーマです
object

1.2. BareMetalHost [metal3.io/v1alpha1]

説明
BareMetalHost は、baremetalhosts API の Schema です。
object

1.3. DataImage [metal3.io/v1alpha1]

説明
DataImage は、dataimages API のスキーマです。
object

1.4. FirmwareSchema [metal3.io/v1alpha1]

説明
FirmwareSchema は、firmwareschemas API のスキーマです。
object

1.5. HardwareData [metal3.io/v1alpha1]

説明
HardwareData は、hardwaredata API のスキーマです。
object

1.6. HostFirmwareComponents [metal3.io/v1alpha1]

説明
HostFirmwareComponents は、hostfirmwarecomponents API のスキーマです。
object

1.7. HostFirmwareSettings [metal3.io/v1alpha1]

説明
HostFirmwareSettings は、hostfirmwaresettings API のスキーマです。
object

1.8. Metal3Remediation [infrastructure.cluster.x-k8s.io/v1beta1]

説明
Metal3Remediation は、metal3remediations API のスキーマです。
object

1.9. Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]

説明
Metal3RemediationTemplate は、metal3remediationtemplates API のスキーマです。
object

1.10. PreprovisioningImage [metal3.io/v1alpha1]

説明
PreprovisioningImage は、preprovisioningimages API のスキーマです。
object

1.11. Provisioning [metal3.io/v1alpha1]

説明
Provisioning には、Provisioning サービス (Ironic) がベアメタルホストをプロビジョニングするために使用する設定が含まれています。Provisioning は、プロビジョニングネットワークおよび PXE ブートに使用できるサーバー上の NIC に関する管理者またはユーザー提供の情報を使用して、OpenShift インストーラーによって作成されます。この CR はシングルトンであり、インストーラーによって作成され、現在、metal3 クラスター内のコンテナーを起動および更新するために cluster-baremetal-operator によってのみ使用されます。
object

第2章 BMCEventSubscription [metal3.io/v1alpha1]

説明
BMCEventSubscription は高速イベント API のスキーマです
object

2.1. 仕様

プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、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

object

 

status

object

 

2.1.1. .spec

説明
object
プロパティー説明

context

string

イベントの任意のユーザーが提供するコンテキスト。

destination

string

イベントを送信する Webhook URL。

hostName

string

BareMetalHost への参照。

httpHeadersRef

object

リクエストを行う際に Destination に渡す必要がある HTTP ヘッダーを含むシークレット。

2.1.2. .spec.httpHeadersRef

説明
リクエストを行う際に Destination に渡す必要がある HTTP ヘッダーを含むシークレット。
object
プロパティー説明

name

string

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

namespace

string

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

2.1.3. .status

説明
object
プロパティー説明

error

string

 

subscriptionID

string

 

2.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/metal3.io/v1alpha1/bmceventsubscriptions

    • GET: kind が BMCEventSubscription のオブジェクトをリスト表示します。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions

    • DELETE: BMCEventSubscription のコレクションを削除します。
    • GET: kind が BMCEventSubscription のオブジェクトをリスト表示します。
    • POST: BMCEventSubscription を作成します。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}

    • DELETE: BMCEventSubscription を削除します。
    • GET: 指定された BMCEventSubscription を読み取ります。
    • PATCH: 指定された BMCEventSubscription を部分的に更新します。
    • PUT: 指定された BMCEventSubscription を置き換えます。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}/status

    • GET: 指定された BMCEventSubscription のステータスを読み取ります。
    • PATCH: 指定された BMCEventSubscription のステータスを部分的に更新します。
    • PUT: 指定された BMCEventSubscription のステータスを置き換えます。

2.2.1. /apis/metal3.io/v1alpha1/bmceventsubscriptions

HTTP メソッド
GET
説明
kind が BMCEventSubscription のオブジェクトをリスト表示します。
表2.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

BMCEventSubscriptionList スキーマ

401 - Unauthorized

空白

2.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions

HTTP メソッド
DELETE
説明
BMCEventSubscription のコレクションを削除します。
表2.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が BMCEventSubscription のオブジェクトをリスト表示します。
表2.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

BMCEventSubscriptionList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
BMCEventSubscription を作成します。
表2.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表2.5 ボディーパラメーター
パラメーター説明

body

BMCEventSubscription スキーマ

 
表2.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

BMCEventSubscription スキーマ

201 - Created

BMCEventSubscription スキーマ

202 - Accepted

BMCEventSubscription スキーマ

401 - Unauthorized

空白

2.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}

表2.7 グローバルパスパラメーター
パラメーター説明

name

string

BMCEventSubscription の名前

HTTP メソッド
DELETE
説明
BMCEventSubscription を削除します。
表2.8 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表2.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された BMCEventSubscription を読み取ります。
表2.10 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

BMCEventSubscription スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された BMCEventSubscription を部分的に更新します。
表2.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表2.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

BMCEventSubscription スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された BMCEventSubscription を置き換えます。
表2.13 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表2.14 ボディーパラメーター
パラメーター説明

body

BMCEventSubscription スキーマ

 
表2.15 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

BMCEventSubscription スキーマ

201 - Created

BMCEventSubscription スキーマ

401 - Unauthorized

空白

2.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}/status

表2.16 グローバルパスパラメーター
パラメーター説明

name

string

BMCEventSubscription の名前

HTTP メソッド
GET
説明
指定された BMCEventSubscription のステータスを読み取ります。
表2.17 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

BMCEventSubscription スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された BMCEventSubscription のステータスを部分的に更新します。
表2.18 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表2.19 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

BMCEventSubscription スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された BMCEventSubscription のステータスを置き換えます。
表2.20 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表2.21 ボディーパラメーター
パラメーター説明

body

BMCEventSubscription スキーマ

 
表2.22 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

BMCEventSubscription スキーマ

201 - Created

BMCEventSubscription スキーマ

401 - Unauthorized

空白

第3章 BareMetalHost [metal3.io/v1alpha1]

説明
BareMetalHost は、baremetalhosts API の Schema です。
object

3.1. 仕様

プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、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

object

BareMetalHostSpec は、BareMetalHost の望ましい状態を定義します。

status

object

BareMetalHostStatus は、BareMetalHost の観測状態を定義します。

3.1.1. .spec

説明
BareMetalHostSpec は、BareMetalHost の望ましい状態を定義します。
object
必須
  • online
プロパティー説明

architecture

string

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

automatedCleaningMode

string

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

bmc

object

BMC に接続するにはどうすればよいですか?

bootMACAddress

string

PXE はどの MAC アドレスで起動しますか? これは一部のタイプではオプションですが、vbmc によって駆動される libvirt 仮想マシンでは必須です。

bootMode

string

起動時にハードウェアを初期化する方法を選択します。デフォルトは UEFI です。

consumerRef

object

consumerRef は、ホストを使用しているものに関する情報を格納するために使用できます。空でない場合、ホストは "使用中" と見なされます。

customDeploy

object

カスタムデプロイの手順。

description

string

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

externallyProvisioned

boolean

externallyProvisioned は、他の何かがホスト上で実行されているイメージを管理していることを意味し、Operator は電源ステータスとハードウェアインベントリー検査のみを管理する必要があります。Image フィールドに入力すると、このフィールドは無視されます。

firmware

object

ベアメタルサーバーの BIOS 設定

hardwareProfile

string

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

image

object

image は、プロビジョニングされるイメージの詳細を保持します。

metaData

object

metaData は、Config Drive に渡されるホストメタデータ (meta_data.json など) を含む Secret への参照を保持します。

networkData

object

networkData は、Config Drive に渡されるネットワーク設定 (network_data.json のコンテンツなど) を含む Secret への参照を保持します。

online

boolean

サーバーはオンラインである必要がありますか?

preprovisioningNetworkDataName

string

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

raid

object

ベアメタルサーバーの RAID 設定

rootDeviceHints

object

プロビジョニングするイメージのデバイスを選択する方法に関するガイダンスを提供します。

taints

array

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

taints[]

object

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

userData

object

userData は、ホストが起動する前にホストに渡されるユーザーデータを含むシークレットへの参照を保持します。

3.1.2. .spec.bmc

説明
BMC に接続するにはどうすればよいですか?
object
必須
  • address
  • credentialsName
プロパティー説明

address

string

address は、ネットワーク上のコントローラーにアクセスするための URL を保持します。

credentialsName

string

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

disableCertificateVerification

boolean

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

3.1.3. .spec.consumerRef

説明
consumerRef は、ホストを使用しているものに関する情報を格納するために使用できます。空でない場合、ホストは "使用中" と見なされます。
object
プロパティー説明

apiVersion

string

参照先の API バージョン。

fieldPath

string

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

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

3.1.4. .spec.customDeploy

説明
カスタムデプロイの手順。
object
必須
  • method
プロパティー説明

method

string

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

3.1.5. .spec.firmware

説明
ベアメタルサーバーの BIOS 設定
object
プロパティー説明

simultaneousMultithreadingEnabled

boolean

単一の物理プロセッサーコアを複数の論理プロセッサーとして表示できるようにします。これは、次のオプションをサポートします: true、false。

sriovEnabled

boolean

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

virtualizationEnabled

boolean

プラットフォームハードウェアの仮想化をサポートします。これは、次のオプションをサポートします: true、false。

3.1.6. .spec.image

説明
image は、プロビジョニングされるイメージの詳細を保持します。
object
必須
  • url
プロパティー説明

checksum

string

checksum はイメージのチェックサム。

checksumType

string

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

format

string

DiskFormat には、イメージのフォーマット (raw、qcow2、…) が含まれています。raw イメージをストリーミングするには、raw に設定する必要があります。live-iso は、URL によって参照される iso がライブブートされ、ディスクにデプロイされないことを意味します。この場合、チェックサムオプションは不要であり、指定されている場合は無視されます。

url

string

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

3.1.7. .spec.metaData

説明
metaData は、Config Drive に渡されるホストメタデータ (meta_data.json など) を含む Secret への参照を保持します。
object
プロパティー説明

name

string

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

namespace

string

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

3.1.8. .spec.networkData

説明
networkData は、Config Drive に渡されるネットワーク設定 (network_data.json のコンテンツなど) を含む Secret への参照を保持します。
object
プロパティー説明

name

string

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

namespace

string

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

3.1.9. .spec.raid

説明
ベアメタルサーバーの RAID 設定
object
プロパティー説明

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 は常に削除されます。

3.1.10. .spec.rootDeviceHints

説明
プロビジョニングするイメージのデバイスを選択する方法に関するガイダンスを提供します。
object
プロパティー説明

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。ヒントは、実際の値と完全に一致する必要があります。

3.1.11. .spec.taints

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

3.1.12. .spec.taints[]

説明
このテイントが接続されているノードは、テイントを許容しない Pod に "影響" を及ぼします。
object
必須
  • effect
  • key
プロパティー説明

effect

string

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

key

string

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

timeAdded

string

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

value

string

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

3.1.13. .spec.userData

説明
userData は、ホストが起動する前にホストに渡されるユーザーデータを含むシークレットへの参照を保持します。
object
プロパティー説明

name

string

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

namespace

string

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

3.1.14. .status

説明
BareMetalHostStatus は、BareMetalHost の観測状態を定義します。
object
必須
  • errorCount
  • errorMessage
  • hardwareProfile
  • operationalStatus
  • poweredOn
  • provisioning
プロパティー説明

errorCount

integer

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

errorMessage

string

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

errorType

string

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

goodCredentials

object

動作していると検証できた最後のクレデンシャル。

ハードウェア

object

ホスト上に存在することが検出されたハードウェア。

hardwareProfile

string

ハードウェアの詳細に一致するプロファイルの名前。

lastUpdated

string

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

operationHistory

object

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

operationalStatus

string

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

poweredOn

boolean

ホストの電源がオンになっているかどうかのインジケーター。

provisioning

object

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

triedCredentials

object

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

3.1.15. .status.goodCredentials

説明
動作していると検証できた最後のクレデンシャル。
object
プロパティー説明

credentials

object

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

credentialsVersion

string

 

3.1.16. .status.goodCredentials.credentials

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

name

string

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

namespace

string

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

3.1.17. .status.hardware

説明
ホスト上に存在することが検出されたハードウェア。
object
プロパティー説明

cpu

object

cpu は、ホスト上の 1 つのプロセッサーを表します。

firmware

object

firmware は、ホスト上のファームウェアを表します。

hostname

string

 

nics

array

 

nics[]

object

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

ramMebibytes

integer

 

storage

array

 

storage[]

object

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

systemVendor

object

HardwareSystemVendor は、ハードウェアシステム全体に関する詳細を格納します。

3.1.18. .status.hardware.cpu

説明
cpu は、ホスト上の 1 つのプロセッサーを表します。
object
プロパティー説明

arch

string

 

clockMegahertz

number

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

count

integer

 

flags

array (string)

 

model

string

 

3.1.19. .status.hardware.firmware

説明
firmware は、ホスト上のファームウェアを表します。
object
プロパティー説明

bios

object

このファームウェアの BIOS

3.1.20. .status.hardware.firmware.bios

説明
このファームウェアの BIOS
object
プロパティー説明

date

string

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

vendor

string

この BIOS のベンダー名

version

string

BIOS のバージョン

3.1.21. .status.hardware.nics

説明
array

3.1.22. .status.hardware.nics[]

説明
nic は、ホスト上の 1 つのネットワークインターフェイスを記述します。
object
プロパティー説明

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 を表します。

3.1.23. .status.hardware.nics[].vlans

説明
利用可能な VLAN
array

3.1.24. .status.hardware.nics[].vlans[]

説明
VLAN は、VLAN の名前と ID を表します。
object
プロパティー説明

id

integer

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

name

string

 

3.1.25. .status.hardware.storage

説明
array

3.1.26. .status.hardware.storage[]

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

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

3.1.27. .status.hardware.systemVendor

説明
HardwareSystemVendor は、ハードウェアシステム全体に関する詳細を格納します。
object
プロパティー説明

manufacturer

string

 

productName

string

 

serialNumber

string

 

3.1.28. .status.operationHistory

説明
operationHistory は、このホストで実行された操作に関する情報を保持します。
object
プロパティー説明

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

object

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

inspect

object

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

provision (プロビジョニング)

object

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

register

object

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

3.1.29. .status.operationHistory.deprovision

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

end

``

 

start

``

 

3.1.30. .status.operationHistory.inspect

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

end

``

 

start

``

 

3.1.31. .status.operationHistory.provision

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

end

``

 

start

``

 

3.1.32. .status.operationHistory.register

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

end

``

 

start

``

 

3.1.33. .status.provisioning

説明
プロビジョニング担当者が追跡する情報。
object
必須
  • ID
  • state
プロパティー説明

ID

string

基盤となるプロビジョニングツールからのマシンの UUID

bootMode

string

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

customDeploy

object

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

firmware

object

ユーザーが設定した BIOS

image

object

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

raid

object

ユーザーが設定したレイド

rootDeviceHints

object

ユーザーが設定した RootDevicehints

state

string

プロビジョニング担当者がホストに対して行っていることの指標。

3.1.34. .status.provisioning.customDeploy

説明
ホストに適用されるカスタムデプロイ手順。
object
必須
  • method
プロパティー説明

method

string

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

3.1.35. .status.provisioning.firmware

説明
ユーザーが設定した BIOS
object
プロパティー説明

simultaneousMultithreadingEnabled

boolean

単一の物理プロセッサーコアを複数の論理プロセッサーとして表示できるようにします。これは、次のオプションをサポートします: true、false。

sriovEnabled

boolean

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

virtualizationEnabled

boolean

プラットフォームハードウェアの仮想化をサポートします。これは、次のオプションをサポートします: true、false。

3.1.36. .status.provisioning.image

説明
イメージは、ホストに正常にプロビジョニングされた最後のイメージの詳細を保持します。
object
必須
  • url
プロパティー説明

checksum

string

checksum はイメージのチェックサム。

checksumType

string

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

format

string

DiskFormat には、イメージのフォーマット (raw、qcow2、…) が含まれています。raw イメージをストリーミングするには、raw に設定する必要があります。live-iso は、URL によって参照される iso がライブブートされ、ディスクにデプロイされないことを意味します。この場合、チェックサムオプションは不要であり、指定されている場合は無視されます。

url

string

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

3.1.37. .status.provisioning.raid

説明
ユーザーが設定したレイド
object
プロパティー説明

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 は常に削除されます。

3.1.38. .status.provisioning.rootDeviceHints

説明
ユーザーが設定した RootDevicehints
object
プロパティー説明

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。ヒントは、実際の値と完全に一致する必要があります。

3.1.39. .status.triedCredentials

説明
プロビジョニングバックエンドに送信した最後のクレデンシャル
object
プロパティー説明

credentials

object

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

credentialsVersion

string

 

3.1.40. .status.triedCredentials.credentials

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

name

string

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

namespace

string

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

3.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/metal3.io/v1alpha1/baremetalhosts

    • GET: kind が BareMetalHost のオブジェクトをリスト表示します。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts

    • DELETE:BareMetalHost のコレクションを削除します。
    • GET: kind が 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 のステータスを置き換えます

3.2.1. /apis/metal3.io/v1alpha1/baremetalhosts

HTTP メソッド
GET
説明
kind が BareMetalHost のオブジェクトをリスト表示します。
表3.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

BareMetalHostList スキーマ

401 - Unauthorized

空白

3.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts

HTTP メソッド
DELETE
説明
BareMetalHost のコレクションを削除します。
表3.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が BareMetalHost のオブジェクトをリスト表示します。
表3.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

BareMetalHostList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
BareMetalHost を作成します。
表3.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表3.5 ボディーパラメーター
パラメーター説明

body

BareMetalHost スキーマ

 
表3.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

BareMetalHost スキーマ

201 - Created

BareMetalHost スキーマ

202 - Accepted

BareMetalHost スキーマ

401 - Unauthorized

空白

3.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}

表3.7 グローバルパスパラメーター
パラメーター説明

name

string

BareMetalHost の名前

HTTP メソッド
DELETE
説明
BareMetalHost を削除します。
表3.8 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表3.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された BareMetalHost を読み取ります。
表3.10 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

BareMetalHost スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された BareMetalHost を部分的に更新します。
表3.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表3.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

BareMetalHost スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された BareMetalHost を置き換えます
表3.13 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表3.14 ボディーパラメーター
パラメーター説明

body

BareMetalHost スキーマ

 
表3.15 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

BareMetalHost スキーマ

201 - Created

BareMetalHost スキーマ

401 - Unauthorized

空白

3.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}/status

表3.16 グローバルパスパラメーター
パラメーター説明

name

string

BareMetalHost の名前

HTTP メソッド
GET
説明
指定された BareMetalHost のステータスを読み取ります。
表3.17 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

BareMetalHost スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された BareMetalHost のステータスを部分的に更新します。
表3.18 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表3.19 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

BareMetalHost スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された BareMetalHost のステータスを置き換えます
表3.20 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表3.21 ボディーパラメーター
パラメーター説明

body

BareMetalHost スキーマ

 
表3.22 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

BareMetalHost スキーマ

201 - Created

BareMetalHost スキーマ

401 - Unauthorized

空白

第4章 DataImage [metal3.io/v1alpha1]

説明
DataImage は、dataimages API のスキーマです。
object

4.1. 仕様

プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、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

object

DataImageSpec は、DataImage の望ましい状態を定義します。

status

object

DataImageStatus は、DataImage の観測状態を定義します。

4.1.1. .spec

説明
DataImageSpec は、DataImage の望ましい状態を定義します。
object
必須
  • url
プロパティー説明

url

string

url は BareMetalHost にアタッチする dataImage のアドレスです。

4.1.2. .status

説明
DataImageStatus は、DataImage の観測状態を定義します。
object
プロパティー説明

attachedImage

object

現在アタッチされている DataImage

error

object

アタッチ/デタッチ時のエラー数とメッセージ

lastReconciled

string

最終調整の時刻。

4.1.3. .status.attachedImage

説明
現在アタッチされている DataImage
object
必須
  • url
プロパティー説明

url

string

 

4.1.4. .status.error

説明
アタッチ/デタッチ時のエラー数とメッセージ
object
必須
  • count
  • message
プロパティー説明

count

integer

 

message

string

 

4.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/metal3.io/v1alpha1/dataimages

    • GET: kind が DataImage のオブジェクトをリスト表示します。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages

    • DELETE: DataImage のコレクションを削除します。
    • GET: kind が DataImage のオブジェクトをリスト表示します。
    • POST: DataImage を作成します。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}

    • DELETE: DataImage を削除します。
    • GET: 指定された DataImage を読み取ります。
    • PATCH: 指定された DataImage を部分的に更新します。
    • PUT: 指定された DataImage を置き換えます。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}/status

    • GET: 指定された DataImage のステータスを読み取ります。
    • PATCH: 指定された DataImage のステータスを部分的に更新します。
    • PUT: 指定された DataImage のステータスを置き換えます。

4.2.1. /apis/metal3.io/v1alpha1/dataimages

HTTP メソッド
GET
説明
kind が DataImage のオブジェクトをリスト表示します。
表4.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

DataImageList スキーマ

401 - Unauthorized

空白

4.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages

HTTP メソッド
DELETE
説明
DataImage のコレクションを削除します。
表4.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が DataImage のオブジェクトをリスト表示します。
表4.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

DataImageList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
DataImage を作成します。
表4.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表4.5 ボディーパラメーター
パラメーター説明

body

DataImage スキーマ

 
表4.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

DataImage スキーマ

201 - Created

DataImage スキーマ

202 - Accepted

DataImage スキーマ

401 - Unauthorized

空白

4.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}

表4.7 グローバルパスパラメーター
パラメーター説明

name

string

DataImage の名前。

HTTP メソッド
DELETE
説明
DataImage を削除します。
表4.8 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表4.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された DataImage を読み取ります。
表4.10 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

DataImage スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された DataImage を部分的に更新します。
表4.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表4.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DataImage スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された DataImage を置き換えます。
表4.13 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表4.14 ボディーパラメーター
パラメーター説明

body

DataImage スキーマ

 
表4.15 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

DataImage スキーマ

201 - Created

DataImage スキーマ

401 - Unauthorized

空白

4.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}/status

表4.16 グローバルパスパラメーター
パラメーター説明

name

string

DataImage の名前。

HTTP メソッド
GET
説明
指定された DataImage のステータスを読み取ります。
表4.17 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

DataImage スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された DataImage のステータスを部分的に更新します。
表4.18 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表4.19 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DataImage スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された DataImage のステータスを置き換えます。
表4.20 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表4.21 ボディーパラメーター
パラメーター説明

body

DataImage スキーマ

 
表4.22 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

DataImage スキーマ

201 - Created

DataImage スキーマ

401 - Unauthorized

空白

第5章 FirmwareSchema [metal3.io/v1alpha1]

説明
FirmwareSchema は、firmwareschemas API のスキーマです。
object

5.1. 仕様

プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、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

object

FirmwareSchemaSpec は、FirmwareSchema の望ましい状態を定義します。

5.1.1. .spec

説明
FirmwareSchemaSpec は、FirmwareSchema の望ましい状態を定義します。
object
必須
  • schema
プロパティー説明

hardwareModel

string

このスキーマに関連付けられているハードウェアモデル

hardwareVendor

string

このスキーマに関連付けられているハードウェアベンダー

schema

object

ファームウェア名のスキーマへのマップ

schema{}

object

ファームウェア設定を説明する追加のデータ。

5.1.2. .spec.schema

説明
ファームウェア名のスキーマへのマップ
object

5.1.3. .spec.schema{}

説明
ファームウェア設定を説明する追加のデータ。
object
プロパティー説明

allowable_values

array (string)

列挙型設定の許容値。

attribute_type

string

設定の種類。

lower_bound

integer

整数型設定の最小値。

max_length

integer

文字列タイプ設定の最大長。

min_length

integer

文字列タイプ設定の最小の長さ。

read_only

boolean

この設定が読み取り専用かどうか。

unique

boolean

この設定の値がこのノードに固有であるかどうか (シリアル番号など)。

upper_bound

integer

整数型設定の最大値。

5.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/metal3.io/v1alpha1/firmwareschemas

    • GET: kind が FirmwareSchema のオブジェクトをリスト表示します。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas

    • DELETE:FirmwareSchema のコレクションを削除します。
    • GET: kind が FirmwareSchema のオブジェクトをリスト表示します。
    • POST:FirmwareSchema を作成します。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas/{name}

    • DELETE:FirmwareSchema を削除します。
    • GET: 指定された FirmwareSchema を読み取ります。
    • PATCH: 指定された FirmwareSchema を部分的に更新します。
    • PUT: 指定された FirmwareSchema を置き換えます

5.2.1. /apis/metal3.io/v1alpha1/firmwareschemas

HTTP メソッド
GET
説明
kind が FirmwareSchema のオブジェクトをリスト表示します。
表5.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

FirmwareSchemaList スキーマ

401 - Unauthorized

空白

5.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas

HTTP メソッド
DELETE
説明
FirmwareSchema のコレクションを削除します。
表5.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が FirmwareSchema のオブジェクトをリスト表示します。
表5.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

FirmwareSchemaList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
FirmwareSchema を作成する
表5.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表5.5 ボディーパラメーター
パラメーター説明

body

FirmwareSchema スキーマ

 
表5.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

FirmwareSchema スキーマ

201 - Created

FirmwareSchema スキーマ

202 - Accepted

FirmwareSchema スキーマ

401 - Unauthorized

空白

5.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas/{name}

表5.7 グローバルパスパラメーター
パラメーター説明

name

string

FirmwareSchema の名前

HTTP メソッド
DELETE
説明
FirmwareSchema を削除します
表5.8 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表5.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された FirmwareSchema を読み取ります。
表5.10 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

FirmwareSchema スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された FirmwareSchema を部分的に更新します
表5.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表5.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

FirmwareSchema スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された FirmwareSchema を置き換えます
表5.13 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表5.14 ボディーパラメーター
パラメーター説明

body

FirmwareSchema スキーマ

 
表5.15 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

FirmwareSchema スキーマ

201 - Created

FirmwareSchema スキーマ

401 - Unauthorized

空白

第6章 HardwareData [metal3.io/v1alpha1]

説明
HardwareData は、hardwaredata API のスキーマです。
object

6.1. 仕様

プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、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

object

HardwareDataSpec は、HardwareData の望ましい状態を定義します。

6.1.1. .spec

説明
HardwareDataSpec は、HardwareData の望ましい状態を定義します。
object
プロパティー説明

ハードウェア

object

検査中にホスト上で検出されたハードウェア。

6.1.2. .spec.hardware

説明
検査中にホスト上で検出されたハードウェア。
object
プロパティー説明

cpu

object

cpu は、ホスト上の 1 つのプロセッサーを表します。

firmware

object

firmware は、ホスト上のファームウェアを表します。

hostname

string

 

nics

array

 

nics[]

object

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

ramMebibytes

integer

 

storage

array

 

storage[]

object

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

systemVendor

object

HardwareSystemVendor は、ハードウェアシステム全体に関する詳細を格納します。

6.1.3. .spec.hardware.cpu

説明
cpu は、ホスト上の 1 つのプロセッサーを表します。
object
プロパティー説明

arch

string

 

clockMegahertz

number

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

count

integer

 

flags

array (string)

 

model

string

 

6.1.4. .spec.hardware.firmware

説明
firmware は、ホスト上のファームウェアを表します。
object
プロパティー説明

bios

object

このファームウェアの BIOS

6.1.5. .spec.hardware.firmware.bios

説明
このファームウェアの BIOS
object
プロパティー説明

date

string

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

vendor

string

この BIOS のベンダー名

version

string

BIOS のバージョン

6.1.6. .spec.hardware.nics

説明
array

6.1.7. .spec.hardware.nics[]

説明
nic は、ホスト上の 1 つのネットワークインターフェイスを記述します。
object
プロパティー説明

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 を表します。

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

説明
利用可能な VLAN
array

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

説明
VLAN は、VLAN の名前と ID を表します。
object
プロパティー説明

id

integer

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

name

string

 

6.1.10. .spec.hardware.storage

説明
array

6.1.11. .spec.hardware.storage[]

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

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

6.1.12. .spec.hardware.systemVendor

説明
HardwareSystemVendor は、ハードウェアシステム全体に関する詳細を格納します。
object
プロパティー説明

manufacturer

string

 

productName

string

 

serialNumber

string

 

6.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/metal3.io/v1alpha1/hardwaredata

    • GET: kind が HardwareData のオブジェクトをリスト表示します。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hardwaredata

    • DELETE: HardwareData のコレクションを削除します。
    • GET: kind が HardwareData のオブジェクトをリスト表示します。
    • POST: HardwareData を作成します。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hardwaredata/{name}

    • DELETE: HardwareData を削除します。
    • GET: 指定された HardwareData を読み取ります。
    • PATCH: 指定された HardwareData を部分的に更新します。
    • PUT: 指定された HardwareData を置き換えます。

6.2.1. /apis/metal3.io/v1alpha1/hardwaredata

HTTP メソッド
GET
説明
kind が HardwareData のオブジェクトをリスト表示します。
表6.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HardwareDataList スキーマ

401 - Unauthorized

空白

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

HTTP メソッド
DELETE
説明
HardwareData のコレクションを削除します。
表6.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が HardwareData のオブジェクトをリスト表示します。
表6.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HardwareDataList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
HardwareData を作成します。
表6.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表6.5 ボディーパラメーター
パラメーター説明

body

HardwareData スキーマ

 
表6.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HardwareData スキーマ

201 - Created

HardwareData スキーマ

202 - Accepted

HardwareData スキーマ

401 - Unauthorized

空白

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

表6.7 グローバルパスパラメーター
パラメーター説明

name

string

HardwareData の名前。

HTTP メソッド
DELETE
説明
HardwareData を削除します。
表6.8 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表6.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された HardwareData を読み取ります。
表6.10 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HardwareData スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された HardwareData を部分的に更新します。
表6.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表6.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

HardwareData スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された HardwareData を置き換えます。
表6.13 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表6.14 ボディーパラメーター
パラメーター説明

body

HardwareData スキーマ

 
表6.15 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HardwareData スキーマ

201 - Created

HardwareData スキーマ

401 - Unauthorized

空白

第7章 HostFirmwareComponents [metal3.io/v1alpha1]

説明
HostFirmwareComponents は、hostfirmwarecomponents API のスキーマです。
object

7.1. 仕様

プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、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

object

HostFirmwareComponentsSpec は、HostFirmwareComponents の望ましい状態を定義します。

status

object

HostFirmwareComponentsStatus は、HostFirmwareComponents の観測状態を定義します。

7.1.1. .spec

説明
HostFirmwareComponentsSpec は、HostFirmwareComponents の望ましい状態を定義します。
object
必須
  • updates
プロパティー説明

updates

array

 

updates[]

object

FirmwareUpdate は、ファームウェア更新仕様を定義します。

7.1.2. .spec.updates

説明
array

7.1.3. .spec.updates[]

説明
FirmwareUpdate は、ファームウェア更新仕様を定義します。
object
必須
  • component
  • url
プロパティー説明

component

string

 

url

string

 

7.1.4. .status

説明
HostFirmwareComponentsStatus は、HostFirmwareComponents の観測状態を定義します。
object
プロパティー説明

コンポーネント

array

components は、利用可能なすべてのファームウェアコンポーネントとその情報のリストです。

components[]

object

FirmwareComponentStatus は、ファームウェアコンポーネントのステータスを定義します。

conditions

array

仕様に保存された更新が、スキーマに基づいて有効かどうかを追跡します。

conditions[]

object

条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

lastUpdated

string

ステータスが最後に更新された時刻です。

updates

array

updates は、更新する必要があるすべてのファームウェアコンポーネントのリストで、名前と URL フィールドで指定されます。

updates[]

object

FirmwareUpdate は、ファームウェア更新仕様を定義します。

7.1.5. .status.components

説明
components は、利用可能なすべてのファームウェアコンポーネントとその情報のリストです。
array

7.1.6. .status.components[]

説明
FirmwareComponentStatus は、ファームウェアコンポーネントのステータスを定義します。
object
必須
  • component
  • initialVersion
プロパティー説明

component

string

 

currentVersion

string

 

initialVersion

string

 

lastVersionFlashed

string

 

updatedAt

string

 

7.1.7. .status.conditions

説明
仕様に保存された更新が、スキーマに基づいて有効かどうかを追跡します。
array

7.1.8. .status.conditions[]

説明
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }
object
必須
  • lastTransitionTime
  • message
  • reason
  • status
  • type
プロパティー説明

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。

message

string

message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。

observedGeneration

integer

observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。

reason

string

reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。

status

string

条件のステータス、True、False、Unknown のいずれか。

type

string

CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。

7.1.9. .status.updates

説明
updates は、更新する必要があるすべてのファームウェアコンポーネントのリストで、名前と URL フィールドで指定されます。
array

7.1.10. .status.updates[]

説明
FirmwareUpdate は、ファームウェア更新仕様を定義します。
object
必須
  • component
  • url
プロパティー説明

component

string

 

url

string

 

7.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/metal3.io/v1alpha1/hostfirmwarecomponents

    • GET: kind が HostFirmwareComponents のオブジェクトをリスト表示します。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents

    • DELETE: HostFirmwareComponents のコレクションを削除します。
    • GET: kind が HostFirmwareComponents のオブジェクトをリスト表示します。
    • POST: HostFirmwareComponents を作成します。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}

    • DELETE: HostFirmwareComponents を削除します。
    • GET: 指定された HostFirmwareComponents を読み取ります。
    • PATCH: 指定された HostFirmwareComponents を部分的に更新します。
    • PUT: 指定された HostFirmwareComponents を置き換えます。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}/status

    • GET: 指定された HostFirmwareComponents のステータスを読み取ります。
    • PATCH: 指定された HostFirmwareComponents のステータスを部分的に更新します。
    • PUT: 指定された HostFirmwareComponents のステータスを置き換えます。

7.2.1. /apis/metal3.io/v1alpha1/hostfirmwarecomponents

HTTP メソッド
GET
説明
kind が HostFirmwareComponents のオブジェクトをリスト表示します。
表7.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareComponentsList スキーマ

401 - Unauthorized

空白

7.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents

HTTP メソッド
DELETE
説明
HostFirmwareComponents のコレクションを削除します。
表7.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が HostFirmwareComponents のオブジェクトをリスト表示します。
表7.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareComponentsList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
HostFirmwareComponents を作成します。
表7.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表7.5 ボディーパラメーター
パラメーター説明

body

HostFirmwareComponents スキーマ

 
表7.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareComponents スキーマ

201 - Created

HostFirmwareComponents スキーマ

202 - Accepted

HostFirmwareComponents スキーマ

401 - Unauthorized

空白

7.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}

表7.7 グローバルパスパラメーター
パラメーター説明

name

string

HostFirmwareComponents の名前

HTTP メソッド
DELETE
説明
HostFirmwareComponents を削除します。
表7.8 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表7.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された HostFirmwareComponents を読み取ります。
表7.10 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareComponents スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された HostFirmwareComponents を部分的に更新します。
表7.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表7.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareComponents スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された HostFirmwareComponents を置き換えます。
表7.13 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表7.14 ボディーパラメーター
パラメーター説明

body

HostFirmwareComponents スキーマ

 
表7.15 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareComponents スキーマ

201 - Created

HostFirmwareComponents スキーマ

401 - Unauthorized

空白

7.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}/status

表7.16 グローバルパスパラメーター
パラメーター説明

name

string

HostFirmwareComponents の名前

HTTP メソッド
GET
説明
指定された HostFirmwareComponents のステータスを読み取ります。
表7.17 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareComponents スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された HostFirmwareComponents のステータスを部分的に更新します。
表7.18 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表7.19 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareComponents スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された HostFirmwareComponents のステータスを置き換えます。
表7.20 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表7.21 ボディーパラメーター
パラメーター説明

body

HostFirmwareComponents スキーマ

 
表7.22 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareComponents スキーマ

201 - Created

HostFirmwareComponents スキーマ

401 - Unauthorized

空白

第8章 HostFirmwareSettings [metal3.io/v1alpha1]

説明
HostFirmwareSettings は、hostfirmwaresettings API のスキーマです。
object

8.1. 仕様

プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、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

object

HostFirmwareSettingsSpec は、HostFirmwareSettings の望ましい状態を定義します。

status

object

HostFirmwareSettingsStatus は、HostFirmwareSettings の観測状態を定義します。

8.1.1. .spec

説明
HostFirmwareSettingsSpec は、HostFirmwareSettings の望ましい状態を定義します。
object
必須
  • settings
プロパティー説明

settings

integer-or-string

settings は、名前と値のペアとして保存されている必要なファームウェア設定です。

8.1.2. .status

説明
HostFirmwareSettingsStatus は、HostFirmwareSettings の観測状態を定義します。
object
必須
  • settings
プロパティー説明

conditions

array

スキーマに基づいて、仕様に保存されている設定が有効かどうかを追跡します。

conditions[]

object

条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

lastUpdated

string

ステータスが最後に更新された時刻です。

schema

object

FirmwareSchema は、各 FirmwareSetting を記述するために使用されるスキーマへの参照です。デフォルトでは、これは設定と同じ Namespace の Schema になりますが、Spec で上書きできます。

settings

object (string)

settings は、名前と値のペアとして保存されるファームウェア設定です。

8.1.3. .status.conditions

説明
スキーマに基づいて、仕様に保存されている設定が有効かどうかを追跡します。
array

8.1.4. .status.conditions[]

説明
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }
object
必須
  • lastTransitionTime
  • message
  • reason
  • status
  • type
プロパティー説明

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。

message

string

message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。

observedGeneration

integer

observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。

reason

string

reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。

status

string

条件のステータス、True、False、Unknown のいずれか。

type

string

CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。

8.1.5. .status.schema

説明
FirmwareSchema は、各 FirmwareSetting を記述するために使用されるスキーマへの参照です。デフォルトでは、これは設定と同じ Namespace の Schema になりますが、Spec で上書きできます。
object
必須
  • name
  • namespace
プロパティー説明

name

string

name はスキーマへの参照です。

namespace

string

namespace は、スキーマが格納されている場所の namespace です。

8.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/metal3.io/v1alpha1/hostfirmwaresettings

    • GET: kind が HostFirmwareSettings のオブジェクトをリスト表示します。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings

    • 削除:HostFirmwareSettings のコレクションを削除します
    • GET: kind が HostFirmwareSettings のオブジェクトをリスト表示します。
    • POST:HostFirmwareSettings を作成します
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}

    • 削除:HostFirmwareSettings を削除します
    • GET: 指定された HostFirmwareSettings を読み取ります。
    • PATCH: 指定された HostFirmwareSettings を部分的に更新します
    • PUT: 指定された HostFirmwareSettings を置き換えます
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}/status

    • GET: 指定された HostFirmwareSettings のステータスを読み取ります。
    • PATCH: 指定された HostFirmwareSettings のステータスを部分的に更新します
    • PUT: 指定された HostFirmwareSettings のステータスを置き換えます

8.2.1. /apis/metal3.io/v1alpha1/hostfirmwaresettings

HTTP メソッド
GET
説明
kind が HostFirmwareSettings のオブジェクトをリスト表示します。
表8.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareSettingsList スキーマ

401 - Unauthorized

空白

8.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings

HTTP メソッド
DELETE
説明
HostFirmwareSettings のコレクションを削除します
表8.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が HostFirmwareSettings のオブジェクトをリスト表示します。
表8.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareSettingsList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
HostFirmwareSettings を作成します
表8.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表8.5 ボディーパラメーター
パラメーター説明

body

HostFirmwareSettings スキーマ

 
表8.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareSettings スキーマ

201 - Created

HostFirmwareSettings スキーマ

202 - Accepted

HostFirmwareSettings スキーマ

401 - Unauthorized

空白

8.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}

表8.7 グローバルパスパラメーター
パラメーター説明

name

string

HostFirmwareSettings の名前

HTTP メソッド
DELETE
説明
HostFirmwareSettings を削除します
表8.8 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表8.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された HostFirmwareSettings を読み取ります
表8.10 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareSettings スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された HostFirmwareSettings を部分的に更新します
表8.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表8.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareSettings スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された HostFirmwareSettings を置き換えます
表8.13 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表8.14 ボディーパラメーター
パラメーター説明

body

HostFirmwareSettings スキーマ

 
表8.15 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareSettings スキーマ

201 - Created

HostFirmwareSettings スキーマ

401 - Unauthorized

空白

8.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}/status

表8.16 グローバルパスパラメーター
パラメーター説明

name

string

HostFirmwareSettings の名前

HTTP メソッド
GET
説明
指定された HostFirmwareSettings のステータスを読み取ります。
表8.17 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareSettings スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された HostFirmwareSettings のステータスを部分的に更新します。
表8.18 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表8.19 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareSettings スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された HostFirmwareSettings のステータスを置き換えます
表8.20 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表8.21 ボディーパラメーター
パラメーター説明

body

HostFirmwareSettings スキーマ

 
表8.22 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

HostFirmwareSettings スキーマ

201 - Created

HostFirmwareSettings スキーマ

401 - Unauthorized

空白

第9章 Metal3Remediation [infrastructure.cluster.x-k8s.io/v1beta1]

説明
Metal3Remediation は、metal3remediations API のスキーマです。
object

9.1. 仕様

プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、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

object

Metal3RemediationSpec は、Metal3Remediation の望ましい状態を定義します。

status

object

Metal3RemediationStatus は、Metal3Remediation の観測状態を定義します。

9.1.1. .spec

説明
Metal3RemediationSpec は、Metal3Remediation の望ましい状態を定義します。
object
プロパティー説明

strategy

object

Strategy フィールドは、修復ストラテジーを定義します。

9.1.2. .spec.strategy

説明
Strategy フィールドは、修復ストラテジーを定義します。
object
プロパティー説明

retryLimit

integer

修復再試行の最大回数を設定します。

timeout

string

修復の再試行間のタイムアウトを設定します。

type

string

修復の種類。

9.1.3. .status

説明
Metal3RemediationStatus は、Metal3Remediation の観測状態を定義します。
object
プロパティー説明

lastRemediated

string

lastRemediated は、ホストが最後に修復された日時を特定します。

phase

string

phase は、マシン修復の現在のフェーズを表します。たとえば、保留中、実行中、完了など。

retryCount

integer

retryCount は、修復中のカウンターとして使用できます。フィールドには、再起動回数などを保持できます。

9.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediations

    • GET: kind が Metal3Remediation のオブジェクトをリスト表示します。
  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations

    • DELETE: Metal3Remediation のコレクションを削除します。
    • GET: kind が Metal3Remediation のオブジェクトをリスト表示します。
    • POST: Metal3Remediation を作成します。
  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations/{name}

    • DELETE: Metal3Remediation を削除します。
    • GET: 指定された Metal3Remediation を読み取ります。
    • PATCH: 指定された Metal3Remediation を部分的に更新します。
    • PUT: 指定された Metal3Remediation を置き換えます。
  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations/{name}/status

    • GET: 指定された Metal3Remediation のステータスを読み取ります。
    • PATCH: 指定された Metal3Remediation のステータスを部分的に更新します。
    • PUT: 指定された Metal3Remediation のステータスを置き換えます。

9.2.1. /apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediations

HTTP メソッド
GET
説明
kind が Metal3Remediation のオブジェクトをリスト表示します。
表9.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Metal3RemediationList スキーマ

401 - Unauthorized

空白

9.2.2. /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations

HTTP メソッド
DELETE
説明
Metal3Remediation のコレクションを削除します。
表9.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が Metal3Remediation のオブジェクトをリスト表示します。
表9.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Metal3RemediationList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
Metal3Remediation を作成します。
表9.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表9.5 ボディーパラメーター
パラメーター説明

body

Metal3Remediation スキーマ

 
表9.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Metal3Remediation スキーマ

201 - Created

Metal3Remediation スキーマ

202 - Accepted

Metal3Remediation スキーマ

401 - Unauthorized

空白

9.2.3. /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations/{name}

表9.7 グローバルパスパラメーター
パラメーター説明

name

string

Metal3Remediation の名前。

HTTP メソッド
DELETE
説明
Metal3Remediation を削除します。
表9.8 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表9.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された Metal3Remediation を読み取ります。
表9.10 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Metal3Remediation スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された Metal3Remediation を部分的に更新します。
表9.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表9.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Metal3Remediation スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された Metal3Remediation を置き換えます。
表9.13 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表9.14 ボディーパラメーター
パラメーター説明

body

Metal3Remediation スキーマ

 
表9.15 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Metal3Remediation スキーマ

201 - Created

Metal3Remediation スキーマ

401 - Unauthorized

空白

9.2.4. /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations/{name}/status

表9.16 グローバルパスパラメーター
パラメーター説明

name

string

Metal3Remediation の名前。

HTTP メソッド
GET
説明
指定された Metal3Remediation のステータスを読み取ります。
表9.17 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Metal3Remediation スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された Metal3Remediation のステータスを部分的に更新します。
表9.18 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表9.19 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Metal3Remediation スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された Metal3Remediation のステータスを置き換えます。
表9.20 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表9.21 ボディーパラメーター
パラメーター説明

body

Metal3Remediation スキーマ

 
表9.22 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Metal3Remediation スキーマ

201 - Created

Metal3Remediation スキーマ

401 - Unauthorized

空白

第10章 Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]

説明
Metal3RemediationTemplate は、metal3remediationtemplates API のスキーマです。
object

10.1. 仕様

プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、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

object

Metal3RemediationTemplateSpec は、Metal3RemediationTemplate の望ましい状態を定義します。

status

object

Metal3RemediationTemplateStatus は、Metal3RemediationTemplate の観測状態を定義します。

10.1.1. .spec

説明
Metal3RemediationTemplateSpec は、Metal3RemediationTemplate の望ましい状態を定義します。
object
必須
  • template
プロパティー説明

template

object

Metal3RemediationTemplateResource は、テンプレートから Metal3Remediation を作成するために必要なデータを記述します。

10.1.2. .spec.template

説明
Metal3RemediationTemplateResource は、テンプレートから Metal3Remediation を作成するために必要なデータを記述します。
object
必須
  • spec
プロパティー説明

spec

object

spec は、Metal3Remediation の望ましい動作の仕様です。

10.1.3. .spec.template.spec

説明
spec は、Metal3Remediation の望ましい動作の仕様です。
object
プロパティー説明

strategy

object

Strategy フィールドは、修復ストラテジーを定義します。

10.1.4. .spec.template.spec.strategy

説明
Strategy フィールドは、修復ストラテジーを定義します。
object
プロパティー説明

retryLimit

integer

修復再試行の最大回数を設定します。

timeout

string

修復の再試行間のタイムアウトを設定します。

type

string

修復の種類。

10.1.5. .status

説明
Metal3RemediationTemplateStatus は、Metal3RemediationTemplate の観測状態を定義します。
object
必須
  • status
プロパティー説明

status

object

Metal3RemediationStatus は、Metal3Remediation の観測状態を定義します。

10.1.6. .status.status

説明
Metal3RemediationStatus は、Metal3Remediation の観測状態を定義します。
object
プロパティー説明

lastRemediated

string

lastRemediated は、ホストが最後に修復された日時を特定します。

phase

string

phase は、マシン修復の現在のフェーズを表します。たとえば、保留中、実行中、完了など。

retryCount

integer

retryCount は、修復中のカウンターとして使用できます。フィールドには、再起動回数などを保持できます。

10.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediationtemplates

    • GET: kind が Metal3RemediationTemplate のオブジェクトをリスト表示します。
  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates

    • DELETE: Metal3RemediationTemplate のコレクションを削除します。
    • GET: kind が Metal3RemediationTemplate のオブジェクトをリスト表示します。
    • POST: Metal3RemediationTemplate を作成します。
  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}

    • DELETE: Metal3RemediationTemplate を削除します。
    • GET: 指定された Metal3RemediationTemplate を読み取ります。
    • PATCH: 指定された Metal3RemediationTemplate を部分的に更新します。
    • PUT: 指定された Metal3RemediationTemplate を置き換えます。
  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}/status

    • GET: 指定された Metal3RemediationTemplate のステータスを読み取ります。
    • PATCH: 指定された Metal3RemediationTemplate のステータスを部分的に更新します。
    • PUT: 指定された Metal3RemediationTemplate のステータスを置き換えます。

10.2.1. /apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediationtemplates

HTTP メソッド
GET
説明
kind が Metal3RemediationTemplate のオブジェクトをリスト表示します。
表10.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Metal3RemediationTemplateList スキーマ

401 - Unauthorized

空白

10.2.2. /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates

HTTP メソッド
DELETE
説明
Metal3RemediationTemplate のコレクションを削除します。
表10.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が Metal3RemediationTemplate のオブジェクトをリスト表示します。
表10.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Metal3RemediationTemplateList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
Metal3RemediationTemplate を作成します。
表10.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表10.5 ボディーパラメーター
パラメーター説明

body

Metal3RemediationTemplate スキーマ

 
表10.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Metal3RemediationTemplate スキーマ

201 - Created

Metal3RemediationTemplate スキーマ

202 - Accepted

Metal3RemediationTemplate スキーマ

401 - Unauthorized

空白

10.2.3. /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}

表10.7 グローバルパスパラメーター
パラメーター説明

name

string

Metal3RemediationTemplate の名前。

HTTP メソッド
DELETE
説明
Metal3RemediationTemplate を削除します。
表10.8 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表10.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された Metal3RemediationTemplate を読み取ります。
表10.10 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Metal3RemediationTemplate スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された Metal3RemediationTemplate を部分的に更新します。
表10.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表10.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Metal3RemediationTemplate スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された Metal3RemediationTemplate を置き換えます。
表10.13 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表10.14 ボディーパラメーター
パラメーター説明

body

Metal3RemediationTemplate スキーマ

 
表10.15 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Metal3RemediationTemplate スキーマ

201 - Created

Metal3RemediationTemplate スキーマ

401 - Unauthorized

空白

10.2.4. /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}/status

表10.16 グローバルパスパラメーター
パラメーター説明

name

string

Metal3RemediationTemplate の名前。

HTTP メソッド
GET
説明
指定された Metal3RemediationTemplate のステータスを読み取ります。
表10.17 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Metal3RemediationTemplate スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された Metal3RemediationTemplate のステータスを部分的に更新します。
表10.18 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表10.19 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Metal3RemediationTemplate スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された Metal3RemediationTemplate のステータスを置き換えます。
表10.20 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表10.21 ボディーパラメーター
パラメーター説明

body

Metal3RemediationTemplate スキーマ

 
表10.22 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Metal3RemediationTemplate スキーマ

201 - Created

Metal3RemediationTemplate スキーマ

401 - Unauthorized

空白

第11章 PreprovisioningImage [metal3.io/v1alpha1]

説明
PreprovisioningImage は、preprovisioningimages API のスキーマです。
object

11.1. 仕様

プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、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

object

PreprovisioningImageSpec は、PreprovisioningImage の望ましい状態を定義します。

status

object

PreprovisioningImageStatus は、PreprovisioningImage の観測状態を定義します。

11.1.1. .spec

説明
PreprovisioningImageSpec は、PreprovisioningImage の望ましい状態を定義します。
object
プロパティー説明

acceptFormats

array (string)

acceptFormats は、受け入れ可能なイメージ形式のリストです。

architecture

string

architecture は、イメージをビルドするプロセッサーアーキテクチャーです。

networkDataName

string

networkDataName は、イメージにビルドするネットワークデータが含まれるローカル namespace 内の Secret の名前です。

11.1.2. .status

説明
PreprovisioningImageStatus は、PreprovisioningImage の観測状態を定義します。
object
プロパティー説明

architecture

string

architecture は、イメージがビルドされるプロセッサーアーキテクチャーです。

conditions

array

conditions は、ビルドされたイメージの状態を記述します。

conditions[]

object

条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

extraKernelParams

string

extraKernelParams は、ネットワーク経由でイメージを起動するときにカーネルに渡す追加パラメーターを含む文字列です。initrd イメージの場合にのみ意味があります。

format

string

format は、ダウンロード URL で利用できるイメージのタイプ (iso または initrd) です。

imageUrl

string

imageUrl は、ビルドされたイメージをダウンロードできる URL です。

kernelUrl

string

kernelUrl は、イメージのカーネルをダウンロードできる URL です。initrd イメージの場合にのみ意味があります。

networkData

object

networkData は、イメージのビルドに使用されるネットワークデータを含む Secret のバージョンへの参照です。

11.1.3. .status.conditions

説明
conditions は、ビルドされたイメージの状態を記述します。
array

11.1.4. .status.conditions[]

説明
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }
object
必須
  • lastTransitionTime
  • message
  • reason
  • status
  • type
プロパティー説明

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。

message

string

message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。

observedGeneration

integer

observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。

reason

string

reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。

status

string

条件のステータス、True、False、Unknown のいずれか。

type

string

CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。

11.1.5. .status.networkData

説明
networkData は、イメージのビルドに使用されるネットワークデータを含む Secret のバージョンへの参照です。
object
プロパティー説明

name

string

 

version

string

 

11.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/metal3.io/v1alpha1/preprovisioningimages

    • GET: kind が PreprovisioningImage のオブジェクトをリスト表示します。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages

    • DELETE: PreprovisioningImage のコレクションを削除します。
    • GET: kind が PreprovisioningImage のオブジェクトをリスト表示します。
    • POST: PreprovisioningImage を作成します。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}

    • DELETE: PreprovisioningImage を削除します。
    • GET: 指定された PreprovisioningImage を読み取ります。
    • PATCH: 指定された PreprovisioningImage を部分的に更新します。
    • PUT: 指定された PreprovisioningImage を置き換えます。
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}/status

    • GET: 指定された PreprovisioningImage のステータスを読み取ります。
    • PATCH: 指定された PreprovisioningImage のステータスを部分的に更新します。
    • PUT: 指定された PreprovisioningImage のステータスを置き換えます。

11.2.1. /apis/metal3.io/v1alpha1/preprovisioningimages

HTTP メソッド
GET
説明
kind が PreprovisioningImage のオブジェクトをリスト表示します。
表11.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PreprovisioningImageList スキーマ

401 - Unauthorized

空白

11.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages

HTTP メソッド
DELETE
説明
PreprovisioningImage のコレクションを削除します。
表11.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が PreprovisioningImage のオブジェクトをリスト表示します。
表11.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PreprovisioningImageList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
PreprovisioningImage を作成します。
表11.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表11.5 ボディーパラメーター
パラメーター説明

body

PreprovisioningImage スキーマ

 
表11.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PreprovisioningImage スキーマ

201 - Created

PreprovisioningImage スキーマ

202 - Accepted

PreprovisioningImage スキーマ

401 - Unauthorized

空白

11.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}

表11.7 グローバルパスパラメーター
パラメーター説明

name

string

PreprovisioningImage イメージの名前。

HTTP メソッド
DELETE
説明
PreprovisioningImage を削除します。
表11.8 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表11.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された PreprovisioningImage を読み取ります。
表11.10 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PreprovisioningImage スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された PreprovisioningImage を部分的に更新します。
表11.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表11.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PreprovisioningImage スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された PreprovisioningImage を置き換えます。
表11.13 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表11.14 ボディーパラメーター
パラメーター説明

body

PreprovisioningImage スキーマ

 
表11.15 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PreprovisioningImage スキーマ

201 - Created

PreprovisioningImage スキーマ

401 - Unauthorized

空白

11.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}/status

表11.16 グローバルパスパラメーター
パラメーター説明

name

string

PreprovisioningImage イメージの名前。

HTTP メソッド
GET
説明
指定された PreprovisioningImage のステータスを読み取ります。
表11.17 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PreprovisioningImage スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された PreprovisioningImage のステータスを部分的に更新します。
表11.18 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表11.19 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PreprovisioningImage スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された PreprovisioningImage のステータスを置き換えます。
表11.20 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表11.21 ボディーパラメーター
パラメーター説明

body

PreprovisioningImage スキーマ

 
表11.22 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PreprovisioningImage スキーマ

201 - Created

PreprovisioningImage スキーマ

401 - Unauthorized

空白

第12章 Provisioning [metal3.io/v1alpha1]

説明
Provisioning には、Provisioning サービス (Ironic) がベアメタルホストをプロビジョニングするために使用する設定が含まれています。Provisioning は、プロビジョニングネットワークおよび PXE ブートに使用できるサーバー上の NIC に関する管理者またはユーザー提供の情報を使用して、OpenShift インストーラーによって作成されます。この CR はシングルトンであり、インストーラーによって作成され、現在、metal3 クラスター内のコンテナーを起動および更新するために cluster-baremetal-operator によってのみ使用されます。
object

12.1. 仕様

プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、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

object

ProvisioningSpec は、プロビジョニングの望ましい状態を定義します。

status

object

ProvisioningStatus は、Provisioning の観測状態を定義します。

12.1.1. .spec

説明
ProvisioningSpec は、プロビジョニングの望ましい状態を定義します。
object
プロパティー説明

bootIsoSource

string

BootIsoSource は、ノードを起動する ISO イメージが提供される場所を設定する方法を提供します。デフォルトでは、ブート ISO イメージはローカルにキャッシュされ、補助 httpd サーバーを使用してプロビジョニングサービス (Ironic) ノードから提供されます。ブート ISO イメージがすでに httpd サーバーによって提供されている場合、このオプションを http に設定すると、そこからイメージを直接提供できます。この場合、ブート ISO をホストする httpd サーバーが存在するネットワーク (内部または外部) には、metal3 Pod からアクセスできる必要があります。

disableVirtualMediaTLS

boolean

DisableVirtualMediaTLS は、仮想メディアサーバー上の TLS をオフにします。これは、HTTPS リンクを受け入れることができないハードウェアに必要な場合があります。

preProvisioningOSDownloadURLs

object

preProvisioningOSDownloadURLs は、仮想メディアまたは PXE のいずれかを使用してワーカーをプロビジョニングするために必要な CoreOS Live URL のセットです。

provisioningDHCPExternal

boolean

provisioningDHCPExternal は、プロビジョニング DHCP 範囲内の IP アドレスの DHCP サーバーが metal3 クラスター内に存在するか外部に存在するかを示します。このフィールドは、provisioningNetwork を優先して非推奨になりました。

provisioningDHCPRange

string

provisioningDHCPRange は、provisioningDHCPExternal と一緒に解釈する必要があります。provisioningDHCPExternal の値が False に設定されている場合、provisioningDHCPRange は、metal3 クラスター内で実行されている DHCP サーバーがベアメタルサーバーのプロビジョニング中に使用できる IP アドレスの範囲を表します。ProvisioningDHCPExternal の値が True に設定されている場合、ProvisioningDHCPRange の値は無視されます。provisioningDHCPExternal の値が False に設定され、内部 DHCP サーバーを示し、provisioningDHCPRange の値が設定されていない場合、DHCP 範囲は、provisioningNetworkCIDR の.10 から.100 までのデフォルト範囲と見なされます。これは、インストーラーが CR を作成した後に変更できる、すべてのプロビジョニング設定の唯一の値です。この値は、provisioningNetworkCIDR 内の 2 つのコンマで区切られた IP アドレスである必要があります。ここで、1 番目のアドレスは範囲の開始を表し、2 番目のアドレスは範囲内の最後の使用可能なアドレスを表します。

provisioningDNS

boolean

provisioningDNS を使用すると、プロビジョニングネットワーク上で DHCP 経由で DNS 情報を送信できます。Provisioning サービス自体 (Ironic) は DNS を必要としないため、デフォルトではオフになっていますが、階層化製品 (ZTP など) では役立つ場合があります。

provisioningIP

string

provisioningIP は、ベアメタルサーバーの provisioningInterface に割り当てられた IP アドレスです。この IP アドレスは、プロビジョニングサブネット内にあり、DHCP 範囲外にある必要があります。

provisioningInterface

string

provisioningInterface は、プロビジョニングネットワークへのベアメタルサーバー上のネットワークインターフェイスの名前です。eth1 や ens3 のような値を持つことができます。

provisioningMacAddresses

array (string)

provisioningMacAddresses は、プロビジョニングネットワークへのベアメタルサーバー上のネットワークインターフェイスの MAC アドレスのリストです。異なる名前のインターフェイスを許可するには、provisioningInterface の代わりにこれを使用します。指定しない場合は、各マスターの BMH.Spec.BootMacAddress によって入力されます。

provisioningNetwork

string

provisioningNetwork は、プロビジョニングネットワークの基盤となるネットワーク設定の状態を示す方法を提供します。プロビジョニングネットワークがベアメタル IPI ソリューションによって完全に管理されている場合、このフィールドには次のいずれかの値 (マネージド) を指定できます。管理 されていない - プロビジョニングネットワークが存在して使用されているが、ユーザーが DHCP を管理する責任がある場合。仮想メディアのプロビジョニングが推奨されますが、必要に応じて PXE を引き続き利用できます。Disabled - プロビジョニングネットワークが完全に無効になっている場合。ユーザーは、仮想メディアまたはアシストインストールを使用してベアメタルクラスターを起動できます。電力管理に metal3 を使用する場合は、マシンネットワークから BMC にアクセスできる必要があります。ユーザーは、プロビジョニングサービスに使用される外部ネットワーク上に 2 つの IP を提供する必要があります。

provisioningNetworkCIDR

string

provisioningNetworkCIDR は、ベアメタルノードがプロビジョニングされるネットワークです。provisioningIP と dhcpRange 内の IP はすべて、このネットワーク内から取得されます。IPv6 を使用していて、ベアメタル IPI ソリューションによって管理されているネットワークでは、これを/64 よりも大きいネットワークにすることはできません。

provisioningOSDownloadURL

string

ProvisioningOSDownloadURL は、ベアメタルホストマシンの起動に使用される OS イメージを metal3 クラスターがダウンロードできる場所です。

virtualMediaViaExternalNetwork

boolean

VirtualMediaViaExternalNetwork フラグを "true" に設定すると、ワーカーは仮想メディアを介して起動し、外部ネットワークを介して metal3 に接続できます。フラグが "false" (デフォルト) に設定されている場合でも、仮想メディアのデプロイメントは、provisioningNetwork で指定された設定に基づいて行うことができます。つまり、無効モードの場合、外部ネットワーク、および管理モードの場合はプロビジョニングネットワークを介して行われます。PXE デプロイメントでは、常にプロビジョニングネットワークが使用され、このフラグの影響を受けません。

watchAllNamespaces

boolean

WatchAllNamespaces は、すべての Namespace でこの Provisioning 設定の使用を明示的に許可する方法を提供します。これはオプションの設定であり、デフォルトは false であり、その状態では、openshift-machine-api namespace でのみベアメタルホストをプロビジョニングするために使用されます。true に設定すると、このプロビジョニング設定は、すべてのネームスペースのベアメタルホストに使用されます。

12.1.2. .spec.preProvisioningOSDownloadURLs

説明
preProvisioningOSDownloadURLs は、仮想メディアまたは PXE のいずれかを使用してワーカーをプロビジョニングするために必要な CoreOS Live URL のセットです。
object
プロパティー説明

initramfsURL

string

InitramfsURLPXE デプロイメントに使用されるイメージ URL

isoURL

string

ライブ ISO デプロイメントに使用される IsoURL イメージ URL

kernelURL

string

KernelURL は、PXE デプロイメントに使用されるイメージ URL です。

rootfsURL

string

PXE デプロイメントに使用される RootfsURL イメージ URL

12.1.3. .status

説明
ProvisioningStatus は、Provisioning の観測状態を定義します。
object
プロパティー説明

conditions

array

conditions は、状態とそのステータスのリストです。

conditions[]

object

OperatorCondition は、標準の状態フィールドです。

generations

array

generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。

generations[]

object

GenerationStatus は、特定のリソースの生成を追跡するため、強制更新に関する決定を行うことができます。

observedGeneration

integer

observedGeneration はあなたが扱った最後の世代の変更です

readyReplicas

integer

readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します

version

string

バージョンは、この可用性が適用されるレベルです

12.1.4. .status.conditions

説明
conditions は、状態とそのステータスのリストです。
array

12.1.5. .status.conditions[]

説明
OperatorCondition は、標準の状態フィールドです。
object
プロパティー説明

lastTransitionTime

string

 

message

string

 

reason

string

 

status

string

 

type

string

 

12.1.6. .status.generations

説明
generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
array

12.1.7. .status.generations[]

説明
GenerationStatus は、特定のリソースの生成を追跡するため、強制更新に関する決定を行うことができます。
object
プロパティー説明

group

string

グループはあなたが追跡しているもののグループです

ハッシュ

string

ハッシュは、シークレットや設定マップのようにコンテンツに依存する、生成されないリソース用に設定されたオプションのフィールドです。

lastGeneration

integer

lastGeneration は、関連するワークロードコントローラーの最後の世代です。

name

string

name は、追跡しているものの名前です

namespace

string

名前空間は、追跡しているものがどこにあるかです

resource

string

リソースは、追跡しているもののリソースタイプです

12.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/metal3.io/v1alpha1/provisionings

    • DELETE: Provisioning のコレクションを削除します。
    • GET: kind が Provisioning のオブジェクトをリスト表示します。
    • POST: Provisioning を作成します。
  • /apis/metal3.io/v1alpha1/provisionings/{name}

    • DELETE: Provisioning を削除します。
    • GET: 指定された Provisioning を読み取ります。
    • PATCH: 指定された Provisioning を部分的に更新します。
    • PUT: 指定された Provisioning を置き換えます。
  • /apis/metal3.io/v1alpha1/provisionings/{name}/status

    • GET: 指定された Provisioning のステータスを読み取ります。
    • PATCH: 指定された Provisioning のステータスを部分的に更新します。
    • PUT: 指定された Provisioning のステータスを置き換えます。

12.2.1. /apis/metal3.io/v1alpha1/provisionings

HTTP メソッド
DELETE
説明
Provisioning のコレクションを削除します。
表12.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が Provisioning のオブジェクトをリスト表示します。
表12.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ProvisioningList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
Provisioning を作成します。
表12.3 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表12.4 ボディーパラメーター
パラメーター説明

body

Provisioning スキーマ

 
表12.5 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Provisioning スキーマ

201 - Created

Provisioning スキーマ

202 - Accepted

Provisioning スキーマ

401 - Unauthorized

空白

12.2.2. /apis/metal3.io/v1alpha1/provisionings/{name}

表12.6 グローバルパスパラメーター
パラメーター説明

name

string

プロビジョニングの名前

HTTP メソッド
DELETE
説明
Provisioning を削除します。
表12.7 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表12.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定されたプロビジョニングを読み取る
表12.9 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Provisioning スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定されたプロビジョニングを部分的に更新します。
表12.10 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表12.11 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Provisioning スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定されたプロビジョニングを置き換えます
表12.12 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表12.13 ボディーパラメーター
パラメーター説明

body

Provisioning スキーマ

 
表12.14 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Provisioning スキーマ

201 - Created

Provisioning スキーマ

401 - Unauthorized

空白

12.2.3. /apis/metal3.io/v1alpha1/provisionings/{name}/status

表12.15 グローバルパスパラメーター
パラメーター説明

name

string

プロビジョニングの名前

HTTP メソッド
GET
説明
指定されたプロビジョニングのステータスを読み取ります
表12.16 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Provisioning スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定されたプロビジョニングのステータスを部分的に更新します。
表12.17 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表12.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Provisioning スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定されたプロビジョニングのステータスを置き換えます
表12.19 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表12.20 ボディーパラメーター
パラメーター説明

body

Provisioning スキーマ

 
表12.21 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Provisioning スキーマ

201 - Created

Provisioning スキーマ

401 - Unauthorized

空白

Legal Notice

Copyright © 2024 Red Hat, Inc.

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

© 2024 Red Hat, Inc.