ストレージ API

attachRequired

boolean

attachRequired は、この CSI ボリュームドライバーにアタッチ操作が必要であることを示し (CSI ControllerPublishVolume () メソッドを実装しているため)、Kubernetes アタッチデタッチコントローラーは、volumeattachment ステータスをチェックし、ボリュームがアタッチされるまで待機してからに進む前に、アタッチデタッチコントローラーを呼び出す必要があります。取り付け。CSI 外部アタッチメントは CSI ボリュームドライバーと調整し、接続操作が完了すると volumeattachment ステータスを更新します。CSIDriverRegistry 機能ゲートが有効で、値が false に指定されている場合、接続操作はスキップされます。それ以外の場合は、アタッチ操作が呼び出されます。

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

fsGroupPolicy

string

fsGroupPolicy は、基になるボリュームがマウント前のボリュームの所有権と権限の変更をサポートするかどうかを定義します。詳細は、特定の FSGroupPolicy 値を参照してください。

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

デフォルトは ReadWriteOnceWithFSType です。これにより、各ボリュームが調べられ、Kubernetes がボリュームの所有権および権限を変更する必要があるかどうかが判断されます。デフォルトのポリシーでは、定義された fsGroup は、fstype が定義されていて、ボリュームのアクセスモードに ReadWriteOnce が含まれている場合にのみ適用されます。

podInfoOnMount

boolean

true に設定すると、podInfoOnMount は、この CSI ボリュームドライバーがマウント操作中に追加の Pod 情報 (podName、podUID など) を必要とすることを示します。false に設定すると、Pod 情報はマウント時に渡されません。デフォルトは false です。

CSI ドライバーは、ドライバーデプロイメントの一部として podInfoOnMount を指定します。true の場合、Kubelet は CSI NodePublishVolume () 呼び出しで VolumeContext として Pod 情報を渡します。CSI ドライバーは、VolumeContext として渡された情報の解析および検証を担当します。

podInfoOnMount が true に設定されている場合は、次の VolumeConext が渡されます。このリストは大きくなる可能性がありますが、接頭辞が使用されます。"csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": ボリュームが CSIVolumeSource によって定義されたエフェメラルインラインボリュームの場合は "true"、それ以外の場合は "false" です。

"csi.storage.k8s.io/ephemeral" は Kubernetes1.16 の新機能です。これは、"Persistent" および "Ephemeral" の両方の VolumeLifecycleMode をサポートするドライバーにのみ必要です。他のドライバーは、Pod 情報を無効のままにするか、このフィールドを無視することができます。Kubernetes 1.15 はこのフィールドをサポートしていないため、ドライバーはそのようなクラスターにデプロイされた場合に 1 つのモードしかサポートできず、デプロイメントによって、たとえばドライバーのコマンドラインパラメーターを介してどのモードであるかが決定されます。

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

requiresRepublish

boolean

requiresRepublish は、CSI ドライバーが、マウントされたボリュームで発生する可能性のある変更を反映するために NodePublishVolume が定期的に呼び出されることを望んでいることを示します。このフィールドのデフォルトは false です。

注: 最初の NodePublishVolume 呼び出しが成功した後、NodePublishVolume への後続の呼び出しは、ボリュームの内容のみを更新する必要があります。新しいマウントポイントは、実行中のコンテナーには表示されません。

seLinuxMount

boolean

seLinuxMount は、CSI ドライバーが "-o context" マウントオプションをサポートするかどうかを指定します。

"true" の場合、CSI ドライバーは、この CSI ドライバーが提供するすべてのボリュームを、異なる -o context オプションを使用して個別にマウントできることを保証する必要があります。これは、ブロックデバイス上のファイルシステムまたは独立した共有ボリュームとしてボリュームを提供するストレージバックエンドでは一般的です。Kubernetes は、SELinux コンテキストを明示的に設定した Pod で使用される ReadWriteOncePod ボリュームをマウントするときに、"-o context=xyz" マウントオプションを指定して NodeStage/NodePublish を呼び出します。今後は、他のボリューム AccessModes に拡張される可能性があります。いずれの場合も、Kubernetes は、ボリュームが単一の SELinux コンテキストでのみマウントされるようにします。

"false" の場合、Kubernetes は特別な SELinux マウントオプションをドライバーに渡しません。これは、サイズの大きい共有ファイルシステムのサブディレクトリーを表すボリュームでは一般的です。

デフォルトは "false" です。

storageCapacity

boolean

true に設定されている場合、storageCapacity は、容量情報を使用して CSIStorageCapacity オブジェクトを作成することにより、CSI ボリュームドライバーが Pod スケジューリングでドライバーデプロイメントが報告するストレージ容量を考慮することを望んでいることを示します。

ドライバーをデプロイすると、チェックをすぐに有効にできます。その場合、遅延バインディングを使用した新しいボリュームのプロビジョニングは、ドライバーのデプロイメントで適切な CSIStorageCapacity オブジェクトが公開されるまで一時停止します。

または、フィールドを unset または false にしてドライバーをデプロイし、後でストレージ容量情報が公開されたときにドライバーを反転させることもできます。

このフィールドは Kubernetes ⇐ 1.22 では不変でしたが、現在は変更可能です。

tokenRequests

array

tokenRequests は、CSI ドライバーが必要な認証を行うためにボリュームをマウントしている Pod のサービスアカウントトークンを必要としていることを示します。Kubelet は、CSI NodePublishVolume 呼び出しで VolumeContext のトークンを渡します。CSI ドライバーは、次の VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": { "<audience>": { "token": <token>, "expirationTimestamp": <expiration timestamp in RFC3339>, }, …​ } を解析して検証する必要があります。

注: 各 TokenRequest のオーディエンスは異なる必要があり、最大で 1 つのトークンが空の文字列です。有効期限後に新しいトークンを受け取るには、RequiresRepublish を使用して NodePublishVolume を定期的にトリガーできます。

tokenRequests[]

object

TokenRequest には、サービスアカウントトークンのパラメーターが含まれています。

volumeLifecycleModes

array (string)

volumeLifecycleModes は、この CSI ボリュームドライバーがサポートするボリュームの種類を定義します。リストが空の場合のデフォルトは "Persistent" です。これは、CSI 仕様で定義され、通常の PV/PVC メカニズムを介して Kubernetes に実装される使用法です。

もう 1 つのモードは "Ephemeral" です。このモードでは、ボリュームは CSIVolumeSource を使用して Pod 仕様内でインラインで定義され、そのライフサイクルはその Pod のライフサイクルに関連付けられます。ドライバーは、そのようなボリュームに対して NodePublishVolume 呼び出しを取得するだけなので、これを認識している必要があります。

このモードの実装の詳細は、https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html を参照してください。ドライバーはこれらのモードの 1 つ以上をサポートでき、将来さらにモードが追加される可能性があります。

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

audience

string

audience は、"TokenRequestSpec" のトークンの対象オーディエンスです。デフォルトでは、kube apiserver のオーディエンスになります。

expirationSeconds

integer

expirationSeconds は、"TokenRequestSpec" 内のトークンの有効期間です。"TokenRequestSpec" の "ExpirationSeconds" と同じデフォルト値があります。

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

CSIDriverList スキーマ

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

CSIDriver スキーマ

200 - OK

CSIDriver スキーマ

201 - Created

CSIDriver スキーマ

202 - Accepted

CSIDriver スキーマ

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

CSIDriver の名前

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

CSIDriver スキーマ

202 - Accepted

CSIDriver スキーマ

401 - Unauthorized

空白

200 - OK

CSIDriver スキーマ

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

CSIDriver スキーマ

201 - Created

CSIDriver スキーマ

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

CSIDriver スキーマ

200 - OK

CSIDriver スキーマ

201 - Created

CSIDriver スキーマ

401 - Unauthorized

空白

name

string

CSIDriver の名前

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

空白

drivers

array

drivers は、ノードに存在するすべての CSI ドライバーの情報のリストです。リスト内のすべてのドライバーがアンインストールされると、これは空になる可能性があります。

drivers[]

object

CSINodeDriver は、ノードにインストールされている 1 つの CSI ドライバーの仕様に関する情報を保持します。

allocatable

object

VolumeNodeResources は、ボリュームのスケジューリングのためのリソース制限のセットです。

name

string

name は、このオブジェクトが参照する CSI ドライバーの名前を表します。これは、そのドライバーの CSI GetPluginName() 呼び出しによって返される名前と同じである必要があります。

nodeID

string

ドライバーの観点から見たノードの nodeID。このフィールドにより、Kubernetes はノードの同じ命名法を共有しないストレージシステムと通信できるようになります。たとえば、Kubernetes は特定のノードを "node1" と呼びますが、ストレージシステムは同じノードを "nodeA" と呼びます。Kubernetes がストレージシステムにコマンドを発行してボリュームを特定のノードに接続する場合は、このフィールドを使用して、ストレージシステムが理解できる ID (たとえば、"node1" ではなく "nodeA") を使用してノード名を参照できます。このフィールドは必須です。

topologyKeys

array (string)

topologyKeys は、ドライバーでサポートされているキーのリストです。ドライバーがクラスターで初期化されると、ドライバーが理解できるトポロジーキーのセットが提供されます (例: "company.com/zone"、"company.com/region")。ドライバーがノードで初期化されると、同じトポロジーキーと値が提供されます。Kubelet は、これらのトポロジーキーを独自のノードオブジェクトのラベルとして公開します。Kubernetes がトポロジー対応プロビジョニングを行う場合は、このリストを使用して、ノードオブジェクトから取得してドライバーに返す必要のあるラベルを決定できます。異なるノードが異なるトポロジーキーを使用する可能性があります。ドライバーがトポロジーをサポートしていない場合、これは空になる可能性があります。

count

integer

count は、CSI ドライバーによって管理され、ノード上で使用できる一意のボリュームの最大数を示します。ノードに接続およびマウントされているボリュームは、2 回ではなく、1 回使用されたと見なされます。同じノード上の複数の Pod 間で共有される一意のボリュームにも同じルールが適用されます。このフィールドが指定されていない場合、このノードでサポートされるボリュームの数に制限はありません。

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

CSINodeList スキーマ

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

CSINode スキーマ

200 - OK

CSINode スキーマ

201 - Created

CSINode スキーマ

202 - Accepted

CSINode スキーマ

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

CSINode の名前

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

CSINode スキーマ

202 - Accepted

CSINode スキーマ

401 - Unauthorized

空白

200 - OK

CSINode スキーマ

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

CSINode スキーマ

201 - Created

CSINode スキーマ

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

CSINode スキーマ

200 - OK

CSINode スキーマ

201 - Created

CSINode スキーマ

401 - Unauthorized

空白

name

string

CSINode の名前

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

空白

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

CSIStorageCapacityList スキーマ

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

空白

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

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

CSIStorageCapacityList スキーマ

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

CSIStorageCapacity スキーマ

200 - OK

CSIStorageCapacity スキーマ

201 - Created

CSIStorageCapacity スキーマ

202 - Accepted

CSIStorageCapacity スキーマ

401 - Unauthorized

空白

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

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

CSIStorageCapacity の名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

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

CSIStorageCapacity スキーマ

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

CSIStorageCapacity スキーマ

201 - Created

CSIStorageCapacity スキーマ

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

CSIStorageCapacity スキーマ

200 - OK

CSIStorageCapacity スキーマ

201 - Created

CSIStorageCapacity スキーマ

401 - Unauthorized

空白

name

string

CSIStorageCapacity の名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

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

空白

accessModes

array (string)

accessModes には、ボリュームのマウント方法がすべて含まれています。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes

awsElasticBlockStore

object

AWS の永続ディスクリソースを表します。

AWS EBS ディスクは、コンテナーにマウントする前に存在している必要があります。また、ディスクは kubelet と同じ AWS ゾーンにある必要があります。AWS EBS ディスクは、読み取り/書き込みとして 1 回だけマウントできます。AWS EBS ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

azureDisk

object

AzureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。

azureFile

object

AzureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。

capacity

object (Quantity)

capacity は、永続ボリュームのリソースおよび容量の説明です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

cephfs

object

Pod の存続期間中持続する Ceph ファイルシステムマウントを表します。Cephfs ボリュームは所有権管理または SELinux の再ラベル付けをサポートしていません。

cinder

object

Openstack の cinder ボリュームリソースを表します。コンテナーにマウントする前に、Cinder ボリュームが存在している必要があります。ボリュームも、kubelet と同じ領域にある必要があります。Cinder ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

claimRef

object

ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。

csi

object

外部 CSI ボリュームドライバーによって管理されるストレージを表します (ベータ機能)

fc

object

ファイバーチャネルボリュームを表します。ファイバーチャネルボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ファイバーチャネルボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

flexVolume

object

FlexPersistentVolumeSource は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用の永続ボリュームリソースを表します。

flocker

object

Flocker エージェントによってマウントされた Flocker ボリュームを表します。datasetName および datasetUUID の 1 つだけを設定する必要があります。Flocker ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

gcePersistentDisk

object

Google Compute Engine の永続ディスクリソースを表します。

GCE PD は、コンテナーにマウントする前に存在している必要があります。ディスクは、kubelet と同じ GCE プロジェクトおよびゾーンにある必要もあります。GCE PD は、読み取り/書き込みとして 1 回のみマウントできます。また、読み取り専用としては何度でもマウントできます。GCE PD は、所有権管理および SELinux の再ラベル付けをサポートします。

glusterfs

object

Pod の存続期間中続く Glusterfs マウントを表します。Glusterfs ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

hostPath

object

Pod にマップされたホストパスを表します。ホストパスボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

iscsi

object

ISCSIPersistentVolumeSource は、ISCSI ディスクを表します。ISCSI ボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ISCSI ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

local

object

Local は、ノードアフィニティーを備えた直接接続ストレージを表します (ベータ機能)

mountOptions

array (string)

mountOptions はマウントオプションのリストです (例: ["ro", "soft"])。検証されていません - 無効な場合、マウントは失敗します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options

nfs

object

Pod の存続期間中続く NFS マウントを表します。NFS ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

nodeAffinity

object

VolumeNodeAffinity は、このボリュームにアクセスできるノードを制限する制約を定義します。

persistentVolumeReclaimPolicy

string

persistentVolumeReclaimPolicy は、永続ボリュームの要求が解除されたときに永続ボリュームに何が起こるかを定義します。有効なオプションは Retain (手動で作成された PersistentVolumes のデフォルト)、Delete (動的にプロビジョニングされる PersistentVolumes のデフォルト)、および Recycle (非推奨) です。Recycle は、この PersistentVolume の基礎となるボリュームプラグインでサポートされる必要があります。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming

使用可能な列挙値: - "Delete" はボリュームが要求から解放されたときに Kubernetes から削除されることを意味します。ボリュームプラグインは削除をサポートしている必要があります。-"Recycle" は、ボリュームが要求から解放されたときに、バインドされていない永続ボリュームのプールにリサイクルされて戻されることを意味します。ボリュームプラグインは、Recycling をサポートする必要があります。- "Retain" は、管理者が手動で回収するためにボリュームが現在のフェーズ (Released) に残ることを意味します。デフォルトのポリシーは Retain です。

photonPersistentDisk

object

Photon Controller 永続ディスクリソースを表します。

portworxVolume

object

PortworxVolumeSource は、Portworx ボリュームリソースを表します。

quobyte

object

Pod の存続期間中続く Quobyte マウントを表します。Quobyte ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

rbd

object

Pod の存続時間中続く Rados Block Device マウントを表します。RBD ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

scaleIO

object

ScaleIOPersistentVolumeSource は、永続的な ScaleIO ボリュームを表します

storageClassName

string

storageClassName は、この永続ボリュームが属する StorageClass の名前です。空の値は、このボリュームが StorageClass に属していないことを意味します。

storageos

object

StorageOS 永続ボリュームリソースを表します。

volumeMode

string

volumeMode は、ボリュームをフォーマットされたファイルシステムで使用するか、または raw ブロック状態のままにするかを定義します。Filesystem の値は、spec に含まれていない場合に暗示されます。

使用可能な列挙値: - "Block" は、ボリュームがファイルシステムでフォーマットされず、生のブロックデバイスのままになります。- "Filesystem" は、ボリュームがファイルシステムでフォーマットされる、またはファイルシステムでフォーマットされます。

vsphereVolume

object

vSphere ボリュームリソースを表します。

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

partition

integer

partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。

readOnly

boolean

readOnly 値 true は、VolumeMounts の readOnly 設定を強制的に実行します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

volumeID

string

volumeID は、AWS の永続ディスクリソースの一意の ID です (Amazon EBS ボリューム)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

cachingMode

string

cachingMode はホストキャッシュモードです (None, Read Only, Read Write)。

使用可能な列挙値: - "None" - "ReadOnly" - "ReadWrite"

diskName

string

diskName は、Blob ストレージ内のデータディスクの名前です。

diskURI

string

diskURI は、BLOB ストレージ内のデータディスクの URI です

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

kind

string

kind での期待値は、Shared (ストレージアカウントごとに複数のブロブディスク)、Dedicated (ストレージアカウントごとにブロブ 1 つ)、Managed (Azure の管理データディスク (管理対象のアベイラビリティーセットのみ)) です。デフォルトは Shared です。

使用可能な列挙値:- "Dedicated" - "Managed" - "Shared"

readOnly

boolean

readOnly。デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretName

string

secretName は、Azure ストレージアカウント名とキーを含むシークレットの名前です。

secretNamespace

string

secretNamespace は、Azure Storage Account Name および Key を含むシークレットの namespace で、デフォルトは Pod と同じです。

shareName

string

shareName は Azure 共有名です。

monitors

array (string)

monitors は必須: Monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

path

string

パスは任意: 完全な Ceph ツリーではなく、マウントされたルートとして使用されます。デフォルトは / です。

readOnly

boolean

readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretFile

string

secretFile は任意: SecretFile はユーザーのキーリングへのパスです。デフォルトは /etc/ceph/user.secret です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretRef

object

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

user

string

user は任意: ユーザーは rados ユーザー名、デフォルトは admin です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

name

string

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

namespace

string

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

fsType

string

マウントする fsType ファイルシステムタイプ。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

readOnly

boolean

readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

secretRef

object

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

volumeID

string

cinder 内のボリュームを識別するために使用される volumeID。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

name

string

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

namespace

string

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

apiVersion

string

参照先の API バージョン。

fieldPath

string

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

kind

string

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

name

string

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

namespace

string

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

resourceVersion

string

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

uid

string

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

controllerExpandSecretRef

object

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

controllerPublishSecretRef

object

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

driver

string

driver は、このボリュームに使用するドライバーの名前です。必須。

fsType

string

マウントする fsType。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。

nodeExpandSecretRef

object

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

nodePublishSecretRef

object

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

nodeStageSecretRef

object

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

readOnly

boolean

ControllerPublishVolumeRequest に渡す readOnly の値。デフォルトは false (読み取り/書き込み) です。

volumeAttributes

object (string)

公開するボリュームの volumeAttributes。

volumeHandle

string

volumeHandle は、CSI ボリュームプラグインの CreateVolume により返される一意のボリューム名であり、後続のすべての呼び出しでボリュームを参照します。必須。

name

string

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

namespace

string

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

name

string

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

namespace

string

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

name

string

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

namespace

string

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

name

string

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

namespace

string

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

name

string

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

namespace

string

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

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

lun

integer

LUN は任意: FC ターゲットの LUN 番号

readOnly

boolean

readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

targetWWNs

array (string)

targetWWNs は任意: FC ターゲットのワールドワイド名 (WWN)

wwids

array (string)

wwids は任意: FC ボリュームのワールドワイド ID(wwids)wwids または targetWWN と lun の組み合わせのいずれかを設定する必要がありますが、両方を同時に設定できません。

driver

string

driver は、このボリュームに使用するドライバーの名前です。

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトのファイルシステムは FlexVolume スクリプトに依存します。

options

object (string)

options は任意: このフィールドには追加のコマンドオプションがあれば保持されます。

readOnly

boolean

readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

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

name

string

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

namespace

string

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

datasetName

string

datasetName はメタデータとして保存されているデータセットの名前です → Flocker のデータセット上の名前は非推奨として扱うようにしてください。

datasetUUID

string

datasetUUID は、データセットの UUID です。これは Flocker データセットの一意の識別子です

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

partition

integer

partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

pdName

string

pdName は、GCE の PD リソースの一意の名前です。GCE でディスクを識別するために使用されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

readOnly

boolean

この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

endpoints

string

endpoints は、Glusterfs トポロジーの詳細を示すエンドポイント名です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

endpointsNamespace

string

endpointsNamespace は、Glusterfs エンドポイントを含む namespace です。このフィールドが空の場合、EndpointNamespace はデフォルトでバインドされた PVC と同じ namespace になります。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

path

string

path は Glusterfs ボリュームパスです。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

readOnly

boolean

この readOnly は、Glusterfs ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

path

string

ホスト上のディレクトリーのパス。パスがシンボリックリンクの場合、実際のパスへのリンクをたどります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

type

string

HostPath ボリュームのデフォルトのタイプは "" です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

使用可能な列挙値: - "" 下位互換性を確保するため、未設定の場合は空のままにします。- "BlockDevice" ブロックデバイスは、指定のパスに配置する必要があります。- "CharDevice" キャラクターデバイスは、指定のパスに配置する必要があります。- "Directory" ディレクトリーは指定のパスに配置する必要があります。- "DirectoryOrCreate" 指定されたパスに何も存在しない場合、空のディレクトリーが必要に応じてファイルモード 0755 で作成され、Kubelet と同じグループと所有権が指定されます。- "File" ファイルは指定のパスに配置する必要があります。- "FileOrCreate" 指定のパスに何も存在しない場合は、必要に応じて空のファイルがファイルモード 0644 で作成され、Kubelet と同じグループと所有権が指定されます。- "Socket" UNIX ソケットは指定のパスに配置する必要があります。

chapAuthDiscovery

boolean

chapAuthDiscovery は、iSCSI 検出 CHAP 認証をサポートするかどうかを定義します。

chapAuthSession

boolean

chapAuthSession は、iSCSI セッション CHAP 認証をサポートするかどうかを定義します。

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#iscsi

initiatorName

string

initiatorName は、カスタムの iSCSI イニシエーター名です。iscsiInterface と同時に initiatorName を指定すると、接続用に新しい iSCSI インターフェイス <target portal>:<volume name> が作成されます。

iqn

string

IQN は、ターゲット iSCSI 修飾名です。

iscsiInterface

string

iscsiInterface は、iSCSI トランスポートを使用するインターフェイス名です。デフォルトは 'default' (tcp) です。

lun

integer

LUN は iSCSI ターゲット Lun 番号です。

portals

array (string)

ポータルは iSCSI ターゲットポータルリストです。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。

readOnly

boolean

この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。

secretRef

object

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

targetPortal

string

targetPortal は iSCSI Target Portal です。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。

name

string

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

namespace

string

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

fsType

string

fsType は、マウントするファイルシステムタイプです。Path がブロックデバイスの場合にのみ適用されます。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルト値は、指定されていないと、ファイルシステムを自動選択します。

path

string

ノード上のボリュームへのフルパス。これは、ディレクトリーまたはブロックデバイス (ディスク、パーティションなど) のいずれかです。

path

string

NFS サーバーがエクスポートしているパス。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

readOnly

boolean

ここで readOnly を指定すると、NFS エクスポートが読み取り専用権限で強制的にマウントされます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

server

string

server は、NFS サーバーのホスト名または IP アドレスです。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

required

object

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

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 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

pdID

string

pdID は、Photon Controller の永続ディスクを識別する ID です。

fsType

string

fSType は、マウントするファイルシステムタイプを表します。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

volumeID

string

volumeID は、Portworx ボリュームを一意に識別します

group

string

アクセスできるボリュームをマップするグループ。デフォルトは no group です。

readOnly

boolean

ここでの readOnly は、Quobyte ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。

registry

string

registry は、host:port ペアの文字列として指定された単一または複数の Quobyte Registry サービスを表し (複数のエントリーはコンマで区切る)、ボリュームの中央レジストリーとして機能します。

tenant

string

動的にプロビジョニングされた Quobyte ボリュームで使用されるバックエンドで指定の Quobyte ボリュームを所有するテナント。値はプラグインにより設定されます。

user

string

アクセスできるボリュームをマップするグループ。デフォルトは serivceaccount user です。

volume

string

volume は、すでに作成されているクオバイトボリュームを名前で参照する文字列です。

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#rbd

image

string

image は rados イメージ名です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

keyring

string

keyring は、RBDUser のキーリングへのパスです。デフォルトは/etc/ceph/keyring です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

monitors

array (string)

monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

pool

string

pool は rados プール名です。デフォルトは rbd です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

readOnly

boolean

この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

secretRef

object

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

user

string

user は rados ユーザー名です。これにより、プール内にイメージを作成できます。デフォルトは admin です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

name

string

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

namespace

string

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

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトは "xfs" です。

gateway

string

gateway は、ScaleIO API ゲートウェイのホストアドレスです。

protectionDomain

string

protectionDomain は、設定されたストレージの ScaleIO 保護ドメインの名前です。

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

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

sslEnabled

boolean

sslEnabled は、ゲートウェイとの SSL 通信を有効/無効にするフラグです。デフォルトは false です

storageMode

string

storageMode は、ボリュームのストレージを ThickProvisioned にするか ThinProvisioned にするかを示します。デフォルトは ThinProvisioned です。

storagePool

string

storagePool は、保護ドメインに関連付けられた ScaleIO ストレージプールです。

system

string

system は、ScaleIO で設定されたストレージシステムの名前です。

volumeName

string

volumeName は、このボリュームソースに関連付けられている、ScaleIO システムですでに作成されているボリュームの名前です。

name

string

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

namespace

string

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

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。

volumeName

string

volumeName は、人間が判読えきる形式の StorageOS ボリュームの名前です。ボリューム名は、ネームスペース内でのみ一意です。

volumeNamespace

string

volumeNamespace は、StorageOS 内のボリュームのスコープを指定します。namespace が指定されていない場合は、Pod の namespace が使用されます。これにより、Kubernetes の名前スコープを StorageOS 内にミラーリングして、より緊密に統合することができます。VolumeName を任意の名前に設定して、デフォルトの動作をオーバーライドします。StorageOS 内で namespace を使用していない場合は、"デフォルト" に設定します。StorageOS 内に事前に存在しない名前空間が作成されます。