Machine API
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
1.10. MachineConfigNode [machineconfiguration.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineConfigNode は、システム上のマシンの健全性を記述します。互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (いずれか長い方) で安定しています。
- 型
-
object
1.11. MachineOSBuild [machineconfiguration.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineOSBuild は、MCO によって管理およびデプロイされるビルドプロセスを記述します。互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (いずれか長い方) で安定しています。
- 型
-
object
1.12. MachineOSConfig [machineconfiguration.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineOSConfig は、MCO によって管理されるビルドプロセスの設定を記述します。互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (いずれか長い方) で安定しています。
- 型
-
object
1.13. PinnedImageSet [machineconfiguration.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
PinnedImageSet は、CRI-O によってピン留めされ、宣言された MachineConfigPools のメンバーであるノードにプルされるイメージのセットを記述します。
互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (いずれか長い方) で安定しています。
- 型
-
object
第2章 ContainerRuntimeConfig [machineconfiguration.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
ContainerRuntimeConfig は、カスタマイズされた Container Runtime 設定を記述します。
互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (いずれか長い方) で安定しています。
- 型
-
object - 必須
-
spec
-
2.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec には、必要なコンテナーランタイム設定が含まれています。 |
|
|
| status には、コンテナーのランタイム設定に関する観測情報が含まれます。 |
2.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec には、必要なコンテナーランタイム設定が含まれています。
- 型
-
object - 必須
-
containerRuntimeConfig
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| containerRuntimeConfig は、コンテナーランタイムのチューナブルを定義します。 |
|
|
| machineConfigPoolSelector は、ContainerRuntimeConfig が適用する必要のあるプールを選択します。nil セレクターを使用すると、プールは選択されません。 |
2.1.2. .spec.containerRuntimeConfig リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- containerRuntimeConfig は、コンテナーランタイムのチューナブルを定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
|
defaultRuntime は、コンテナーのデフォルトとして使用される OCI ランタイムの名前です。許可される値は |
|
|
| logLevel は、設定されているレベルに基づいてログの詳細度を指定します。オプションは、fatal、panic、error、warn、info、および debug です。 |
|
|
| logSizeMax は、コンテナーログファイルに許可される最大サイズを指定します。負の数は、サイズ制限が課されていないことを示します。正の場合、conmon の読み取りバッファーと一致/超過するには >=8192 である必要があります。 |
|
|
| overlaySize は、コンテナーイメージの最大サイズを指定します。このフラグを使用して、コンテナーイメージのサイズにクォータを設定できます。(デフォルト:10GB) |
|
|
| pidsLimit は、コンテナーで許可されるプロセスの最大数を指定します |
2.1.3. .spec.machineConfigPoolSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- machineConfigPoolSelector は、ContainerRuntimeConfig が適用する必要のあるプールを選択します。nil セレクターを使用すると、プールは選択されません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| 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 は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
2.1.6. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status には、コンテナーのランタイム設定に関する観測情報が含まれます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、現在の状態に関して利用可能な最新の観測結果を表します。 |
|
|
| ContainerRuntimeConfigCondition は、ContainerRuntimeConfig の状態を定義します |
|
|
| observedGeneration は、コントローラーによって監視された世代を表します。 |
2.1.7. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、現在の状態に関して利用可能な最新の観測結果を表します。
- 型
-
array
2.1.8. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ContainerRuntimeConfigCondition は、ContainerRuntimeConfig の状態を定義します
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
| `` | lastTransitionTime は、現在のステータスオブジェクトが最後に更新された時刻です。 |
|
|
| message は、現在の状態に関する追加情報を提供します。これは人間によってのみ消費されます。 |
|
|
| reason は、条件の最後の遷移の理由です。理由は PascalCase です |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| 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}-
DELETE: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 のコレクションを削除します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が ContainerRuntimeConfig のオブジェクトをリスト表示します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ContainerRuntimeConfig を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
2.2.2. /apis/machineconfiguration.openshift.io/v1/containerruntimeconfigs/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ContainerRuntimeConfig の名前 |
- HTTP メソッド
-
DELETE - 説明
- ContainerRuntimeConfig を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された ContainerRuntimeConfig を読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ContainerRuntimeConfig を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ContainerRuntimeConfig を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
2.2.3. /apis/machineconfiguration.openshift.io/v1/containerruntimeconfigs/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ContainerRuntimeConfig の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された ContainerRuntimeConfig のステータスを読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ContainerRuntimeConfig のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ContainerRuntimeConfig のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第3章 ControllerConfig [machineconfiguration.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
ControllerConfig は、MachineConfigController の設定を記述します。これは現在、TemplateController によって生成された MachineConfig オブジェクトを駆動するためにのみ使用されます。
互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (いずれか長い方) で安定しています。
- 型
-
object - 必須
-
spec
-
3.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec には、必要なコントローラー設定が含まれています。 |
|
|
| status には、コントローラー設定に関する観測情報が含まれます。 |
3.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec には、必要なコントローラー設定が含まれています。
- 型
-
object - 必須
-
baseOSContainerImage -
cloudProviderConfig -
clusterDNSIP -
images -
ipFamilies -
kubeAPIServerServingCAData -
releaseImage -
rootCAData
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
| `` | additionalTrustBundle は、ノードの信頼できる証明書ストアに追加される証明書バンドルです。 |
|
|
| baseOSContainerImage は、オペレーティングシステムの更新用の新しい形式のコンテナーイメージです。 |
|
|
| baseOSExtensionsContainerImage は、新しい形式のコンテナーに一致するエクステンションコンテナーです。 |
|
| `` | cloudProviderCAData は、クラウドプロバイダー CA データを指定します。 |
|
|
| cloudProviderConfig は、特定のクラウドプロバイダーの設定です |
|
|
| clusterDNSIP は、クラスター DNS IP アドレスです。 |
|
|
| dns はクラスター DNS の詳細を保持します |
|
|
| etcdDiscoveryDomain は非推奨です。代わりに、Infra.Status.EtcdDiscoveryDomain を使用してください。 |
|
|
| imageRegistryBundleData is the ImageRegistryData |
|
|
| ImageRegistryBundle には、イメージレジストリー証明書を書き込むための情報が含まれています。 |
|
|
| imageRegistryBundleUserData はユーザーが提供するイメージレジストリーデータです |
|
|
| ImageRegistryBundle には、イメージレジストリー証明書を書き込むための情報が含まれています。 |
|
|
| images は、コントローラーが./templates/の下にテンプレートをレンダリングするために使用するイメージのマップです。 |
|
|
| infra は、インフラストラクチャーの詳細を保持します。 |
|
| `` | internalRegistryPullSecret は内部レジストリーのプルシークレットであり、rpm-ostree が内部レジストリーからイメージをプルするために使用します (存在する場合) |
|
|
| ipFamilies は、クラスターネットワークで使用されている IP ファミリーを示します |
|
|
| kubeAPIServerServingCAData が管理する Kubelet から API サーバー証明書へ…自動的にローテーション |
|
| `` | network には追加のネットワーク関連情報が含まれています。 |
|
|
| networkType は、クラスターが XXX を使用しているネットワークのタイプを保持します。これは一時的なものであり、ネットワーク関連サービスを適切な方法で開始するためのより良いサポートのために、できるだけ早く削除されます。クラスターが最初に起動して実行されると、誰もこれを変更しないため、これが変更された場合は再生成を許可しないでください。 |
|
|
| osImageURL は、OS 更新ペイロードを含む古い形式のコンテナーイメージです。 |
|
|
| プラットフォームは非推奨です。代わりに Infra.Status.PlatformStatus.Type を使用してください |
|
| `` | プロキシーは、ノードの現在のプロキシー設定を保持します |
|
|
| pullSecret は、すべてのマシンにインストールする必要があるデフォルトのプルシークレットです。 |
|
|
| releaseImage は、クラスターのインストール時に使用されるイメージです |
|
|
| rootCAData は、root CA データを指定します |
3.1.2. .spec.dns リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- dns はクラスター DNS の詳細を保持します
- 型
-
object - 必須
-
spec -
kind -
apiVersion
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion は、オブジェクトのこの表現のバージョンスキーマを定義します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind は、このオブジェクトのタイプを表す文字列値です。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 |
3.1.3. .spec.imageRegistryBundleData リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- imageRegistryBundleData is the ImageRegistryData
- 型
-
array
3.1.4. .spec.imageRegistryBundleData[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ImageRegistryBundle には、イメージレジストリー証明書を書き込むための情報が含まれています。
- 型
-
object - 必須
-
data -
file
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| data は、ファイルのロケーションに書き込まれるバンドルの内容を保持します。 |
|
|
| file は、バンドルがディスクに書き込まれるファイルの名前を保持します |
3.1.5. .spec.imageRegistryBundleUserData リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- imageRegistryBundleUserData はユーザーが提供するイメージレジストリーデータです
- 型
-
array
3.1.6. .spec.imageRegistryBundleUserData[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ImageRegistryBundle には、イメージレジストリー証明書を書き込むための情報が含まれています。
- 型
-
object - 必須
-
data -
file
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| data は、ファイルのロケーションに書き込まれるバンドルの内容を保持します。 |
|
|
| file は、バンドルがディスクに書き込まれるファイルの名前を保持します |
3.1.7. .spec.infra リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- infra は、インフラストラクチャーの詳細を保持します。
- 型
-
object - 必須
-
spec -
kind -
apiVersion
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion は、オブジェクトのこの表現のバージョンスキーマを定義します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind は、このオブジェクトのタイプを表す文字列値です。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 |
3.1.8. .spec.pullSecret リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- pullSecret は、すべてのマシンにインストールする必要があるデフォルトのプルシークレットです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 参照先の API バージョン。 |
|
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
|
| 参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
3.1.9. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status には、コントローラー設定に関する観測情報が含まれます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、現在の状態に関して利用可能な最新の観測結果を表します。 |
|
|
| ControllerConfigStatusCondition には、ControllerConfigStatus の条件情報が含まれています |
|
|
| controllerCertificates は、MCO 内の自動的にローテーションされる証明書の最新の利用可能な観測結果を表します。 |
|
|
| ControllerCertificate には特定の証明書に関する情報が含まれています。 |
|
|
| observedGeneration は、コントローラーによって監視された世代を表します。 |
3.1.10. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、現在の状態に関して利用可能な最新の観測結果を表します。
- 型
-
array
3.1.11. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ControllerConfigStatusCondition には、ControllerConfigStatus の条件情報が含まれています
- 型
-
object - 必須
-
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
| `` | lastTransitionTime は、現在のステータスオブジェクトが最後に更新された時刻です。 |
|
|
| message は、現在の状態に関する追加情報を提供します。これは人間によってのみ消費されます。 |
|
|
| reason は、条件の最後の遷移の理由です。理由は PascalCase です |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| type は、Operator の調整機能の状態を指定します。 |
3.1.12. .status.controllerCertificates リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- controllerCertificates は、MCO 内の自動的にローテーションされる証明書の最新の利用可能な観測結果を表します。
- 型
-
array
3.1.13. .status.controllerCertificates[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ControllerCertificate には特定の証明書に関する情報が含まれています。
- 型
-
object - 必須
-
bundleFile -
signer -
subject
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| bundleFile は証明書の元となる大きなバンドルです |
|
|
| notAfter は有効性の上限です |
|
|
| notBefore は有効性の下限です |
|
|
| signer は証明書の Issuer です |
|
|
| subject は証明書のサブジェクトです。 |
3.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/machineconfiguration.openshift.io/v1/controllerconfigs-
DELETE:ControllerConfig のコレクションを削除します -
GET: 種類が ControllerConfig のオブジェクトをリスト表示します -
POST:ControllerConfig を作成します
-
/apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}-
DELETE: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 のコレクションを削除します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が ControllerConfig のオブジェクトをリスト表示します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ControllerConfig を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
3.2.2. /apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ControllerConfig の名前 |
- HTTP メソッド
-
DELETE - 説明
- ControllerConfig を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された ControllerConfig を読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ControllerConfig を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ControllerConfig を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
3.2.3. /apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ControllerConfig の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された ControllerConfig のステータスを読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ControllerConfig のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ControllerConfig のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第4章 ControlPlaneMachineSet [machine.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ControlPlaneMachineSet を使用すると、指定された数のコントロールプレーンマシンのレプリカが常に実行されるようになります。互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (いずれか長い方) で安定しています。
- 型
-
object
4.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| ControlPlaneMachineSet は、ControlPlaneMachineSet の設定を表します。 |
|
|
| ControlPlaneMachineSetStatus は、ControlPlaneMachineSet CRD のステータスを表します。 |
4.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ControlPlaneMachineSet は、ControlPlaneMachineSet の設定を表します。
- 型
-
object - 必須
-
replicas -
selector -
template
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| machineNamePrefix は、マシン名を作成するときに使用される接頭辞です。各マシン名は、この接頭辞、それに続くランダムに生成された 5 文字の文字列、およびマシンのインデックスで構成されます。小文字の英数字、ハイフン ('-')、ピリオド ('.') が含まれる小文字の RFC 1123 サブドメインである必要があります。ピリオドで区切られた各ブロックは、英数字で始まり、英数字で終わる必要があります。ブロックの先頭または末尾にハイフンを使用することはできず、ピリオドの連続も許可されません。接頭辞の長さは 1 文字以上 245 文字以下にする必要があります。たとえば、machineNamePrefix が 'control-plane' に設定され、3 台のマシンが作成された場合、それらの名前は control-plane-abcde-0、control-plane-fghij-1、control-plane-klmno-2 のようになります。 |
|
|
| replicas は、この ControlPlaneMachineSet によって作成されるコントロールプレーン Machine の数を定義します。このフィールドはイミュータブルであり、クラスターのインストール後に変更することはできません。ControlPlaneMachineSet は 3 または 5 ノードのコントロールプレーンでのみ動作し、このフィールドの有効な値は 3 と 5 のみです。 |
|
|
| Machine のラベルセレクター。このセレクターによって選択された既存の Machine が、この ControlPlaneMachineSet の影響を受ける Machine になります。テンプレートのラベルと一致する必要があります。このフィールドは、リソースの作成後はイミュータブルと見なされます。 |
|
|
| state は、ControlPlaneMachineSet がアクティブか非アクティブかを定義します。非アクティブな場合、ControlPlaneMachineSet はクラスター内の Machine の状態に対して何のアクションも実行しません。アクティブな場合、ControlPlaneMachineSet は Machine を調整し、必要に応じて Machine を更新します。ControlPlaneMachineSet は、一度アクティブになると非アクティブにすることはできません。これ以上のアクションを阻止するには、ControlPlaneMachineSet を削除してください。 |
|
|
| strategy は、ControlPlaneMachineSet が ProviderSpec の変更を検出したときに Machine を更新する方法を定義します。 |
|
|
| template は、この ControlPlaneMachineSet によって作成されるコントロールプレーンマシンを記述します。 |
4.1.2. .spec.selector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Machine のラベルセレクター。このセレクターによって選択された既存の Machine が、この ControlPlaneMachineSet の影響を受ける Machine になります。テンプレートのラベルと一致する必要があります。このフィールドは、リソースの作成後はイミュータブルと見なされます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| 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 は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
4.1.5. .spec.strategy リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- strategy は、ControlPlaneMachineSet が ProviderSpec の変更を検出したときに Machine を更新する方法を定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| type は、ControlPlaneMachineSet が所有する Machine を更新するときに使用する更新ストラテジーのタイプを定義します。有効な値は "RollingUpdate" と "OnDelete" です。現在のデフォルト値は "RollingUpdate" です。 |
4.1.6. .spec.template リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- template は、この ControlPlaneMachineSet によって作成されるコントロールプレーンマシンを記述します。
- 型
-
object - 必須
-
machineType
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| machineType は、ControlPlaneMachineSet によって管理される必要がある Machine のタイプを決定します。現在、有効な値は machines_v1beta1_machine_openshift_io のみです。 |
|
|
| OpenShiftMachineV1Beta1Machine は、v1beta1.machine.openshift.io API グループから Machine を作成するためのテンプレートを定義します。 |
4.1.7. .spec.template.machines_v1beta1_machine_openshift_io リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OpenShiftMachineV1Beta1Machine は、v1beta1.machine.openshift.io API グループから Machine を作成するためのテンプレートを定義します。
- 型
-
object - 必須
-
metadata -
spec
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| failureDomains は、ControlPlaneMachineSet がコントロールプレーンマシンのバランスをとる必要がある障害ドメイン (アベイラビリティーゾーンと呼ばれる場合もある) のリストです。これは、テンプレートで指定された ProviderSpec にマージされます。配置情報を必要としないプラットフォームでは、このフィールドはオプションです。 |
|
|
| ObjectMeta は標準のオブジェクトメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。ラベルは、ControlPlaneMachineSet セレクターと一致する必要があります。 |
|
|
| spec には、コントロールプレーンマシンの必要な設定が含まれています。ProviderSpec には、コントロールプレーンマシンを作成するためのプラットフォーム固有の詳細が含まれています。ProviderSe は、プラットフォーム固有の障害ドメインフィールドを除いて完了している必要があります。これは、FailureDomains フィールドに基づいて Machine が作成される際にオーバーライドされます。 |
4.1.8. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- failureDomains は、ControlPlaneMachineSet がコントロールプレーンマシンのバランスをとる必要がある障害ドメイン (アベイラビリティーゾーンと呼ばれる場合もある) のリストです。これは、テンプレートで指定された ProviderSpec にマージされます。配置情報を必要としないプラットフォームでは、このフィールドはオプションです。
- 型
-
object - 必須
-
platform
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| aws は、AWS プラットフォームの障害ドメイン情報を設定します。 |
|
|
| AWSFailureDomain は、AWS プラットフォームの障害ドメイン情報を設定します。 |
|
|
| azure は、Azure プラットフォームの障害ドメイン情報を設定します。 |
|
|
| AzureFailureDomain は、Azure プラットフォームの障害ドメイン情報を設定します。 |
|
|
| gcp は、GCP プラットフォームの障害ドメイン情報を設定します。 |
|
|
| GCPFailureDomain は、GCP プラットフォームの障害ドメイン情報を設定します。 |
|
|
| nutanix は、Nutanix プラットフォームの障害ドメイン情報を設定します。 |
|
|
| NutanixFailureDomainReference は、Nutanix プラットフォームの障害ドメインを参照します。 |
|
|
| openstack は、OpenStack プラットフォームの障害ドメイン情報を設定します。 |
|
|
| OpenStackFailureDomain は、OpenStack プラットフォームの障害ドメイン情報を設定します。 |
|
|
| platform は、FailureDomain が表すプラットフォームを識別します。現在サポートされている値は、AWS、Azure、GCP、OpenStack、VSphere、Nutanix です。 |
|
|
| vsphere は、VSphere プラットフォームの障害ドメイン情報を設定します。 |
|
|
| 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 は、このインスタンスの配置情報を設定します。 |
|
|
| subnet は、このインスタンスに使用するサブネットへの参照です。 |
4.1.11. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[].placement リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- placement は、このインスタンスの配置情報を設定します。
- 型
-
object - 必須
-
availabilityZone
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| availabilityZone はインスタンスのアベイラビリティーゾーンです。 |
4.1.12. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[].subnet リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- subnet は、このインスタンスに使用するサブネットへの参照です。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| リソースの arn。 |
|
|
| filters は、リソースを識別するために使用されるフィルターのセットです。 |
|
|
| AWSResourceFilter は、AWS リソースを識別するために使用されるフィルターです |
|
|
| リソースの id。 |
|
|
| type は、参照が 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| フィルターの名前。フィルター名では大文字と小文字が区別されます。 |
|
|
| values には 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 は、仮想マシンが作成されるネットワークサブネットの名前です。省略した場合は、マシンの providerSpec テンプレートのサブネット値が使用されます。 |
|
|
| 仮想マシンのアベイラビリティーゾーン。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 は、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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 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 は、OpenStack マシンプロバイダーが仮想マシンを作成する nova アベイラビリティーゾーンです。指定しない場合、仮想マシンは nova 設定で指定されたデフォルトのアベイラビリティーゾーンに作成されます。アベイラビリティーゾーン名には : を含めることはできません。これは、サーバー作成時にインスタンスが起動されるホストを指定するために管理者ユーザーが使用するためです。また、スペースを含めることはできません。スペースを含めると、このアベイラビリティーゾーンに属するノードの登録が失敗します。詳細は、kubernetes/cloud-provider-openstack#1379 を参照してください。ラベルの制限により、アベイラビリティーゾーン名の最大長は 63 です。 |
|
|
| rootVolume には、OpenStack マシンプロバイダーが仮想マシンに接続された root ボリュームを作成するために使用する設定が含まれています。指定されない場合は、root ボリュームは作成されません。 |
4.1.23. .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.openstack[].rootVolume リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- rootVolume には、OpenStack マシンプロバイダーが仮想マシンに接続された root ボリュームを作成するために使用する設定が含まれています。指定されない場合は、root ボリュームは作成されません。
- 型
-
object - 必須
-
volumeType
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 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 は、プロビジョニングされる 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 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 は、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations |
|
|
| オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: 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 リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec には、コントロールプレーンマシンの必要な設定が含まれています。ProviderSpec には、コントロールプレーンマシンを作成するためのプラットフォーム固有の詳細が含まれています。ProviderSe は、プラットフォーム固有の障害ドメインフィールドを除いて完了している必要があります。これは、FailureDomains フィールドに基づいて Machine が作成される際にオーバーライドされます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lifecycleHooks を使用すると、ユーザーはマシンのライフサイクル内の特定の定義済みポイントでマシン上の操作を一時停止できます。 |
|
|
| ObjectMeta は、作成されたノードに自動入力します。これを使用して、ノードの作成時に使用するラベル、アノテーション、名前接頭辞などを示します。 |
|
|
| providerID は、プロバイダーによって提供されたマシンの ID です。このフィールドは、このマシンに対応するノードオブジェクトに表示されるプロバイダー ID と一致する必要があります。このフィールドは、cluster-api の上位レベルのコンシューマーに必要です。ユースケースの例は、プロバイダーとして cluster-api を使用するクラスターオートスケーラーです。オートスケーラーのクリーンアップロジックは、マシンをノードと比較して、Kubernetes ノードとして登録できなかったプロバイダーのマシンを見つけます。オートスケーラーの一般的なツリー外プロバイダーとして cluster-api を使用する場合、このフィールドは、マシンのリストのプロバイダービューを持つことができるようにするためにオートスケーラーによって必要とされます。k8s apiserver からノードの別のリストが照会され、比較が行われて未登録のマシンが検出され、削除のマークが付けられます。このフィールドはアクチュエーターによって設定され、汎用プロバイダーとして cluster-api とインターフェイスするオートスケーラーなどの高レベルのエンティティーによって消費されます。 |
|
|
| providerSpec は、ノードの作成時に使用するプロバイダー固有の設定を詳述するものです。 |
|
|
| 対応するノードに追加的に適用されるテイントのリスト。このリストは、他のエンティティーによって継続的にノードに追加された他のテイントを上書きしません。これらのテイントは積極的に調整する必要があります。たとえば、マシンコントローラーにテイントを適用するように依頼し、手動でテイントを除去すると、マシンコントローラーはテイントを元に戻します)、マシンコントローラーにテイントを除去させないでください。 |
|
|
| この Taint が接続されているノードは、Taint を許容しない Pod に "影響を及ぼし" ます。 |
4.1.28. .spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- lifecycleHooks を使用すると、ユーザーはマシンのライフサイクル内の特定の定義済みポイントでマシン上の操作を一時停止できます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| preDrain フックは、マシンの drain (Pod の退避) の実行を阻止します。これにより、終了などのライフサイクルイベントもさらにブロックされます。 |
|
|
| LifecycleHook はライフサイクルフックの単一インスタンスを表します。 |
|
|
| preTerminate フックはマシンが終了するのを防ぎます。preTerminate フックは、Machine が drain (Pod の退避) を実行された後に実行されます。 |
|
|
| LifecycleHook はライフサイクルフックの単一インスタンスを表します。 |
4.1.29. .spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks.preDrain リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- preDrain フックは、マシンの drain (Pod の退避) の実行を阻止します。これにより、終了などのライフサイクルイベントもさらにブロックされます。
- 型
-
array
4.1.30. .spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks.preDrain[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- LifecycleHook はライフサイクルフックの単一インスタンスを表します。
- 型
-
object - 必須
-
name -
owner
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name はライフサイクルフックの一意の名前を定義します。名前は一意でわかりやすく、理想的には 1 - 3 語で CamelCase で表記する必要がありますが、namespace を使用することもできます (例: foo.example.com/CamelCase)。名前は一意である必要があり、単一のエンティティーによってのみ管理される必要があります。 |
|
|
| owner は、ライフサイクルフックの所有者を定義します。これは、ライフサイクルをブロックしているのが誰であるかをユーザーが識別できるように、わかるように説明してある必要があります。これは、コントローラーの名前 (例: clusteroperator/etcd) またはフックを管理する管理者の名前である可能性があります。 |
4.1.31. .spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks.preTerminate リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- preTerminate フックはマシンが終了するのを防ぎます。preTerminate フックは、Machine が drain (Pod の退避) を実行された後に実行されます。
- 型
-
array
4.1.32. .spec.template.machines_v1beta1_machine_openshift_io.spec.lifecycleHooks.preTerminate[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- LifecycleHook はライフサイクルフックの単一インスタンスを表します。
- 型
-
object - 必須
-
name -
owner
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name はライフサイクルフックの一意の名前を定義します。名前は一意でわかりやすく、理想的には 1 - 3 語で CamelCase で表記する必要がありますが、namespace を使用することもできます (例: foo.example.com/CamelCase)。名前は一意である必要があり、単一のエンティティーによってのみ管理される必要があります。 |
|
|
| owner は、ライフサイクルフックの所有者を定義します。これは、ライフサイクルをブロックしているのが誰であるかをユーザーが識別できるように、わかるように説明してある必要があります。これは、コントローラーの名前 (例: clusteroperator/etcd) またはフックを管理する管理者の名前である可能性があります。 |
4.1.33. .spec.template.machines_v1beta1_machine_openshift_io.spec.metadata リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ObjectMeta は、作成されたノードに自動入力します。これを使用して、ノードの作成時に使用するラベル、アノテーション、名前接頭辞などを示します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| annotations は、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations |
|
|
| generateName は、Name フィールドが指定されていない場合に限り一意の名前を生成するためにサーバーが使用するオプションの接頭辞です。このフィールドを使用する場合、クライアントに返される名前は渡された名前とは異なります。この値は、一意の接尾辞とも組み合わされます。提供された値には、名前フィールドと同じ検証ルールがあり、サーバー上で値を一意にするために必要な接尾辞の長さで切り捨てられる場合があります。 このフィールドが指定されており、生成された名前が存在する場合、サーバーは 409 を返しません。代わりに、割り当てられた時間内に一意の名前が見つからなかったことを示す Reason ServerTimeout で 201 Created または 500 を返します。クライアントは再試行する必要があります (オプションで、Retry-After ヘッダーに示されている時間の後)。 Name が指定されていない場合にのみ適用されます。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency |
|
|
| オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labels |
|
|
| name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これは更新できません。詳細: http://kubernetes.io/docs/user-guide/identifiers#names |
|
|
| namespace は、各名前内のスペースが一意である必要があることを定義します。空の namespace は "default" の namespace と同じですが、"default" が正式な表現です。すべてのオブジェクトを namespace のスコープに設定する必要はありません。それらのオブジェクトでは、このフィールドの値は空になります。 DNS_LABEL である必要があります。これは更新できません。詳細: http://kubernetes.io/docs/user-guide/namespaces |
|
|
| このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。 |
|
|
| OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ namespace にあるか、クラスタースコープである必要があるため、namespace フィールドはありません。 |
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 には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ namespace にあるか、クラスタースコープである必要があるため、namespace フィールドはありません。
- 型
-
object - 必須
-
apiVersion -
kind -
name -
uid
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 参照先の API バージョン。 |
|
|
| true の場合、および所有者が "foregroundDeletion" ファイナライザーを持っている場合、この参照が削除されるまで、所有者を Key-Value ストアから削除することはできません。ガベージコレクターがこのフィールドと対話し、フォアグラウンドを強制的に削除する方法は、https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion を参照してください。デフォルトは false です。このフィールドを設定するには、ユーザーは所有者の "削除" 権限を必要とします。そうしないと、422 (処理不能エンティティー) が返されます。 |
|
|
| true の場合、この参照は管理コントローラーを指します。 |
|
|
| 参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
|
|
| 参照先の 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[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- この Taint が接続されているノードは、Taint を許容しない Pod に "影響を及ぼし" ます。
- 型
-
object - 必須
-
effect -
key
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 必須。テイントを許容しない Pod に対するテイントの影響。有効な効果は、NoSchedule、PreferNoSchedule、および NoExecute です。 |
|
|
| 必須。ノードに適用されるテイントキー。 |
|
|
| timeAdded は、テイントが追加された時刻を表します。NoExecute テイントにのみ作成されます。 |
|
|
| テイントキーに対応するテイント値。 |
4.1.39. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ControlPlaneMachineSetStatus は、ControlPlaneMachineSet CRD のステータスを表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、ControlPlaneMachineSet の現在の状態に関する観測結果を表します。既知の .status.conditions.type は、Available、Degraded、および Progressing です。 |
|
|
| condition には、この API Resource の現在の状態のある側面の詳細が含まれます。 |
|
|
| observedGeneration は、この ControlPlaneMachineSet で観測された最新の世代です。これは、API サーバーによる変更時に更新される ControlPlaneMachineSets の世代に対応します。 |
|
|
| readyReplicas は、ControlPlaneMachineSet コントローラーによって作成され、準備が完了したコントロールプレーンマシンの数です。ローリング更新の進行中は、この値が希望するレプリカ数よりも高くなる可能性があることに注意してください。 |
|
|
| replicas は、ControlPlaneMachineSet コントローラーによって作成されたコントロールプレーンマシンの数です。更新操作中、この値は必要なレプリカ数と異なる場合があることに注意してください。 |
|
|
| unavailableReplicas は、ControlPlaneMachineSet が必要とする使用可能な容量に達するまでに引き続き必要なコントロールプレーンマシンの数です。この値がゼロ以外の場合、ReadyReplicas の数は必要なレプリカの数よりも少なくなります。 |
|
|
| updatedReplicas は、ControlPlaneMachineSet コントローラーによって作成され、必要なプロバイダー spec を持ち、準備ができている、終了していないコントロールプレーンマシンの数です。目的の spec への変更が検出されると、この値は 0 に設定されます。更新ストラテジーが RollingUpdate の場合、これはマシンの更新プロセスの開始と同時に行われます。更新ストラテジーが OnDelete の場合、ユーザーが既存のレプリカを削除し、その置き換えが準備されるまで、この値は 0 のままになります。 |
4.1.40. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、ControlPlaneMachineSet の現在の状態に関する観測結果を表します。既知の .status.conditions.type は、Available、Degraded、および Progressing です。
- 型
-
array
4.1.41. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- condition には、この API Resource の現在の状態のある側面の詳細が含まれます。
- 型
-
object - 必須
-
lastTransitionTime -
message -
reason -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
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 のオブジェクトをリスト表示します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
4.2.2. /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- ControlPlaneMachineSet のコレクションを削除します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- kind が ControlPlaneMachineSet のオブジェクトをリスト表示します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ControlPlaneMachineSet を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
4.2.3. /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ControlPlaneMachineSet の名前 |
- HTTP メソッド
-
DELETE - 説明
- ControlPlaneMachineSet を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された ControlPlaneMachineSet を読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ControlPlaneMachineSet を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ControlPlaneMachineSet を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
4.2.4. /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets/{name}/scale リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ControlPlaneMachineSet の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された ControlPlaneMachineSet のスケールを読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ControlPlaneMachineSet のスケールを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ControlPlaneMachineSet のスケールを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
4.2.5. /apis/machine.openshift.io/v1/namespaces/{namespace}/controlplanemachinesets/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ControlPlaneMachineSet の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された ControlPlaneMachineSet のステータスを読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ControlPlaneMachineSet のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ControlPlaneMachineSet のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第5章 KubeletConfig [machineconfiguration.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
KubeletConfig は、カスタマイズされた Kubelet 設定を記述します。
互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (いずれか長い方) で安定しています。
- 型
-
object - 必須
-
spec
-
5.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec には必要な kubelet 設定が含まれています。 |
|
|
| status には、kubelet 設定に関する観測情報が含まれます。 |
5.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec には必要な kubelet 設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| |
|
| `` | kubeletConfig フィールドは、kubernetes アップストリームで定義されます。アップストリーム kubernetes の OpenShift で使用されるバージョン/コミットで定義されているタイプを参照してください。kubelet 設定のフィールドはアップストリームから直接フェッチされるため、これらの値の検証は kubelet によって直接処理されることに注意してください。これらのフィールドの有効な値は、関連する kubernetes のアップストリームバージョンを参照してください。kubelet 設定フィールドの値が無効な場合、クラスターノードが使用できなくなる可能性があります。 |
|
|
| |
|
|
| machineConfigPoolSelector は、KubeletConfig を適用するプールを選択します。nil セレクターを使用すると、プールは選択されません。 |
|
|
| 設定されていない場合、デフォルトは apiservers.config.openshift.io/cluster リソースに基づいています。現在サポートされているのは Old および Intermediate プロファイルのみであり、使用可能な minTLSVersion の最大バージョンは VersionTLS12 であることに注意してください。 |
5.1.2. .spec.machineConfigPoolSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- machineConfigPoolSelector は、KubeletConfig を適用するプールを選択します。nil セレクターを使用すると、プールは選択されません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| 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 は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| 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 は、ユーザー定義の TLS セキュリティープロファイルです。無効な設定は壊滅的である可能性があるため、カスタムプロファイルの使用には細心の注意を払ってください。カスタムプロファイルの例は次のようになります。 暗号化: - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 minTLSVersion: VersionTLS11 |
|
| `` | intermediate は、以下に基づく TLS セキュリティープロファイルです。 https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29 以下のようになります (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 は、以下に基づく TLS セキュリティープロファイルです。 https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility 以下のようになります (yaml): 暗号化: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 minTLSVersion: VersionTLS13 |
|
| `` | old は、以下に基づく TLS セキュリティープロファイルです。 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 は、Old、Intermediate、Modern、または Custom のいずれかです。カスタムは、個々の TLS セキュリティープロファイルパラメーターを指定する機能を提供します。Old、Intermediate、Modern は、以下に基づく TLS セキュリティープロファイルです。 https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations プロファイルは意図に基づいているため、時間の経過とともに新しい暗号が開発され、既存の暗号がセキュアでないことが判明すると、変更される可能性があります。プロセスで使用できる暗号の正確さに応じて、リストが削減される場合があります。 Modern プロファイルは、一般的なソフトウェアライブラリーでまだ十分に採用されていないため、現在サポートされていないことに注意してください。 |
5.1.6. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status には、kubelet 設定に関する観測情報が含まれます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、現在の状態に関して利用可能な最新の観測結果を表します。 |
|
|
| KubeletConfigCondition は、KubeletConfig の状態を定義します |
|
|
| observedGeneration は、コントローラーによって監視された世代を表します。 |
5.1.7. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、現在の状態に関して利用可能な最新の観測結果を表します。
- 型
-
array
5.1.8. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- KubeletConfigCondition は、KubeletConfig の状態を定義します
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
| `` | lastTransitionTime は、現在のステータスオブジェクトが最後に更新された時刻です。 |
|
|
| message は、現在の状態に関する追加情報を提供します。これは人間によってのみ消費されます。 |
|
|
| reason は、条件の最後の遷移の理由です。理由は PascalCase です |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| 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}-
DELETE: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 のコレクションを削除します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が KubeletConfig のオブジェクトをリスト表示します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- KubeletConfig を作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
5.2.2. /apis/machineconfiguration.openshift.io/v1/kubeletconfigs/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| KubeletConfig の名前。 |
- HTTP メソッド
-
DELETE - 説明
- KubeletConfig を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された KubeletConfig を読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された KubeletConfig を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された KubeletConfig を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
5.2.3. /apis/machineconfiguration.openshift.io/v1/kubeletconfigs/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| KubeletConfig の名前。 |
- HTTP メソッド
-
GET - 説明
- 指定された KubeletConfig のステータスを読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された KubeletConfig のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された KubeletConfig のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第6章 MachineConfig [machineconfiguration.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
MachineConfig は、マシンの設定を定義します。
互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (いずれか長い方) で安定しています。
- 型
-
object
6.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| MachineConfigSpec は、MachineConfig の spec です。 |
6.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineConfigSpec は、MachineConfig の spec です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| baseOSExtensionsContainerImage は、新しい形式の OS イメージに一致するエクステンションコンテナーを取得するために使用されるリモートロケーションを指定します。 |
|
| `` | config は Ignition Config オブジェクトです。 |
|
|
| extensions には、ホストで有効にできる追加機能のリストが含まれています |
|
|
| fips は FIPS モードを制御します |
|
| `` | kernelArguments には、追加するカーネル引数のリストが含まれています |
|
|
| kernelType には、デフォルト (従来型)、リアルタイム、64k ページ (aarch64 のみ) など、実行するカーネルが含まれます。 |
|
|
| 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}-
DELETE:MachineConfig を削除します -
GET: 指定された MachineConfig を読み取ります -
PATCH: 指定された MachineConfig を部分的に更新します -
PUT: 指定された MachineConfig を置き換えます
-
6.2.1. /apis/machineconfiguration.openshift.io/v1/machineconfigs リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- MachineConfig のコレクションを削除します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が MachineConfig のオブジェクトをリスト表示します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- MachineConfig を作します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
6.2.2. /apis/machineconfiguration.openshift.io/v1/machineconfigs/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| MachineConfig の名前 |
- HTTP メソッド
-
DELETE - 説明
- MachineConfig を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された MachineConfig を読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された MachineConfig を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された MachineConfig を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第7章 MachineConfigPool [machineconfiguration.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
MachineConfigPool は、MachineConfig のプールを記述します。
互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (いずれか長い方) で安定しています。
- 型
-
object - 必須
-
spec
-
7.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec には、必要なマシン設定プールの設定が含まれています。 |
|
|
| status には、マシン設定プールに関する観察された情報が含まれます。 |
7.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec には、必要なマシン設定プールの設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| マシン設定プールのターゲットとなる MachineConfig オブジェクト。 |
|
|
| machineConfigSelector は、MachineConfigs のラベルセレクターを指定します。ラベルとセレクターの動作は、https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ を参照してください。 |
|
|
| maxUnavailable は、更新中に使用不可になる可能性のあるプール内のノードの整数の数またはパーセンテージを定義します。これには、ユーザーが開始した遮断、障害のあるノードなど、何らかの理由で使用できないノードが含まれます。デフォルト値は 1 です。 値が 1 より大きい場合、更新中に複数のノードが使用できなくなるため、残りのノードのワークロードのストレスに影響する可能性があります。この値を 0 に設定して更新を停止することはできません (デフォルトで 1 に戻ります)。更新を停止するには、代わりに 'paused' プロパティーを使用します。drain (Pod の退避) の実行は、maxUnavailable が 1 より大きい場合でも、etcd クォーラムガードなどの Pod Disruption Budget (PDB) を尊重します。 |
|
|
| nodeSelector は、マシンのラベルセレクターを指定します |
|
|
| paused は、このマシン設定プールへの変更を停止するかどうかを指定します。これには、新しい desiredMachineConfig の生成とマシンの更新が含まれます。 |
|
|
| pinnedImageSets は、プールの PinnedImageSetRef オブジェクトのシーケンスを指定します。このプール内のノードは、PinnedImageSet で定義されたイメージをプリロードしてピン留めします。イメージをプルする前に、MachineConfigDaemon はすべてのイメージの合計非圧縮サイズが利用可能なリソースを超えないことを確認します。イメージの合計サイズが利用可能なリソースを超える場合、コントローラーは MachineConfigPool に Degraded ステータスを報告し、イメージのプルを試行しません。また、kubelet がストレージリスクを軽減できるようにするために、pinned_image 設定とそれに続くサービスのリロードは、各セットのすべてのイメージがプルされた後にのみ実行されます。複数の PinnedImageSets からのイメージは、リストされている順序で逐次的にロードおよびピン留めされます。重複したイメージや既存のイメージはスキップされます。 イメージのプリフェッチまたはピン留めに失敗すると、そのプールは Degraded 状態になります。これらの障害を解決するのはユーザーの責任です。管理者は、十分なストレージと適切なイメージ認証が事前に確保されていることを積極的に確認する必要があります。 |
|
|
|
7.1.2. .spec.configuration リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- マシン設定プールのターゲットとなる MachineConfig オブジェクト。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 参照先の API バージョン。 |
|
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
|
| 参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
|
source は、 |
|
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
|
|
| 参照先の 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 には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 参照先の API バージョン。 |
|
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
|
| 参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
7.1.5. .spec.machineConfigSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- machineConfigSelector は、MachineConfigs のラベルセレクターを指定します。ラベルとセレクターの動作は、https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ を参照してください。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| 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 は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
7.1.8. .spec.nodeSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- nodeSelector は、マシンのラベルセレクターを指定します
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| 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 は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
7.1.11. .spec.pinnedImageSets リンクのコピーリンクがクリップボードにコピーされました!
- 説明
pinnedImageSets は、プールの PinnedImageSetRef オブジェクトのシーケンスを指定します。このプール内のノードは、PinnedImageSet で定義されたイメージをプリロードしてピン留めします。イメージをプルする前に、MachineConfigDaemon はすべてのイメージの合計非圧縮サイズが利用可能なリソースを超えないことを確認します。イメージの合計サイズが利用可能なリソースを超える場合、コントローラーは MachineConfigPool に Degraded ステータスを報告し、イメージのプルを試行しません。また、kubelet がストレージリスクを軽減できるようにするために、pinned_image 設定とそれに続くサービスのリロードは、各セットのすべてのイメージがプルされた後にのみ実行されます。複数の PinnedImageSets からのイメージは、リストされている順序で逐次的にロードおよびピン留めされます。重複したイメージや既存のイメージはスキップされます。
イメージのプリフェッチまたはピン留めに失敗すると、そのプールは Degraded 状態になります。これらの障害を解決するのはユーザーの責任です。管理者は、十分なストレージと適切なイメージ認証が事前に確保されていることを積極的に確認する必要があります。
- 型
-
array
7.1.12. .spec.pinnedImageSets[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は PinnedImageSet の名前への参照です。RFC-1123 (https://tools.ietf.org/html/rfc1123) に準拠する必要があります。ピリオド (.) で区切られた 1 つ以上のセグメントで構成され、各セグメントは英数字とハイフン (-) で構成され、英数字で始まって終わる必要があり、長さは最大 63 文字です。名前の合計の長さは 253 文字を超えることはできません。 |
7.1.13. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status には、マシン設定プールに関する観察された情報が含まれます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| certExpirys は重要な証明書の有効期限データを記録します |
|
|
| ceryExpiry にはバンドル名と有効期限が含まれます |
|
|
| conditions は、現在の状態に関して利用可能な最新の観測結果を表します。 |
|
|
| MachineConfigPoolCondition には、MachineConfigPool の条件情報が含まれています。 |
|
|
| configuration は、マシン設定プールの現在の MachineConfig オブジェクトを表します。 |
|
|
| degradedMachineCount は、degraded (または unreconcilable) とマークされたマシンの総数を表します。設定の適用に失敗した場合、ノードは劣化としてマークされます。 |
|
|
| machineCount は、マシン設定プール内のマシンの総数を表します。 |
|
|
| observedGeneration は、コントローラーによって監視された世代を表します。 |
|
|
| poolSynchronizersStatus は、プールシンクロナイザーによって管理されるマシンのステータスです。 |
|
|
| |
|
|
| readyMachineCount は、プールの対象となる準備完了マシンの総数を表します。 |
|
|
| unavailableMachineCount は、プールの対象となる使用できない (準備ができていない) マシンの総数を表します。ノードが更新状態にあるか、NodeReady 条件が false の場合、ノードは使用不可としてマークされます。 |
|
|
| updatedMachineCount は、設定として CurrentMachineConfig を持つプールのターゲットとなるマシンの総数を表します。 |
7.1.14. .status.certExpirys リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- certExpirys は重要な証明書の有効期限データを記録します
- 型
-
array
7.1.15. .status.certExpirys[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ceryExpiry にはバンドル名と有効期限が含まれます
- 型
-
object - 必須
-
bundle -
subject
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| bundle は、サブジェクト証明書が存在するバンドルの名前です。 |
|
|
| expiry は、証明書が有効でなくなる日付です。 |
|
|
| subject は証明書のサブジェクトです。 |
7.1.16. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、現在の状態に関して利用可能な最新の観測結果を表します。
- 型
-
array
7.1.17. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineConfigPoolCondition には、MachineConfigPool の条件情報が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
| `` | lastTransitionTime は、この条件の最後のステータス変更に対応するタイムスタンプです。 |
|
|
| メッセージは、最後の遷移の詳細を人間が読める形式で説明したものであり、理由を補足します。 |
|
|
| 理由は、条件の最後の遷移に関する簡単な機械可読な説明です。 |
|
|
| 条件のステータス、'True'、'False'、'Unknown' のいずれか。 |
|
|
| 現在の条件のタイプ ('Done'、'Updating'、'Failed')。 |
7.1.18. .status.configuration リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- configuration は、マシン設定プールの現在の MachineConfig オブジェクトを表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 参照先の API バージョン。 |
|
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
|
| 参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
|
source は、 |
|
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
|
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
7.1.19. .status.configuration.source リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
source は、
contentで指定された単一の MachineConfig オブジェクトを生成するために使用された MachineConfig オブジェクトのリストです。 - 型
-
array
7.1.20. .status.configuration.source[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 参照先の API バージョン。 |
|
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
|
| 参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
7.1.21. .status.poolSynchronizersStatus リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- poolSynchronizersStatus は、プールシンクロナイザーによって管理されるマシンのステータスです。
- 型
-
array
7.1.22. .status.poolSynchronizersStatus[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 型
-
object - 必須
-
availableMachineCount -
machineCount -
poolSynchronizerType -
readyMachineCount -
unavailableMachineCount -
updatedMachineCount
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| availableMachineCount は、ノードシンクロナイザーによって管理されているマシンのうち、利用可能なマシンの数です。 |
|
|
| machineCount は、ノードシンクロナイザーによって管理されるマシンの数です。 |
|
|
| observedGeneration は、適用された最後の世代の変更です。 |
|
|
| poolSynchronizerType は、プールシンクロナイザーのタイプを記述します。 |
|
|
| readyMachineCount は、ノードシンクロナイザーによって管理され、ready 状態にあるマシンの数です。 |
|
|
| unavailableMachineCount は、ノードシンクロナイザーによって管理されているマシンのうち、利用不可能なマシンの数です。 |
|
|
| updatedMachineCount は、ノードシンクロナイザーによって更新されたマシンの数です。 |
7.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/machineconfiguration.openshift.io/v1/machineconfigpools-
DELETE:MachineConfigPool のコレクションを削除します -
GET: 種類が MachineConfigPool のオブジェクトをリスト表示します -
POST:MachineConfigPool を作成します
-
/apis/machineconfiguration.openshift.io/v1/machineconfigpools/{name}-
DELETE: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 のコレクションを削除します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が MachineConfigPool のオブジェクトをリスト表示します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- MachineConfigPool を作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
7.2.2. /apis/machineconfiguration.openshift.io/v1/machineconfigpools/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| MachineConfigPool の名前 |
- HTTP メソッド
-
DELETE - 説明
- MachineConfigPool を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された MachineConfigPool を読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された MachineConfigPool を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された MachineConfigPool を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
7.2.3. /apis/machineconfiguration.openshift.io/v1/machineconfigpools/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| MachineConfigPool の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された MachineConfigPool のステータスを読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された MachineConfigPool のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された MachineConfigPool のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第8章 MachineHealthCheck [machine.openshift.io/v1beta1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineHealthCheck は、machinehealthchecks API のスキーマです。互換性レベル 2: メジャーリリース内で最低 9 カ月間、または 3 つのマイナーリリース内 (いずれか長い方) で安定しています。
- 型
-
object
8.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| マシンヘルスチェックポリシーの仕様 |
|
|
| MachineHealthCheck リソースの最近観察されたステータス |
8.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- マシンヘルスチェックポリシーの仕様
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| それ以上の修復は、"セレクター" によって選択された最大で "maxUnhealthy" マシンが正常でない場合にのみ許可されます。正の整数値またはパーセンテージ値のいずれかを期待します。パーセンテージ値は正の整数でなければならず、100% を上限とします。0% と 0% の両方が有効であり、すべての修復をブロックします。設定されていない場合はデフォルトで 100% になります。 |
|
|
| ノードのないこの期間より古いマシンは、障害が発生したと見なされ、修正されます。ノードのないマシンが削除されないようにするには、この値を明示的に "0" に設定して起動チェックを無効にします。それぞれオプションの分数と単位接尾辞が付いた 10 進数の符号なし期間文字列 ("300ms"、"1.5h"、"2h45m" など) が必要です。有効な時間単位は、"ns"、"us" (または "µs")、"ms"、"s"、"m"、"h" です。 |
|
|
| remediationTemplate は、インフラストラクチャープロバイダーによって提供される修復テンプレートへの参照です。 このフィールドは完全にオプションです。入力すると、MachineHealthCheck コントローラーは、参照されるテンプレートから新しいオブジェクトを作成し、マシンの修復を Machine API Operator の外部にあるコントローラーに渡します。 |
|
|
| ヘルスチェックの対象となるマシンに一致するラベルセレクター。注: 空のセレクターはすべてのマシンに一致します。 |
|
|
| unhealthyConditions には、ノードが異常であると見なされるかどうかを決定する条件のリストが含まれています。条件は論理 OR で結合されます。つまり、条件のいずれかが満たされた場合、ノードは異常です。 |
|
|
| UnhealthyCondition は、期間として指定されたタイムアウトを持つノード条件タイプと値を表します。指定された条件が少なくともタイムアウト値の間指定されたステータスにある場合、ノードは異常であると見なされます。 |
8.1.2. .spec.remediationTemplate リンクのコピーリンクがクリップボードにコピーされました!
- 説明
remediationTemplate は、インフラストラクチャープロバイダーによって提供される修復テンプレートへの参照です。
このフィールドは完全にオプションです。入力すると、MachineHealthCheck コントローラーは、参照されるテンプレートから新しいオブジェクトを作成し、マシンの修復を Machine API Operator の外部にあるコントローラーに渡します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 参照先の API バージョン。 |
|
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
|
| 参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
8.1.3. .spec.selector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ヘルスチェックの対象となるマシンに一致するラベルセレクター。注: 空のセレクターはすべてのマシンに一致します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| 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 は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
8.1.6. .spec.unhealthyConditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- unhealthyConditions には、ノードが異常であると見なされるかどうかを決定する条件のリストが含まれています。条件は論理 OR で結合されます。つまり、条件のいずれかが満たされた場合、ノードは異常です。
- 型
-
array
8.1.7. .spec.unhealthyConditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- UnhealthyCondition は、期間として指定されたタイムアウトを持つノード条件タイプと値を表します。指定された条件が少なくともタイムアウト値の間指定されたステータスにある場合、ノードは異常であると見なされます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| |
|
|
| それぞれオプションの分数と単位接尾辞が付いた 10 進数の符号なし期間文字列 ("300ms"、"1.5h"、"2h45m" など) が必要です。有効な時間単位は、"ns"、"us" (または "µs")、"ms"、"s"、"m"、"h" です。 |
|
|
|
8.1.8. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineHealthCheck リソースの最近観察されたステータス
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 条件は、MachineHealthCheck の現在の状態を定義します。 |
|
|
| condition は、Machine API リソースの運用状態に関する観測結果を定義します。 |
|
|
| このマシンヘルスチェックでカウントされたマシンの総数 |
|
|
| このマシンヘルスチェックでカウントされたマシンの総数 |
|
|
| remediationsAllowed は、maxUnhealthy 短絡が適用される前に、このマシンヘルスチェックによって許可される追加の修復の数です。 |
8.1.9. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 条件は、MachineHealthCheck の現在の状態を定義します。
- 型
-
array
8.1.10. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- condition は、Machine API リソースの運用状態に関する観測結果を定義します。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 最後にある状態から別の状態に遷移した時間。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| 遷移の詳細を示す人が判読できるメッセージ。このフィールドは空の場合があります。 |
|
|
| CamelCase での状態の最後の遷移に関する理由。特定の API は、このフィールドが保証された API と見なされるかどうかを選択できます。このフィールドには空白を指定できません。 |
|
|
| severity は理由コードの明示的な分類を提供するため、ユーザーまたはマシンは現在の状況を即座に理解し、それに応じて行動できます。Severity フィールドは、Status=False の場合にのみ設定する必要があります。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| 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-
DELETE:MachineHealthCheck のコレクションを削除します -
GET: 種類が MachineHealthCheck のオブジェクトをリスト表示します -
POST:MachineHealthCheck を作成します
-
/apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks/{name}-
DELETE: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 のオブジェクトをリスト表示します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
8.2.2. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- MachineHealthCheck のコレクションを削除します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が MachineHealthCheck のオブジェクトをリスト表示します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- MachineHealthCheck を作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
8.2.3. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| MachineHealthCheck の名前 |
- HTTP メソッド
-
DELETE - 説明
- MachineHealthCheck を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された MachineHealthCheck を読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された MachineHealthCheck を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された MachineHealthCheck を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
8.2.4. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| MachineHealthCheck の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された MachineHealthCheck のステータスを読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された MachineHealthCheck のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された MachineHealthCheck のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第9章 Machine [machine.openshift.io/v1beta1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Machine は、マシン API のスキーマです。互換性レベル 2: メジャーリリース内で最低 9 カ月間、または 3 つのマイナーリリース内 (いずれか長い方) で安定しています。
- 型
-
object
9.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| MachineSpec は、Machine の望ましい状態を定義します |
|
|
| MachineStatus は、Machine の監視状態を定義します |
9.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineSpec は、Machine の望ましい状態を定義します
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lifecycleHooks を使用すると、ユーザーはマシンのライフサイクル内の特定の定義済みポイントでマシン上の操作を一時停止できます。 |
|
|
| ObjectMeta は、作成されたノードに自動入力します。これを使用して、ノードの作成時に使用するラベル、アノテーション、名前接頭辞などを示します。 |
|
|
| providerID は、プロバイダーによって提供されたマシンの ID です。このフィールドは、このマシンに対応するノードオブジェクトに表示されるプロバイダー ID と一致する必要があります。このフィールドは、cluster-api の上位レベルのコンシューマーに必要です。ユースケースの例は、プロバイダーとして cluster-api を使用するクラスターオートスケーラーです。オートスケーラーのクリーンアップロジックは、マシンをノードと比較して、Kubernetes ノードとして登録できなかったプロバイダーのマシンを見つけます。オートスケーラーの一般的なツリー外プロバイダーとして cluster-api を使用する場合、このフィールドは、マシンのリストのプロバイダービューを持つことができるようにするためにオートスケーラーによって必要とされます。k8s apiserver からノードの別のリストが照会され、比較が行われて未登録のマシンが検出され、削除のマークが付けられます。このフィールドはアクチュエーターによって設定され、汎用プロバイダーとして cluster-api とインターフェイスするオートスケーラーなどの高レベルのエンティティーによって消費されます。 |
|
|
| providerSpec は、ノードの作成時に使用するプロバイダー固有の設定を詳述するものです。 |
|
|
| 対応するノードに追加的に適用されるテイントのリスト。このリストは、他のエンティティーによって継続的にノードに追加された他のテイントを上書きしません。これらのテイントは積極的に調整する必要があります。たとえば、マシンコントローラーにテイントを適用するように依頼し、手動でテイントを除去すると、マシンコントローラーはテイントを元に戻します)、マシンコントローラーにテイントを除去させないでください。 |
|
|
| この Taint が接続されているノードは、Taint を許容しない Pod に "影響を及ぼし" ます。 |
9.1.2. .spec.lifecycleHooks リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- lifecycleHooks を使用すると、ユーザーはマシンのライフサイクル内の特定の定義済みポイントでマシン上の操作を一時停止できます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| preDrain フックは、マシンの drain (Pod の退避) の実行を阻止します。これにより、終了などのライフサイクルイベントもさらにブロックされます。 |
|
|
| LifecycleHook はライフサイクルフックの単一インスタンスを表します。 |
|
|
| preTerminate フックはマシンが終了するのを防ぎます。preTerminate フックは、Machine が drain (Pod の退避) を実行された後に実行されます。 |
|
|
| LifecycleHook はライフサイクルフックの単一インスタンスを表します。 |
9.1.3. .spec.lifecycleHooks.preDrain リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- preDrain フックは、マシンの drain (Pod の退避) の実行を阻止します。これにより、終了などのライフサイクルイベントもさらにブロックされます。
- 型
-
array
9.1.4. .spec.lifecycleHooks.preDrain[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- LifecycleHook はライフサイクルフックの単一インスタンスを表します。
- 型
-
object - 必須
-
name -
owner
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name はライフサイクルフックの一意の名前を定義します。名前は一意でわかりやすく、理想的には 1 - 3 語で CamelCase で表記する必要がありますが、namespace を使用することもできます (例: foo.example.com/CamelCase)。名前は一意である必要があり、単一のエンティティーによってのみ管理される必要があります。 |
|
|
| owner は、ライフサイクルフックの所有者を定義します。これは、ライフサイクルをブロックしているのが誰であるかをユーザーが識別できるように、わかるように説明してある必要があります。これは、コントローラーの名前 (例: clusteroperator/etcd) またはフックを管理する管理者の名前である可能性があります。 |
9.1.5. .spec.lifecycleHooks.preTerminate リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- preTerminate フックはマシンが終了するのを防ぎます。preTerminate フックは、Machine が drain (Pod の退避) を実行された後に実行されます。
- 型
-
array
9.1.6. .spec.lifecycleHooks.preTerminate[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- LifecycleHook はライフサイクルフックの単一インスタンスを表します。
- 型
-
object - 必須
-
name -
owner
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name はライフサイクルフックの一意の名前を定義します。名前は一意でわかりやすく、理想的には 1 - 3 語で CamelCase で表記する必要がありますが、namespace を使用することもできます (例: foo.example.com/CamelCase)。名前は一意である必要があり、単一のエンティティーによってのみ管理される必要があります。 |
|
|
| owner は、ライフサイクルフックの所有者を定義します。これは、ライフサイクルをブロックしているのが誰であるかをユーザーが識別できるように、わかるように説明してある必要があります。これは、コントローラーの名前 (例: clusteroperator/etcd) またはフックを管理する管理者の名前である可能性があります。 |
9.1.7. .spec.metadata リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ObjectMeta は、作成されたノードに自動入力します。これを使用して、ノードの作成時に使用するラベル、アノテーション、名前接頭辞などを示します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| annotations は、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations |
|
|
| generateName は、Name フィールドが指定されていない場合に限り一意の名前を生成するためにサーバーが使用するオプションの接頭辞です。このフィールドを使用する場合、クライアントに返される名前は渡された名前とは異なります。この値は、一意の接尾辞とも組み合わされます。提供された値には、名前フィールドと同じ検証ルールがあり、サーバー上で値を一意にするために必要な接尾辞の長さで切り捨てられる場合があります。 このフィールドが指定されており、生成された名前が存在する場合、サーバーは 409 を返しません。代わりに、割り当てられた時間内に一意の名前が見つからなかったことを示す Reason ServerTimeout で 201 Created または 500 を返します。クライアントは再試行する必要があります (オプションで、Retry-After ヘッダーに示されている時間の後)。 Name が指定されていない場合にのみ適用されます。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency |
|
|
| オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labels |
|
|
| name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これは更新できません。詳細: http://kubernetes.io/docs/user-guide/identifiers#names |
|
|
| namespace は、各名前内のスペースが一意である必要があることを定義します。空の namespace は "default" の namespace と同じですが、"default" が正式な表現です。すべてのオブジェクトを namespace のスコープに設定する必要はありません。それらのオブジェクトでは、このフィールドの値は空になります。 DNS_LABEL である必要があります。これは更新できません。詳細: http://kubernetes.io/docs/user-guide/namespaces |
|
|
| このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。 |
|
|
| OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ namespace にあるか、クラスタースコープである必要があるため、namespace フィールドはありません。 |
9.1.8. .spec.metadata.ownerReferences リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。
- 型
-
array
9.1.9. .spec.metadata.ownerReferences[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ namespace にあるか、クラスタースコープである必要があるため、namespace フィールドはありません。
- 型
-
object - 必須
-
apiVersion -
kind -
name -
uid
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 参照先の API バージョン。 |
|
|
| true の場合、および所有者が "foregroundDeletion" ファイナライザーを持っている場合、この参照が削除されるまで、所有者を Key-Value ストアから削除することはできません。ガベージコレクターがこのフィールドと対話し、フォアグラウンドを強制的に削除する方法は、https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion を参照してください。デフォルトは false です。このフィールドを設定するには、ユーザーは所有者の "削除" 権限を必要とします。そうしないと、422 (処理不能エンティティー) が返されます。 |
|
|
| true の場合、この参照は管理コントローラーを指します。 |
|
|
| 参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
|
|
| 参照先の 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[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- この Taint が接続されているノードは、Taint を許容しない Pod に "影響を及ぼし" ます。
- 型
-
object - 必須
-
effect -
key
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 必須。テイントを許容しない Pod に対するテイントの影響。有効な効果は、NoSchedule、PreferNoSchedule、および NoExecute です。 |
|
|
| 必須。ノードに適用されるテイントキー。 |
|
|
| timeAdded は、テイントが追加された時刻を表します。NoExecute テイントにのみ作成されます。 |
|
|
| テイントキーに対応するテイント値。 |
9.1.13. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineStatus は、Machine の監視状態を定義します
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| addresses は、マシンに割り当てられたアドレスのリストです。可能な場合は、クラウドプロバイダーから照会されます。 |
|
|
| NodeAddress には、ノードのアドレスに関する情報が含まれています。 |
|
|
| conditions は、Machine の現在の状態を定義します。 |
|
|
| condition は、Machine API リソースの運用状態に関する観測結果を定義します。 |
|
|
| errorMessage は、マシンの調整に最終的な問題が発生した場合に設定され、ロギングと人間による消費に適したより詳細な文字列が含まれます。 このフィールドは、時間の経過とともに自動的に修正されることが予想される、コントローラーが直面する推移的なエラー (サービスの停止など) には設定しないでください。代わりに、マシンの仕様またはコントローラーの設定に根本的な問題があること、およびそのマニュアルを示します。介入が必要です。ターミナルエラーの例としては、仕様の設定の無効な組み合わせ、コントローラーでサポートされていない値、または責任のあるコントローラー自体が重大に誤って設定されていることが挙げられます。 マシンの調整中に発生する一時的なエラーは、イベントとしてマシンオブジェクトに追加したり、コントローラーの出力に記録したりできます。 |
|
|
| errorReason は、マシンの調整に最終的な問題が発生した場合に設定され、マシンの解釈に適した簡潔な値が含まれます。 このフィールドは、時間の経過とともに自動的に修正されることが予想される、コントローラーが直面する推移的なエラー (サービスの停止など) には設定しないでください。代わりに、マシンの仕様またはコントローラーの設定に根本的な問題があること、およびそのマニュアルを示します。介入が必要です。ターミナルエラーの例としては、仕様の設定の無効な組み合わせ、コントローラーでサポートされていない値、または責任のあるコントローラー自体が重大に誤って設定されていることが挙げられます。 マシンの調整中に発生する一時的なエラーは、イベントとしてマシンオブジェクトに追加したり、コントローラーの出力に記録したりできます。 |
|
|
| lastOperation は、マシンコントローラーによって実行される最後の操作を記述します。この API は、特定のマシンで実行された最新の操作に関する履歴として役立つはずです。また、最新の操作の状態を伝える必要があります。たとえば、それがまだ進行中、失敗、または正常に完了した場合などです。 |
|
|
| lastUpdated は、このステータスが最後に観測された日時を識別します。 |
|
|
| nodeRef は、対応するノードが存在する場合はそれを指します。 |
|
|
| phase は、マシンのアクチュエーションの現在のフェーズを表します。Failed、Provisioning、Provisioned、Running、Deleting のいずれかを表します。 |
|
| `` | providerStatus は、プロバイダー固有のステータスの詳細を示します。プロバイダーは、このフィールドからシリアル化/逆シリアル化する必要がある独自のバージョン管理された API タイプを維持することを推奨します。 |
9.1.14. .status.addresses リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- addresses は、マシンに割り当てられたアドレスのリストです。可能な場合は、クラウドプロバイダーから照会されます。
- 型
-
array
9.1.15. .status.addresses[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- NodeAddress には、ノードのアドレスに関する情報が含まれています。
- 型
-
object - 必須
-
address -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ノードアドレス。 |
|
|
| ノードアドレスタイプ。ホスト名、ExternalIP、または InternalIP のいずれか。 |
9.1.16. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、Machine の現在の状態を定義します。
- 型
-
array
9.1.17. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- condition は、Machine API リソースの運用状態に関する観測結果を定義します。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 最後にある状態から別の状態に遷移した時間。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| 遷移の詳細を示す人が判読できるメッセージ。このフィールドは空の場合があります。 |
|
|
| CamelCase での状態の最後の遷移に関する理由。特定の API は、このフィールドが保証された API と見なされるかどうかを選択できます。このフィールドには空白を指定できません。 |
|
|
| severity は理由コードの明示的な分類を提供するため、ユーザーまたはマシンは現在の状況を即座に理解し、それに応じて行動できます。Severity フィールドは、Status=False の場合にのみ設定する必要があります。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。 |
9.1.18. .status.lastOperation リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- lastOperation は、マシンコントローラーによって実行される最後の操作を記述します。この API は、特定のマシンで実行された最新の操作に関する履歴として役立つはずです。また、最新の操作の状態を伝える必要があります。たとえば、それがまだ進行中、失敗、または正常に完了した場合などです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| description は、最後の操作の人間が読める形式の説明です。 |
|
|
| lastUpdated は、LastOperation API が最後に更新されたタイムスタンプです。 |
|
|
| state は、最後に実行された操作の現在のステータスです。たとえば、処理中、失敗、成功など |
|
|
| type は、最後に実行された操作のタイプです。たとえば、作成、削除、更新など |
9.1.19. .status.nodeRef リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- nodeRef は、対応するノードが存在する場合はそれを指します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 参照先の API バージョン。 |
|
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
|
| 参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
9.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/machine.openshift.io/v1beta1/machines-
GET: 種類が Machine のオブジェクトをリスト表示します
-
/apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines-
DELETE: Machine のコレクションを削除します -
GET: 種類が Machine のオブジェクトをリスト表示します -
POST: Machine を作成します
-
/apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines/{name}-
DELETE: Machine を削除します -
GET: 指定された Machine を読み取ります -
PATCH: 指定された Machine を部分的に更新します -
PUT: 指定された Machine を交換します
-
/apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines/{name}/status-
GET: 指定された Machine のステータスを読み取ります -
PATCH: 指定された Machine のステータスを部分的に更新します -
PUT: 指定された Machine のステータスを置き換えます
-
9.2.1. /apis/machine.openshift.io/v1beta1/machines リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
GET - 説明
- 種類が Machine のオブジェクトをリスト表示します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
9.2.2. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- Machine のコレクションを削除します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が Machine のオブジェクトをリスト表示します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- Machine を作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
9.2.3. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| Machine の名前 |
- HTTP メソッド
-
DELETE - 説明
- Machine を削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された Machine を読み取ります。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された Machine を部分的に更新します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された Machine を置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
9.2.4. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| Machine の名前 |
- HTTP メソッド
-
GET - 説明
- 指定されたマシンのステータスを読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定したマシンのステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたマシンのステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第10章 MachineSet [machine.openshift.io/v1beta1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineSet は、指定された数のマシンレプリカが常に実行されていることを確認します。互換性レベル 2: メジャーリリース内で最低 9 カ月間、または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object
10.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| MachineSetSpec は、MachineSet の望ましい状態を定義します |
|
|
| MachineSetStatus は、MachineSet の監視状態を定義します |
10.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineSetSpec は、MachineSet の望ましい状態を定義します
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| deletePolicy は、ダウンスケーリング時に削除するノードを識別するために使用されるポリシーを定義します。デフォルトは "Random" です。有効な値は "Random"、"Newest"、"Oldest" です。 |
|
|
| minReadySeconds は、新しく作成されたマシンの準備ができる最小秒数です。デフォルトは 0 です (マシンは準備ができ次第利用可能と見なされます) |
|
|
| replicas は、必要なレプリカの数です。これは、明示的なゼロと指定されていないものを区別するためのポインターです。デフォルトは 1 です。 |
|
|
| selector は、レプリカ数と一致する必要があるマシンに対するラベルクエリーです。この MachineSet によって制御されるために一致する必要があるキーと値にラベルを付けます。マシンテンプレートのラベルと一致する必要があります。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
|
|
| template は、不十分なレプリカが検出された場合に作成されるマシンを記述するオブジェクトです。 |
10.1.2. .spec.selector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- selector は、レプリカ数と一致する必要があるマシンに対するラベルクエリーです。この MachineSet によって制御されるために一致する必要があるキーと値にラベルを付けます。マシンテンプレートのラベルと一致する必要があります。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| 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 は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.5. .spec.template リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- template は、不十分なレプリカが検出された場合に作成されるマシンを記述するオブジェクトです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
| マシンに期待される動作の仕様。詳細: 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 は、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations |
|
|
| generateName は、Name フィールドが指定されていない場合に限り一意の名前を生成するためにサーバーが使用するオプションの接頭辞です。このフィールドを使用する場合、クライアントに返される名前は渡された名前とは異なります。この値は、一意の接尾辞とも組み合わされます。提供された値には、名前フィールドと同じ検証ルールがあり、サーバー上で値を一意にするために必要な接尾辞の長さで切り捨てられる場合があります。 このフィールドが指定されており、生成された名前が存在する場合、サーバーは 409 を返しません。代わりに、割り当てられた時間内に一意の名前が見つからなかったことを示す Reason ServerTimeout で 201 Created または 500 を返します。クライアントは再試行する必要があります (オプションで、Retry-After ヘッダーに示されている時間の後)。 Name が指定されていない場合にのみ適用されます。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency |
|
|
| オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labels |
|
|
| name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これは更新できません。詳細: http://kubernetes.io/docs/user-guide/identifiers#names |
|
|
| namespace は、各名前内のスペースが一意である必要があることを定義します。空の namespace は "default" の namespace と同じですが、"default" が正式な表現です。すべてのオブジェクトを namespace のスコープに設定する必要はありません。それらのオブジェクトでは、このフィールドの値は空になります。 DNS_LABEL である必要があります。これは更新できません。詳細: http://kubernetes.io/docs/user-guide/namespaces |
|
|
| このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。 |
|
|
| OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ namespace にあるか、クラスタースコープである必要があるため、namespace フィールドはありません。 |
10.1.7. .spec.template.metadata.ownerReferences リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。
- 型
-
array
10.1.8. .spec.template.metadata.ownerReferences[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ namespace にあるか、クラスタースコープである必要があるため、namespace フィールドはありません。
- 型
-
object - 必須
-
apiVersion -
kind -
name -
uid
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 参照先の API バージョン。 |
|
|
| true の場合、および所有者が "foregroundDeletion" ファイナライザーを持っている場合、この参照が削除されるまで、所有者を Key-Value ストアから削除することはできません。ガベージコレクターがこのフィールドと対話し、フォアグラウンドを強制的に削除する方法は、https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion を参照してください。デフォルトは false です。このフィールドを設定するには、ユーザーは所有者の "削除" 権限を必要とします。そうしないと、422 (処理不能エンティティー) が返されます。 |
|
|
| true の場合、この参照は管理コントローラーを指します。 |
|
|
| 参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
|
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids |
10.1.9. .spec.template.spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- マシンに期待される動作の仕様。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lifecycleHooks を使用すると、ユーザーはマシンのライフサイクル内の特定の定義済みポイントでマシン上の操作を一時停止できます。 |
|
|
| ObjectMeta は、作成されたノードに自動入力します。これを使用して、ノードの作成時に使用するラベル、アノテーション、名前接頭辞などを示します。 |
|
|
| providerID は、プロバイダーによって提供されたマシンの ID です。このフィールドは、このマシンに対応するノードオブジェクトに表示されるプロバイダー ID と一致する必要があります。このフィールドは、cluster-api の上位レベルのコンシューマーに必要です。ユースケースの例は、プロバイダーとして cluster-api を使用するクラスターオートスケーラーです。オートスケーラーのクリーンアップロジックは、マシンをノードと比較して、Kubernetes ノードとして登録できなかったプロバイダーのマシンを見つけます。オートスケーラーの一般的なツリー外プロバイダーとして cluster-api を使用する場合、このフィールドは、マシンのリストのプロバイダービューを持つことができるようにするためにオートスケーラーによって必要とされます。k8s apiserver からノードの別のリストが照会され、比較が行われて未登録のマシンが検出され、削除のマークが付けられます。このフィールドはアクチュエーターによって設定され、汎用プロバイダーとして cluster-api とインターフェイスするオートスケーラーなどの高レベルのエンティティーによって消費されます。 |
|
|
| providerSpec は、ノードの作成時に使用するプロバイダー固有の設定を詳述するものです。 |
|
|
| 対応するノードに追加的に適用されるテイントのリスト。このリストは、他のエンティティーによって継続的にノードに追加された他のテイントを上書きしません。これらのテイントは積極的に調整する必要があります。たとえば、マシンコントローラーにテイントを適用するように依頼し、手動でテイントを除去すると、マシンコントローラーはテイントを元に戻します)、マシンコントローラーにテイントを除去させないでください。 |
|
|
| この Taint が接続されているノードは、Taint を許容しない Pod に "影響を及ぼし" ます。 |
10.1.10. .spec.template.spec.lifecycleHooks リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- lifecycleHooks を使用すると、ユーザーはマシンのライフサイクル内の特定の定義済みポイントでマシン上の操作を一時停止できます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| preDrain フックは、マシンの drain (Pod の退避) の実行を阻止します。これにより、終了などのライフサイクルイベントもさらにブロックされます。 |
|
|
| LifecycleHook はライフサイクルフックの単一インスタンスを表します。 |
|
|
| preTerminate フックはマシンが終了するのを防ぎます。preTerminate フックは、Machine が drain (Pod の退避) を実行された後に実行されます。 |
|
|
| LifecycleHook はライフサイクルフックの単一インスタンスを表します。 |
10.1.11. .spec.template.spec.lifecycleHooks.preDrain リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- preDrain フックは、マシンの drain (Pod の退避) の実行を阻止します。これにより、終了などのライフサイクルイベントもさらにブロックされます。
- 型
-
array
10.1.12. .spec.template.spec.lifecycleHooks.preDrain[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- LifecycleHook はライフサイクルフックの単一インスタンスを表します。
- 型
-
object - 必須
-
name -
owner
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name はライフサイクルフックの一意の名前を定義します。名前は一意でわかりやすく、理想的には 1 - 3 語で CamelCase で表記する必要がありますが、namespace を使用することもできます (例: foo.example.com/CamelCase)。名前は一意である必要があり、単一のエンティティーによってのみ管理される必要があります。 |
|
|
| owner は、ライフサイクルフックの所有者を定義します。これは、ライフサイクルをブロックしているのが誰であるかをユーザーが識別できるように、わかるように説明してある必要があります。これは、コントローラーの名前 (例: clusteroperator/etcd) またはフックを管理する管理者の名前である可能性があります。 |
10.1.13. .spec.template.spec.lifecycleHooks.preTerminate リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- preTerminate フックはマシンが終了するのを防ぎます。preTerminate フックは、Machine が drain (Pod の退避) を実行された後に実行されます。
- 型
-
array
10.1.14. .spec.template.spec.lifecycleHooks.preTerminate[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- LifecycleHook はライフサイクルフックの単一インスタンスを表します。
- 型
-
object - 必須
-
name -
owner
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name はライフサイクルフックの一意の名前を定義します。名前は一意でわかりやすく、理想的には 1 - 3 語で CamelCase で表記する必要がありますが、namespace を使用することもできます (例: foo.example.com/CamelCase)。名前は一意である必要があり、単一のエンティティーによってのみ管理される必要があります。 |
|
|
| owner は、ライフサイクルフックの所有者を定義します。これは、ライフサイクルをブロックしているのが誰であるかをユーザーが識別できるように、わかるように説明してある必要があります。これは、コントローラーの名前 (例: clusteroperator/etcd) またはフックを管理する管理者の名前である可能性があります。 |
10.1.15. .spec.template.spec.metadata リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ObjectMeta は、作成されたノードに自動入力します。これを使用して、ノードの作成時に使用するラベル、アノテーション、名前接頭辞などを示します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| annotations は、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations |
|
|
| generateName は、Name フィールドが指定されていない場合に限り一意の名前を生成するためにサーバーが使用するオプションの接頭辞です。このフィールドを使用する場合、クライアントに返される名前は渡された名前とは異なります。この値は、一意の接尾辞とも組み合わされます。提供された値には、名前フィールドと同じ検証ルールがあり、サーバー上で値を一意にするために必要な接尾辞の長さで切り捨てられる場合があります。 このフィールドが指定されており、生成された名前が存在する場合、サーバーは 409 を返しません。代わりに、割り当てられた時間内に一意の名前が見つからなかったことを示す Reason ServerTimeout で 201 Created または 500 を返します。クライアントは再試行する必要があります (オプションで、Retry-After ヘッダーに示されている時間の後)。 Name が指定されていない場合にのみ適用されます。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency |
|
|
| オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labels |
|
|
| name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これは更新できません。詳細: http://kubernetes.io/docs/user-guide/identifiers#names |
|
|
| namespace は、各名前内のスペースが一意である必要があることを定義します。空の namespace は "default" の namespace と同じですが、"default" が正式な表現です。すべてのオブジェクトを namespace のスコープに設定する必要はありません。それらのオブジェクトでは、このフィールドの値は空になります。 DNS_LABEL である必要があります。これは更新できません。詳細: http://kubernetes.io/docs/user-guide/namespaces |
|
|
| このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。 |
|
|
| OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ namespace にあるか、クラスタースコープである必要があるため、namespace フィールドはありません。 |
10.1.16. .spec.template.spec.metadata.ownerReferences リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。
- 型
-
array
10.1.17. .spec.template.spec.metadata.ownerReferences[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ namespace にあるか、クラスタースコープである必要があるため、namespace フィールドはありません。
- 型
-
object - 必須
-
apiVersion -
kind -
name -
uid
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 参照先の API バージョン。 |
|
|
| true の場合、および所有者が "foregroundDeletion" ファイナライザーを持っている場合、この参照が削除されるまで、所有者を Key-Value ストアから削除することはできません。ガベージコレクターがこのフィールドと対話し、フォアグラウンドを強制的に削除する方法は、https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion を参照してください。デフォルトは false です。このフィールドを設定するには、ユーザーは所有者の "削除" 権限を必要とします。そうしないと、422 (処理不能エンティティー) が返されます。 |
|
|
| true の場合、この参照は管理コントローラーを指します。 |
|
|
| 参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
|
|
| 参照先の 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[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- この Taint が接続されているノードは、Taint を許容しない Pod に "影響を及ぼし" ます。
- 型
-
object - 必須
-
effect -
key
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 必須。テイントを許容しない Pod に対するテイントの影響。有効な効果は、NoSchedule、PreferNoSchedule、および NoExecute です。 |
|
|
| 必須。ノードに適用されるテイントキー。 |
|
|
| timeAdded は、テイントが追加された時刻を表します。NoExecute テイントにのみ作成されます。 |
|
|
| テイントキーに対応するテイント値。 |
10.1.21. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineSetStatus は、MachineSet の監視状態を定義します
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| この MachineSet で使用可能なレプリカの数 (少なくとも minReadySeconds の準備ができています)。 |
|
|
| conditions は、MachineSet の現在の状態を定義します |
|
|
| condition は、Machine API リソースの運用状態に関する観測結果を定義します。 |
|
|
| |
|
|
| レプリカの調整で最終的な問題が発生した場合は、ErrorReason と ErrorMessage の両方が設定されます。ErrorReason には、マシンの解釈に適した簡潔な値が入力されますが、ErrorMessage には、ロギングと人間による消費に適したより詳細な文字列が含まれます。 これらのフィールドは、時間の経過とともに自動的に修正されると予想されるコントローラーが直面する推移的なエラー (サービスの停止など) に対して設定するべきではありませんが、代わりに、MachineTemplate の仕様またはマシンコントローラーの設定に根本的な問題があることを示します。手動による介入が必要です。ターミナルエラーの例としては、仕様の設定の無効な組み合わせ、マシンコントローラーでサポートされていない値、または責任のあるマシンコントローラー自体が重大に誤って設定されていることが挙げられます。 マシンの調整中に発生する一時的なエラーは、イベントとして MachineSet オブジェクトに追加したり、コントローラーの出力に記録したりできます。 |
|
|
| MachineSet のマシンテンプレートのラベルと一致するラベルを持つレプリカの数。 |
|
|
| observedGeneration は、直近に観測された MachineSet の世代を反映します。 |
|
|
| この MachineSet の準備ができているレプリカの数。ノードが作成され、準備完了になると、マシンは "準備完了" と見なされます。 |
|
|
| replicas は、最近観察されたレプリカの数です。 |
10.1.22. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、MachineSet の現在の状態を定義します
- 型
-
array
10.1.23. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- condition は、Machine API リソースの運用状態に関する観測結果を定義します。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 最後にある状態から別の状態に遷移した時間。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| 遷移の詳細を示す人が判読できるメッセージ。このフィールドは空の場合があります。 |
|
|
| CamelCase での状態の最後の遷移に関する理由。特定の API は、このフィールドが保証された API と見なされるかどうかを選択できます。このフィールドには空白を指定できません。 |
|
|
| severity は理由コードの明示的な分類を提供するため、ユーザーまたはマシンは現在の状況を即座に理解し、それに応じて行動できます。Severity フィールドは、Status=False の場合にのみ設定する必要があります。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| 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}-
DELETE: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 のオブジェクトをリスト表示します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
10.2.2. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinesets リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- MachineSet のコレクションを削除します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が MachineSet のオブジェクトをリスト表示します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- MachineSet を作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
10.2.3. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinesets/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| MachineSet の名前 |
- HTTP メソッド
-
DELETE - 説明
- MachineSet を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された MachineSet を読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された MachineSet を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された MachineSet を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
10.2.4. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinesets/{name}/scale リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| MachineSet の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された MachineSet のスケールを読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された MachineSet のスケールを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された MachineSet のスケールを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
10.2.5. /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinesets/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| MachineSet の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された MachineSet のステータスを読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された MachineSet のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された MachineSet のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第11章 MachineConfigNode [machineconfiguration.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineConfigNode は、システム上のマシンの健全性を記述します。互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (いずれか長い方) で安定しています。
- 型
-
object - 必須
-
spec
-
11.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec は、マシン設定ノードの設定を記述します。 |
|
|
| status は、このマシン設定ノードの最後に観測された状態を表します。 |
11.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、マシン設定ノードの設定を記述します。
- 型
-
object - 必須
-
configVersion -
node -
pool
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| configVersion は、このマシン設定ノードリソースの対象となるノードに必要な設定バージョンを保持します。必要なバージョンは、ノードが更新を試みるマシン設定を表し、Machine Config Operator が新しいマシン設定を現在のマシン設定に対して検証する前に設定されます。 |
|
|
| ノードには、このマシン設定ノードのノードへの参照が含まれています。 |
|
|
| プールには、このマシン設定ノードの参照ノードが属するマシン設定プールへの参照が含まれています。 |
11.1.2. .spec.configVersion リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- configVersion は、このマシン設定ノードリソースの対象となるノードに必要な設定バージョンを保持します。必要なバージョンは、ノードが更新を試みるマシン設定を表し、Machine Config Operator が新しいマシン設定を現在のマシン設定に対して検証する前に設定されます。
- 型
-
object - 必須
-
desired
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| desired は、ノードをアップグレードするマシン設定の名前です。この値は、マシン設定プールがレンダリングされた設定の新しいバージョンを生成するときに設定されます。この値が変更されると、マシン設定デーモンはノードのアップグレードプロセスを開始します。この値は、マシン設定がアップグレードの対象となり、検証される前に、マシン設定ノード仕様に設定されます。小文字の英数字、ハイフン (-)、ピリオド (.) のみで構成される小文字の RFC-1123 サブドメイン名 (https://tools.ietf.org/html/rfc1123) である必要があります。先頭と末尾は英数字で、長さは最大 253 文字である必要があります。 |
11.1.3. .spec.node リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ノードには、このマシン設定ノードのノードへの参照が含まれています。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は参照されるオブジェクトの名前です。たとえば、これはマシン設定プールまたはノード名を表すことができます。小文字の英数字、ハイフン (-)、ピリオド (.) のみで構成される小文字の RFC-1123 サブドメイン名 (https://tools.ietf.org/html/rfc1123) である必要があります。先頭と末尾は英数字で、長さは最大 253 文字である必要があります。 |
11.1.4. .spec.pool リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- プールには、このマシン設定ノードの参照ノードが属するマシン設定プールへの参照が含まれています。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は参照されるオブジェクトの名前です。たとえば、これはマシン設定プールまたはノード名を表すことができます。小文字の英数字、ハイフン (-)、ピリオド (.) のみで構成される小文字の RFC-1123 サブドメイン名 (https://tools.ietf.org/html/rfc1123) である必要があります。先頭と末尾は英数字で、長さは最大 253 文字である必要があります。 |
11.1.5. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status は、このマシン設定ノードの最後に観測された状態を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、マシン設定ノードの現在の状態に関する観測結果を表します。有効なタイプ: UpdatePrepared, UpdateExecuted, UpdatePostActionComplete, UpdateComplete, Updated, Resumed, Drained, AppliedFilesAndOS, Cordoned, Uncordoned, RebootedNode, NodeDegraded, PinnedImageSetsProgressing, PinnedImageSetsDegraded. |
|
|
| condition には、この API Resource の現在の状態のある側面の詳細が含まれます。 |
|
|
| configVersion は、このノードの現在のマシン設定バージョンと必要なマシン設定バージョンを記述します。 |
|
|
| observerGeneration は、Machine Config Operator のコントローラーによって観測された MachineConfigNode オブジェクトの世代を表します。このフィールドは、コントローラーがマシン設定ノード仕様の configVersion 内における desiredConfig の変更を観測したときに更新されます。 |
|
|
| pinnedImageSets は、このノードの現在のピン留めされたイメージセットと必要なピン留めされたイメージセットを記述します。 |
|
|
| MachineConfigNodeStatusPinnedImageSet は、観測対象のマシン設定ノードの現在の、必要な、および失敗したピン留めされたイメージセットに関する情報を保持します。 |
11.1.6. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、マシン設定ノードの現在の状態に関する観測結果を表します。有効なタイプ: UpdatePrepared, UpdateExecuted, UpdatePostActionComplete, UpdateComplete, Updated, Resumed, Drained, AppliedFilesAndOS, Cordoned, Uncordoned, RebootedNode, NodeDegraded, PinnedImageSetsProgressing, PinnedImageSetsDegraded.
- 型
-
array
11.1.7. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- condition には、この API Resource の現在の状態のある側面の詳細が含まれます。
- 型
-
object - 必須
-
lastTransitionTime -
message -
reason -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
11.1.8. .status.configVersion リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- configVersion は、このノードの現在のマシン設定バージョンと必要なマシン設定バージョンを記述します。
- 型
-
object - 必須
-
desired
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| current は、ノードで現在使用されているマシン設定の名前です。この値は、マシン設定デーモンがノードの設定の更新を完了すると更新されます。アップグレードが進行中でない限り、この値は必要なバージョンと一致する必要があります。小文字の英数字、ハイフン (-)、ピリオド (.) のみで構成される小文字の RFC-1123 サブドメイン名 (https://tools.ietf.org/html/rfc1123) である必要があります。先頭と末尾は英数字で、長さは最大 253 文字である必要があります。 |
|
|
| desired は、ノードがアップグレードする MachineConfig です。この値は、マシン設定が現在のマシン設定に対して検証されると、マシン設定ノードのステータスに設定されます。小文字の英数字、ハイフン (-)、ピリオド (.) のみで構成される小文字の RFC-1123 サブドメイン名 (https://tools.ietf.org/html/rfc1123) である必要があります。先頭と末尾は英数字で、長さは最大 253 文字である必要があります。 |
11.1.9. .status.pinnedImageSets リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- pinnedImageSets は、このノードの現在のピン留めされたイメージセットと必要なピン留めされたイメージセットを記述します。
- 型
-
array
11.1.10. .status.pinnedImageSets[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineConfigNodeStatusPinnedImageSet は、観測対象のマシン設定ノードの現在の、必要な、および失敗したピン留めされたイメージセットに関する情報を保持します。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| currentGeneration は、このノード上で直近にプルおよびピン留めが成功した、ピン留めされたイメージセットの世代です。 |
|
|
| desiredGeneration は、このノードにプルおよびピン留めされる対象となるピン留めされたイメージセットの世代です。 |
|
|
| lastFailedGeneration は、このノード上でプルおよびピン留めが失敗した、直近にピン留めされたイメージセットの世代です。 |
|
|
| lastFailedGenerationError は、必要なイメージをプルおよびピン留めできなかった理由を説明するエラーです。イメージのプルとピン留めが成功した場合、エラーは空の文字列になります。 |
|
|
| name はピン留めされたイメージセットの名前です。小文字の英数字、ハイフン (-)、ピリオド (.) のみで構成される小文字の RFC-1123 サブドメイン名 (https://tools.ietf.org/html/rfc1123) である必要があります。先頭と末尾は英数字で、長さは最大 253 文字である必要があります。 |
11.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/machineconfiguration.openshift.io/v1/machineconfignodes-
DELETE: MachineConfigNode のコレクションを削除します -
GET: 種類が MachineConfigNode のオブジェクトをリスト表示します -
POST: MachineConfigNode を作成します
-
/apis/machineconfiguration.openshift.io/v1/machineconfignodes/{name}-
DELETE: MachineConfigNode を削除します -
GET: 指定された MachineConfigNode を読み取ります -
PATCH: 指定された MachineConfigNode を部分的に更新します -
PUT: 指定された MachineConfigNode を置き換えます
-
/apis/machineconfiguration.openshift.io/v1/machineconfignodes/{name}/status-
GET: 指定された MachineConfigNode のステータスを読み取ります -
PATCH: 指定された MachineConfigNode のステータスを部分的に更新します -
PUT: 指定された MachineConfigNode のステータスを置き換えます
-
11.2.1. /apis/machineconfiguration.openshift.io/v1/machineconfignodes リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- MachineConfigNode のコレクションを削除します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が MachineConfigNode のオブジェクトをリスト表示します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- MachineConfigNode を作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
11.2.2. /apis/machineconfiguration.openshift.io/v1/machineconfignodes/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| MachineConfigNode の名前 |
- HTTP メソッド
-
DELETE - 説明
- MachineConfigNode を削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された MachineConfigNode を読み取ります。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された MachineConfigNode を部分的に更新します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された MachineConfigNode を置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
11.2.3. /apis/machineconfiguration.openshift.io/v1/machineconfignodes/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| MachineConfigNode の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された MachineConfigNode のステータスを読み取ります。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された MachineConfigNode のステータスを部分的に更新します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された MachineConfigNode のステータスを置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第12章 MachineOSBuild [machineconfiguration.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineOSBuild は、MCO によって管理およびデプロイされるビルドプロセスを記述します。互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (いずれか長い方) で安定しています。
- 型
-
object - 必須
-
spec
-
12.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec は、マシン os ビルドの設定を記述します。これは、一度設定すると変更できません。 |
|
|
| status は、このマシン OS ビルドの最後に観測された状態を記述します。 |
12.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、マシン os ビルドの設定を記述します。これは、一度設定すると変更できません。
- 型
-
object - 必須
-
machineConfig -
machineOSConfig -
renderedImagePushSpec
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| machineConfig は、このイメージビルドに含めるレンダリング済みの MachineConfig リソースを指します。 |
|
|
| machineOSConfig は、このイメージビルドによって拡張される MachineOSConfig リソースを参照します。 |
|
|
| renderedImagePushSpec は、このビルドがアタッチされている MachineOSConfig オブジェクトから Machine Config Operator によって設定されます。このフィールドは、ビルド完了後にプッシュされる最終イメージの場所を記述します。イメージプッシュ spec の形式は、host[:port][/namespace]/name:<tag> or svc_name.namespace.svc[:port]/repository/name:<tag> です。プッシュ spec の長さは 1 文字以上 447 文字以下にする必要があります。 |
12.1.2. .spec.machineConfig リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- machineConfig は、このイメージビルドに含めるレンダリング済みの MachineConfig リソースを指します。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、レンダリング済みの MachineConfig オブジェクトの名前です。この値は 10 文字以上 253 文字以下で、小文字の英数字、ハイフン、ピリオドのみを含み、先頭と末尾は英数字にする必要があります。 |
12.1.3. .spec.machineOSConfig リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- machineOSConfig は、このイメージビルドによって拡張される MachineOSConfig リソースを参照します。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| MachineOSConfig の名前。名前には、小文字の英数字、'-'、または '.' のみを含めることができ、先頭と末尾は英数字にする必要があります。 |
12.1.4. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status は、このマシン OS ビルドの最後に観測された状態を記述します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| buildEnd は、ビルダーバックエンドの完了に対応するタイムスタンプです。省略された場合、ビルドは開始されていないか、進行中です。ビルドが完了するか、失敗するか、中断されると、この情報が入力されます。 |
|
|
| buildStart は、この MachineOSBuild のビルドバックエンドを開始するビルドコントローラーに対応するタイムスタンプです。 |
|
|
| builder は、このビルドに使用される Image Builder バックエンドを記述します。 |
|
|
| conditions は、ビルドの状態に関連するものです。有効なタイプは、Prepared、Building、Failed、Interrupted、Succeeded です。ビルドが Failed、Interrupted、または Succeeded とマークされると、それ以降は新しい condition を設定できません。 |
|
|
| condition には、この API Resource の現在の状態のある側面の詳細が含まれます。 |
|
|
| digestedImagePushSpec は、このビルドによって生成された完全修飾プッシュ spec を記述します。プッシュ spec の形式は、host[:port][/namespace]/name@sha256:<digest> です。digest は 64 文字の長さで、小文字の 16 進文字 (a - f と 0 - 9) のみが含まれている必要があります。spec 全体の長さは 1 文字以上 447 文字以下にする必要があります。 |
|
|
| relatedObjects は、ビルドプロセスの実行中に使用されることを想定した、一時的なオブジェクト (ConfigMaps や Secrets など) への参照のリストです。ビルドが成功した後、またはこの MachineOSBuild が削除されると、これらの一時オブジェクトは削除されます。ビルドが失敗した場合、ビルドが削除されるまでオブジェクトは残され、調査ができるようになっています。 |
|
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
12.1.5. .status.builder リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- builder は、このビルドに使用される Image Builder バックエンドを記述します。
- 型
-
object - 必須
-
imageBuilderType
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| imageBuilderType は、このイメージをビルドするために使用される Image Builder のタイプを記述します。有効な値は Job のみです。Job に設定すると、buildah を使用する Pod ベースのビルダーが起動され、指定されたイメージがビルドされます。 |
|
|
| job は、イメージビルドを管理しているジョブオブジェクトへの参照です。これは、imageBuilderType が Job の場合は必須、それ以外の場合は禁止されています。 |
12.1.6. .status.builder.job リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- job は、イメージビルドを管理しているジョブオブジェクトへの参照です。これは、imageBuilderType が Job の場合は必須、それ以外の場合は禁止されています。
- 型
-
object - 必須
-
group -
name -
resource
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 指示対象のグループ。名前には、小文字の英数字、'-'、または '.' のみを含めることができ、先頭と末尾は英数字にする必要があります。たとえば、""、"apps"、"build.openshift.io" です。 |
|
|
| 参照先の名前。名前には、小文字の英数字、'-'、または '.' のみを含めることができ、先頭と末尾は英数字にする必要があります。 |
|
|
| 参照先の namespace。この値は最大 63 文字で、小文字の英数字とハイフンのみを含み、先頭と末尾は英数字にする必要があります。 |
|
|
| 指示対象のリソース。この値は最大 63 文字で、小文字の英数字とハイフンのみを含み、英字で始まり英数字で終わる必要があります。たとえば、"deployments"、"deploymentconfigs"、"pods" です。 |
12.1.7. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、ビルドの状態に関連するものです。有効なタイプは、Prepared、Building、Failed、Interrupted、Succeeded です。ビルドが Failed、Interrupted、または Succeeded とマークされると、それ以降は新しい condition を設定できません。
- 型
-
array
12.1.8. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- condition には、この API Resource の現在の状態のある側面の詳細が含まれます。
- 型
-
object - 必須
-
lastTransitionTime -
message -
reason -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
12.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/machineconfiguration.openshift.io/v1/machineosbuilds-
DELETE: MachineOSBuild のコレクションを削除します -
GET: 種類が MachineOSBuild のオブジェクトをリスト表示します -
POST: MachineOSBuild を作成します
-
/apis/machineconfiguration.openshift.io/v1/machineosbuilds/{name}-
DELETE: MachineOSBuild を削除します -
GET: 指定された MachineOSBuild を読み取ります -
PATCH: 指定された MachineOSBuild を部分的に更新します -
PUT: 指定された MachineOSBuild を置き換えます
-
/apis/machineconfiguration.openshift.io/v1/machineosbuilds/{name}/status-
GET: 指定された MachineOSBuild のステータスを読み取ります -
PATCH: 指定された MachineOSBuild のステータスを部分的に更新します -
PUT: 指定された MachineOSBuild のステータスを置き換えます
-
12.2.1. /apis/machineconfiguration.openshift.io/v1/machineosbuilds リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- MachineOSBuild のコレクションを削除します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が MachineOSBuild のオブジェクトをリスト表示します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- MachineOSBuild を作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
12.2.2. /apis/machineconfiguration.openshift.io/v1/machineosbuilds/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| MachineOSBuild の名前。 |
- HTTP メソッド
-
DELETE - 説明
- MachineOSBuild を削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された MachineOSBuild を読み取ります。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された MachineOSBuild を部分的に更新します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された MachineOSBuild を置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
12.2.3. /apis/machineconfiguration.openshift.io/v1/machineosbuilds/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| MachineOSBuild の名前。 |
- HTTP メソッド
-
GET - 説明
- 指定された MachineOSBuild のステータスを読み取ります。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された MachineOSBuild のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された MachineOSBuild のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第13章 MachineOSConfig [machineconfiguration.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineOSConfig は、MCO によって管理されるビルドプロセスの設定を記述します。互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (いずれか長い方) で安定しています。
- 型
-
object - 必須
-
spec
-
13.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec は、machineosconfig の設定を記述します。 |
|
|
| status は、machineosconfig のステータスを記述します。 |
13.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、machineosconfig の設定を記述します。
- 型
-
object - 必須
-
imageBuilder -
machineConfigPool -
renderedImagePushSecret -
renderedImagePushSpec
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| baseImagePullSecret は、ベースイメージをプルするために使用されるシークレットです。提供される場合、openshift-machine-config-operator namespace に存在する必要があります。指定されていない場合は、デフォルトでクラスター全体のプルシークレットが使用されます。これはクラスターのインストール時に提供され、openshift-config namespace にシークレットとして存在します。 |
|
|
| containerFile は、ユーザーがイメージに組み込むために指定したカスタムデータを記述します。これは一般的に Dockerfile とも呼ばれており、Dockerfile として扱うことができます。コンテンツは Dockerfile のコンテンツです。spec 参照は、https://github.com/containers/common/blob/main/docs/Containerfile.5.md を参照してください。これはアーキテクチャー名 (例: AMD64) でインデックス付けされたリストであり、arch ごとに 1 つの containerFile (最大 4 つ) を指定できます。 |
|
|
| MachineOSContainerfile には、ユーザーがイメージに組み込みたいすべてのカスタムコンテンツが含まれています。 |
|
|
| imageBuilder は、この MachineOSConfig によってトリガーされる各ビルドで使用される Image Builder を記述します。現在サポートされているタイプ: Job |
|
|
| machineConfigPool は、ビルドの対象となるプールです。Machine Config Operator はビルドを実行し、ビルドされたイメージを指定されたプールにロールアウトします。 |
|
|
| renderedImagePushSecret は、ユーザーレジストリーに接続するために使用されるシークレットです。最終的なイメージのプッシュ用とプル用のシークレットは分離して、最小権限の原則を想定して設定される必要があります。書き込み特権を持つプッシュシークレットは、MachineConfigController Pod をホストしているノードにのみ存在する必要があります。読み取り専用特権を持つプルシークレットは、すべてのノードで必要です。2 つのシークレットを分離することで、書き込み認証情報が侵害されるリスクが軽減されます。 |
|
|
| renderedImagePushSpec は、最終イメージの場所を記述します。MachineOSConfig オブジェクトは、クラスター内のイメージレジストリー設定を使用します。registries.conf に固有のミラーまたはその他の設定を使用する場合は、クラスターの image.config、ImageContentSourcePolicies、ImageDigestMirrorSet、または ImageTagMirrorSet オブジェクトを介して、クラスター全体の registries.conf でそれらを指定してください。イメージプッシュ spec の形式は、host[:port][/namespace]/name:<tag> or svc_name.namespace.svc[:port]/repository/name:<tag> です。プッシュ spec の長さは 1 文字以上 447 文字以下にする必要があります。 |
13.1.2. .spec.baseImagePullSecret リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- baseImagePullSecret は、ベースイメージをプルするために使用されるシークレットです。提供される場合、openshift-machine-config-operator namespace に存在する必要があります。指定されていない場合は、デフォルトでクラスター全体のプルシークレットが使用されます。これはクラスターのインストール時に提供され、openshift-config namespace にシークレットとして存在します。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、この MachineOSConfig オブジェクトをプッシュまたはプルするために使用されるシークレットの名前です。小文字の英数字、'-'、または '.' が含まれ、先頭と末尾は英数字にする必要があります。このシークレットは、openshift-machine-config-operator namespace に存在する必要があります。 |
13.1.3. .spec.containerFile リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- containerFile は、ユーザーがイメージに組み込むために指定したカスタムデータを記述します。これは一般的に Dockerfile とも呼ばれており、Dockerfile として扱うことができます。コンテンツは Dockerfile のコンテンツです。spec 参照は、https://github.com/containers/common/blob/main/docs/Containerfile.5.md を参照してください。これはアーキテクチャー名 (例: AMD64) でインデックス付けされたリストであり、arch ごとに 1 つの containerFile (最大 4 つ) を指定できます。
- 型
-
array
13.1.4. .spec.containerFile[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- MachineOSContainerfile には、ユーザーがイメージに組み込みたいすべてのカスタムコンテンツが含まれています。
- 型
-
object - 必須
-
content
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| containerfileArch は、この containerfile がビルドされるアーキテクチャーを記述します。この arch はオプションです。ユーザーがアーキテクチャーを指定しない場合は、コンテンツはすべてのアーキテクチャーに適用できるか、単一のアーキテクチャークラスター (唯一のアーキテクチャー) に適用できるものとみなされます。 |
|
|
| content は、イメージに組み込まれるコンテンツを定義する埋め込み Containerfile/Dockerfile です。spec 参照は、https://github.com/containers/common/blob/main/docs/Containerfile.5.md を参照してください。たとえば、次のようにすることで、tree パッケージがホストに追加されます: FROM configs AS final RUN rpm-ostree install tree && \ ostree container commit このフィールドは必須で、最大 4096 文字まで指定できます。 |
13.1.5. .spec.imageBuilder リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- imageBuilder は、この MachineOSConfig によってトリガーされる各ビルドで使用される Image Builder を記述します。現在サポートされているタイプ: Job
- 型
-
object - 必須
-
imageBuilderType
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| imageBuilderType は、イメージのビルドに使用するバックエンドを指定します。有効なオプション: Job |
13.1.6. .spec.machineConfigPool リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- machineConfigPool は、ビルドの対象となるプールです。Machine Config Operator はビルドを実行し、ビルドされたイメージを指定されたプールにロールアウトします。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| MachineConfigPool オブジェクトの名前。この値は最大 253 文字で、小文字の英数字、ハイフン、ピリオドのみを含み、先頭と末尾は英数字にする必要があります。 |
13.1.7. .spec.renderedImagePushSecret リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- renderedImagePushSecret は、ユーザーレジストリーに接続するために使用されるシークレットです。最終的なイメージのプッシュ用とプル用のシークレットは分離して、最小権限の原則を想定して設定される必要があります。書き込み特権を持つプッシュシークレットは、MachineConfigController Pod をホストしているノードにのみ存在する必要があります。読み取り専用特権を持つプルシークレットは、すべてのノードで必要です。2 つのシークレットを分離することで、書き込み認証情報が侵害されるリスクが軽減されます。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、この MachineOSConfig オブジェクトをプッシュまたはプルするために使用されるシークレットの名前です。小文字の英数字、'-'、または '.' が含まれ、先頭と末尾は英数字にする必要があります。このシークレットは、openshift-machine-config-operator namespace に存在する必要があります。 |
13.1.8. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status は、machineosconfig のステータスを記述します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、オブジェクトの状態に関連するものです。 |
|
|
| condition には、この API Resource の現在の状態のある側面の詳細が含まれます。 |
|
|
| currentImagePullSpec は、MCO が新しい OSImage をプルダウンするために使用する完全修飾イメージプル spec です。これには、sha256 イメージダイジェストが含まれます。これは、Machine Config Operator のビルドコントローラーがビルドを正常に完了したときに生成され、対応する MachineOSBuild オブジェクトの FinalImagePushSpec から情報が設定されます。これは、新しいイメージのビルドを引き起こす spec の変更に応じて完了後に変更される可能性がありますが、削除されることはありません。イメージプル spec の形式は、host[:port][/namespace]/name@sha256:<digest> です。digest は 64 文字の長さで、小文字の 16 進文字 (a - f と 0 - 9) のみが含まれている必要があります。spec 全体の長さは 1 文字以上 447 文字以下にする必要があります。 |
|
|
| machineOSBuild は、この MachineOSConfig の MachineOSBuild オブジェクトへの参照であり、イメージビルドのステータスが含まれます。 |
|
|
| observedGeneration は、Machine Config Operator のビルドコントローラーによって観測された MachineOSConfig オブジェクトの世代を表します。 |
13.1.9. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、オブジェクトの状態に関連するものです。
- 型
-
array
13.1.10. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- condition には、この API Resource の現在の状態のある側面の詳細が含まれます。
- 型
-
object - 必須
-
lastTransitionTime -
message -
reason -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
13.1.11. .status.machineOSBuild リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- machineOSBuild は、この MachineOSConfig の MachineOSBuild オブジェクトへの参照であり、イメージビルドのステータスが含まれます。
- 型
-
object - 必須
-
group -
name -
resource
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 指示対象のグループ。名前には、小文字の英数字、'-'、または '.' のみを含めることができ、先頭と末尾は英数字にする必要があります。たとえば、""、"apps"、"build.openshift.io" です。 |
|
|
| 参照先の名前。名前には、小文字の英数字、'-'、または '.' のみを含めることができ、先頭と末尾は英数字にする必要があります。 |
|
|
| 参照先の namespace。この値は最大 63 文字で、小文字の英数字とハイフンのみを含み、先頭と末尾は英数字にする必要があります。 |
|
|
| 指示対象のリソース。この値は最大 63 文字で、小文字の英数字とハイフンのみを含み、英字で始まり英数字で終わる必要があります。たとえば、"deployments"、"deploymentconfigs"、"pods" です。 |
13.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/machineconfiguration.openshift.io/v1/machineosconfigs-
DELETE: MachineOSConfig のコレクションを削除します -
GET: 種類が MachineOSConfig のオブジェクトをリスト表示します -
POST: MachineOSConfig を作成します
-
/apis/machineconfiguration.openshift.io/v1/machineosconfigs/{name}-
DELETE: MachineOSConfig を削除します -
GET: 指定された MachineOSConfig を読み取ります -
PATCH: 指定された MachineOSConfig を部分的に更新します -
PUT: 指定された MachineOSConfig を置き換えます
-
/apis/machineconfiguration.openshift.io/v1/machineosconfigs/{name}/status-
GET: 指定された MachineOSConfig のステータスを読み取ります -
PATCH: 指定された MachineOSConfig のステータスを部分的に更新します -
PUT: 指定された MachineOSConfig のステータスを置き換えます
-
13.2.1. /apis/machineconfiguration.openshift.io/v1/machineosconfigs リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- MachineOSConfig のコレクションを削除する
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が MachineOSConfig のオブジェクトをリスト表示します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- MachineOSConfig を作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
13.2.2. /apis/machineconfiguration.openshift.io/v1/machineosconfigs/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| MachineOSConfig の名前 |
- HTTP メソッド
-
DELETE - 説明
- MachineOSConfig を削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された MachineOSConfig を読み取る
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された MachineOSConfig を部分的に更新する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された MachineOSConfig を置き換える
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
13.2.3. /apis/machineconfiguration.openshift.io/v1/machineosconfigs/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| MachineOSConfig の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された MachineOSConfig のステータスを読み取る
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された MachineOSConfig のステータスを部分的に更新する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された MachineOSConfig のステータスを置き換える
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第14章 PinnedImageSet [machineconfiguration.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
PinnedImageSet は、CRI-O によってピン留めされ、宣言された MachineConfigPools のメンバーであるノードにプルされるイメージのセットを記述します。
互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (いずれか長い方) で安定しています。
- 型
-
object - 必須
-
spec
-
14.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec は、このピン留めされたイメージセットの設定を記述します。 |
14.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、このピン留めされたイメージセットの設定を記述します。
- 型
-
object - 必須
-
pinnedImages
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| pinnedImages は、MachineConfigPool のノードによってピン留めされ、事前ロードされるダイジェストによって参照される OCI イメージのリストです。/etc/crio/crio.conf.d ディレクトリー内に、次のような内容の新しいファイルとして変換されます。 pinned_images = [ "quay.io/openshift-release-dev/ocp-release@sha256:…", "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:…", "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:…", … ] イメージ参照は、ダイジェストによって行う必要があります。最大 500 のイメージを指定できます。 |
|
|
| PinnedImageRef は OCI イメージへの参照を表します。 |
14.1.2. .spec.pinnedImages リンクのコピーリンクがクリップボードにコピーされました!
- 説明
pinnedImages は、MachineConfigPool のノードによってピン留めされ、事前ロードされるダイジェストによって参照される OCI イメージのリストです。/etc/crio/crio.conf.d ディレクトリー内に、次のような内容の新しいファイルとして変換されます。
pinned_images = [ "quay.io/openshift-release-dev/ocp-release@sha256:...", "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:...", "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:...", ... ]イメージ参照は、ダイジェストによって行う必要があります。最大 500 のイメージを指定できます。
- 型
-
array
14.1.3. .spec.pinnedImages[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- PinnedImageRef は OCI イメージへの参照を表します。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、ダイジェストによって参照される OCI イメージです。イメージプル spec の形式は、host[:port][/namespace]/name@sha256:<digest> です。digest は 64 文字の長さで、小文字の 16 進文字 (a - f と 0 - 9) のみが含まれている必要があります。spec 全体の長さは 1 文字以上 447 文字以下にする必要があります。 |
14.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/machineconfiguration.openshift.io/v1/pinnedimagesets-
DELETE: PinnedImageSet のコレクションを削除します -
GET: 種類が PinnedImageSet のオブジェクトをリスト表示します -
POST: PinnedImageSet を作成します
-
/apis/machineconfiguration.openshift.io/v1/pinnedimagesets/{name}-
DELETE: PinnedImageSet を削除します -
GET: 指定された PinnedImageSet を読み取ります -
PATCH: 指定された PinnedImageSet を部分的に更新します -
PUT: 指定された PinnedImageSet を置き換えます
-
14.2.1. /apis/machineconfiguration.openshift.io/v1/pinnedimagesets リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- PinnedImageSet のコレクションを削除します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が PinnedImageSet のオブジェクトをリスト表示します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- PinnedImageSet を作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
14.2.2. /apis/machineconfiguration.openshift.io/v1/pinnedimagesets/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| PinnedImageSet の名前 |
- HTTP メソッド
-
DELETE - 説明
- PinnedImageSet を削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された PinnedImageSet を読み取ります。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された PinnedImageSet を部分的に更新します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された PinnedImageSet を置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |