テンプレート API

bindingIDs

array (string)

bindingIDs は、テンプレートサービスブローカーへの連続したバインド呼び出し中に提供される 'binding_id' のリストです。

secret

ObjectReference

secret は、namespace にある Secret オブジェクトへの参照であり、必要なテンプレートパラメーターが含まれています。

templateInstance

ObjectReference

templateinstance は、namespace にある TemplateInstance オブジェクトへの参照です。

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

dryRun

string

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

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

orphanDependents

boolean

非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

sendInitialEvents

boolean

`sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。

'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。

`resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

body

DeleteOptions スキーマ

200 - OK

Status スキーマ

401 - Unauthorized

空白

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

sendInitialEvents

boolean

`sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。

'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。

`resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

200 - OK

BrokerTemplateInstanceList スキーマ

401 - Unauthorized

空白

dryRun

string

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

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

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

body

BrokerTemplateInstance スキーマ

200 - OK

BrokerTemplateInstance スキーマ

201 - Created

BrokerTemplateInstance スキーマ

202 - Accepted

BrokerTemplateInstance スキーマ

401 - Unauthorized

空白

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

sendInitialEvents

boolean

`sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。

'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。

`resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

name

string

BrokerTemplateInstance の名前

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

dryRun

string

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

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

orphanDependents

boolean

非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。

body

DeleteOptions スキーマ

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

200 - OK

BrokerTemplateInstance スキーマ

401 - Unauthorized

空白

dryRun

string

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

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。

fieldValidation

string

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

force

boolean

"force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。

body

Patch スキーマ

200 - OK

BrokerTemplateInstance スキーマ

201 - Created

BrokerTemplateInstance スキーマ

401 - Unauthorized

空白

dryRun

string

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

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

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

body

BrokerTemplateInstance スキーマ

200 - OK

BrokerTemplateInstance スキーマ

201 - Created

BrokerTemplateInstance スキーマ

401 - Unauthorized

空白

name

string

BrokerTemplateInstance の名前

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

sendInitialEvents

boolean

`sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。

'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。

`resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

metadata

ObjectMeta

標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

spec

object

PodSpec は Pod の説明です。

activeDeadlineSeconds

integer

システムがアクティブに失敗のマークを付けて関連するコンテナーを強制終了する前に、StartTime を基準にして Pod がノード上でアクティブになる可能性がある秒単位のオプションの期間。その値は正の整数でなければなりません。

affinity

object

アフィニティーは、アフィニティースケジューリングルールのグループです。

automountServiceAccountToken

boolean

AutomountServiceAccountToken は、サービスアカウントトークンを自動的にマウントする必要があるかどうかを示します。

containers

array

Pod に属するコンテナーのリスト。現在、コンテナーを追加または削除することはできません。Pod には少なくとも 1 つのコンテナーが必要です。これを更新することはできません。

containers[]

object

Pod 内で実行する単一のアプリケーションコンテナー。

dnsConfig

object

PodDNSConfig は、DNSPolicy から生成されたパラメーターに加えて、Pod の DNS パラメーターを定義します。

dnsPolicy

string

Pod の DNS ポリシーを設定します。デフォルトは "ClusterFirst" です。有効な値は、'ClusterFirstWithHostNet'、'ClusterFirst'、'Default'、または 'None' です。DNSConfig で指定された DNS パラメーターは、DNSPolicy で選択されたポリシーとマージされます。hostNetwork とともに DNS オプションを設定するには、DNS ポリシーを 'ClusterFirstWithHostNet' に明示的に指定する必要があります。

使用可能な列挙値: - "ClusterFirst" は hostNetwork が true でない限り、Pod が最初にクラスター DNS を使用する必要があることを示します。クラスター DNS が使用可能な場合は、デフォルト (kubelet によって決定される) DNS 設定にフォールバックします。- "ClusterFirstWithHostNet" は Pod が最初にクラスター DNS を使用し、それが使用可能な場合は、その後、デフォルト (kubelet によって決定される) DNS 設定にフォールバックする必要があることを示します。- "Default" は Pod がデフォルトの (kubelet によって決定された) DNS 設定を使用する必要があることを示します。- "None" は Pod が空の DNS 設定を使用する必要があることを示します。ネームサーバーや検索パスなどの DNS パラメーターは、DNSConfig で定義する必要があります。

enableServiceLinks

boolean

EnableServiceLinks は、Docker リンクの構文と一致して、サービスに関する情報を Pod の環境変数に挿入する必要があるかどうかを示します。オプション: デフォルトは true です。

ephemeralContainers

array

この Pod で実行されるエフェメラルコンテナーのリスト。エフェメラルコンテナーを既存の Pod で実行して、デバッグなどのユーザーが開始するアクションを実行できます。このリストは、Pod の作成時に指定することはできません。また、Pod の仕様を更新して変更することもできません。エフェメラルコンテナーを既存の Pod に追加するには、Pod のエフェメラルコンテナーサブリソースを使用します。

ephemeralContainers[]

object

EphemeralContainer は、デバッグなど、ユーザーが開始したアクティビティーに対して、既存の Pod に追加できる一時コンテナーです。エフェメラルコンテナーにはリソースやスケジュールの保証がなく、コンテナーの終了時、または Pod の削除または再起動時に再起動されません。エフェメラルコンテナーが原因で Pod がリソース割り当てを超過した場合、kubelet は Pod をエビクトする可能性があります。

エフェメラルコンテナーを追加するには、既存の Pod の ephemeralcontainers サブリソースを使用します。エフェメラルコンテナーは削除または再起動できません。

hostAliases

array

HostAliases は、指定された場合に Pod の hosts ファイルに注入されるホストおよび IP のオプションのリストです。これは、hostNetwork 以外の Pod にのみ有効です。

hostAliases[]

object

HostAlias は、Pod の hosts ファイルのエントリーとして挿入される IP とホスト名の間のマッピングを保持します。

hostIPC

boolean

ホストの ipc 名前空間を使用します。オプション: デフォルトは false です。

hostNetwork

boolean

この Pod に要求されたホストネットワーク。ホストのネットワーク名前空間を使用します。このオプションを設定する場合は、使用するポートを指定する必要があります。デフォルトは false です。

hostPID

boolean

ホストの pid 名前空間を使用します。オプション: デフォルトは false です。

hostUsers

boolean

ホストのユーザー namespace を使用します。任意: デフォルトは true です。true に設定するか存在しない場合、Pod はホストユーザーの namespace で実行されます。これは、CAP_SYS_MODULE を使用したカーネルモジュールのロードなど、ホストユーザー namespace でのみ利用できる機能が Pod に必要な場合に役立ちます。false に設定すると、Pod 用に新しい userns が作成されます。false に設定すると、コンテナーブレークアウトの脆弱性を軽減するのに役立ち、ユーザーがホスト上で実際に root 権限を持たずにコンテナーを root として実行できるようになります。このフィールドはアルファレベルであり、UserNamespacesSupport 機能を有効にするサーバーでのみ認識されます。

hostname

string

Pod のホスト名を指定します指定しない場合、Pod のホスト名はシステム定義の値に設定されます。

imagePullSecrets

array

ImagePullSecrets は、この PodSpec で使用されるイメージをプルするために使用する、同じ名前空間内のシークレットへの参照のオプションのリストです。指定されている場合、これらのシークレットは、使用するために個々のプラー実装に渡されます。詳細: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

imagePullSecrets[]

object

LocalObjectReference には、同じ namespace 内で参照オブジェクトを見つけるのに十分な情報が含まれます。

initContainers

array

Pod に属する初期化コンテナーのリスト。コンテナーが開始される前に、初期化コンテナーが順番に実行されます。init コンテナーに障害が発生した場合、Pod は障害が発生したと見なされ、restartPolicy に従って処理されます。init コンテナーまたは通常のコンテナーの名前は、すべてのコンテナー間で一意である必要があります。Init コンテナーには、ライフサイクルアクション、準備プローブ、ライブネスプローブ、またはスタートアッププローブがない場合があります。init コンテナーの resourceRequirements は、各リソースタイプの最大の要求/制限を見つけ、その値の最大値または通常のコンテナーの合計を使用することにより、スケジューリング中に考慮されます。同様の方法で、init コンテナーに制限が適用されます。現在、初期化コンテナーを追加または削除することはできません。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

initContainers[]

object

Pod 内で実行する単一のアプリケーションコンテナー。

nodeName

string

NodeName は、この Pod を特定のノードにスケジュールするためのリクエストです。空でない場合、スケジューラーは、リソース要件に適合していると想定して、この Pod をそのノードにスケジュールするだけです。

nodeSelector

object (string)

NodeSelector は、Pod がノードに収まるようにするために true である必要があるセレクターです。そのノードでスケジュールされる Pod のノードのラベルと一致する必要があるセレクター。詳細: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

os

object

PodOS は、Pod の OS パラメーターを定義します。

overhead

object (Quantity)

オーバーヘッドは、特定の RuntimeClass の Pod の実行に関連するリソースオーバーヘッドを表します。このフィールドは、RuntimeClass アドミッションコントローラーによってアドミッション時に自動入力されます。RuntimeClass アドミッションコントローラーが有効になっている場合は、Pod 作成要求でオーバーヘッドを設定しないでください。RuntimeClass アドミッションコントローラーは、オーバーヘッドがすでに設定されている Pod 作成要求を拒否します。RuntimeClass が PodSpec で設定および選択されている場合、オーバーヘッドは対応する RuntimeClass で定義されている値に設定されます。それ以外の場合は、未設定のままでゼロとして扱われます。詳細は、https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md を参照してください。

preemptionPolicy

string

PreemptionPolicy は、優先度の低い Pod をプリエンプトするためのポリシーです。Never、PreemptLowerPriority の 1 つ。設定されていない場合、デフォルトは PreemptLowerPriority です。

使用可能な列挙値: - "Never" は Pod が優先順位の低い他の Pod をプリエンプトしないことを意味します。- "PreemptLowerPriority" は Pod が優先順位の低い他の Pod をプリエンプトできることを意味します。

priority

integer

優先度の値。さまざまなシステムコンポーネントがこのフィールドを使用して、Pod の優先度を検索します。Priority Admission Controller が有効になっている場合、ユーザーはこのフィールドを設定できません。アドミッションコントローラーは、PriorityClassName からこのフィールドに入力します。値が高いと優先順位が高くなります。

priorityClassName

string

指定されている場合、Pod の優先度を示します。"system-node-critical" と "system-cluster-critical" は、最も高い優先度を示す 2 つの特別なキーワードであり、前者が最も高い優先度です。その他の名前は、その名前で PriorityClass オブジェクトを作成して定義する必要があります。指定しない場合、Pod の優先度はデフォルトになり、デフォルトがない場合はゼロになります。

readinessGates

array

指定した場合、すべての準備ゲートが Pod の準備状況に対して評価されます。すべてのコンテナーの準備が整い、準備ゲートで指定されたすべての条件のステータスが "True" になると、Pod の準備が整います。詳細: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

readinessGates[]

object

PodReadinessGate には、Pod 条件への参照が含まれています

resourceClaims

array

ResourceClaims は、Pod の起動を許可する前にどの ResourceClaim を割り当てて予約する必要があるかを定義します。リソースは、名前ベースでリソースを使用するコンテナーに提供されます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは不変です。

resourceClaims[]

object

PodResourceClaim は、ClaimSource を介して 1 つの ResourceClaim のみを参照します。Pod 内の ResourceClaim を一意に識別する名前を追加します。ResourceClaim へのアクセスが必要なコンテナーは、この名前で参照します。

restartPolicy

string

Pod 内のすべてのコンテナーのポリシーを再起動します。Always、OnFailure、Never のいずれか。コンテキストによっては、これらの値のサブセットのみが使用できます。デフォルトは Always です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

使用可能な列挙値: - "Always" - "Never" - "OnFailure"

runtimeClassName

string

RuntimeClassName は、node.k8s.io グループ内の RuntimeClass オブジェクトを参照します。このオブジェクトは、この Pod を実行するために使用する必要があります。指定されたクラスに一致する RuntimeClass リソースがない場合、Pod は実行されません。設定されていないか空の場合は、"レガシー" の RuntimeClass が使用されます。これは、デフォルトのランタイムハンドラーを使用する空の定義を持つ暗黙のクラスです。詳細は、https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class を参照してください。

schedulerName

string

指定した場合、Pod は指定したスケジューラーによってディスパッチされます。指定しない場合、Pod はデフォルトのスケジューラーによってディスパッチされます。

schedulingGates

array

SchedulingGates は、指定されている場合に Pod のスケジューリングをブロックする不透明な値のリストです。schedulingGates が空でない場合、Pod は SchedulingGated 状態のままになり、スケジューラーは Pod のスケジュールを試行しません。

SchedulingGates を設定できるのは Pod の作成時にのみで、それ以降は削除されます。

これは、PodSchedulingReadiness フィーチャーゲートによって有効になるベータ機能です。

schedulingGates[]

object

PodSchedulingGate は Pod に割り当てられ、そのスケジューリングを保護します。

securityContext

object

PodSecurityContext は、Pod レベルのセキュリティー属性と一般的なコンテナー設定を保持します。一部のフィールドは container.securityContext にも存在します。container.securityContext のフィールド値は、PodSecurityContext のフィールド値よりも優先されます。

serviceAccount

string

DeprecatedServiceAccount は、ServiceAccountName の減価償却されたエイリアスです。非推奨: 代わりに serviceAccountName を使用してください。

serviceAccountName

string

ServiceAccountName は、この Pod の実行に使用する ServiceAccount の名前です。詳細: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

setHostnameAsFQDN

boolean

true の場合、Pod のホスト名は、リーフ名 (デフォルト) ではなく、Pod の FQDN として設定されます。Linux コンテナーでは、これはカーネルのホスト名フィールド (struct utsname のノード名フィールド) に FQDN を設定することを意味します。Windows コンテナーでは、これはレジストリーキー HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters のホスト名のレジストリー値を FQDN に設定することを意味します。Pod に FQDN がない場合、これは効果がありません。デフォルトは false です。

shareProcessNamespace

boolean

Pod 内のすべてのコンテナー間で単一のプロセス名前空間を共有します。これが設定されると、コンテナーは同じ Pod 内の他のコンテナーからのプロセスを表示および通知できるようになり、各コンテナーの最初のプロセスには PID1 が割り当てられません。HostPID と ShareProcessNamespace の両方を設定することはできません。オプション: デフォルトは false です。

subdomain

string

指定した場合、完全修飾 Pod のホスト名は "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>" になります。指定しない場合、Pod にはドメイン名がまったくありません。

terminationGracePeriodSeconds

integer

Pod が正常に終了する必要がある秒単位のオプションの期間。削除リクエストで減少する可能性があります。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。この値が nil の場合、代わりにデフォルトの猶予期間が使用されます。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。デフォルトは 30 秒です。

tolerations

array

指定されている場合、Pod の許容範囲。

tolerations[]

object

この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。

topologySpreadConstraints

array

TopologySpreadConstraints は、Pod のグループがトポロジードメイン全体にどのように分散するべきかを説明します。スケジューラーは、制約に従う方法で Pod をスケジュールします。すべての topologySpreadConstraints は AND 演算されます。

topologySpreadConstraints[]

object

topologySpreadConstraint は、指定されたトポロジー間で一致する Pod を分散する方法を指定します。

volumes

array

Pod に属するコンテナーによってマウントできるボリュームのリスト。詳細: https://kubernetes.io/docs/concepts/storage/volumes

volumes[]

object

ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。

nodeAffinity

object

ノードアフィニティーは、ノードアフィニティースケジューリングルールのグループです。

podAffinity

object

Pod アフィニティーは、Pod 間アフィニティースケジューリングルールのグループです。

podAntiAffinity

object

Pod アンチアフィニティーは、Pod 間アンチアフィニティースケジューリングルールのグループです。

preferredDuringSchedulingIgnoredDuringExecution

array

スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。

preferredDuringSchedulingIgnoredDuringExecution[]

object

空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。

requiredDuringSchedulingIgnoredDuringExecution

object

ノードセレクターは、ノードのセットに対する 1 つ以上のラベルクエリーの結果の和集合を表します。つまり、ノードセレクター用語で表されるセレクターの OR を表します。

preference

object

null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。

weight

integer

対応する nodeSelectorTerm の一致に関連する重み (1〜100 の範囲)。

matchExpressions

array

ノードのラベルごとのノードセレクター要件のリスト。

matchExpressions[]

object

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

matchFields

array

ノードのフィールドごとのノードセレクター要件のリスト。

matchFields[]

object

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

key

string

セレクターが適用されるラベルキー。

operator

string

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

使用可能な列挙値：- "DoesNotExist" - "Exists" - "Gt" - "In" - "Lt" - "NotIn"

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

key

string

セレクターが適用されるラベルキー。

operator

string

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

使用可能な列挙値：- "DoesNotExist" - "Exists" - "Gt" - "In" - "Lt" - "NotIn"

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

nodeSelectorTerms

array

必須。ノードセレクター用語のリスト。用語は OR されています。

nodeSelectorTerms[]

object

null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。

matchExpressions

array

ノードのラベルごとのノードセレクター要件のリスト。

matchExpressions[]

object

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

matchFields

array

ノードのフィールドごとのノードセレクター要件のリスト。

matchFields[]

object

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

key

string

セレクターが適用されるラベルキー。

operator

string

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

使用可能な列挙値：- "DoesNotExist" - "Exists" - "Gt" - "In" - "Lt" - "NotIn"

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

key

string

セレクターが適用されるラベルキー。

operator

string

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

使用可能な列挙値：- "DoesNotExist" - "Exists" - "Gt" - "In" - "Lt" - "NotIn"

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

preferredDuringSchedulingIgnoredDuringExecution

array

スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。

preferredDuringSchedulingIgnoredDuringExecution[]

object

一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。

requiredDuringSchedulingIgnoredDuringExecution

array

このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。

requiredDuringSchedulingIgnoredDuringExecution[]

object

この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。

podAffinityTerm

object

この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。

weight

integer

対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。

labelSelector

LabelSelector

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

LabelSelector

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespace

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

labelSelector

LabelSelector

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

LabelSelector

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespace

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

preferredDuringSchedulingIgnoredDuringExecution

array

スケジューラーは、このフィールドで指定された非アフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。

preferredDuringSchedulingIgnoredDuringExecution[]

object

一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。

requiredDuringSchedulingIgnoredDuringExecution

array

このフィールドで指定された非アフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定された非アフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。

requiredDuringSchedulingIgnoredDuringExecution[]

object

この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。

podAffinityTerm

object

この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。

weight

integer

対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。

labelSelector

LabelSelector

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

LabelSelector

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespace

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

labelSelector

LabelSelector

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

LabelSelector

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespace

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

args

array (string)

エントリーポイントへの引数。これが指定されていない場合は、コンテナーイメージの CMD が使用されます。変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。これを更新することはできません。詳細: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

command

array (string)

エントリーポイント配列。シェル内では実行されません。これが指定されていない場合は、コンテナーイメージの ENTRYPOINT が使用されます。変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。これを更新することはできません。詳細: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

env

array

コンテナーに設定する環境変数のリスト。これを更新することはできません。

env[]

object

EnvVar は、コンテナーに存在する環境変数を表します。

envFrom

array

コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これを更新することはできません。

envFrom[]

object

EnvFromSource は、一連の ConfigMap のソースを表します

image

string

コンテナーイメージ名詳細: https://kubernetes.io/docs/concepts/containers/images このフィールドはオプションであり、高レベルの設定管理で、Deployments や StatefulSets などのワークロードコントローラーのコンテナーイメージをデフォルトまたはオーバーライドできます。

imagePullPolicy

string

イメージプルポリシーAlways、Never、IfNotPresent のいずれか。デフォルトは、:latest タグが指定されている場合は常に、それ以外の場合は IfNotPresent です。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/containers/images#updating-images

使用可能な列挙値: - "Always" は kubelet が常に最新イメージのプルを試行することを意味します。プルに失敗するとコンテナーで問題が発生します。- "IfNotPresent" は、イメージがディスクに存在しない場合に kubelet がプルすることを意味します。イメージが存在せず、プルに失敗すると、コンテナーに問題が発生します。- "Never" は kubelet がイメージを取得せず、ローカルイメージのみを使用することを意味します。イメージが存在しない場合、コンテナーは失敗します。

lifecycle

object

ライフサイクルは、コンテナーのライフサイクルイベントに対応して管理システムが実行する必要のあるアクションを表します。PostStart および PreStop ライフサイクルハンドラーの場合、コンテナープロセスが失敗しない限り、アクションが完了するまでコンテナー管理がブロックされます。失敗した場合、ハンドラーは中止されます。

livenessProbe

object

プローブは、コンテナーが稼働しているか、トラフィックを受け取る準備ができているかどうかを判断するために、コンテナーに対して実行されるヘルスチェックを記述します。

name

string

DNS_LABEL として指定されたコンテナーの名前。Pod 内の各コンテナーには、一意の名前 (DNS_LABEL) が必要です。これを更新することはできません。

ports

array

コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これを更新することはできません。

ports[]

object

ContainerPort は、単一のコンテナー内のネットワークポートを表します。

readinessProbe

object

プローブは、コンテナーが稼働しているか、トラフィックを受け取る準備ができているかどうかを判断するために、コンテナーに対して実行されるヘルスチェックを記述します。

resizePolicy

array

コンテナーのリソースサイズ変更ポリシー。

resizePolicy[]

object

ContainerResizePolicy は、コンテナーのリソースサイズ変更ポリシーを表します。

resources

object

ResourceRequirements は、コンピュートリソースの要件を説明します。

securityContext

object

SecurityContext は、コンテナーに適用されるセキュリティー設定を保持します。一部のフィールドは、SecurityContext と PodSecurityContext の両方に存在します。両方が設定されている場合は、SecurityContext の値が優先されます。

startupProbe

object

プローブは、コンテナーが稼働しているか、トラフィックを受け取る準備ができているかどうかを判断するために、コンテナーに対して実行されるヘルスチェックを記述します。

stdin

boolean

このコンテナーがコンテナーランタイムで stdin にバッファーを割り当てる必要があるかどうか。これが設定されていない場合、コンテナー内の stdin からの読み取りは常に EOF になります。デフォルトは false です。

stdinOnce

boolean

コンテナーランタイムが、単一の接続によって開かれた後に stdin チャネルを閉じる必要があるかどうか。stdin が true の場合、stdin ストリームは複数の接続セッションにわたって開いたままになります。stdinOnce が true に設定されている場合、stdin はコンテナーの起動時に開かれ、最初のクライアントが stdin に接続するまで空になり、クライアントが切断されるまで開いたままでデータを受け入れます。切断されると、stdin は閉じられ、コンテナーが再起動されるまで閉じられたままになります。。このフラグが false の場合、stdin から読み取るコンテナープロセスは EOF を受信しません。デフォルトは false です。

terminationMessagePath

string

オプション: コンテナーの終了メッセージが書き込まれるファイルがコンテナーのファイルシステムにマウントされるパス。書き込まれるメッセージは、アサーション失敗メッセージなどの簡単な最終ステータスを目的としています。4096 バイトを超える場合、ノードによって切り捨てられます。すべてのコンテナーの合計メッセージ長は 12kb に制限されます。デフォルトは/dev/termination-log です。これを更新することはできません。

terminationMessagePolicy

string

終了メッセージの入力方法を示します。ファイルは、terminationMessagePath の内容を使用して、成功と失敗の両方でコンテナーステータスメッセージを入力します。終了メッセージファイルが空で、コンテナーがエラーで終了した場合、FallbackToLogsOnError はコンテナーログ出力の最後のチャンクを使用します。ログ出力は、2048 バイトまたは 80 行のいずれか小さい方に制限されます。デフォルトは File です。これを更新することはできません。

使用可能な列挙値: - "FallbackToLogsOnError" は、コンテナーがエラーで終了し、terminationMessagePath に何も含まれていない場合に、コンテナーステータスメッセージのコンテナーログの最新の内容を読み取ります。- "File" はデフォルトの動作で、コンテナーが終了するときにコンテナーのステータスメッセージをコンテナーの terminationMessagePath の内容に設定します。

tty

boolean

このコンテナーがそれ自体に TTY を割り当てる必要があるかどうかには、'stdin' が true である必要もあります。デフォルトは false です。

volumeDevices

array

volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。

volumeDevices[]

object

volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。

volumeMounts

array

コンテナーのファイルシステムにマウントする Pod ボリューム。これを更新することはできません。

volumeMounts[]

object

VolumeMount は、コンテナー内でのボリュームのマウントを説明します。

workingDir

string

コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これを更新することはできません。

name

string

環境変数の名前。C_IDENTIFIER でなければなりません。

value

string

変数参照 $(VAR_NAME) は、コンテナー内で以前に定義された環境変数と任意のサービス環境変数を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。デフォルトは "" です。

valueFrom

object

EnvVarSource は、EnvVar の値のソースを表します。

configMapKeyRef

object

ConfigMap からキーを選択します。

fieldRef

object

ObjectFieldSelector は、オブジェクトの APIVersioned フィールドを選択します。

resourceFieldRef

object

ResourceFieldSelector は、コンテナーリソース (CPU、メモリー) とその出力形式を表します。

secretKeyRef

object

SecretKeySelector は、シークレットのキーを選択します。

key

string

選択するキー。

name

string

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

optional

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

apiVersion

string

FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。

fieldPath

string

指定された API バージョンで選択するフィールドのパス。

containerName

string

コンテナー名: ボリュームには必須、env 変数にはオプション

divisor

quantity

公開されたリソースの出力形式を指定します。デフォルトは "1" です。

resource

string

必須: 選択するリソース

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

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

optional

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

configMapRef

object

ConfigMapEnvSource は、環境変数に入力する ConfigMap を選択します。

ターゲットの ConfigMap のデータフィールドの内容は、キーと値のペアを環境変数として表します。

prefix

string

ConfigMap の各キーの前に追加するオプションの識別子。C_IDENTIFIER でなければなりません。

secretRef

object

SecretEnvSource は、環境変数に入力するシークレットを選択します。

ターゲットシークレットのデータフィールドの内容は、キーと値のペアを環境変数として表します。

name

string

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

optional

boolean

ConfigMap を定義する必要があるかどうかを指定します

name

string

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

optional

boolean

シークレットを定義する必要があるかどうかを指定します

postStart

object

LifecycleHandler は、ライフサイクルフックで実行する必要がある特定のアクションを定義します。TCPSocket を除くフィールドのうち 1 つだけを指定する必要があります。

preStop

object

LifecycleHandler は、ライフサイクルフックで実行する必要がある特定のアクションを定義します。TCPSocket を除くフィールドのうち 1 つだけを指定する必要があります。

exec

object

ExecAction は、"run in container" アクションを記述します。

httpGet

object

HTTPGetAction は、HTTP GET リクエストに基づくアクションを記述します。

tcpSocket

object

TCPSocketAction は、ソケットを開くことに基づくアクションを記述します

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

IntOrString

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

使用可能な列挙値：- "HTTP" は、使用するスキームが http:// - https であることを指定します。- "HTTPS" は、使用するスキームが https:// であることを指定します。

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

IntOrString

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

exec

object

ExecAction は、"run in container" アクションを記述します。

httpGet

object

HTTPGetAction は、HTTP GET リクエストに基づくアクションを記述します。

tcpSocket

object

TCPSocketAction は、ソケットを開くことに基づくアクションを記述します

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

IntOrString

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

使用可能な列挙値：- "HTTP" は、使用するスキームが http:// - https であることを指定します。- "HTTPS" は、使用するスキームが https:// であることを指定します。

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

IntOrString

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

exec

object

ExecAction は、"run in container" アクションを記述します。

failureThreshold

integer

正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。

grpc

object

GRPC は、GRPC ポートに関連するアクションを指定します。

httpGet

object

HTTPGetAction は、HTTP GET リクエストに基づくアクションを記述します。

initialDelaySeconds

integer

コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

integer

プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。

successThreshold

integer

失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。

tcpSocket

object

TCPSocketAction は、ソケットを開くことに基づくアクションを記述します

terminationGracePeriodSeconds

integer

プローブの障害時に Pod が正常に終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。

timeoutSeconds

integer

プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

port

integer

gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。

service

string

Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。

これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

IntOrString

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

使用可能な列挙値：- "HTTP" は、使用するスキームが http:// - https であることを指定します。- "HTTPS" は、使用するスキームが https:// であることを指定します。

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

IntOrString

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

containerPort

integer

Pod の IP アドレスで公開するポートの数。これは有効なポート番号である必要があります、0<x<65536。

hostIP

string

外部ポートをバインドするホスト IP。

hostPort

integer

ホストで公開するポートの数。指定する場合、これは有効なポート番号、0<x<65536 である必要があります。HostNetwork が指定されている場合、これは ContainerPort と一致する必要があります。ほとんどのコンテナーはこれを必要としません。

name

string

指定する場合、これは IANA_SVC_NAME であり、Pod 内で一意である必要があります。Pod 内の名前付きポートにはそれぞれ一意の名前を付ける必要があります。サービスが参照できるポートの名前。

protocol

string

ポートのプロトコル。UDP、TCP、または SCTP である必要があります。デフォルトは "TCP" です。

使用可能な列挙値: - "SCTP" は SCTP プロトコル、"TCP" は TCP プロトコル、"UDP" は UDP プロトコルです。

exec

object

ExecAction は、"run in container" アクションを記述します。

failureThreshold

integer

正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。

grpc

object

GRPC は、GRPC ポートに関連するアクションを指定します。

httpGet

object

HTTPGetAction は、HTTP GET リクエストに基づくアクションを記述します。

initialDelaySeconds

integer

コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

integer

プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。

successThreshold

integer

失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。

tcpSocket

object

TCPSocketAction は、ソケットを開くことに基づくアクションを記述します

terminationGracePeriodSeconds

integer

プローブの障害時に Pod が正常に終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。

timeoutSeconds

integer

プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

port

integer

gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。

service

string

Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。

これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

IntOrString

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

使用可能な列挙値：- "HTTP" は、使用するスキームが http:// - https であることを指定します。- "HTTPS" は、使用するスキームが https:// であることを指定します。

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

IntOrString

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

resourceName

string

このリソースサイズ変更ポリシーが適用されるリソースの名前。対応している値は、cpu、memory です。

restartPolicy

string

指定されたリソースのサイズが変更されたときに適用する再起動ポリシー。指定しない場合、デフォルトの NotRequired が設定されます。

claims

array

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは不変です。これはコンテナーにのみ設定できます。

claims[]

object

ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。

limits

object (Quantity)

limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

requests

object (Quantity)

requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

name

string

name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。

allowPrivilegeEscalation

boolean

AllowPrivilegeEscalation は、プロセスがその親プロセスよりも多くの特権を取得できるかどうかを制御します。このブール値は、no_new_privs フラグがコンテナープロセスに設定されるかどうかを直接制御します。コンテナーが 1) 特権で実行されており、CAP_SYS_ADMIN が割り当てられている場合、2) AllowPrivilegeEscalation は常に true です。spec.os.name が windows の場合は、このフィールドは設定できないことに注意してください。

capabilities

object

実行中のコンテナーに POSIX 機能を追加および削除します。

privileged

boolean

コンテナーを特権モードで実行します。特権コンテナー内のプロセスは、基本的にホスト上の root と同等です。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

procMount

string

procMount は、コンテナーに使用する proc マウントのタイプを示します。デフォルトは DefaultProcMount で、読み取り専用パスとマスクされたパスにコンテナーランタイムのデフォルトを使用します。これには、ProcMountType 機能フラグを有効にする必要があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

使用可能な列挙値: - "Default" は、/proc の読み取り専用およびマスクされたパスのコンテナーランタイムのデフォルトを使用します。ほとんどのコンテナーランタイムは、特殊なデバイスや情報が偶発的にセキュリティーのリスクに晒されることを回避するために、/proc 内の特定のパスをマスクします。- "Unmasked" は、コンテナーランタイムのデフォルトのマスキング動作をバイパスし、新しく作成された/proc (コンテナー) が変更されずにそのまま維持されるようにします。

readOnlyRootFilesystem

boolean

このコンテナーに読み取り専用のルートファイルシステムがあるかどうか。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

runAsGroup

integer

コンテナープロセスのエントリーポイントを実行するための GID。設定されていない場合は、実行時のデフォルトを使用します。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

runAsNonRoot

boolean

コンテナーが root 以外のユーザーとして実行される必要があることを示します。true の場合、Kubelet は実行時にイメージを検証して、イメージが UID 0(ルート) として実行されないことを確認し、実行される場合はコンテナーの開始に失敗します。未設定または false の場合、そのような検証は実行されません。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

runAsUser

integer

コンテナープロセスのエントリーポイントを実行するための UID。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

seLinuxOptions

object

SELinuxOptions は、コンテナーに適用されるラベルです。

seccompProfile

object

SeccompProfile は、Pod/コンテナーの seccomp プロファイル設定を定義します。設定できるプロファイルソースは 1 つだけです。

windowsOptions

object

WindowsSecurityContextOptions には、Windows 固有のオプションおよび認証情報が含まれています。

add

array (string)

追加された機能

drop

array (string)

削除された機能

level

string

Level は、コンテナーに適用される SELinux レベルのラベルです。

role

string

Role は、コンテナーに適用される SELinux ロールラベルです。

type

string

Type は、コンテナーに適用される SELinux タイプのラベルです。

user

string

User は、コンテナーに適用される SELinux ユーザーラベルです。

localhostProfile

string

localhostProfile は、ノード上のファイルで定義されたプロファイルを使用する必要があることを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。kubelet の設定済みの seccomp プロファイルの場所を基準にして、降順のパスである必要があります。タイプが "Localhost" の場合にのみ設定する必要があります。

type

string

type は、適用される seccomp プロファイルの種類を示します。有効なオプションは以下のとおりです。

Localhost - ノード上のファイルで定義されたプロファイルを使用する必要があります。RuntimeDefault- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。

使用可能な列挙値: - "Localhost" は、ノード上のファイルで定義されたプロファイルを使用する必要があることを示します。<kubelet-root-dir>/seccomp を基準としたファイルの相対的な場所。- "RuntimeDefault" はデフォルトのコンテナーランタイム seccomp プロファイルを表します。- "Unconfined" は seccomp プロファイルが適用されていないことを示します (別名、unconfined)。

gmsaCredentialSpec

string

GMSACredentialSpec は、GMSA アドミッション Webhook (https://github.com/kubernetes-sigs/windows-gmsa) が GMSACredentialSpecName フィールドで指定された GMSA クレデンシャル仕様のコンテンツをインライン化する場所です。

gmsaCredentialSpecName

string

GMSACredentialSpecName は、使用する GMSA 認証情報仕様の名前です。

hostProcess

boolean

hostProcess は、コンテナーを 'Host Process' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。

runAsUserName

string

コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

exec

object

ExecAction は、"run in container" アクションを記述します。

failureThreshold

integer

正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。

grpc

object

GRPC は、GRPC ポートに関連するアクションを指定します。

httpGet

object

HTTPGetAction は、HTTP GET リクエストに基づくアクションを記述します。

initialDelaySeconds

integer

コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

integer

プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。

successThreshold

integer

失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。

tcpSocket

object

TCPSocketAction は、ソケットを開くことに基づくアクションを記述します

terminationGracePeriodSeconds

integer

プローブの障害時に Pod が正常に終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。

timeoutSeconds

integer

プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

port

integer

gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。

service

string

Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。

これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

IntOrString

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

使用可能な列挙値：- "HTTP" は、使用するスキームが http:// - https であることを指定します。- "HTTPS" は、使用するスキームが https:// であることを指定します。

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

IntOrString

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

devicePath

string

devicePath は、デバイスがマップされるコンテナー内のパスです。

name

string

name は、Pod 内の persistentVolumeClaim の名前と一致する必要があります

mountPath

string

ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。

mountPropagation

string

mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。

使用可能な列挙値: - "Bidirectional" は、コンテナー内のボリュームがホストまたは他のコンテナーから新しいマウントを受け取り、そのボリューム自体のマウントがコンテナーからホストまたは他のコンテナーに伝播されることを意味します。このモードは、ボリューム内のすべてのマウント (Linux 用語では "rshared") に再帰的に適用されることに注意してください。- "HostToContainer" はコンテナー内のボリュームがホストまたは他のコンテナーから新しいマウントを受け取りますが、コンテナー内にマウントされたファイルシステムがホストまたは他のコンテナーに伝播されないことを意味します。このモードは、ボリューム内のすべてのマウント (Linux 用語では "rslave") に再帰的に適用されることに注意してください。- "None" は、コンテナー内のボリュームがホストまたは他のコンテナーから新しいマウントを受け取らず、コンテナー内にマウントされたファイルシステムがホストまたは他のコンテナーに伝播されないことを意味します。このモードは、Linux の用語の "private" に対応することに注意してください。

name

string

ボリュームの名前に一致する必要があります。

readOnly

boolean

true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。

subPath

string

コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。

subPathExpr

string

コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。

nameservers

array (string)

DNS ネームサーバーの IP アドレスのリスト。これは、DNSPolicy から生成されたベースネームサーバーに追加されます。重複したネームサーバーは削除されます。

options

array

DNS リゾルバーオプションのリスト。これは、DNSPolicy から生成された基本オプションとマージされます。重複したエントリーは削除されます。オプションで指定された解決オプションは、ベース DNS ポリシーに表示されるものをオーバーライドします。

options[]

object

PodDNSConfigOption は、Pod の DNS リゾルバーオプションを定義します。

searches

array (string)

ホスト名ルックアップ用の DNS 検索ドメインのリスト。これは、DNSPolicy から生成された基本検索パスに追加されます。重複する検索パスは削除されます。

name

string

必須。

value

string

args

array (string)

エントリーポイントへの引数。このプロパティが指定されていない場合は、イメージの CMD が使用されます。変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。これを更新することはできません。詳細: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

command

array (string)

エントリーポイント配列。シェル内では実行されません。これが指定されていない場合は、イメージの ENTRYPOINT が使用されます。変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。これを更新することはできません。詳細: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

env

array

コンテナーに設定する環境変数のリスト。これを更新することはできません。

env[]

object

EnvVar は、コンテナーに存在する環境変数を表します。

envFrom

array

コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これを更新することはできません。

envFrom[]

object

EnvFromSource は、一連の ConfigMap のソースを表します

image

string

コンテナーイメージ名詳細: https://kubernetes.io/docs/concepts/containers/images

imagePullPolicy

string

イメージプルポリシーAlways、Never、IfNotPresent のいずれか。デフォルトは、:latest タグが指定されている場合は常に、それ以外の場合は IfNotPresent です。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/containers/images#updating-images

使用可能な列挙値: - "Always" は kubelet が常に最新イメージのプルを試行することを意味します。プルに失敗するとコンテナーで問題が発生します。- "IfNotPresent" は、イメージがディスクに存在しない場合に kubelet がプルすることを意味します。イメージが存在せず、プルに失敗すると、コンテナーに問題が発生します。- "Never" は kubelet がイメージを取得せず、ローカルイメージのみを使用することを意味します。イメージが存在しない場合、コンテナーは失敗します。

lifecycle

object

ライフサイクルは、コンテナーのライフサイクルイベントに対応して管理システムが実行する必要のあるアクションを表します。PostStart および PreStop ライフサイクルハンドラーの場合、コンテナープロセスが失敗しない限り、アクションが完了するまでコンテナー管理がブロックされます。失敗した場合、ハンドラーは中止されます。

livenessProbe

object

プローブは、コンテナーが稼働しているか、トラフィックを受け取る準備ができているかどうかを判断するために、コンテナーに対して実行されるヘルスチェックを記述します。

name

string

DNS_LABEL として指定されたエフェメラルコンテナーの名前。この名前は、すべてのコンテナー、init コンテナー、およびエフェメラルコンテナーの中で一意である必要があります。

ports

array

エフェメラルコンテナーのポートは許可されていません。

ports[]

object

ContainerPort は、単一のコンテナー内のネットワークポートを表します。

readinessProbe

object

プローブは、コンテナーが稼働しているか、トラフィックを受け取る準備ができているかどうかを判断するために、コンテナーに対して実行されるヘルスチェックを記述します。

resizePolicy

array

コンテナーのリソースサイズ変更ポリシー。

resizePolicy[]

object

ContainerResizePolicy は、コンテナーのリソースサイズ変更ポリシーを表します。

resources

object

ResourceRequirements は、コンピュートリソースの要件を説明します。

securityContext

object

SecurityContext は、コンテナーに適用されるセキュリティー設定を保持します。一部のフィールドは、SecurityContext と PodSecurityContext の両方に存在します。両方が設定されている場合は、SecurityContext の値が優先されます。

startupProbe

object

プローブは、コンテナーが稼働しているか、トラフィックを受け取る準備ができているかどうかを判断するために、コンテナーに対して実行されるヘルスチェックを記述します。

stdin

boolean

このコンテナーがコンテナーランタイムで stdin にバッファーを割り当てる必要があるかどうか。これが設定されていない場合、コンテナー内の stdin からの読み取りは常に EOF になります。デフォルトは false です。

stdinOnce

boolean

コンテナーランタイムが、単一の接続によって開かれた後に stdin チャネルを閉じる必要があるかどうか。stdin が true の場合、stdin ストリームは複数の接続セッションにわたって開いたままになります。stdinOnce が true に設定されている場合、stdin はコンテナーの起動時に開かれ、最初のクライアントが stdin に接続するまで空になり、クライアントが切断されるまで開いたままでデータを受け入れます。切断されると、stdin は閉じられ、コンテナーが再起動されるまで閉じられたままになります。。このフラグが false の場合、stdin から読み取るコンテナープロセスは EOF を受信しません。デフォルトは false です。

targetContainerName

string

設定されている場合、このエフェメラルコンテナーがターゲットとする PodSpec からのコンテナーの名前。エフェメラルコンテナーは、このコンテナーの namespace (IPC、PID など) で実行されます。設定されていない場合、エフェメラルコンテナーは Pod 仕様で設定された namespace を使用します。

コンテナーランタイムは、この機能のサポートを実装する必要があります。ランタイムが namespace ターゲットをサポートしていない場合、このフィールドの設定結果は定義されません。

terminationMessagePath

string

オプション: コンテナーの終了メッセージが書き込まれるファイルがコンテナーのファイルシステムにマウントされるパス。書き込まれるメッセージは、アサーション失敗メッセージなどの簡単な最終ステータスを目的としています。4096 バイトを超える場合、ノードによって切り捨てられます。すべてのコンテナーの合計メッセージ長は 12kb に制限されます。デフォルトは/dev/termination-log です。これを更新することはできません。

terminationMessagePolicy

string

終了メッセージの入力方法を示します。ファイルは、terminationMessagePath の内容を使用して、成功と失敗の両方でコンテナーステータスメッセージを入力します。終了メッセージファイルが空で、コンテナーがエラーで終了した場合、FallbackToLogsOnError はコンテナーログ出力の最後のチャンクを使用します。ログ出力は、2048 バイトまたは 80 行のいずれか小さい方に制限されます。デフォルトは File です。これを更新することはできません。

使用可能な列挙値: - "FallbackToLogsOnError" は、コンテナーがエラーで終了し、terminationMessagePath に何も含まれていない場合に、コンテナーステータスメッセージのコンテナーログの最新の内容を読み取ります。- "File" はデフォルトの動作で、コンテナーが終了するときにコンテナーのステータスメッセージをコンテナーの terminationMessagePath の内容に設定します。

tty

boolean

このコンテナーがそれ自体に TTY を割り当てる必要があるかどうかには、'stdin' が true である必要もあります。デフォルトは false です。

volumeDevices

array

volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。

volumeDevices[]

object

volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。

volumeMounts

array

コンテナーのファイルシステムにマウントする Pod ボリューム。エフェメラルコンテナーでは、サブパスをマウントできません。これを更新することはできません。

volumeMounts[]

object

VolumeMount は、コンテナー内でのボリュームのマウントを説明します。

workingDir

string

コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これを更新することはできません。

name

string

環境変数の名前。C_IDENTIFIER でなければなりません。

value

string

変数参照 $(VAR_NAME) は、コンテナー内で以前に定義された環境変数と任意のサービス環境変数を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。デフォルトは "" です。

valueFrom

object

EnvVarSource は、EnvVar の値のソースを表します。

configMapKeyRef

object

ConfigMap からキーを選択します。

fieldRef

object

ObjectFieldSelector は、オブジェクトの APIVersioned フィールドを選択します。

resourceFieldRef

object

ResourceFieldSelector は、コンテナーリソース (CPU、メモリー) とその出力形式を表します。

secretKeyRef

object

SecretKeySelector は、シークレットのキーを選択します。

key

string

選択するキー。

name

string

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

optional

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

apiVersion

string

FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。

fieldPath

string

指定された API バージョンで選択するフィールドのパス。

containerName

string

コンテナー名: ボリュームには必須、env 変数にはオプション

divisor

quantity

公開されたリソースの出力形式を指定します。デフォルトは "1" です。

resource

string

必須: 選択するリソース

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

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

optional

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

configMapRef

object

ConfigMapEnvSource は、環境変数に入力する ConfigMap を選択します。

ターゲットの ConfigMap のデータフィールドの内容は、キーと値のペアを環境変数として表します。

prefix

string

ConfigMap の各キーの前に追加するオプションの識別子。C_IDENTIFIER でなければなりません。

secretRef

object

SecretEnvSource は、環境変数に入力するシークレットを選択します。

ターゲットシークレットのデータフィールドの内容は、キーと値のペアを環境変数として表します。

name

string

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

optional

boolean

ConfigMap を定義する必要があるかどうかを指定します

name

string

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

optional

boolean

シークレットを定義する必要があるかどうかを指定します

postStart

object

LifecycleHandler は、ライフサイクルフックで実行する必要がある特定のアクションを定義します。TCPSocket を除くフィールドのうち 1 つだけを指定する必要があります。

preStop

object

LifecycleHandler は、ライフサイクルフックで実行する必要がある特定のアクションを定義します。TCPSocket を除くフィールドのうち 1 つだけを指定する必要があります。

exec

object

ExecAction は、"run in container" アクションを記述します。

httpGet

object

HTTPGetAction は、HTTP GET リクエストに基づくアクションを記述します。