Machine API


OpenShift Container Platform 4.17

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

Red Hat OpenShift Documentation Team

概要

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

第1章 Machine API

1.1. ContainerRuntimeConfig [machineconfiguration.openshift.io/v1]

説明
ContainerRuntimeConfig は、カスタマイズされた Container Runtime 設定を記述します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.2. ControllerConfig [machineconfiguration.openshift.io/v1]

説明
ControllerConfig は、MachineConfigController の設定を説明しています。これは現在、TemplateController によって生成された MachineConfig オブジェクトを駆動するためにのみ使用されます。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.3. ControlPlaneMachineSet [machine.openshift.io/v1]

説明
ControlPlaneMachineSet を使用すると、指定された数のコントロールプレーンマシンのレプリカが常に実行されます。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.4. KubeletConfig [machineconfiguration.openshift.io/v1]

説明
KubeletConfig は、カスタマイズされた Kubelet 設定を説明します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.5. MachineConfig [machineconfiguration.openshift.io/v1]

説明
MachineConfig は、マシンの互換性レベル 1 の設定を定義します。メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース内 (いずれか長い方) で安定しています。
object

1.6. MachineConfigPool [machineconfiguration.openshift.io/v1]

説明
MachineConfigPool は、MachineConfig のプールを説明します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.7. MachineHealthCheck [machine.openshift.io/v1beta1]

説明
MachineHealthCheck は、machinehealthchecks API のスキーマです。互換性レベル 2: メジャーリリース内で最低 9 カ月間、または 3 つのマイナーリリース内 (いずれか長い方) で安定しています。
object

1.8. Machine [machine.openshift.io/v1beta1]

説明
Machine は、マシン API のスキーマです。互換性レベル 2: メジャーリリース内で最低 9 カ月間、または 3 つのマイナーリリース内 (いずれか長い方) で安定しています。
object

1.9. MachineSet [machine.openshift.io/v1beta1]

説明
MachineSet は、指定された数のマシンレプリカが常に実行されていることを確認します。互換性レベル 2: メジャーリリース内で最低 9 カ月間、または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

第2章 ContainerRuntimeConfig [machineconfiguration.openshift.io/v1]

説明
ContainerRuntimeConfig は、カスタマイズされた Container Runtime 設定を記述します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object
必須
  • spec

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

ContainerRuntimeConfigSpec は、ContainerRuntimeConfig の望ましい状態を定義します

status

object

ContainerRuntimeConfigStatus は、ContainerRuntimeConfig の監視状態を定義します

2.1.1. .spec

説明
ContainerRuntimeConfigSpec は、ContainerRuntimeConfig の望ましい状態を定義します
object
必須
  • containerRuntimeConfig
プロパティー説明

containerRuntimeConfig

object

ContainerRuntimeConfiguration は、コンテナーランタイムのチューナブルを定義します。

machineConfigPoolSelector

object

MachineConfigPoolSelector は、ContainerRuntimeConfig を適用するプールを選択します。nil セレクターを使用すると、プールは選択されません。

2.1.2. .spec.containerRuntimeConfig

説明
ContainerRuntimeConfiguration は、コンテナーランタイムのチューナブルを定義します。
object
プロパティー説明

defaultRuntime

string

defaultRuntime は、デフォルトとして使用される OCI ランタイムの名前です。

logLevel

string

logLevel は、設定されているレベルに基づいてログの詳細度を指定します。オプションは、致命的、パニック、エラー、警告、情報、およびデバッグです。

logSizeMax

integer-or-string

logSizeMax は、コンテナーログファイルに許可される最大サイズを指定します。負の数は、サイズ制限が課されていないことを示します。正の場合、conmon の読み取りバッファーと一致/超過するには >=8192 である必要があります。

overlaySize

integer-or-string

overlaySize は、コンテナーイメージの最大サイズを指定します。このフラグを使用して、コンテナーイメージのサイズにクォータを設定できます。(デフォルト:10GB)

pidsLimit

integer

pidsLimit は、コンテナーで許可されるプロセスの最大数を指定します

2.1.3. .spec.machineConfigPoolSelector

説明
MachineConfigPoolSelector は、ContainerRuntimeConfig を適用するプールを選択します。nil セレクターを使用すると、プールは選択されません。
object
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

2.1.4. .spec.machineConfigPoolSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

2.1.5. .spec.machineConfigPoolSelector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.6. .status

説明
ContainerRuntimeConfigStatus は、ContainerRuntimeConfig の監視状態を定義します
object
プロパティー説明

conditions

array

条件は、現在の状態の最新の利用可能な観測を表します。

conditions[]

object

ContainerRuntimeConfigCondition は、ContainerRuntimeConfig の状態を定義します

observedGeneration

integer

observedGeneration は、コントローラーによって監視された世代を表します。

2.1.7. .status.conditions

説明
条件は、現在の状態の最新の利用可能な観測を表します。
array

2.1.8. .status.conditions[]

説明
ContainerRuntimeConfigCondition は、ContainerRuntimeConfig の状態を定義します
object
プロパティー説明

lastTransitionTime

``

lastTransitionTime は、現在のステータスオブジェクトが最後に更新された時刻です。

message

string

message は、現在の状態に関する追加情報を提供します。これは人間によってのみ消費されます。

reason

string

reason は、条件の最後の遷移の理由です。理由は PascalCase です

status

string

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

type

string

type は、Operator の調整機能の状態を指定します。

2.2. API エンドポイント

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

  • /apis/machineconfiguration.openshift.io/v1/containerruntimeconfigs

    • DELETE:ContainerRuntimeConfig のコレクションを削除します
    • GET: 種類 ContainerRuntimeConfig のオブジェクトをリスト表示します
    • POST:ContainerRuntimeConfig を作成します
  • /apis/machineconfiguration.openshift.io/v1/containerruntimeconfigs/{name}

    • 削除:ContainerRuntimeConfig を削除します
    • GET: 指定された ContainerRuntimeConfig を読み取ります
    • PATCH: 指定された ContainerRuntimeConfig を部分的に更新します
    • PUT: 指定された ContainerRuntimeConfig を置き換えます
  • /apis/machineconfiguration.openshift.io/v1/containerruntimeconfigs/{name}/status

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

2.2.1. /apis/machineconfiguration.openshift.io/v1/containerruntimeconfigs

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

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類 ContainerRuntimeConfig のオブジェクトをリスト表示します
表2.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ContainerRuntimeConfigList schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表2.4 ボディのパラメーター
パラメーター説明

body

ContainerRuntimeConfig schema

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

200 - OK

ContainerRuntimeConfig schema

201 - Created

ContainerRuntimeConfig schema

202 - Accepted

ContainerRuntimeConfig schema

401 - Unauthorized

空白

2.2.2. /apis/machineconfiguration.openshift.io/v1/containerruntimeconfigs/{name}

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

name

string

ContainerRuntimeConfig の名前

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

dryRun

string

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

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

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

200 - OK

ContainerRuntimeConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

200 - OK

ContainerRuntimeConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表2.13 ボディのパラメーター
パラメーター説明

body

ContainerRuntimeConfig schema

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

200 - OK

ContainerRuntimeConfig schema

201 - Created

ContainerRuntimeConfig schema

401 - Unauthorized

空白

2.2.3. /apis/machineconfiguration.openshift.io/v1/containerruntimeconfigs/{name}/status

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

name

string

ContainerRuntimeConfig の名前

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

200 - OK

ContainerRuntimeConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

200 - OK

ContainerRuntimeConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表2.20 ボディのパラメーター
パラメーター説明

body

ContainerRuntimeConfig schema

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

200 - OK

ContainerRuntimeConfig schema

201 - Created

ContainerRuntimeConfig schema

401 - Unauthorized

空白

第3章 ControllerConfig [machineconfiguration.openshift.io/v1]

説明
ControllerConfig は、MachineConfigController の設定を説明しています。これは現在、TemplateController によって生成された MachineConfig オブジェクトを駆動するためにのみ使用されます。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object
必須
  • spec

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

ControllerConfigSpec は、ControllerConfig リソースの仕様です。

status

object

ControllerConfigStatus は、ControllerConfig のステータスです。

3.1.1. .spec

説明
ControllerConfigSpec は、ControllerConfig リソースの仕様です。
object
必須
  • baseOSContainerImage
  • cloudProviderConfig
  • clusterDNSIP
  • images
  • ipFamilies
  • kubeAPIServerServingCAData
  • releaseImage
  • rootCAData
プロパティー説明

additionalTrustBundle

``

additionalTrustBundle は、ノードの信頼できる証明書ストアに追加される証明書バンドルです。

baseOSContainerImage

string

BaseOSContainerImage は、オペレーティングシステムの更新用の新しい形式のコンテナーイメージです。

baseOSExtensionsContainerImage

string

BaseOSExtensionsContainerImage は、新しい形式のコンテナーに一致するエクステンションコンテナーです。

cloudProviderCAData

``

cloudProvider は、クラウドプロバイダーの CA データを指定します

cloudProviderConfig

string

cloudProviderConfig は、特定のクラウドプロバイダーの設定です

clusterDNSIP

string

clusterDNSIP は、クラスター DNSIP アドレスです。

dns

object

dns はクラスター DNS の詳細を保持します

etcdDiscoveryDomain

string

etcdDiscoveryDomain は非推奨です。代わりに、Infra.Status.EtcdDiscoveryDomain を使用してください。

imageRegistryBundleData

array

imageRegistryBundleData is the ImageRegistryData

imageRegistryBundleData[]

object

ImageRegistryBundle には、イメージレジストリー証明書を書き込むための情報が含まれています。

imageRegistryBundleUserData

array

imageRegistryBundleUserData はユーザーが提供するイメージレジストリーデータです

imageRegistryBundleUserData[]

object

ImageRegistryBundle には、イメージレジストリー証明書を書き込むための情報が含まれています。

images

object (string)

images は、コントローラーが./templates/の下にテンプレートをレンダリングするために使用するイメージのマップです。

infra

object

インフラストラクチャーの詳細を保持するインフラストラクチャー

internalRegistryPullSecret

``

internalRegistryPullSecret は内部レジストリーのプルシークレットであり、rpm-ostree が内部レジストリーからイメージをプルするために使用します (存在する場合)

ipFamilies

string

ipFamilies は、クラスターネットワークで使用されている IP ファミリーを示します

kubeAPIServerServingCAData

string

kubeAPIServerServingCAData が管理する Kubelet から API サーバー証明書へ…自動的にローテーション

network

``

ネットワークには追加のネットワーク関連情報が含まれています

networkType

string

networkType は、クラスターが XXX を使用しているネットワークのタイプを保持します。これは一時的なものであり、ネットワーク関連サービスを適切な方法で開始するためのより良いサポートのために、できるだけ早く削除されます。クラスターが最初に起動して実行されると、誰もこれを変更しないため、これが変更された場合は再生成を許可しないでください。

osImageURL

string

osImageURL は、OS 更新ペイロードを含む古い形式のコンテナーイメージです。

platform

string

プラットフォームは非推奨です。代わりに Infra.Status.PlatformStatus.Type を使用してください

proxy

``

プロキシーは、ノードの現在のプロキシー設定を保持します

pullSecret

object

pullSecret は、すべてのマシンにインストールする必要があるデフォルトのプルシークレットです。

releaseImage

string

releaseImage は、クラスターのインストール時に使用されるイメージです

rootCAData

string

rootCAData は、root CA データを指定します

3.1.2. .spec.dns

説明
dns はクラスター DNS の詳細を保持します
object
必須
  • spec
  • kind
  • apiVersion
プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind は、このオブジェクトのタイプを表す文字列値です。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 を参照してください。

3.1.3. .spec.imageRegistryBundleData

説明
imageRegistryBundleData is the ImageRegistryData
array

3.1.4. .spec.imageRegistryBundleData[]

説明
ImageRegistryBundle には、イメージレジストリー証明書を書き込むための情報が含まれています。
object
必須
  • data
  • file
プロパティー説明

data

string

data は、ファイルのロケーションに書き込まれるバンドルの内容を保持します。

file

string

file は、バンドルがディスクに書き込まれるファイルの名前を保持します

3.1.5. .spec.imageRegistryBundleUserData

説明
imageRegistryBundleUserData はユーザーが提供するイメージレジストリーデータです
array

3.1.6. .spec.imageRegistryBundleUserData[]

説明
ImageRegistryBundle には、イメージレジストリー証明書を書き込むための情報が含まれています。
object
必須
  • data
  • file
プロパティー説明

data

string

data は、ファイルのロケーションに書き込まれるバンドルの内容を保持します。

file

string

file は、バンドルがディスクに書き込まれるファイルの名前を保持します

3.1.7. .spec.infra

説明
インフラストラクチャーの詳細を保持するインフラストラクチャー
object
必須
  • spec
  • kind
  • apiVersion
プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind は、このオブジェクトのタイプを表す文字列値です。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 を参照してください。

3.1.8. .spec.pullSecret

説明
pullSecret は、すべてのマシンにインストールする必要があるデフォルトのプルシークレットです。
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.9. .status

説明
ControllerConfigStatus は、ControllerConfig のステータスです。
object
プロパティー説明

conditions

array

条件は、現在の状態の最新の利用可能な観測を表します。

conditions[]

object

ControllerConfigStatusCondition には、ControllerConfigStatus の条件情報が含まれています

controllerCertificates

array

controllerCertificates は、MCO 内の自動的にローテーションされる証明書の最新の利用可能な観測値を表します。

controllerCertificates[]

object

ControllerCertificate には特定の証明書に関する情報が含まれています。

observedGeneration

integer

observedGeneration は、コントローラーによって監視された世代を表します。

3.1.10. .status.conditions

説明
条件は、現在の状態の最新の利用可能な観測を表します。
array

3.1.11. .status.conditions[]

説明
ControllerConfigStatusCondition には、ControllerConfigStatus の条件情報が含まれています
object
必須
  • status
  • type
プロパティー説明

lastTransitionTime

``

lastTransitionTime は、現在のステータスオブジェクトが最後に更新された時刻です。

message

string

message は、現在の状態に関する追加情報を提供します。これは人間によってのみ消費されます。

reason

string

reason は、条件の最後の遷移の理由です。理由は PascalCase です

status

string

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

type

string

type は、Operator の調整機能の状態を指定します。

3.1.12. .status.controllerCertificates

説明
controllerCertificates は、MCO 内の自動的にローテーションされる証明書の最新の利用可能な観測値を表します。
array

3.1.13. .status.controllerCertificates[]

説明
ControllerCertificate には特定の証明書に関する情報が含まれています。
object
必須
  • bundleFile
  • signer
  • subject
プロパティー説明

bundleFile

string

bundleFile は証明書の元となる大きなバンドルです

notAfter

string

notAfter は有効性の上限です

notBefore

string

notBefore は有効性の下限です

signer

string

signer は証明書の Issuer です

subject

string

subject は証明書のサブジェクトです

3.2. API エンドポイント

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

  • /apis/machineconfiguration.openshift.io/v1/controllerconfigs

    • DELETE:ControllerConfig のコレクションを削除します
    • GET: 種類 ControllerConfig のオブジェクトをリスト表示します
    • POST:ControllerConfig を作成します
  • /apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}

    • 削除:ControllerConfig を削除します
    • GET: 指定された ControllerConfig を読み取ります
    • PATCH: 指定された ControllerConfig を部分的に更新します
    • PUT: 指定された ControllerConfig を置き換えます
  • /apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}/status

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

3.2.1. /apis/machineconfiguration.openshift.io/v1/controllerconfigs

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

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
ControllerConfig の種類のオブジェクトをリスト表示します
表3.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ControllerConfigList schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表3.4 ボディのパラメーター
パラメーター説明

body

ControllerConfig schema

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

200 - OK

ControllerConfig schema

201 - Created

ControllerConfig schema

202 - Accepted

ControllerConfig schema

401 - Unauthorized

空白

3.2.2. /apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}

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

name

string

ControllerConfig の名前

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

dryRun

string

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

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

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

200 - OK

ControllerConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

200 - OK

ControllerConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表3.13 ボディのパラメーター
パラメーター説明

body

ControllerConfig schema

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

200 - OK

ControllerConfig schema

201 - Created

ControllerConfig schema

401 - Unauthorized

空白

3.2.3. /apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}/status

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

name

string

ControllerConfig の名前

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

200 - OK

ControllerConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

200 - OK

ControllerConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表3.20 ボディのパラメーター
パラメーター説明

body

ControllerConfig schema

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

200 - OK

ControllerConfig schema

201 - Created

ControllerConfig schema

401 - Unauthorized

空白

第4章 ControlPlaneMachineSet [machine.openshift.io/v1]

説明
ControlPlaneMachineSet を使用すると、指定された数のコントロールプレーンマシンのレプリカが常に実行されます。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
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

ControlPlaneMachineSet は、ControlPlaneMachineSet の設定を表します。

status

object

ControlPlaneMachineSetStatus は、ControlPlaneMachineSet CRD のステータスを表します。

4.1.1. .spec

説明
ControlPlaneMachineSet は、ControlPlaneMachineSet の設定を表します。
object
必須
  • replicas
  • selector
  • template
プロパティー説明

replicas

integer

replicas は、この ControlPlaneMachineSet によって作成されるコントロールプレーンマシンの数を定義します。このフィールドはイミュータブルであり、クラスターのインストール後に変更することはできません。ControlPlaneMachineSet は 3 または 5 ノードのコントロールプレーンでのみ動作し、このフィールドの有効な値は 3 と 5 のみです。

selector

object

Machine のラベルセレクター。このセレクターによって選択された既存のマシンが、この ControlPlaneMachineSet の影響を受けるマシンになります。テンプレートのラベルと一致する必要があります。このフィールドは、リソースの作成後はイミュータブルと見なされます。

state

string

state は、ControlPlaneMachineSet がアクティブか非アクティブかを定義します。非アクティブな場合、ControlPlaneMachineSet はクラスター内のマシンの状態に対して何のアクションも実行しません。アクティブな場合、ControlPlaneMachineSet はマシンを調整し、必要に応じてマシンを更新します。ControlPlaneMachineSet は、一度アクティブになると非アクティブにすることはできません。これ以上のアクションを阻止するには、ControlPlaneMachineSet を削除してください。

strategy

object

ストラテジーは、ControlPlaneMachineSet が ProviderSpec の変更を検出したときにマシンを更新する方法を定義します。

template

object

テンプレートは、この ControlPlaneMachineSet によって作成されるコントロールプレーンマシンを記述します。

4.1.2. .spec.selector

説明
Machine のラベルセレクター。このセレクターによって選択された既存のマシンが、この ControlPlaneMachineSet の影響を受けるマシンになります。テンプレートのラベルと一致する必要があります。このフィールドは、リソースの作成後はイミュータブルと見なされます。
object
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

4.1.3. .spec.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

4.1.4. .spec.selector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

4.1.5. .spec.strategy

説明
ストラテジーは、ControlPlaneMachineSet が ProviderSpec の変更を検出したときにマシンを更新する方法を定義します。
object
プロパティー説明

type

string

type は、ControlPlaneMachineSet が所有するマシンを更新するときに使用する更新ストラテジーのタイプを定義します。有効な値は "RollingUpdate" と "OnDelete" です。現在のデフォルト値は "RollingUpdate" です。

4.1.6. .spec.template

説明
テンプレートは、この ControlPlaneMachineSet によって作成されるコントロールプレーンマシンを記述します。
object
必須
  • machineType
プロパティー説明

machineType

string

MachineType は、ControlPlaneMachineSet によって管理される必要があるマシンのタイプを決定します。現在、有効な値は machines_v1beta1_machine_openshift_io のみです。

machines_v1beta1_machine_openshift_io

object

OpenShiftMachineV1Beta1Machine は、v1beta1.machine.openshift.io API グループからマシンを作成するためのテンプレートを定義します。

4.1.7. .spec.template.machines_v1beta1_machine_openshift_io

説明
OpenShiftMachineV1Beta1Machine は、v1beta1.machine.openshift.io API グループからマシンを作成するためのテンプレートを定義します。
object
必須
  • metadata
  • spec
プロパティー説明

failureDomains

object

FailureDomains は、ControlPlaneMachineSet がコントロールプレーンマシンのバランスをとる必要がある障害ドメイン (アベイラビリティーゾーンと呼ばれる場合もある) のリストです。これは、テンプレートで指定された ProviderSpec にマージされます。配置情報を必要としないプラットフォームでは、このフィールドはオプションです。

metadata

object

ObjectMeta は標準のオブジェクトメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。ラベルは、ControlPlaneMachineSet セレクターと一致する必要があります。

spec

object

仕様には、コントロールプレーンマシンの必要な設定が含まれています。ProviderSpec には、コントロールプレーンマシンを作成するためのプラットフォーム固有の詳細が含まれています。ProviderSe は、プラットフォーム固有の障害ドメインフィールドを除いて完了している必要があります。これは、FailureDomains フィールドに基づいてマシンが作成される際にオーバーライドされます。

4.1.8. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains

説明
FailureDomains は、ControlPlaneMachineSet がコントロールプレーンマシンのバランスをとる必要がある障害ドメイン (アベイラビリティーゾーンと呼ばれる場合もある) のリストです。これは、テンプレートで指定された ProviderSpec にマージされます。配置情報を必要としないプラットフォームでは、このフィールドはオプションです。
object
必須
  • platform
プロパティー説明

aws

array

AWS は、AWS プラットフォームの障害ドメイン情報を設定します。

aws[]

object

AWSFailureDomain は、AWS プラットフォームの障害ドメイン情報を設定します。

azure

array

Azure は、Azure プラットフォームの障害ドメイン情報を設定します。

azure[]

object

AzureFailureDomain は、Azure プラットフォームの障害ドメイン情報を設定します。

gcp

array

GCP は、GCP プラットフォームの障害ドメイン情報を設定します。

gcp[]

object

GCPFailureDomain は、GCP プラットフォームの障害ドメイン情報を設定します。

nutanix

array

nutanix は、Nutanix プラットフォームの障害ドメイン情報を設定します。

nutanix[]

object

NutanixFailureDomainReference は、Nutanix プラットフォームの障害ドメインを参照します。

openstack

array

OpenStack は、OpenStack プラットフォームの障害ドメイン情報を設定します。

openstack[]

object

OpenStackFailureDomain は、OpenStack プラットフォームの障害ドメイン情報を設定します。

platform

string

プラットフォームは、FailureDomain が表すプラットフォームを識別します。現在サポートされている値は、AWS、Azure、GCP、OpenStack、VSphere、Nutanix です。

vsphere

array

vsphere は、VSphere プラットフォームの障害ドメイン情報を設定します。

vsphere[]

object

VSphereFailureDomain は、vSphere プラットフォームの障害ドメイン情報を設定します

4.1.9. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws

説明
AWS は、AWS プラットフォームの障害ドメイン情報を設定します。
array

4.1.10. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[]

説明
AWSFailureDomain は、AWS プラットフォームの障害ドメイン情報を設定します。
object
プロパティー説明

placement

object

placement は、このインスタンスの配置情報を設定します。

subnet

object

subnet は、このインスタンスに使用するサブネットへの参照です。

4.1.11. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[].placement

説明
placement は、このインスタンスの配置情報を設定します。
object
必須
  • availabilityZone
プロパティー説明

availabilityZone

string

AvailabilityZone はインスタンスのアベイラビリティーゾーンです。

4.1.12. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[].subnet

説明
subnet は、このインスタンスに使用するサブネットへの参照です。
object
必須
  • type
プロパティー説明

arn

string

リソースの ARN。

filters

array

filters は、リソースを識別するために使用されるフィルターのセットです。

filters[]

object

AWSResourceFilter は、AWS リソースを識別するために使用されるフィルターです

id

string

リソースの ID。

type

string

タイプは、参照が AWS リソースを取得する方法を決定します。

4.1.13. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[].subnet.filters

説明
filters は、リソースを識別するために使用されるフィルターのセットです。
array

4.1.14. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[].subnet.filters[]

説明
AWSResourceFilter は、AWS リソースを識別するために使用されるフィルターです
object
必須
  • name
プロパティー説明

name

string

フィルターの名前。フィルター名では大文字と小文字が区別されます。

values

array (string)

値には 1 つ以上のフィルター値が含まれます。フィルター値では大文字と小文字が区別されます。

4.1.15. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.azure

説明
Azure は、Azure プラットフォームの障害ドメイン情報を設定します。
array

4.1.16. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.azure[]

説明
AzureFailureDomain は、Azure プラットフォームの障害ドメイン情報を設定します。
object
必須
  • zone
プロパティー説明

subnet

string

subnet は、仮想マシンが作成されるネットワークサブネットの名前です。省略した場合は、マシンの providerSpec テンプレートのサブネット値が使用されます。

zone

string

仮想マシンのアベイラビリティーゾーン。nil の場合、仮想マシンはどのゾーンにもデプロイされません。

4.1.17. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.gcp

説明
GCP は、GCP プラットフォームの障害ドメイン情報を設定します。
array

4.1.18. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.gcp[]

説明
GCPFailureDomain は、GCP プラットフォームの障害ドメイン情報を設定します。
object
必須
  • zone
プロパティー説明

zone

string

ゾーンは、GCP マシンプロバイダーが仮想マシンを作成するゾーンです。

4.1.19. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.nutanix

説明
nutanix は、Nutanix プラットフォームの障害ドメイン情報を設定します。
array

4.1.20. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.nutanix[]

説明
NutanixFailureDomainReference は、Nutanix プラットフォームの障害ドメインを参照します。
object
必須
  • name
プロパティー説明

name

string

nutanix マシンプロバイダーが仮想マシンを作成する障害ドメインの名前。障害ドメインは、クラスターの config.openshift.io/Infrastructure リソースで定義されます。

4.1.21. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.openstack

説明
OpenStack は、OpenStack プラットフォームの障害ドメイン情報を設定します。
array

4.1.22. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.openstack[]

説明
OpenStackFailureDomain は、OpenStack プラットフォームの障害ドメイン情報を設定します。
object
プロパティー説明

availabilityZone

string

availabilityZone は、OpenStack マシンプロバイダーが仮想マシンを作成する nova アベイラビリティーゾーンです。指定しない場合、仮想マシンは nova 設定で指定されたデフォルトのアベイラビリティーゾーンに作成されます。アベイラビリティーゾーン名には : を含めることはできません。これは、サーバー作成時にインスタンスが起動されるホストを指定するために管理者ユーザーが使用するためです。また、スペースを含めることはできません。スペースを含めると、このアベイラビリティーゾーンに属するノードの登録が失敗します。詳細は、kubernetes/cloud-provider-openstack#1379 を参照してください。ラベルの制限により、アベイラビリティーゾーン名の最大長は 63 です。

rootVolume

object

rootVolume には、OpenStack マシンプロバイダーが仮想マシンに接続された root ボリュームを作成するために使用する設定が含まれています。指定されない場合は、root ボリュームは作成されません。

4.1.23. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.openstack[].rootVolume

説明
rootVolume には、OpenStack マシンプロバイダーが仮想マシンに接続された root ボリュームを作成するために使用する設定が含まれています。指定されない場合は、root ボリュームは作成されません。
object
必須
  • volumeType
プロパティー説明

availabilityZone

string

availabilityZone は、root ボリュームが作成される Cinder アベイラビリティーゾーンを指定します。指定しない場合は、cinder 設定のボリュームタイプで指定されたアベイラビリティーゾーンに root ボリュームが作成されます。ボリュームタイプ (OpenStack クラスターで設定) でアベイラビリティーゾーンが指定されていない場合、root ボリュームは cinder 設定で指定されたデフォルトのアベイラビリティーゾーンに作成されます。詳細は、https://docs.openstack.org/cinder/latest/admin/availability-zone-type.html を参照してください。cross_az_attach 設定オプションを false に設定して OpenStack クラスターをデプロイする場合、root ボリュームは、仮想マシンと同じアベイラビリティーゾーン (OpenStackFailureDomain.AvailabilityZone によって定義) に配置される必要があります。アベイラビリティーゾーン名にはスペースを含めることはできません。スペースを含めると、このアベイラビリティーゾーンに属するボリュームの登録が失敗します。詳細は、kubernetes/cloud-provider-openstack#1379 を参照してください。ラベルの制限により、アベイラビリティーゾーン名の最大長は 63 です。

volumeType

string

volumeType は、プロビジョニングされる root ボリュームのタイプを指定します。ボリュームタイプ名の最大長は、OpenStack の制限に従って 255 文字です。

4.1.24. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.vsphere

説明
vsphere は、VSphere プラットフォームの障害ドメイン情報を設定します。
array

4.1.25. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.vsphere[]

説明
VSphereFailureDomain は、vSphere プラットフォームの障害ドメイン情報を設定します
object
必須
  • name
プロパティー説明

name

string

vSphere マシンプロバイダーが仮想マシンを作成する障害ドメインの名前。障害ドメインは、クラスターの config.openshift.io/Infrastructure リソースで定義されます。障害ドメイン間でマシンのバランスをとる場合、コントロールプレーンマシンセットは、インフラストラクチャーリソースからマシンの providerSpec に設定を注入して、マシンを障害ドメインに割り当てます。

4.1.26. .spec.template.machines_v1beta1_machine_openshift_io.metadata

説明
ObjectMeta は標準のオブジェクトメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。ラベルは、ControlPlaneMachineSet セレクターと一致する必要があります。
object
必須
  • labels
プロパティー説明

annotations

object (string)

アノテーションは、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations

labels

object (string)

オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labelsこのフィールドには、'machine.openshift.io/cluster-api-machine-role' ラベルおよび 'machine.openshift.io/cluster-api-machine-type' ラベルの両方が含まれ、両方の値は 'master' である必要があります。また、'machine.openshift.io/cluster-api-cluster' キーを持つラベルも含まれている必要があります。

4.1.27. .spec.template.machines_v1beta1_machine_openshift_io.spec

説明
仕様には、コントロールプレーンマシンの必要な設定が含まれています。ProviderSpec には、コントロールプレーンマシンを作成するためのプラットフォーム固有の詳細が含まれています。ProviderSe は、プラットフォーム固有の障害ドメインフィールドを除いて完了している必要があります。これは、FailureDomains フィールドに基づいてマシンが作成される際にオーバーライドされます。
object
プロパティー説明

lifecycleHooks

object

lifecycleHooks を使用すると、ユーザーはマシンのライフサイクル内の特定の定義済みポイントでマシン上の操作を一時停止できます。

metadata

object

ObjectMeta は、作成されたノードに自動入力します。これを使用して、ノードの作成時に使用するラベル、アノテーション、名前接頭辞などを示します。

providerID

string

providerID は、プロバイダーによって提供されたマシンの ID です。このフィールドは、このマシンに対応するノードオブジェクトに表示されるプロバイダー ID と一致する必要があります。このフィールドは、cluster-api の上位レベルのコンシューマーに必要です。ユースケースの例は、プロバイダーとして cluster-api を使用するクラスターオートスケーラーです。オートスケーラーのクリーンアップロジックは、マシンをノードと比較して、Kubernetes ノードとして登録できなかったプロバイダーのマシンを見つけます。オートスケーラーの一般的なツリー外プロバイダーとして cluster-api を使用する場合、このフィールドは、マシンのリストのプロバイダービューを持つことができるようにするためにオートスケーラーによって必要とされます。k8s apiserver からノードの別のリストが照会され、比較が行われて未登録のマシンが検出され、削除のマークが付けられます。このフィールドはアクチュエーターによって設定され、汎用プロバイダーとして cluster-api とインターフェイスするオートスケーラーなどの高レベルのエンティティーによって消費されます。

providerSpec

object

ProviderSpec の詳細ノードの作成中に使用するプロバイダー固有の設定。

taints

array

対応するノードに追加的に適用されるテイントのリスト。このリストは、他のエンティティーによって継続的にノードに追加された他のテイントを上書きしません。これらのテイントは積極的に調整する必要があります。たとえば、マシンコントローラーにテイントを適用するように依頼し、手動でテイントを除去すると、マシンコントローラーはテイントを元に戻します)、マシンコントローラーにテイントを除去させないでください。

taints[]

object

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

4.1.28. .spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks

説明
lifecycleHooks を使用すると、ユーザーはマシンのライフサイクル内の特定の定義済みポイントでマシン上の操作を一時停止できます。
object
プロパティー説明

preDrain

array

PreDrain フックは、マシンのドレインを阻止します。これにより、終了などのライフサイクルイベントもさらにブロックされます。

preDrain[]

object

lifecycleHook はライフサイクルフックの単一インスタンスを表します。

preTerminate

array

preTerminate フックはマシンが終了するのを防ぎます。preTerminate フックは、マシンがドレインされた後に実行されます。

preTerminate[]

object

lifecycleHook はライフサイクルフックの単一インスタンスを表します。

4.1.29. .spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks.preDrain

説明
PreDrain フックは、マシンのドレインを阻止します。これにより、終了などのライフサイクルイベントもさらにブロックされます。
array

4.1.30. .spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks.preDrain[]

説明
lifecycleHook はライフサイクルフックの単一インスタンスを表します。
object
必須
  • name
  • owner
プロパティー説明

name

string

name はライフサイクルフックの一意の名前を定義します。名前は一意でわかりやすく、理想的には 1 - 3 語で CamelCase で表記する必要がありますが、名前空間を使用することもできます (例: foo.example.com/CamelCase)。名前は一意である必要があり、単一のエンティティーによってのみ管理される必要があります。

owner

string

owner は、ライフサイクルフックの所有者を定義します。これは、ライフサイクルをブロックしているのが誰であるかをユーザーが識別できるように、わかるように説明してある必要があります。これは、コントローラーの名前 (例: clusteroperator/etcd) またはフックを管理する管理者の名前である可能性があります。

4.1.31. .spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks.preTerminate

説明
preTerminate フックはマシンが終了するのを防ぎます。preTerminate フックは、マシンがドレインされた後に実行されます。
array

4.1.32. .spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks.preTerminate[]

説明
lifecycleHook はライフサイクルフックの単一インスタンスを表します。
object
必須
  • name
  • owner
プロパティー説明

name

string

name はライフサイクルフックの一意の名前を定義します。名前は一意でわかりやすく、理想的には 1 - 3 語で CamelCase で表記する必要がありますが、名前空間を使用することもできます (例: foo.example.com/CamelCase)。名前は一意である必要があり、単一のエンティティーによってのみ管理される必要があります。

owner

string

owner は、ライフサイクルフックの所有者を定義します。これは、ライフサイクルをブロックしているのが誰であるかをユーザーが識別できるように、わかるように説明してある必要があります。これは、コントローラーの名前 (例: clusteroperator/etcd) またはフックを管理する管理者の名前である可能性があります。

4.1.33. .spec.template.machines_v1beta1_machine_openshift_io.spec.metadata

説明
ObjectMeta は、作成されたノードに自動入力します。これを使用して、ノードの作成時に使用するラベル、アノテーション、名前接頭辞などを示します。
object
プロパティー説明

annotations

object (string)

アノテーションは、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations

generateName

string

generateName は、Name フィールドが指定されていない場合に限り一意の名前を生成するためにサーバーが使用するオプションの接頭辞です。このフィールドを使用する場合、クライアントに返される名前は渡された名前とは異なります。この値は、一意の接尾辞とも組み合わされます。提供された値には、名前フィールドと同じ検証ルールがあり、サーバー上で値を一意にするために必要な接尾辞の長さで切り捨てられる場合があります。このフィールドが指定されており、生成された名前が存在する場合、サーバーは 409 を返しません。代わりに、割り当てられた時間内に一意の名前が見つからなかったことを示す Reason ServerTimeout で 201 Created または 500 を返します。クライアントは再試行する必要があります (オプションで、Retry-After ヘッダーに示されている時間の後)。Name が指定されていない場合にのみ適用されます。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

labels

object (string)

オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labels

name

string

name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これを更新することはできません。詳細: http://kubernetes.io/docs/user-guide/identifiers#names

namespace

string

名前空間は、各名前内のスペースが一意である必要があることを定義します。空の namespace は "default" の namespace と同じですが、"default" は正規表現です。すべてのオブジェクトを namespace のスコープに設定する必要はありません。それらのオブジェクトでは、このフィールドの値は空になります。DNS_LABEL である必要があります。これを更新することはできません。詳細: http://kubernetes.io/docs/user-guide/namespaces

ownerReferences

array

このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。

ownerReferences[]

object

OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ名前空間にあるか、クラスタースコープである必要があるため、名前空間フィールドはありません。

4.1.34. .spec.template.machines_v1beta1_machine_openshift_io.spec.metadata.ownerReferences

説明
このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。
array

4.1.35. .spec.template.machines_v1beta1_machine_openshift_io.spec.metadata.ownerReferences[]

説明
OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ名前空間にあるか、クラスタースコープである必要があるため、名前空間フィールドはありません。
object
必須
  • apiVersion
  • kind
  • name
  • uid
プロパティー説明

apiVersion

string

参照先の API バージョン。

blockOwnerDeletion

boolean

true の場合、および所有者が "foregroundDeletion" ファイナライザーを持っている場合、この参照が削除されるまで、所有者を Key-Value ストアから削除することはできません。ガベージコレクターがこのフィールドと対話し、フォアグラウンドを強制的に削除する方法は、https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion を参照してください。デフォルトは false です。このフィールドを設定するには、ユーザーは所有者の "削除" 権限を必要とします。そうしないと、422 (処理不能エンティティー) が返されます。

controller

boolean

true の場合、この参照は管理コントローラーを指します。

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

uid

string

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

4.1.36. .spec.template.machines_v1beta1_machine_openshift_io.spec.providerSpec

説明
ProviderSpec の詳細ノードの作成中に使用するプロバイダー固有の設定。
object
プロパティー説明

value

``

値は、リソース設定のインライン化されたシリアル化された表現です。プロバイダーは、コンポーネント設定と同様に、このフィールドからシリアル化/逆シリアル化する必要がある独自のバージョン管理された API タイプを維持することを推奨します。

4.1.37. .spec.template.machines_v1beta1_machine_openshift_io.spec.taints

説明
対応するノードに追加的に適用されるテイントのリスト。このリストは、他のエンティティーによって継続的にノードに追加された他のテイントを上書きしません。これらのテイントは積極的に調整する必要があります。たとえば、マシンコントローラーにテイントを適用するように依頼し、手動でテイントを除去すると、マシンコントローラーはテイントを元に戻します)、マシンコントローラーにテイントを除去させないでください。
array

4.1.38. .spec.template.machines_v1beta1_machine_openshift_io.spec.taints[]

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

effect

string

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

key

string

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

timeAdded

string

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

value

string

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

4.1.39. .status

説明
ControlPlaneMachineSetStatus は、ControlPlaneMachineSet CRD のステータスを表します。
object
プロパティー説明

conditions

array

条件は、ControlPlaneMachineSet の現在の状態の観察を表します。既知の .status.conditions.type は、Available、Degraded、および Progressing です。

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 }

observedGeneration

integer

observedGeneration は、この ControlPlaneMachineSet で観測された最新の世代です。これは、API サーバーによる変更時に更新される ControlPlaneMachineSets の世代に対応します。

readyReplicas

integer

ReadyReplicas は、ControlPlaneMachineSet コントローラーによって作成され、準備が完了したコントロールプレーンマシンの数です。ローリング更新の進行中は、この値が希望するレプリカ数よりも高くなる可能性があることに注意してください。

replicas

integer

replicas は、ControlPlaneMachineSet コントローラーによって作成されたコントロールプレーンマシンの数です。更新操作中、この値は必要なレプリカ数と異なる場合があることに注意してください。

unavailableReplicas

integer

unavailableReplicas は、ControlPlaneMachineSet が必要とする使用可能な容量に達するまでに引き続き必要なコントロールプレーンマシンの数です。この値がゼロ以外の場合、ReadyReplicas の数は必要なレプリカの数よりも少なくなります。

updatedReplicas

integer

updatedReplicas は、ControlPlaneMachineSet コントローラーによって作成され、必要なプロバイダー仕様を持ち、準備ができている、終了していないコントロールプレーンマシンの数です。目的の仕様への変更が検出されると、この値は 0 に設定されます。更新ストラテジーが RollingUpdate の場合、これはマシンの更新プロセスの開始と同時に行われます。更新ストラテジーが OnDelete の場合、ユーザーが既存のレプリカを削除し、その置き換えが準備されるまで、この値は 0 のままになります。

4.1.40. .status.conditions

説明
条件は、ControlPlaneMachineSet の現在の状態の観察を表します。既知の .status.conditions.type は、Available、Degraded、および Progressing です。
array

4.1.41. .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) です。

4.2. API エンドポイント

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

  • /apis/machine.openshift.io/v1/controlplanemachinesets

    • GET: kind が ControlPlaneMachineSet のオブジェクトをリスト表示します
  • /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets

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

    • DELETE: ControlPlaneMachineSet を削除します
    • GET : 指定された ControlPlaneMachineSet を読み取ります
    • PATCH: 指定された ControlPlaneMachineSet を部分的に更新します
    • PUT: 指定された ControlPlaneMachineSet を置き換えます
  • /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets/{name}/scale

    • GET: 指定された ControlPlaneMachineSet のスケールを読み取ります
    • PATCH: 指定された ControlPlaneMachineSet のスケールを部分的に更新します
    • PUT: 指定された ControlPlaneMachineSet のスケールを置き換えます
  • /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets/{name}/status

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

4.2.1. /apis/machine.openshift.io/v1/controlplanemachinesets

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

200 - OK

ControlPlaneMachineSetList schema

401 - Unauthorized

空白

4.2.2. /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets

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

200 - OK

Status スキーマ

401 - Unauthorized

空白

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

200 - OK

ControlPlaneMachineSetList schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

body

ControlPlaneMachineSet schema

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

200 - OK

ControlPlaneMachineSet schema

201 - Created

ControlPlaneMachineSet schema

202 - Accepted

ControlPlaneMachineSet schema

401 - Unauthorized

空白

4.2.3. /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets/{name}

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

name

string

ControlPlaneMachineSet の名前

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

dryRun

string

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

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

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

200 - OK

ControlPlaneMachineSet schema

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された ControlPlaneMachineSet を部分的に更新します
表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

ControlPlaneMachineSet schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

body

ControlPlaneMachineSet schema

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

200 - OK

ControlPlaneMachineSet schema

201 - Created

ControlPlaneMachineSet schema

401 - Unauthorized

空白

4.2.4. /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets/{name}/scale

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

name

string

ControlPlaneMachineSet の名前

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

200 - OK

Scale スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された ControlPlaneMachineSet のスケールを部分的に更新します
表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

Scale スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

body

Scale スキーマ

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

200 - OK

Scale スキーマ

201 - Created

Scale スキーマ

401 - Unauthorized

空白

4.2.5. /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets/{name}/status

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

name

string

ControlPlaneMachineSet の名前

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

200 - OK

ControlPlaneMachineSet schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

200 - OK

ControlPlaneMachineSet schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表4.28 ボディのパラメーター
パラメーター説明

body

ControlPlaneMachineSet schema

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

200 - OK

ControlPlaneMachineSet schema

201 - Created

ControlPlaneMachineSet schema

401 - Unauthorized

空白

第5章 KubeletConfig [machineconfiguration.openshift.io/v1]

説明
KubeletConfig は、カスタマイズされた Kubelet 設定を説明します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object
必須
  • spec

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

KubeletConfigSpec は、KubeletConfig の目的の状態を定義します

status

object

KubeletConfigStatus は、KubeletConfig の監視状態を定義します

5.1.1. .spec

説明
KubeletConfigSpec は、KubeletConfig の目的の状態を定義します
object
プロパティー説明

autoSizingReserved

boolean

 

kubeletConfig

``

kubeletConfig フィールドは、kubernetes アップストリームで定義されます。アップストリーム kubernetes の OpenShift で使用されるバージョン/コミットで定義されているタイプを参照してください。kubelet 設定のフィールドはアップストリームから直接フェッチされるため、これらの値の検証は kubelet によって直接処理されることに注意してください。これらのフィールドの有効な値は、関連する kubernetes のアップストリームバージョンを参照してください。kubelet 設定フィールドの値が無効な場合、クラスターノードが使用できなくなる可能性があります。

logLevel

integer

 

machineConfigPoolSelector

object

MachineConfigPoolSelector は、KubeletConfig を適用するプールを選択します。nil セレクターを使用すると、プールは選択されません。

tlsSecurityProfile

object

設定されていない場合、デフォルトは apiservers.config.openshift.io/cluster リソースに基づいています。現在サポートされているのは Old および Intermediate プロファイルのみであり、使用可能な minTLSVersion の最大バージョンは VersionTLS12 であることに注意してください。

5.1.2. .spec.machineConfigPoolSelector

説明
MachineConfigPoolSelector は、KubeletConfig を適用するプールを選択します。nil セレクターを使用すると、プールは選択されません。
object
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

5.1.3. .spec.machineConfigPoolSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

5.1.4. .spec.machineConfigPoolSelector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

5.1.5. .spec.tlsSecurityProfile

説明
設定されていない場合、デフォルトは apiservers.config.openshift.io/cluster リソースに基づいています。現在サポートされているのは Old および Intermediate プロファイルのみであり、使用可能な minTLSVersion の最大バージョンは VersionTLS12 であることに注意してください。
object
プロパティー説明

custom

``

custom は、ユーザー定義の TLS セキュリティープロファイルです。無効な設定は壊滅的である可能性があるため、カスタムプロファイルの使用には細心の注意を払ってください。カスタムプロファイルの例は次のようになります。暗号: - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 minTLSVersion: VersionTLS11

intermediate

``

intermediate は、https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29 に基づく TLS セキュリティープロファイルであり、次のようになります (yaml)。暗号: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - DHE-RSA-AES128-GCM-SHA256 - DHE-RSA-AES256-GCM-SHA384 minTLSVersion: VersionTLS12

modern

``

modern は、https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility に基づく TLS セキュリティープロファイルであり、次のようになります (yaml): 暗号: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 minTLSVersion: VersionTLS13

old

``

old は https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility に基づくセキュリティープロファイルであり、次のようになります (yaml)。暗号: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - DHE-RSA-AES128-GCM-SHA256 - DHE-RSA-AES256-GCM-SHA384 - DHE-RSA-CHACHA20-POLY1305 - ECDHE-ECDSA-AES128-SHA256 - ECDHE-RSA-AES128-SHA256 - ECDHE-ECDSA-AES128-SHA - ECDHE-RSA-AES128-SHA - ECDHE-ECDSA-AES256-SHA384 - ECDHE-RSA-AES256-SHA384 - ECDHE-ECDSA-AES256-SHA - ECDHE-RSA-AES256-SHA - DHE-RSA-AES128-SHA256 - DHE-RSA-AES256-SHA256 - AES128-GCM-SHA256 - AES256-GCM-SHA384 - AES128-SHA256 - AES256-SHA256 - AES128-SHA - AES256-SHA - DES-CBC3-SHA minTLSVersion: VersionTLS10

type

string

タイプは、Old、Intermediate、Modern、または Custom のいずれかです。カスタムは、個々の TLS セキュリティープロファイルパラメーターを指定する機能を提供します。Old、Intermediate、Modern は、以下に基づく TLS セキュリティープロファイルです https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations プロファイルはインテントベースであるため、新しい暗号が開発され、既存の暗号が安全ではありません。プロセスで使用できる暗号の正確さに応じて、リストが削減される場合があります。Modern プロファイルは、一般的なソフトウェアライブラリーでまだ十分に採用されていないため、現在サポートされていないことに注意してください。

5.1.6. .status

説明
KubeletConfigStatus は、KubeletConfig の監視状態を定義します
object
プロパティー説明

conditions

array

条件は、現在の状態の最新の利用可能な観測を表します。

conditions[]

object

KubeletConfigCondition は、KubeletConfig の状態を定義します

observedGeneration

integer

observedGeneration は、コントローラーによって監視された世代を表します。

5.1.7. .status.conditions

説明
条件は、現在の状態の最新の利用可能な観測を表します。
array

5.1.8. .status.conditions[]

説明
KubeletConfigCondition は、KubeletConfig の状態を定義します
object
プロパティー説明

lastTransitionTime

``

lastTransitionTime は、現在のステータスオブジェクトが最後に更新された時刻です。

message

string

message は、現在の状態に関する追加情報を提供します。これは人間によってのみ消費されます。

reason

string

reason は、条件の最後の遷移の理由です。理由は PascalCase です

status

string

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

type

string

type は、Operator の調整機能の状態を指定します。

5.2. API エンドポイント

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

  • /apis/machineconfiguration.openshift.io/v1/kubeletconfigs

    • DELETE:KubeletConfig のコレクションを削除します
    • GET: 種類 KubeletConfig のオブジェクトをリスト表示します
    • POST:KubeletConfig を作成します
  • /apis/machineconfiguration.openshift.io/v1/kubeletconfigs/{name}

    • 削除:KubeletConfig を削除します
    • GET: 指定された KubeletConfig を読み取ります
    • PATCH: 指定された KubeletConfig を部分的に更新します
    • PUT: 指定された KubeletConfig を置き換えます
  • /apis/machineconfiguration.openshift.io/v1/kubeletconfigs/{name}/status

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

5.2.1. /apis/machineconfiguration.openshift.io/v1/kubeletconfigs

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

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類 KubeletConfig のオブジェクトをリスト表示します
表5.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

KubeletConfigList schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表5.4 ボディのパラメーター
パラメーター説明

body

KubeletConfig schema

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

200 - OK

KubeletConfig schema

201 - Created

KubeletConfig schema

202 - Accepted

KubeletConfig schema

401 - Unauthorized

空白

5.2.2. /apis/machineconfiguration.openshift.io/v1/kubeletconfigs/{name}

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

name

string

KubeletConfig の名前。

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

dryRun

string

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

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

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

200 - OK

KubeletConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

200 - OK

KubeletConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表5.13 ボディのパラメーター
パラメーター説明

body

KubeletConfig schema

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

200 - OK

KubeletConfig schema

201 - Created

KubeletConfig schema

401 - Unauthorized

空白

5.2.3. /apis/machineconfiguration.openshift.io/v1/kubeletconfigs/{name}/status

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

name

string

KubeletConfig の名前。

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

200 - OK

KubeletConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

200 - OK

KubeletConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表5.20 ボディのパラメーター
パラメーター説明

body

KubeletConfig schema

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

200 - OK

KubeletConfig schema

201 - Created

KubeletConfig schema

401 - Unauthorized

空白

第6章 MachineConfig [machineconfiguration.openshift.io/v1]

説明
MachineConfig は、マシンの互換性レベル 1 の設定を定義します。メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース内 (いずれか長い方) で安定しています。
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

MachineConfigSpec は、MachineConfig の仕様です。

6.1.1. .spec

説明
MachineConfigSpec は、MachineConfig の仕様です。
object
プロパティー説明

baseOSExtensionsContainerImage

string

baseOSExtensionsContainerImage は、新しい形式の OS イメージに一致するエクステンションコンテナーを取得するために使用されるリモートロケーションを指定します。

config

``

config は Ignition Config オブジェクトです。

extensions

array (string)

extensions には、ホストで有効にできる追加機能のリストが含まれています

fips

boolean

fips は FIPS モードを制御します

kernelArguments

``

kernelArguments には、追加するカーネル引数のリストが含まれています

kernelType

string

kernelType には、デフォルト (従来型)、リアルタイム、64k ページ (aarch64 のみ) など、実行するカーネルが含まれます。

osImageURL

string

osImageURL は、OS を取得するために使用されるリモートロケーションを指定します。

6.2. API エンドポイント

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

  • /apis/machineconfiguration.openshift.io/v1/machineconfigs

    • DELETE:MachineConfig のコレクションを削除します
    • GET: 種類の MachineConfig のオブジェクトをリスト表示します
    • POST:MachineConfig を作成します
  • /apis/machineconfiguration.openshift.io/v1/machineconfigs/{name}

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

6.2.1. /apis/machineconfiguration.openshift.io/v1/machineconfigs

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

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
MachineConfig の種類のオブジェクトをリスト表示します
表6.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

MachineConfigList schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表6.4 ボディのパラメーター
パラメーター説明

body

MachineConfig schema

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

200 - OK

MachineConfig schema

201 - Created

MachineConfig schema

202 - Accepted

MachineConfig schema

401 - Unauthorized

空白

6.2.2. /apis/machineconfiguration.openshift.io/v1/machineconfigs/{name}

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

name

string

MachineConfig の名前

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

dryRun

string

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

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

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

200 - OK

MachineConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

200 - OK

MachineConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表6.13 ボディのパラメーター
パラメーター説明

body

MachineConfig schema

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

200 - OK

MachineConfig schema

201 - Created

MachineConfig schema

401 - Unauthorized

空白

第7章 MachineConfigPool [machineconfiguration.openshift.io/v1]

説明
MachineConfigPool は、MachineConfig のプールを説明します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object
必須
  • spec

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

MachineConfigPoolSpec は、MachineConfigPool リソースの仕様です。

status

object

MachineConfigPoolStatus は、MachineConfigPool リソースのステータスです。

7.1.1. .spec

説明
MachineConfigPoolSpec は、MachineConfigPool リソースの仕様です。
object
プロパティー説明

設定

object

マシン設定プールのターゲットとなる MachineConfig オブジェクト。

machineConfigSelector

object

machineConfigSelector は、MachineConfigs のラベルセレクターを指定します。ラベルとセレクターの動作は、https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ を参照してください。

maxUnavailable

integer-or-string

maxUnavailable は、更新中に使用不可になる可能性のあるプール内のノードの整数の数またはパーセンテージを定義します。これには、ユーザーが開始した遮断、障害のあるノードなど、何らかの理由で使用できないノードが含まれます。デフォルト値は 1 です。値が 1 より大きい場合、更新中に複数のノードが使用できなくなるため、残りのノードのワークロードのストレスに影響する可能性があります。この値を 0 に設定して更新を停止することはできません (デフォルトで 1 に戻ります)。更新を停止するには、代わりに 'paused' プロパティーを使用します。ドレインは、maxUnavailable が 1 より大きい場合でも、etcd クォーラムガードなどの Pod Disruption Budget (PDB) を尊重します。

nodeSelector

object

nodeSelector は、マシンのラベルセレクターを指定します

paused

boolean

paused は、このマシン設定プールへの変更を停止するかどうかを指定します。これには、新しい desiredMachineConfig の生成とマシンの更新が含まれます。

7.1.2. .spec.configuration

説明
マシン設定プールのターゲットとなる MachineConfig オブジェクト。
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

source

array

source は、content で指定された単一の MachineConfig オブジェクトを生成するために使用された MachineConfig オブジェクトのリストです。

source[]

object

ObjectReference には、参照先のオブジェクトを検査または変更するのに十分な情報が含まれています。--- API に埋め込まれた場合、使用方法を説明するのが難しいため、このタイプの新しい使用は推奨されません。1. 無視されたフィールド。一般的には尊重されない多くの分野が含まれます。たとえば、ResourceVersion と FieldPath はどちらも実際の使用ではほとんど有効ではありません。2. 使用法のヘルプが無効です。個別の使用状況に応じた具体的なヘルプを追加することはできません。ほとんどの埋め込みの使用法では、「タイプ A と B のみを参照する必要がある」または「UID は尊重されない」、「名前を制限する必要がある」などの特定の制限があります。埋め込まれると、それらはうまく説明できません。3. 検証に一貫性がありません。使用方法が異なるため、検証ルールも使用方法によって異なり、何が起こるかをユーザーが予測することが難しくなります。4. フィールドは不正確であると同時に過度に正確です。kind は URL への正確なマッピングではありません。これにより、解釈中に曖昧さが生じる可能性があり、REST マッピングが必要になります。ほとんどの場合、依存関係はグループ、リソースのタプルにあり、実際の構造体のバージョンは無関係です。5. 簡単に変えることはできません。このタイプは多くのロケーションに埋め込まれているため、このタイプを更新すると、多数のスキーマに影響します。新しい API に、制御できない指定が不十分な API タイプを埋め込まないでください。この型を使用する代わりに、参照に重点を置いた、ローカルで提供および使用される型を作成します。たとえば、アドミッション登録の ServiceReferences の場合: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533

uid

string

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

7.1.3. .spec.configuration.source

説明
source は、content で指定された単一の MachineConfig オブジェクトを生成するために使用された MachineConfig オブジェクトのリストです。
array

7.1.4. .spec.configuration.source[]

説明
ObjectReference には、参照先のオブジェクトを検査または変更するのに十分な情報が含まれています。--- API に埋め込まれた場合、使用方法を説明するのが難しいため、このタイプの新しい使用は推奨されません。1. 無視されたフィールド。一般的には尊重されない多くの分野が含まれます。たとえば、ResourceVersion と FieldPath はどちらも実際の使用ではほとんど有効ではありません。2. 使用法のヘルプが無効です。個別の使用状況に応じた具体的なヘルプを追加することはできません。ほとんどの埋め込みの使用法では、「タイプ A と B のみを参照する必要がある」または「UID は尊重されない」、「名前を制限する必要がある」などの特定の制限があります。埋め込まれると、それらはうまく説明できません。3. 検証に一貫性がありません。使用方法が異なるため、検証ルールも使用方法によって異なり、何が起こるかをユーザーが予測することが難しくなります。4. フィールドは不正確であると同時に過度に正確です。kind は URL への正確なマッピングではありません。これにより、解釈中に曖昧さが生じる可能性があり、REST マッピングが必要になります。ほとんどの場合、依存関係はグループ、リソースのタプルにあり、実際の構造体のバージョンは無関係です。5. 簡単に変えることはできません。このタイプは多くのロケーションに埋め込まれているため、このタイプを更新すると、多数のスキーマに影響します。新しい API に、制御できない指定が不十分な API タイプを埋め込まないでください。この型を使用する代わりに、参照に重点を置いた、ローカルで提供および使用される型を作成します。たとえば、アドミッション登録の ServiceReferences の場合: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533
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

7.1.5. .spec.machineConfigSelector

説明
machineConfigSelector は、MachineConfigs のラベルセレクターを指定します。ラベルとセレクターの動作は、https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ を参照してください。
object
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

7.1.6. .spec.machineConfigSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

7.1.7. .spec.machineConfigSelector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

7.1.8. .spec.nodeSelector

説明
nodeSelector は、マシンのラベルセレクターを指定します
object
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

7.1.9. .spec.nodeSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

7.1.10. .spec.nodeSelector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

7.1.11. .status

説明
MachineConfigPoolStatus は、MachineConfigPool リソースのステータスです。
object
プロパティー説明

certExpirys

array

certExpirys は重要な証明書の有効期限データを記録します

certExpirys[]

object

ceryExpiry にはバンドル名と有効期限が含まれます

conditions

array

条件は、現在の状態の最新の利用可能な観測を表します。

conditions[]

object

MachineConfigPoolCondition には、MachineConfigPool の条件情報が含まれています。

設定

object

configuration は、マシン設定プールの現在の MachineConfig オブジェクトを表します。

degradedMachineCount

integer

degradedMachineCount は、degraded (または unreconcilable) とマークされたマシンの総数を表します。設定の適用に失敗した場合、ノードは劣化としてマークされます。

machineCount

integer

machineCount は、マシン設定プール内のマシンの総数を表します。

observedGeneration

integer

observedGeneration は、コントローラーによって監視された世代を表します。

readyMachineCount

integer

readyMachineCount は、プールの対象となる準備完了マシンの総数を表します。

unavailableMachineCount

integer

availableMachineCount は、プールの対象となる使用できない (準備ができていない) マシンの総数を表します。ノードが更新状態にあるか、NodeReady 条件が false の場合、ノードは使用不可としてマークされます。

updatedMachineCount

integer

updatedMachineCount は、設定として CurrentMachineConfig を持つプールのターゲットとなるマシンの総数を表します。

7.1.12. .status.certExpirys

説明
certExpirys は重要な証明書の有効期限データを記録します
array

7.1.13. .status.certExpirys[]

説明
ceryExpiry にはバンドル名と有効期限が含まれます
object
必須
  • bundle
  • subject
プロパティー説明

bundle

string

bundle は、サブジェクト証明書が存在するバンドルの名前です。

expiry

string

expiry は、証明書が有効でなくなる日付です。

subject

string

subject は証明書のサブジェクトです

7.1.14. .status.conditions

説明
条件は、現在の状態の最新の利用可能な観測を表します。
array

7.1.15. .status.conditions[]

説明
MachineConfigPoolCondition には、MachineConfigPool の条件情報が含まれています。
object
プロパティー説明

lastTransitionTime

``

lastTransitionTime は、この条件の最後のステータス変更に対応するタイムスタンプです。

message

string

メッセージは、最後の遷移の詳細を人間が読める形式で説明したものであり、理由を補足します。

reason

string

理由は、条件の最後の遷移に関する簡単な機械可読な説明です。

status

string

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

type

string

現在の条件のタイプ ('Done'、'Updating'、'Failed')。

7.1.16. .status.configuration

説明
configuration は、マシン設定プールの現在の MachineConfig オブジェクトを表します。
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

source

array

source は、content で指定された単一の MachineConfig オブジェクトを生成するために使用された MachineConfig オブジェクトのリストです。

source[]

object

ObjectReference には、参照先のオブジェクトを検査または変更するのに十分な情報が含まれています。--- API に埋め込まれた場合、使用方法を説明するのが難しいため、このタイプの新しい使用は推奨されません。1. 無視されたフィールド。一般的には尊重されない多くの分野が含まれます。たとえば、ResourceVersion と FieldPath はどちらも実際の使用ではほとんど有効ではありません。2. 使用法のヘルプが無効です。個別の使用状況に応じた具体的なヘルプを追加することはできません。ほとんどの埋め込みの使用法では、「タイプ A と B のみを参照する必要がある」または「UID は尊重されない」、「名前を制限する必要がある」などの特定の制限があります。埋め込まれると、それらはうまく説明できません。3. 検証に一貫性がありません。使用方法が異なるため、検証ルールも使用方法によって異なり、何が起こるかをユーザーが予測することが難しくなります。4. フィールドは不正確であると同時に過度に正確です。kind は URL への正確なマッピングではありません。これにより、解釈中に曖昧さが生じる可能性があり、REST マッピングが必要になります。ほとんどの場合、依存関係はグループ、リソースのタプルにあり、実際の構造体のバージョンは無関係です。5. 簡単に変えることはできません。このタイプは多くのロケーションに埋め込まれているため、このタイプを更新すると、多数のスキーマに影響します。新しい API に、制御できない指定が不十分な API タイプを埋め込まないでください。この型を使用する代わりに、参照に重点を置いた、ローカルで提供および使用される型を作成します。たとえば、アドミッション登録の ServiceReferences の場合: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533

uid

string

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

7.1.17. .status.configuration.source

説明
source は、content で指定された単一の MachineConfig オブジェクトを生成するために使用された MachineConfig オブジェクトのリストです。
array

7.1.18. .status.configuration.source[]

説明
ObjectReference には、参照先のオブジェクトを検査または変更するのに十分な情報が含まれています。--- API に埋め込まれた場合、使用方法を説明するのが難しいため、このタイプの新しい使用は推奨されません。1. 無視されたフィールド。一般的には尊重されない多くの分野が含まれます。たとえば、ResourceVersion と FieldPath はどちらも実際の使用ではほとんど有効ではありません。2. 使用法のヘルプが無効です。個別の使用状況に応じた具体的なヘルプを追加することはできません。ほとんどの埋め込みの使用法では、「タイプ A と B のみを参照する必要がある」または「UID は尊重されない」、「名前を制限する必要がある」などの特定の制限があります。埋め込まれると、それらはうまく説明できません。3. 検証に一貫性がありません。使用方法が異なるため、検証ルールも使用方法によって異なり、何が起こるかをユーザーが予測することが難しくなります。4. フィールドは不正確であると同時に過度に正確です。kind は URL への正確なマッピングではありません。これにより、解釈中に曖昧さが生じる可能性があり、REST マッピングが必要になります。ほとんどの場合、依存関係はグループ、リソースのタプルにあり、実際の構造体のバージョンは無関係です。5. 簡単に変えることはできません。このタイプは多くのロケーションに埋め込まれているため、このタイプを更新すると、多数のスキーマに影響します。新しい API に、制御できない指定が不十分な API タイプを埋め込まないでください。この型を使用する代わりに、参照に重点を置いた、ローカルで提供および使用される型を作成します。たとえば、アドミッション登録の ServiceReferences の場合: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533
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

7.2. API エンドポイント

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

  • /apis/machineconfiguration.openshift.io/v1/machineconfigpools

    • DELETE:MachineConfigPool のコレクションを削除します
    • GET: 種類の MachineConfigPool のオブジェクトをリスト表示します
    • POST:MachineConfigPool を作成します
  • /apis/machineconfiguration.openshift.io/v1/machineconfigpools/{name}

    • 削除:MachineConfigPool を削除します
    • GET: 指定された MachineConfigPool を読み取ります
    • PATCH: 指定された MachineConfigPool を部分的に更新します
    • PUT: 指定された MachineConfigPool を置き換えます
  • /apis/machineconfiguration.openshift.io/v1/machineconfigpools/{name}/status

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

7.2.1. /apis/machineconfiguration.openshift.io/v1/machineconfigpools

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

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
MachineConfigPool の種類のオブジェクトをリスト表示します
表7.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

MachineConfigPoolList schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表7.4 ボディのパラメーター
パラメーター説明

body

MachineConfigPool schema

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

200 - OK

MachineConfigPool schema

201 - Created

MachineConfigPool schema

202 - Accepted

MachineConfigPool schema

401 - Unauthorized

空白

7.2.2. /apis/machineconfiguration.openshift.io/v1/machineconfigpools/{name}

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

name

string

MachineConfigPool の名前

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

dryRun

string

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

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

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

200 - OK

MachineConfigPool schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

200 - OK

MachineConfigPool schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表7.13 ボディのパラメーター
パラメーター説明

body

MachineConfigPool schema

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

200 - OK

MachineConfigPool schema

201 - Created

MachineConfigPool schema

401 - Unauthorized

空白

7.2.3. /apis/machineconfiguration.openshift.io/v1/machineconfigpools/{name}/status

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

name

string

MachineConfigPool の名前

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

200 - OK

MachineConfigPool schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

200 - OK

MachineConfigPool schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表7.20 ボディのパラメーター
パラメーター説明

body

MachineConfigPool schema

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

200 - OK

MachineConfigPool schema

201 - Created

MachineConfigPool schema

401 - Unauthorized

空白

第8章 MachineHealthCheck [machine.openshift.io/v1beta1]

説明
MachineHealthCheck は、machinehealthchecks API のスキーマです。互換性レベル 2: メジャーリリース内で最低 9 カ月間、または 3 つのマイナーリリース内 (いずれか長い方) で安定しています。
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

マシンヘルスチェックポリシーの仕様

status

object

MachineHealthCheck リソースの最近観察されたステータス

8.1.1. .spec

説明
マシンヘルスチェックポリシーの仕様
object
プロパティー説明

maxUnhealthy

integer-or-string

それ以上の修復は、"セレクター" によって選択された最大で "maxUnhealthy" マシンが正常でない場合にのみ許可されます。正の整数値またはパーセンテージ値のいずれかを期待します。パーセンテージ値は正の整数でなければならず、100% を上限とします。0% と 0% の両方が有効であり、すべての修復をブロックします。

nodeStartupTimeout

string

ノードのないこの期間より古いマシンは、障害が発生したと見なされ、修正されます。ノードのないマシンが削除されないようにするには、この値を明示的に "0" に設定して起動チェックを無効にします。それぞれオプションの分数と単位接尾辞が付いた 10 進数の符号なし期間文字列 ("300ms"、"1.5h"、"2h45m" など) が必要です。有効な時間単位は、"ns"、"us" (または "µs")、"ms"、"s"、"m"、"h" です。

remediationTemplate

object

RemediationTemplate は、インフラストラクチャープロバイダーによって提供される修復テンプレートへの参照です。このフィールドは完全にオプションです。入力すると、MachineHealthCheck コントローラーは、参照されるテンプレートから新しいオブジェクトを作成し、マシンの修復を Machine API Operator の外部にあるコントローラーに渡します。

selector

object

ヘルスが行使されるマシンに一致するようにセレクターにラベルを付けます。注: 空のセレクターはすべてのマシンに一致します。

unhealthyConditions

array

UnhealthyConditions には、ノードが異常であると見なされるかどうかを決定する条件のリストが含まれています。条件は論理 OR で結合されます。つまり、条件のいずれかが満たされた場合、ノードは異常です。

unhealthyConditions[]

object

UnhealthyCondition は、期間として指定されたタイムアウトを持つノード条件タイプと値を表します。指定された条件が少なくともタイムアウト値の間指定されたステータスにある場合、ノードは異常であると見なされます。

8.1.2. .spec.remediationTemplate

説明
RemediationTemplate は、インフラストラクチャープロバイダーによって提供される修復テンプレートへの参照です。このフィールドは完全にオプションです。入力すると、MachineHealthCheck コントローラーは、参照されるテンプレートから新しいオブジェクトを作成し、マシンの修復を Machine API Operator の外部にあるコントローラーに渡します。
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

8.1.3. .spec.selector

説明
ヘルスが行使されるマシンに一致するようにセレクターにラベルを付けます。注: 空のセレクターはすべてのマシンに一致します。
object
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

8.1.4. .spec.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

8.1.5. .spec.selector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

8.1.6. .spec.unhealthyConditions

説明
UnhealthyConditions には、ノードが異常であると見なされるかどうかを決定する条件のリストが含まれています。条件は論理 OR で結合されます。つまり、条件のいずれかが満たされた場合、ノードは異常です。
array

8.1.7. .spec.unhealthyConditions[]

説明
UnhealthyCondition は、期間として指定されたタイムアウトを持つノード条件タイプと値を表します。指定された条件が少なくともタイムアウト値の間指定されたステータスにある場合、ノードは異常であると見なされます。
object
プロパティー説明

status

string

 

timeout

string

それぞれオプションの分数と単位接尾辞が付いた 10 進数の符号なし期間文字列 ("300ms"、"1.5h"、"2h45m" など) が必要です。有効な時間単位は、"ns"、"us" (または "µs")、"ms"、"s"、"m"、"h" です。

type

string

 

8.1.8. .status

説明
MachineHealthCheck リソースの最近観察されたステータス
object
プロパティー説明

conditions

array

条件は、MachineHealthCheck の現在の状態を定義します

conditions[]

object

condition は、Machine API リソースの動作状態の監視を定義します。

currentHealthy

integer

このマシンヘルスチェックでカウントされたマシンの総数

expectedMachines

integer

このマシンヘルスチェックでカウントされたマシンの総数

remediationsAllowed

integer

RemediationsAllowed は、maxUnhealthy 短絡が適用される前に、このマシンヘルスチェックによって許可される追加の修復の数です。

8.1.9. .status.conditions

説明
条件は、MachineHealthCheck の現在の状態を定義します
array

8.1.10. .status.conditions[]

説明
condition は、Machine API リソースの動作状態の監視を定義します。
object
必須
  • type
プロパティー説明

lastTransitionTime

string

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

message

string

遷移の詳細を示す人が判読できるメッセージ。このフィールドは空の場合があります。

reason

string

CamelCase での状態の最後の遷移に関する理由。特定の API は、このフィールドが保証された API と見なされるかどうかを選択できます。このフィールドには空白を指定できません。

severity

string

重大度は理由コードの明示的な分類を提供するため、ユーザーまたはマシンは現在の状況を即座に理解し、それに応じて行動できます。Severity フィールドは、Status=False の場合にのみ設定する必要があります。

status

string

状態のステータス (True、False、Unknown のいずれか)。

type

string

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

8.2. API エンドポイント

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

  • /apis/machine.openshift.io/v1beta1/machinehealthchecks

    • GET: 種類のオブジェクトをリスト表示する MachineHealthCheck
  • /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks

    • 削除:MachineHealthCheck のコレクションを削除します
    • GET: 種類のオブジェクトをリスト表示する MachineHealthCheck
    • POST:MachineHealthCheck を作成します
  • /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks/{name}

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

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

8.2.1. /apis/machine.openshift.io/v1beta1/machinehealthchecks

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

200 - OK

MachineHealthCheckList schema

401 - Unauthorized

空白

8.2.2. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks

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

200 - OK

Status スキーマ

401 - Unauthorized

空白

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

200 - OK

MachineHealthCheckList schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

body

MachineHealthCheck schema

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

200 - OK

MachineHealthCheck schema

201 - Created

MachineHealthCheck schema

202 - Accepted

MachineHealthCheck schema

401 - Unauthorized

空白

8.2.3. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks/{name}

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

name

string

MachineHealthCheck の名前

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

dryRun

string

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

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

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

200 - OK

MachineHealthCheck schema

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された MachineHealthCheck を部分的に更新します
表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

MachineHealthCheck schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

body

MachineHealthCheck schema

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

200 - OK

MachineHealthCheck schema

201 - Created

MachineHealthCheck schema

401 - Unauthorized

空白

8.2.4. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks/{name}/status

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

name

string

MachineHealthCheck の名前

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

200 - OK

MachineHealthCheck schema

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された MachineHealthCheck のステータスを部分的に更新します
表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

MachineHealthCheck schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

body

MachineHealthCheck schema

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

200 - OK

MachineHealthCheck schema

201 - Created

MachineHealthCheck schema

401 - Unauthorized

空白

第9章 Machine [machine.openshift.io/v1beta1]

説明
Machine は、マシン API のスキーマです。互換性レベル 2: メジャーリリース内で最低 9 カ月間、または 3 つのマイナーリリース内 (いずれか長い方) で安定しています。
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

MachineSpec は、マシンの望ましい状態を定義します

status

object

MachineStatus は、マシンの監視状態を定義します

9.1.1. .spec

説明
MachineSpec は、マシンの望ましい状態を定義します
object
プロパティー説明

lifecycleHooks

object

lifecycleHooks を使用すると、ユーザーはマシンのライフサイクル内の特定の定義済みポイントでマシン上の操作を一時停止できます。

metadata

object

ObjectMeta は、作成されたノードに自動入力します。これを使用して、ノードの作成時に使用するラベル、アノテーション、名前接頭辞などを示します。

providerID

string

providerID は、プロバイダーによって提供されたマシンの ID です。このフィールドは、このマシンに対応するノードオブジェクトに表示されるプロバイダー ID と一致する必要があります。このフィールドは、cluster-api の上位レベルのコンシューマーに必要です。ユースケースの例は、プロバイダーとして cluster-api を使用するクラスターオートスケーラーです。オートスケーラーのクリーンアップロジックは、マシンをノードと比較して、Kubernetes ノードとして登録できなかったプロバイダーのマシンを見つけます。オートスケーラーの一般的なツリー外プロバイダーとして cluster-api を使用する場合、このフィールドは、マシンのリストのプロバイダービューを持つことができるようにするためにオートスケーラーによって必要とされます。k8s apiserver からノードの別のリストが照会され、比較が行われて未登録のマシンが検出され、削除のマークが付けられます。このフィールドはアクチュエーターによって設定され、汎用プロバイダーとして cluster-api とインターフェイスするオートスケーラーなどの高レベルのエンティティーによって消費されます。

providerSpec

object

ProviderSpec の詳細ノードの作成中に使用するプロバイダー固有の設定。

taints

array

対応するノードに追加的に適用されるテイントのリスト。このリストは、他のエンティティーによって継続的にノードに追加された他のテイントを上書きしません。これらのテイントは積極的に調整する必要があります。たとえば、マシンコントローラーにテイントを適用するように依頼し、手動でテイントを除去すると、マシンコントローラーはテイントを元に戻します)、マシンコントローラーにテイントを除去させないでください。

taints[]

object

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

9.1.2. .spec.lifecycleHooks

説明
lifecycleHooks を使用すると、ユーザーはマシンのライフサイクル内の特定の定義済みポイントでマシン上の操作を一時停止できます。
object
プロパティー説明

preDrain

array

PreDrain フックは、マシンのドレインを阻止します。これにより、終了などのライフサイクルイベントもさらにブロックされます。

preDrain[]

object

lifecycleHook はライフサイクルフックの単一インスタンスを表します。

preTerminate

array

preTerminate フックはマシンが終了するのを防ぎます。preTerminate フックは、マシンがドレインされた後に実行されます。

preTerminate[]

object

lifecycleHook はライフサイクルフックの単一インスタンスを表します。

9.1.3. .spec.lifecycleHooks.preDrain

説明
PreDrain フックは、マシンのドレインを阻止します。これにより、終了などのライフサイクルイベントもさらにブロックされます。
array

9.1.4. .spec.lifecycleHooks.preDrain[]

説明
lifecycleHook はライフサイクルフックの単一インスタンスを表します。
object
必須
  • name
  • owner
プロパティー説明

name

string

name はライフサイクルフックの一意の名前を定義します。名前は一意でわかりやすく、理想的には 1 - 3 語で CamelCase で表記する必要がありますが、名前空間を使用することもできます (例: foo.example.com/CamelCase)。名前は一意である必要があり、単一のエンティティーによってのみ管理される必要があります。

owner

string

owner は、ライフサイクルフックの所有者を定義します。これは、ライフサイクルをブロックしているのが誰であるかをユーザーが識別できるように、わかるように説明してある必要があります。これは、コントローラーの名前 (例: clusteroperator/etcd) またはフックを管理する管理者の名前である可能性があります。

9.1.5. .spec.lifecycleHooks.preTerminate

説明
preTerminate フックはマシンが終了するのを防ぎます。preTerminate フックは、マシンがドレインされた後に実行されます。
array

9.1.6. .spec.lifecycleHooks.preTerminate[]

説明
lifecycleHook はライフサイクルフックの単一インスタンスを表します。
object
必須
  • name
  • owner
プロパティー説明

name

string

name はライフサイクルフックの一意の名前を定義します。名前は一意でわかりやすく、理想的には 1 - 3 語で CamelCase で表記する必要がありますが、名前空間を使用することもできます (例: foo.example.com/CamelCase)。名前は一意である必要があり、単一のエンティティーによってのみ管理される必要があります。

owner

string

owner は、ライフサイクルフックの所有者を定義します。これは、ライフサイクルをブロックしているのが誰であるかをユーザーが識別できるように、わかるように説明してある必要があります。これは、コントローラーの名前 (例: clusteroperator/etcd) またはフックを管理する管理者の名前である可能性があります。

9.1.7. .spec.metadata

説明
ObjectMeta は、作成されたノードに自動入力します。これを使用して、ノードの作成時に使用するラベル、アノテーション、名前接頭辞などを示します。
object
プロパティー説明

annotations

object (string)

アノテーションは、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations

generateName

string

generateName は、Name フィールドが指定されていない場合に限り一意の名前を生成するためにサーバーが使用するオプションの接頭辞です。このフィールドを使用する場合、クライアントに返される名前は渡された名前とは異なります。この値は、一意の接尾辞とも組み合わされます。提供された値には、名前フィールドと同じ検証ルールがあり、サーバー上で値を一意にするために必要な接尾辞の長さで切り捨てられる場合があります。このフィールドが指定されており、生成された名前が存在する場合、サーバーは 409 を返しません。代わりに、割り当てられた時間内に一意の名前が見つからなかったことを示す Reason ServerTimeout で 201 Created または 500 を返します。クライアントは再試行する必要があります (オプションで、Retry-After ヘッダーに示されている時間の後)。Name が指定されていない場合にのみ適用されます。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

labels

object (string)

オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labels

name

string

name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これを更新することはできません。詳細: http://kubernetes.io/docs/user-guide/identifiers#names

namespace

string

名前空間は、各名前内のスペースが一意である必要があることを定義します。空の namespace は "default" の namespace と同じですが、"default" は正規表現です。すべてのオブジェクトを namespace のスコープに設定する必要はありません。それらのオブジェクトでは、このフィールドの値は空になります。DNS_LABEL である必要があります。これを更新することはできません。詳細: http://kubernetes.io/docs/user-guide/namespaces

ownerReferences

array

このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。

ownerReferences[]

object

OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ名前空間にあるか、クラスタースコープである必要があるため、名前空間フィールドはありません。

9.1.8. .spec.metadata.ownerReferences

説明
このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。
array

9.1.9. .spec.metadata.ownerReferences[]

説明
OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ名前空間にあるか、クラスタースコープである必要があるため、名前空間フィールドはありません。
object
必須
  • apiVersion
  • kind
  • name
  • uid
プロパティー説明

apiVersion

string

参照先の API バージョン。

blockOwnerDeletion

boolean

true の場合、および所有者が "foregroundDeletion" ファイナライザーを持っている場合、この参照が削除されるまで、所有者を Key-Value ストアから削除することはできません。ガベージコレクターがこのフィールドと対話し、フォアグラウンドを強制的に削除する方法は、https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion を参照してください。デフォルトは false です。このフィールドを設定するには、ユーザーは所有者の "削除" 権限を必要とします。そうしないと、422 (処理不能エンティティー) が返されます。

controller

boolean

true の場合、この参照は管理コントローラーを指します。

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

uid

string

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

9.1.10. .spec.providerSpec

説明
ProviderSpec の詳細ノードの作成中に使用するプロバイダー固有の設定。
object
プロパティー説明

value

``

値は、リソース設定のインライン化されたシリアル化された表現です。プロバイダーは、コンポーネント設定と同様に、このフィールドからシリアル化/逆シリアル化する必要がある独自のバージョン管理された API タイプを維持することを推奨します。

9.1.11. .spec.taints

説明
対応するノードに追加的に適用されるテイントのリスト。このリストは、他のエンティティーによって継続的にノードに追加された他のテイントを上書きしません。これらのテイントは積極的に調整する必要があります。たとえば、マシンコントローラーにテイントを適用するように依頼し、手動でテイントを除去すると、マシンコントローラーはテイントを元に戻します)、マシンコントローラーにテイントを除去させないでください。
array

9.1.12. .spec.taints[]

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

effect

string

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

key

string

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

timeAdded

string

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

value

string

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

9.1.13. .status

説明
MachineStatus は、マシンの監視状態を定義します
object
プロパティー説明

addresses

array

アドレスは、マシンに割り当てられたアドレスのリストです。可能な場合は、クラウドプロバイダーから照会されます。

addresses[]

object

NodeAddress には、ノードのアドレスに関する情報が含まれています。

conditions

array

条件は、マシンの現在の状態を定義します

conditions[]

object

condition は、Machine API リソースの動作状態の監視を定義します。

errorMessage

string

ErrorMessage は、マシンの調整に最終的な問題が発生した場合に設定され、ロギングと人間による消費に適したより詳細な文字列が含まれます。このフィールドは、時間の経過とともに自動的に修正されることが予想される、コントローラーが直面する推移的なエラー (サービスの停止など) には設定しないでください。代わりに、マシンの仕様またはコントローラーの設定に根本的な問題があること、およびそのマニュアルを示します。介入が必要です。ターミナルエラーの例としては、仕様の設定の無効な組み合わせ、コントローラーでサポートされていない値、または責任のあるコントローラー自体が重大に誤って設定されていることが挙げられます。マシンの調整中に発生する一時的なエラーは、イベントとしてマシンオブジェクトに追加したり、コントローラーの出力に記録したりできます。

errorReason

string

ErrorReason は、マシンの調整に最終的な問題が発生した場合に設定され、マシンの解釈に適した簡潔な値が含まれます。このフィールドは、時間の経過とともに自動的に修正されることが予想される、コントローラーが直面する推移的なエラー (サービスの停止など) には設定しないでください。代わりに、マシンの仕様またはコントローラーの設定に根本的な問題があること、およびそのマニュアルを示します。介入が必要です。ターミナルエラーの例としては、仕様の設定の無効な組み合わせ、コントローラーでサポートされていない値、または責任のあるコントローラー自体が重大に誤って設定されていることが挙げられます。マシンの調整中に発生する一時的なエラーは、イベントとしてマシンオブジェクトに追加したり、コントローラーの出力に記録したりできます。

lastOperation

object

LastOperation は、マシンコントローラーによって実行される最後の操作を記述します。この API は、特定のマシンで実行された最新の操作に関する履歴として役立つはずです。また、最新の操作の状態を伝える必要があります。たとえば、それがまだ進行中、失敗、または正常に完了した場合などです。

lastUpdated

string

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

nodeRef

object

NodeRef は、対応するノードが存在する場合はそれを指します。

phase

string

フェーズは、機械作動の現在のフェーズを表します。失敗、プロビジョニング、プロビジョニング、実行、削除のいずれか

providerStatus

``

ProviderStatus は、プロバイダー固有のステータスの詳細を示します。プロバイダーは、このフィールドからシリアル化/逆シリアル化する必要がある独自のバージョン管理された API タイプを維持することを推奨します。

9.1.14. .status.addresses

説明
アドレスは、マシンに割り当てられたアドレスのリストです。可能な場合は、クラウドプロバイダーから照会されます。
array

9.1.15. .status.addresses[]

説明
NodeAddress には、ノードのアドレスに関する情報が含まれています。
object
必須
  • address
  • type
プロパティー説明

address

string

ノードアドレス。

type

string

ノードアドレスタイプ。ホスト名、ExternalIP、または InternalIP のいずれか。

9.1.16. .status.conditions

説明
条件は、マシンの現在の状態を定義します
array

9.1.17. .status.conditions[]

説明
condition は、Machine API リソースの動作状態の監視を定義します。
object
必須
  • type
プロパティー説明

lastTransitionTime

string

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

message

string

遷移の詳細を示す人が判読できるメッセージ。このフィールドは空の場合があります。

reason

string

CamelCase での状態の最後の遷移に関する理由。特定の API は、このフィールドが保証された API と見なされるかどうかを選択できます。このフィールドには空白を指定できません。

severity

string

重大度は理由コードの明示的な分類を提供するため、ユーザーまたはマシンは現在の状況を即座に理解し、それに応じて行動できます。Severity フィールドは、Status=False の場合にのみ設定する必要があります。

status

string

状態のステータス (True、False、Unknown のいずれか)。

type

string

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

9.1.18. .status.lastOperation

説明
LastOperation は、マシンコントローラーによって実行される最後の操作を記述します。この API は、特定のマシンで実行された最新の操作に関する履歴として役立つはずです。また、最新の操作の状態を伝える必要があります。たとえば、それがまだ進行中、失敗、または正常に完了した場合などです。
object
プロパティー説明

description

string

説明は、最後の操作の人間が読める形式の説明です。

lastUpdated

string

LastUpdated は、LastOperation API が最後に更新されたタイムスタンプです。

state

string

状態は、最後に実行された操作の現在のステータスです。例:処理中、失敗、成功など

type

string

タイプは、最後に実行された操作のタイプです。例:作成、削除、更新など

9.1.19. .status.nodeRef

説明
NodeRef は、対応するノードが存在する場合はそれを指します。
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

9.2. API エンドポイント

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

  • /apis/machine.openshift.io/v1beta1/machines

    • GET: 種類のオブジェクトをリスト表示する Machine
  • /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines

    • DELETE: マシンのコレクションを削除します
    • GET: 種類のオブジェクトをリスト表示する Machine
    • POST: マシンを作成する
  • /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines/{name}

    • 削除: マシンを削除します
    • GET: 指定されたマシンを読み取ります
    • PATCH: 指定されたマシンを部分的に更新します
    • PUT: 指定されたマシンを交換してください
  • /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines/{name}/status

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

9.2.1. /apis/machine.openshift.io/v1beta1/machines

HTTP メソッド
GET
説明
種類のオブジェクトをリスト表示する Machine
表9.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

MachineList schema

401 - Unauthorized

空白

9.2.2. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines

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

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類のオブジェクトをリスト表示する Machine
表9.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

MachineList schema

401 - Unauthorized

空白

HTTP メソッド
POST
説明
マシンを作成する
表9.4 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

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

body

Machine schema

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

200 - OK

Machine schema

201 - Created

Machine schema

202 - Accepted

Machine schema

401 - Unauthorized

空白

9.2.3. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines/{name}

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

name

string

マシンの名前

HTTP メソッド
DELETE
説明
マシンを削除する
表9.8 クエリーパラメーター
パラメーター説明

dryRun

string

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

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定されたマシンを読み取る
表9.10 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Machine schema

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定されたマシンを部分的に更新します
表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

Machine schema

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定されたマシンを交換してください
表9.13 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

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

body

Machine schema

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

200 - OK

Machine schema

201 - Created

Machine schema

401 - Unauthorized

空白

9.2.4. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines/{name}/status

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

name

string

マシンの名前

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

200 - OK

Machine schema

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定したマシンのステータスを部分的に更新します
表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

Machine schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

body

Machine schema

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

200 - OK

Machine schema

201 - Created

Machine schema

401 - Unauthorized

空白

第10章 MachineSet [machine.openshift.io/v1beta1]

説明
MachineSet は、指定された数のマシンレプリカが常に実行されていることを確認します。互換性レベル 2: メジャーリリース内で最低 9 カ月間、または 3 つのマイナーリリース (どちらか長い方) で安定しています。
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

MachineSetSpec は、MachineSet の望ましい状態を定義します

status

object

MachineSetStatus は、MachineSet の監視状態を定義します

10.1.1. .spec

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

deletePolicy

string

DeletePolicy は、ダウンスケーリング時に削除するノードを識別するために使用されるポリシーを定義します。デフォルトは "Random" です。有効な値は "Random"、"Newest"、"Oldest" です。

minReadySeconds

integer

MinReadySeconds は、新しく作成されたマシンの準備ができる最小秒数です。デフォルトは 0 です (マシンは準備ができ次第利用可能と見なされます)

replicas

integer

レプリカは、必要なレプリカの数です。これは、明示的なゼロと指定されていないものを区別するためのポインターです。デフォルトは 1 です。

selector

object

セレクターは、レプリカ数と一致する必要があるマシンに対するラベルクエリーです。この MachineSet によって制御されるために一致する必要があるキーと値にラベルを付けます。マシンテンプレートのラベルと一致する必要があります。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

template

object

テンプレートは、不十分なレプリカが検出された場合に作成されるマシンを説明するオブジェクトです。

10.1.2. .spec.selector

説明
セレクターは、レプリカ数と一致する必要があるマシンに対するラベルクエリーです。この MachineSet によって制御されるために一致する必要があるキーと値にラベルを付けます。マシンテンプレートのラベルと一致する必要があります。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
object
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

10.1.3. .spec.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

10.1.4. .spec.selector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

10.1.5. .spec.template

説明
テンプレートは、不十分なレプリカが検出された場合に作成されるマシンを説明するオブジェクトです。
object
プロパティー説明

metadata

object

標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

spec

object

Pod に期待される動作の仕様。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

10.1.6. .spec.template.metadata

説明
標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
object
プロパティー説明

annotations

object (string)

アノテーションは、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations

generateName

string

generateName は、Name フィールドが指定されていない場合に限り一意の名前を生成するためにサーバーが使用するオプションの接頭辞です。このフィールドを使用する場合、クライアントに返される名前は渡された名前とは異なります。この値は、一意の接尾辞とも組み合わされます。提供された値には、名前フィールドと同じ検証ルールがあり、サーバー上で値を一意にするために必要な接尾辞の長さで切り捨てられる場合があります。このフィールドが指定されており、生成された名前が存在する場合、サーバーは 409 を返しません。代わりに、割り当てられた時間内に一意の名前が見つからなかったことを示す Reason ServerTimeout で 201 Created または 500 を返します。クライアントは再試行する必要があります (オプションで、Retry-After ヘッダーに示されている時間の後)。Name が指定されていない場合にのみ適用されます。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

labels

object (string)

オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labels

name

string

name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これを更新することはできません。詳細: http://kubernetes.io/docs/user-guide/identifiers#names

namespace

string

名前空間は、各名前内のスペースが一意である必要があることを定義します。空の namespace は "default" の namespace と同じですが、"default" は正規表現です。すべてのオブジェクトを namespace のスコープに設定する必要はありません。それらのオブジェクトでは、このフィールドの値は空になります。DNS_LABEL である必要があります。これを更新することはできません。詳細: http://kubernetes.io/docs/user-guide/namespaces

ownerReferences

array

このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。

ownerReferences[]

object

OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ名前空間にあるか、クラスタースコープである必要があるため、名前空間フィールドはありません。

10.1.7. .spec.template.metadata.ownerReferences

説明
このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。
array

10.1.8. .spec.template.metadata.ownerReferences[]

説明
OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ名前空間にあるか、クラスタースコープである必要があるため、名前空間フィールドはありません。
object
必須
  • apiVersion
  • kind
  • name
  • uid
プロパティー説明

apiVersion

string

参照先の API バージョン。

blockOwnerDeletion

boolean

true の場合、および所有者が "foregroundDeletion" ファイナライザーを持っている場合、この参照が削除されるまで、所有者を Key-Value ストアから削除することはできません。ガベージコレクターがこのフィールドと対話し、フォアグラウンドを強制的に削除する方法は、https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion を参照してください。デフォルトは false です。このフィールドを設定するには、ユーザーは所有者の "削除" 権限を必要とします。そうしないと、422 (処理不能エンティティー) が返されます。

controller

boolean

true の場合、この参照は管理コントローラーを指します。

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

uid

string

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

10.1.9. .spec.template.spec

説明
Pod に期待される動作の仕様。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
object
プロパティー説明

lifecycleHooks

object

lifecycleHooks を使用すると、ユーザーはマシンのライフサイクル内の特定の定義済みポイントでマシン上の操作を一時停止できます。

metadata

object

ObjectMeta は、作成されたノードに自動入力します。これを使用して、ノードの作成時に使用するラベル、アノテーション、名前接頭辞などを示します。

providerID

string

providerID は、プロバイダーによって提供されたマシンの ID です。このフィールドは、このマシンに対応するノードオブジェクトに表示されるプロバイダー ID と一致する必要があります。このフィールドは、cluster-api の上位レベルのコンシューマーに必要です。ユースケースの例は、プロバイダーとして cluster-api を使用するクラスターオートスケーラーです。オートスケーラーのクリーンアップロジックは、マシンをノードと比較して、Kubernetes ノードとして登録できなかったプロバイダーのマシンを見つけます。オートスケーラーの一般的なツリー外プロバイダーとして cluster-api を使用する場合、このフィールドは、マシンのリストのプロバイダービューを持つことができるようにするためにオートスケーラーによって必要とされます。k8s apiserver からノードの別のリストが照会され、比較が行われて未登録のマシンが検出され、削除のマークが付けられます。このフィールドはアクチュエーターによって設定され、汎用プロバイダーとして cluster-api とインターフェイスするオートスケーラーなどの高レベルのエンティティーによって消費されます。

providerSpec

object

ProviderSpec の詳細ノードの作成中に使用するプロバイダー固有の設定。

taints

array

対応するノードに追加的に適用されるテイントのリスト。このリストは、他のエンティティーによって継続的にノードに追加された他のテイントを上書きしません。これらのテイントは積極的に調整する必要があります。たとえば、マシンコントローラーにテイントを適用するように依頼し、手動でテイントを除去すると、マシンコントローラーはテイントを元に戻します)、マシンコントローラーにテイントを除去させないでください。

taints[]

object

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

10.1.10. .spec.template.spec.lifecycleHooks

説明
lifecycleHooks を使用すると、ユーザーはマシンのライフサイクル内の特定の定義済みポイントでマシン上の操作を一時停止できます。
object
プロパティー説明

preDrain

array

PreDrain フックは、マシンのドレインを阻止します。これにより、終了などのライフサイクルイベントもさらにブロックされます。

preDrain[]

object

lifecycleHook はライフサイクルフックの単一インスタンスを表します。

preTerminate

array

preTerminate フックはマシンが終了するのを防ぎます。preTerminate フックは、マシンがドレインされた後に実行されます。

preTerminate[]

object

lifecycleHook はライフサイクルフックの単一インスタンスを表します。

10.1.11. .spec.template.spec.lifecycleHooks.preDrain

説明
PreDrain フックは、マシンのドレインを阻止します。これにより、終了などのライフサイクルイベントもさらにブロックされます。
array

10.1.12. .spec.template.spec.lifecycleHooks.preDrain[]

説明
lifecycleHook はライフサイクルフックの単一インスタンスを表します。
object
必須
  • name
  • owner
プロパティー説明

name

string

name はライフサイクルフックの一意の名前を定義します。名前は一意でわかりやすく、理想的には 1 - 3 語で CamelCase で表記する必要がありますが、名前空間を使用することもできます (例: foo.example.com/CamelCase)。名前は一意である必要があり、単一のエンティティーによってのみ管理される必要があります。

owner

string

owner は、ライフサイクルフックの所有者を定義します。これは、ライフサイクルをブロックしているのが誰であるかをユーザーが識別できるように、わかるように説明してある必要があります。これは、コントローラーの名前 (例: clusteroperator/etcd) またはフックを管理する管理者の名前である可能性があります。

10.1.13. .spec.template.spec.lifecycleHooks.preTerminate

説明
preTerminate フックはマシンが終了するのを防ぎます。preTerminate フックは、マシンがドレインされた後に実行されます。
array

10.1.14. .spec.template.spec.lifecycleHooks.preTerminate[]

説明
lifecycleHook はライフサイクルフックの単一インスタンスを表します。
object
必須
  • name
  • owner
プロパティー説明

name

string

name はライフサイクルフックの一意の名前を定義します。名前は一意でわかりやすく、理想的には 1 - 3 語で CamelCase で表記する必要がありますが、名前空間を使用することもできます (例: foo.example.com/CamelCase)。名前は一意である必要があり、単一のエンティティーによってのみ管理される必要があります。

owner

string

owner は、ライフサイクルフックの所有者を定義します。これは、ライフサイクルをブロックしているのが誰であるかをユーザーが識別できるように、わかるように説明してある必要があります。これは、コントローラーの名前 (例: clusteroperator/etcd) またはフックを管理する管理者の名前である可能性があります。

10.1.15. .spec.template.spec.metadata

説明
ObjectMeta は、作成されたノードに自動入力します。これを使用して、ノードの作成時に使用するラベル、アノテーション、名前接頭辞などを示します。
object
プロパティー説明

annotations

object (string)

アノテーションは、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations

generateName

string

generateName は、Name フィールドが指定されていない場合に限り一意の名前を生成するためにサーバーが使用するオプションの接頭辞です。このフィールドを使用する場合、クライアントに返される名前は渡された名前とは異なります。この値は、一意の接尾辞とも組み合わされます。提供された値には、名前フィールドと同じ検証ルールがあり、サーバー上で値を一意にするために必要な接尾辞の長さで切り捨てられる場合があります。このフィールドが指定されており、生成された名前が存在する場合、サーバーは 409 を返しません。代わりに、割り当てられた時間内に一意の名前が見つからなかったことを示す Reason ServerTimeout で 201 Created または 500 を返します。クライアントは再試行する必要があります (オプションで、Retry-After ヘッダーに示されている時間の後)。Name が指定されていない場合にのみ適用されます。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

labels

object (string)

オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labels

name

string

name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これを更新することはできません。詳細: http://kubernetes.io/docs/user-guide/identifiers#names

namespace

string

名前空間は、各名前内のスペースが一意である必要があることを定義します。空の namespace は "default" の namespace と同じですが、"default" は正規表現です。すべてのオブジェクトを namespace のスコープに設定する必要はありません。それらのオブジェクトでは、このフィールドの値は空になります。DNS_LABEL である必要があります。これを更新することはできません。詳細: http://kubernetes.io/docs/user-guide/namespaces

ownerReferences

array

このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。

ownerReferences[]

object

OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ名前空間にあるか、クラスタースコープである必要があるため、名前空間フィールドはありません。

10.1.16. .spec.template.spec.metadata.ownerReferences

説明
このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。
array

10.1.17. .spec.template.spec.metadata.ownerReferences[]

説明
OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ名前空間にあるか、クラスタースコープである必要があるため、名前空間フィールドはありません。
object
必須
  • apiVersion
  • kind
  • name
  • uid
プロパティー説明

apiVersion

string

参照先の API バージョン。

blockOwnerDeletion

boolean

true の場合、および所有者が "foregroundDeletion" ファイナライザーを持っている場合、この参照が削除されるまで、所有者を Key-Value ストアから削除することはできません。ガベージコレクターがこのフィールドと対話し、フォアグラウンドを強制的に削除する方法は、https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion を参照してください。デフォルトは false です。このフィールドを設定するには、ユーザーは所有者の "削除" 権限を必要とします。そうしないと、422 (処理不能エンティティー) が返されます。

controller

boolean

true の場合、この参照は管理コントローラーを指します。

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

uid

string

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

10.1.18. .spec.template.spec.providerSpec

説明
ProviderSpec の詳細ノードの作成中に使用するプロバイダー固有の設定。
object
プロパティー説明

value

``

値は、リソース設定のインライン化されたシリアル化された表現です。プロバイダーは、コンポーネント設定と同様に、このフィールドからシリアル化/逆シリアル化する必要がある独自のバージョン管理された API タイプを維持することを推奨します。

10.1.19. .spec.template.spec.taints

説明
対応するノードに追加的に適用されるテイントのリスト。このリストは、他のエンティティーによって継続的にノードに追加された他のテイントを上書きしません。これらのテイントは積極的に調整する必要があります。たとえば、マシンコントローラーにテイントを適用するように依頼し、手動でテイントを除去すると、マシンコントローラーはテイントを元に戻します)、マシンコントローラーにテイントを除去させないでください。
array

10.1.20. .spec.template.spec.taints[]

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

effect

string

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

key

string

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

timeAdded

string

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

value

string

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

10.1.21. .status

説明
MachineSetStatus は、MachineSet の監視状態を定義します
object
プロパティー説明

availableReplicas

integer

この MachineSet で使用可能なレプリカの数 (少なくとも minReadySeconds の準備ができています)。

conditions

array

条件は、MachineSet の現在の状態を定義します

conditions[]

object

condition は、Machine API リソースの動作状態の監視を定義します。

errorMessage

string

 

errorReason

string

レプリカの調整で最終的な問題が発生した場合は、ErrorReason と ErrorMessage の両方が設定されます。ErrorReason には、マシンの解釈に適した簡潔な値が入力されますが、ErrorMessage には、ロギングと人間による消費に適したより詳細な文字列が含まれます。これらのフィールドは、時間の経過とともに自動的に修正されると予想されるコントローラーが直面する推移的なエラー (サービスの停止など) に対して設定するべきではありませんが、代わりに、MachineTemplate の仕様またはマシンコントローラーの設定に根本的な問題があることを示します。手動による介入が必要です。ターミナルエラーの例としては、仕様の設定の無効な組み合わせ、マシンコントローラーでサポートされていない値、または責任のあるマシンコントローラー自体が重大に誤って設定されていることが挙げられます。マシンの調整中に発生する一時的なエラーは、イベントとして MachineSet オブジェクトに追加したり、コントローラーの出力に記録したりできます。

fullyLabeledReplicas

integer

MachineSet のマシンテンプレートのラベルと一致するラベルを持つレプリカの数。

observedGeneration

integer

ObservedGeneration は、最後に観察された MachineSet の生成を反映します。

readyReplicas

integer

この MachineSet の準備ができているレプリカの数。ノードが作成され、準備完了になると、マシンは "準備完了" と見なされます。

replicas

integer

レプリカは、最近観察されたレプリカの数です。

10.1.22. .status.conditions

説明
条件は、MachineSet の現在の状態を定義します
array

10.1.23. .status.conditions[]

説明
condition は、Machine API リソースの動作状態の監視を定義します。
object
必須
  • type
プロパティー説明

lastTransitionTime

string

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

message

string

遷移の詳細を示す人が判読できるメッセージ。このフィールドは空の場合があります。

reason

string

CamelCase での状態の最後の遷移に関する理由。特定の API は、このフィールドが保証された API と見なされるかどうかを選択できます。このフィールドには空白を指定できません。

severity

string

重大度は理由コードの明示的な分類を提供するため、ユーザーまたはマシンは現在の状況を即座に理解し、それに応じて行動できます。Severity フィールドは、Status=False の場合にのみ設定する必要があります。

status

string

状態のステータス (True、False、Unknown のいずれか)。

type

string

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

10.2. API エンドポイント

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

  • /apis/machine.openshift.io/v1beta1/machinesets

    • GET: 種類の MachineSet のオブジェクトをリスト表示します
  • /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinesets

    • DELETE:MachineSet のコレクションを削除します
    • GET: 種類の MachineSet のオブジェクトをリスト表示します
    • POST:MachineSet を作成します
  • /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinesets/{name}

    • 削除:MachineSet を削除します
    • GET: 指定された MachineSet を読み取ります
    • PATCH: 指定された MachineSet を部分的に更新します
    • PUT: 指定された MachineSet を置き換えます
  • /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinesets/{name}/scale

    • GET: 指定された MachineSet のスケールを読み取ります
    • PATCH: 指定された MachineSet のスケールを部分的に更新します
    • PUT: 指定された MachineSet のスケールを置き換えます
  • /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinesets/{name}/status

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

10.2.1. /apis/machine.openshift.io/v1beta1/machinesets

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

200 - OK

MachineSetList schema

401 - Unauthorized

空白

10.2.2. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinesets

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

200 - OK

Status スキーマ

401 - Unauthorized

空白

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

200 - OK

MachineSetList schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

body

MachineSet schema

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

200 - OK

MachineSet schema

201 - Created

MachineSet schema

202 - Accepted

MachineSet schema

401 - Unauthorized

空白

10.2.3. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinesets/{name}

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

name

string

MachineSet の名前

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

dryRun

string

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

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

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

200 - OK

MachineSet schema

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された MachineSet を部分的に更新します
表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

MachineSet schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

body

MachineSet schema

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

200 - OK

MachineSet schema

201 - Created

MachineSet schema

401 - Unauthorized

空白

10.2.4. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinesets/{name}/scale

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

name

string

MachineSet の名前

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

200 - OK

Scale スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された MachineSet のスケールを部分的に更新します
表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

Scale スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

body

Scale スキーマ

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

200 - OK

Scale スキーマ

201 - Created

Scale スキーマ

401 - Unauthorized

空白

10.2.5. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinesets/{name}/status

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

name

string

MachineSet の名前

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

200 - OK

MachineSet schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

200 - OK

MachineSet schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

表10.28 ボディのパラメーター
パラメーター説明

body

MachineSet schema

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

200 - OK

MachineSet schema

201 - Created

MachineSet schema

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.