ストレージ API
ストレージ API のリファレンスガイド
概要
第1章 ストレージ API
1.1. CSIDriver [storage.k8s.io/v1]
- 説明
- CSIDriver は、クラスターにデプロイされた Container Storage Interface (CSI) ボリュームドライバーに関する情報をキャプチャーします。Kubernetes アタッチデタッチコントローラーは、このオブジェクトを使用して、アタッチが必要かどうかを判断します。Kubelet はこのオブジェクトを使用して、Pod 情報をマウントで渡す必要があるかどうかを判断します。CSIDriver オブジェクトには namespace がありません。
- 型
-
object
1.2. CSINode [storage.k8s.io/v1]
- 説明
- CSINode は、ノードにインストールされているすべての CSI ドライバーに関する情報を保持します。CSI ドライバーは、CSINode オブジェクトを直接作成する必要はありません。node-driver-registrar サイドカーコンテナーを使用している限り、kubelet は、kubelet プラグイン登録の一部として CSI ドライバーの CSINode オブジェクトに自動的にデータを入力します。CSINode の名前はノードと同じです。オブジェクトが欠落している場合は、ノードで使用可能な CSI ドライバーがないか、Kubelet のバージョンが十分に低いためにこのオブジェクトが作成されないことを意味します。CSINode には、対応するノードオブジェクトを指す OwnerReference があります。
- 型
-
object
1.3. CSIStorageCapacity [storage.k8s.io/v1]
- 説明
CSIStorageCapacity は、1 回の CSI GetCapacity 呼び出しの結果を保存します。特定の StorageClass について、これは特定のトポロジーセグメントで使用可能な容量を表します。これは、新しい PersistentVolumes をインスタンス化する場所を検討するときに使用できます。
たとえば、これは次のように表すことができます。- StorageClass "standard" の "1234 GiB" は "topology.kubernetes.io/zone=us-east1" で利用可能 - StorageClass "localssd" の "10 GiB" は "kubernetes.io/hostname=knode-abc123" で利用可能
次の 3 つのケースはすべて、特定の組み合わせで使用可能な容量がないことを意味します。- 適切なトポロジーとストレージクラス名を持つオブジェクトが存在しない - そのようなオブジェクトは存在するが、容量は設定されていない - そのようなオブジェクトは存在するが、容量はゼロである
これらのオブジェクトの作成者は、どちらのアプローチがより適切かを判断できます。
これらは、CSI ドライバーが CSIDriverSpec.StorageCapacity による容量認識スケジューリングを選択するときに、kube-scheduler によって消費されます。スケジューラーは、保留中のボリュームで要求されたサイズと MaximumVolumeSize を比較して、不適切なノードを除外します。MaximumVolumeSize が設定されていない場合は、正確性の低い容量との比較に戻ります。これも設定されていない場合、スケジューラーは容量が不十分であると判断し、他のノードを試行します。
- 型
-
object
1.4. PersistentVolume [v1]
- 説明
- PersistentVolume (PV) は、管理者によってプロビジョニングされたストレージリソースです。これはノードに似ています。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes
- 型
-
object
1.5. PersistentVolumeClaim [v1]
- 説明
- PersistentVolumeClaim は、永続ボリュームに対するユーザーの要求および要求です。
- 型
-
object
1.6. StorageClass [storage.k8s.io/v1]
- 説明
StorageClass は、PersistentVolumes を動的にプロビジョニングできるストレージのクラスのパラメーターを記述します。
StorageClasses は namespace ではありません。etcd に従ったストレージクラスの名前は ObjectMeta.Name にあります。
- 型
-
object
1.7. StorageState [migration.k8s.io/v1alpha1]
- 説明
- 特定のリソースのストレージの状態。
- 型
-
object
1.8. StorageVersionMigration [migration.k8s.io/v1alpha1]
- 説明
- StorageVersionMigration は、保存されたデータの最新のストレージバージョンへの移行を表します。
- 型
-
object
1.9. VolumeAttachment [storage.k8s.io/v1]
- 説明
VolumeAttachment は、指定されたボリュームを指定されたノードにアタッチまたはデタッチする意図をキャプチャーします。
VolumeAttachment オブジェクトには namespace がありません。
- 型
-
object
1.10. VolumeSnapshot [snapshot.storage.k8s.io/v1]
- 説明
- VolumeSnapshot は、永続ボリュームのポイントインタイムスナップショットを作成するか、既存のスナップショットにバインドするためのユーザーの要求です。
- 型
-
object
1.11. VolumeSnapshotClass [snapshot.storage.k8s.io/v1]
- 説明
- VolumeSnapshotClass は、基礎となるストレージシステムがボリュームスナップショットを作成する際に使用するパラメーターを指定します。VolumeSnapshotClass は、VolumeSnapshot オブジェクトの中でその名前を指定することで使用します。VolumeSnapshotClass は名前なしです。
- 型
-
object
1.12. VolumeSnapshotContent [snapshot.storage.k8s.io/v1]
- 説明
- VolumeSnapshotContent は、基盤となるストレージシステム内の実際の "ディスク上" のスナップショットオブジェクトを表します
- 型
-
object
第2章 CSIDriver [storage.k8s.io/v1]
- 説明
- CSIDriver は、クラスターにデプロイされた Container Storage Interface (CSI) ボリュームドライバーに関する情報をキャプチャーします。Kubernetes アタッチデタッチコントローラーは、このオブジェクトを使用して、アタッチが必要かどうかを判断します。Kubelet はこのオブジェクトを使用して、Pod 情報をマウントで渡す必要があるかどうかを判断します。CSIDriver オブジェクトには namespace がありません。
- 型
-
object
- 必須
-
spec
-
2.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。metadata.Name は、このオブジェクトが参照する CSI ドライバーの名前を示します。そのドライバーの CSI GetPluginName() 呼び出しによって返される名前と同じである必要があります。ドライバー名は 63 文字以下で、ダッシュ (-)、ドット (.)、およびその間に英数字を含む英数字 ([a-z0-9A-Z]) で開始および終了する必要があります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| CSIDriverSpec は、CSIDriver の仕様です。 |
2.1.1. .spec
- 説明
- CSIDriverSpec は、CSIDriver の仕様です。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| attachRequired は、この CSI ボリュームドライバーにアタッチ操作が必要であることを示し (CSI ControllerPublishVolume () メソッドを実装しているため)、Kubernetes アタッチデタッチコントローラーは、volumeattachment ステータスをチェックし、ボリュームがアタッチされるまで待機してからに進む前に、アタッチデタッチコントローラーを呼び出す必要があります。取り付け。CSI 外部アタッチメントは CSI ボリュームドライバーと調整し、接続操作が完了すると volumeattachment ステータスを更新します。CSIDriverRegistry 機能ゲートが有効で、値が false に指定されている場合、接続操作はスキップされます。それ以外の場合は、アタッチ操作が呼び出されます。 このフィールドは不変です。 |
|
| fsGroupPolicy は、基になるボリュームがマウント前のボリュームの所有権と権限の変更をサポートするかどうかを定義します。詳細は、特定の FSGroupPolicy 値を参照してください。 このフィールドは不変です。 デフォルトは ReadWriteOnceWithFSType です。これにより、各ボリュームが調べられ、Kubernetes がボリュームの所有権および権限を変更する必要があるかどうかが判断されます。デフォルトのポリシーでは、定義された fsGroup は、fstype が定義されていて、ボリュームのアクセスモードに ReadWriteOnce が含まれている場合にのみ適用されます。 |
|
| true に設定すると、podInfoOnMount は、この CSI ボリュームドライバーがマウント操作中に追加の Pod 情報 (podName、podUID など) を必要とすることを示します。false に設定すると、Pod 情報はマウント時に渡されません。デフォルトは false です。 CSI ドライバーは、ドライバーデプロイメントの一部として podInfoOnMount を指定します。true の場合、Kubelet は CSI NodePublishVolume () 呼び出しで VolumeContext として Pod 情報を渡します。CSI ドライバーは、VolumeContext として渡された情報の解析および検証を担当します。 podInfoOnMount が true に設定されていると、次の VolumeContext が渡されます。このリストは大きくなる可能性がありますが、接頭辞が使用されます。"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 は、CSI ドライバーが、マウントされたボリュームで発生する可能性のある変更を反映するために 注: 最初の NodePublishVolume 呼び出しが成功した後、NodePublishVolume への後続の呼び出しは、ボリュームの内容のみを更新する必要があります。新しいマウントポイントは、実行中のコンテナーには表示されません。 |
|
| seLinuxMount は、CSI ドライバーが "-o context" マウントオプションをサポートするかどうかを指定します。
"true" の場合、CSI ドライバーは、この CSI ドライバーが提供するすべてのボリュームを、異なる "false" の場合、Kubernetes は特別な SELinux マウントオプションをドライバーに渡しません。これは、サイズの大きい共有ファイルシステムのサブディレクトリーを表すボリュームでは一般的です。 デフォルトは "false" です。 |
|
| true に設定されている場合、storageCapacity は、容量情報を使用して CSIStorageCapacity オブジェクトを作成することにより、CSI ボリュームドライバーが Pod スケジューリングでドライバーデプロイメントが報告するストレージ容量を考慮することを望んでいることを示します。 ドライバーをデプロイすると、チェックをすぐに有効にできます。その場合、遅延バインディングを使用した新しいボリュームのプロビジョニングは、ドライバーのデプロイメントで適切な CSIStorageCapacity オブジェクトが公開されるまで一時停止します。 または、フィールドを unset または false にしてドライバーをデプロイし、後でストレージ容量情報が公開されたときにドライバーを反転させることもできます。 このフィールドは Kubernetes ⇐ 1.22 では不変でしたが、現在は変更可能です。 |
|
| 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 を定期的にトリガーできます。 |
|
| TokenRequest には、サービスアカウントトークンのパラメーターが含まれています。 |
|
| volumeLifecycleModes は、この CSI ボリュームドライバーがサポートするボリュームの種類を定義します。リストが空の場合のデフォルトは "Persistent" です。これは、CSI 仕様で定義され、通常の PV/PVC メカニズムを介して Kubernetes に実装される使用法です。 もう 1 つのモードは "Ephemeral" です。このモードでは、ボリュームは CSIVolumeSource を使用して Pod 仕様内でインラインで定義され、そのライフサイクルはその Pod のライフサイクルに関連付けられます。ドライバーは、そのようなボリュームに対して NodePublishVolume 呼び出しを取得するだけなので、これを認識している必要があります。 このモードの実装の詳細は、https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html を参照してください。ドライバーはこれらのモードの 1 つ以上をサポートでき、将来さらにモードが追加される可能性があります。 このフィールドはベータ版です。このフィールドは不変です。 |
2.1.2. .spec.tokenRequests
- 説明
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 を定期的にトリガーできます。
- 型
-
array
2.1.3. .spec.tokenRequests[]
- 説明
- TokenRequest には、サービスアカウントトークンのパラメーターが含まれています。
- 型
-
object
- 必須
-
audience
-
プロパティー | 型 | 説明 |
---|---|---|
|
| audience は、"TokenRequestSpec" のトークンの対象オーディエンスです。デフォルトでは、kube apiserver のオーディエンスになります。 |
|
| expirationSeconds は、"TokenRequestSpec" 内のトークンの有効期間です。"TokenRequestSpec" の "ExpirationSeconds" と同じデフォルト値があります。 |
2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/storage.k8s.io/v1/csidrivers
-
DELETE
: CSIDriver のコレクションを削除する -
GET
: CSIDriver 種類のオブジェクトをリスト表示または監視する -
POST
: CSIDriver を作成する
-
/apis/storage.k8s.io/v1/watch/csidrivers
-
GET
: CSIDriver のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/storage.k8s.io/v1/csidrivers/{name}
-
DELETE
: CSIDriver を削除する -
GET
: 指定された CSIDriver を読み取る -
PATCH
: 指定された CSIDriver を部分的に更新する -
PUT
: 指定された CSIDriver を置き換える
-
/apis/storage.k8s.io/v1/watch/csidrivers/{name}
-
GET
: CSIDriver 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
2.2.1. /apis/storage.k8s.io/v1/csidrivers
- HTTP メソッド
-
DELETE
- 説明
- CSIDriver のコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- CSIDriver 種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- CSIDriver を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
2.2.2. /apis/storage.k8s.io/v1/watch/csidrivers
- HTTP メソッド
-
GET
- 説明
- CSIDriver のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
2.2.3. /apis/storage.k8s.io/v1/csidrivers/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| CSIDriver の名前 |
- HTTP メソッド
-
DELETE
- 説明
- CSIDriver を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された CSIDriver を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された CSIDriver を部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された CSIDriver を置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
2.2.4. /apis/storage.k8s.io/v1/watch/csidrivers/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| CSIDriver の名前 |
- HTTP メソッド
-
GET
- 説明
- CSIDriver 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
第3章 CSINode [storage.k8s.io/v1]
- 説明
- CSINode は、ノードにインストールされているすべての CSI ドライバーに関する情報を保持します。CSI ドライバーは、CSINode オブジェクトを直接作成する必要はありません。node-driver-registrar サイドカーコンテナーを使用している限り、kubelet は、kubelet プラグイン登録の一部として CSI ドライバーの CSINode オブジェクトに自動的にデータを入力します。CSINode の名前はノードと同じです。オブジェクトが欠落している場合は、ノードで使用可能な CSI ドライバーがないか、Kubelet のバージョンが十分に低いためにこのオブジェクトが作成されないことを意味します。CSINode には、対応するノードオブジェクトを指す OwnerReference があります。
- 型
-
object
- 必須
-
spec
-
3.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。metadata.name は Kubernetes ノード名である必要があります。 | |
|
| CSINodeSpec は、ノードにインストールされているすべての CSI ドライバーの仕様に関する情報を保持します |
3.1.1. .spec
- 説明
- CSINodeSpec は、ノードにインストールされているすべての CSI ドライバーの仕様に関する情報を保持します
- 型
-
object
- 必須
-
drivers
-
プロパティー | 型 | 説明 |
---|---|---|
|
| drivers は、ノードに存在するすべての CSI ドライバーの情報のリストです。リスト内のすべてのドライバーがアンインストールされると、これは空になる可能性があります。 |
|
| CSINodeDriver は、ノードにインストールされている 1 つの CSI ドライバーの仕様に関する情報を保持します。 |
3.1.2. .spec.drivers
- 説明
- drivers は、ノードに存在するすべての CSI ドライバーの情報のリストです。リスト内のすべてのドライバーがアンインストールされると、これは空になる可能性があります。
- 型
-
array
3.1.3. .spec.drivers[]
- 説明
- CSINodeDriver は、ノードにインストールされている 1 つの CSI ドライバーの仕様に関する情報を保持します。
- 型
-
object
- 必須
-
name
-
nodeID
-
プロパティー | 型 | 説明 |
---|---|---|
|
| VolumeNodeResources は、ボリュームのスケジューリングのためのリソース制限のセットです。 |
|
| name は、このオブジェクトが参照する CSI ドライバーの名前を表します。これは、そのドライバーの CSI GetPluginName() 呼び出しによって返される名前と同じである必要があります。 |
|
| ドライバーの観点から見たノードの nodeID。このフィールドにより、Kubernetes はノードの同じ命名法を共有しないストレージシステムと通信できるようになります。たとえば、Kubernetes は特定のノードを "node1" と呼びますが、ストレージシステムは同じノードを "nodeA" と呼びます。Kubernetes がストレージシステムにコマンドを発行してボリュームを特定のノードに接続する場合は、このフィールドを使用して、ストレージシステムが理解できる ID (たとえば、"node1" ではなく "nodeA") を使用してノード名を参照できます。このフィールドは必須です。 |
|
| topologyKeys は、ドライバーでサポートされているキーのリストです。ドライバーがクラスターで初期化されると、ドライバーが理解できるトポロジーキーのセットが提供されます (例: "company.com/zone"、"company.com/region")。ドライバーがノードで初期化されると、同じトポロジーキーと値が提供されます。Kubelet は、これらのトポロジーキーを独自のノードオブジェクトのラベルとして公開します。Kubernetes がトポロジー対応プロビジョニングを行う場合は、このリストを使用して、ノードオブジェクトから取得してドライバーに返す必要のあるラベルを決定できます。異なるノードが異なるトポロジーキーを使用する可能性があります。ドライバーがトポロジーをサポートしていない場合、これは空になる可能性があります。 |
3.1.4. .spec.drivers[].allocatable
- 説明
- VolumeNodeResources は、ボリュームのスケジューリングのためのリソース制限のセットです。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| count は、CSI ドライバーによって管理され、ノード上で使用できる一意のボリュームの最大数を示します。ノードに接続およびマウントされているボリュームは、2 回ではなく、1 回使用されたと見なされます。同じノード上の複数の Pod 間で共有される一意のボリュームにも同じルールが適用されます。このフィールドが指定されていない場合、このノードでサポートされるボリュームの数に制限はありません。 |
3.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/storage.k8s.io/v1/csinodes
-
DELETE
: CSINode のコレクションを削除する -
GET
: CSINode 種類のオブジェクトをリスト表示または監視する -
POST
: CSINode を作成する
-
/apis/storage.k8s.io/v1/watch/csinodes
-
GET
: CSINode のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/storage.k8s.io/v1/csinodes/{name}
-
DELETE
: CSINode を削除する -
GET
: 指定された CSINode を読み取る -
PATCH
: 指定された CSINode を部分的に更新します -
PUT
: 指定された CSINode を置き換える
-
/apis/storage.k8s.io/v1/watch/csinodes/{name}
-
GET
: CSINode 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
3.2.1. /apis/storage.k8s.io/v1/csinodes
- HTTP メソッド
-
DELETE
- 説明
- CSINode のコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- CSINode 種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- CSINode を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
3.2.2. /apis/storage.k8s.io/v1/watch/csinodes
- HTTP メソッド
-
GET
- 説明
- CSINode のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
3.2.3. /apis/storage.k8s.io/v1/csinodes/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| CSINode の名前 |
- HTTP メソッド
-
DELETE
- 説明
- CSINode を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された CSINode を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された CSINode を部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された CSINode を置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
3.2.4. /apis/storage.k8s.io/v1/watch/csinodes/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| CSINode の名前 |
- HTTP メソッド
-
GET
- 説明
- CSINode 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
第4章 CSIStorageCapacity [storage.k8s.io/v1]
- 説明
CSIStorageCapacity は、1 回の CSI GetCapacity 呼び出しの結果を保存します。特定の StorageClass について、これは特定のトポロジーセグメントで使用可能な容量を表します。これは、新しい PersistentVolumes をインスタンス化する場所を検討するときに使用できます。
たとえば、これは次のように表すことができます。- StorageClass "standard" の "1234 GiB" は "topology.kubernetes.io/zone=us-east1" で利用可能 - StorageClass "localssd" の "10 GiB" は "kubernetes.io/hostname=knode-abc123" で利用可能
次の 3 つのケースはすべて、特定の組み合わせで使用可能な容量がないことを意味します。- 適切なトポロジーとストレージクラス名を持つオブジェクトが存在しない - そのようなオブジェクトは存在するが、容量は設定されていない - そのようなオブジェクトは存在するが、容量はゼロである
これらのオブジェクトの作成者は、どちらのアプローチがより適切かを判断できます。
これらは、CSI ドライバーが CSIDriverSpec.StorageCapacity による容量認識スケジューリングを選択するときに、kube-scheduler によって消費されます。スケジューラーは、保留中のボリュームで要求されたサイズと MaximumVolumeSize を比較して、不適切なノードを除外します。MaximumVolumeSize が設定されていない場合は、正確性の低い容量との比較に戻ります。これも設定されていない場合、スケジューラーは容量が不十分であると判断し、他のノードを試行します。
- 型
-
object
- 必須
-
storageClassName
-
4.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| capacity は、前のフィールドと一致するトポロジーとパラメーターを持つ GetCapacityRequest の GetCapacityResponse で CSI ドライバーによって報告される値です。 セマンティクスは現在 (CSI 仕様 1.2) 次のように定義されています。ボリュームのプロビジョニングに使用できるストレージの使用可能な容量 (バイト単位)。設定されていない場合、その情報は現在利用できません。 | |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| maximumVolumeSize は、前のフィールドと一致するトポロジーとパラメーターを持つ GetCapacityRequest の GetCapacityResponse で CSI ドライバーによって報告される値です。 これは、CSI 仕様 1.4.0 以降、GetCapacityRequest と同じパラメーターでボリュームを作成するために CreateVolumeRequest.capacity_range.required_bytes フィールドで使用できる最大サイズとして定義されています。Kubernetes API の対応する値は、ボリュームクレームの ResourceRequirements.Requests です。 | |
| 標準オブジェクトのメタデータ。名前には特別な意味はありません。DNS サブドメインである必要があります (ドットを使用可、253 文字)。クラスター上の他の CSI ドライバーとの競合がないことを確認するには、csisc-<uuid>,、生成された名前、または一意の CSI ドライバー名で終わる逆ドメイン名を使用することを推奨します。 オブジェクトには namespaced が付けられます。 詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
| nodeTopology は、容量が報告されたストレージにアクセスできるノードを定義します。設定されていない場合は、クラスター内のどのノードからもストレージにアクセスできません。空の場合、ストレージはすべてのノードからアクセスできます。このフィールドは不変です。 | |
|
| storageClassName は、報告された容量が適用される StorageClass の名前を表します。StorageClass オブジェクト (空でない DNS サブドメイン) の名前と同じ要件を満たす必要があります。そのオブジェクトが存在しなくなった場合、CSIStorageCapacity オブジェクトは廃止され、作成者が削除する必要があります。このフィールドは不変です。 |
4.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/storage.k8s.io/v1/csistoragecapacities
-
GET
: CSIStorageCapacity 種類のオブジェクトをリスト表示または監視します
-
/apis/storage.k8s.io/v1/watch/csistoragecapacities
-
GET
: CSIStorageCapacity のリストへの個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities
-
DELETE
: CSIStorageCapacity のコレクションを削除する -
GET
: CSIStorageCapacity 種類のオブジェクトをリスト表示または監視します -
POST
: CSIStorageCapacity を作成する
-
/apis/storage.k8s.io/v1/watch/namespaces/{namespace}/csistoragecapacities
-
GET
: CSIStorageCapacity のリストへの個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}
-
DELETE
: CSIStorageCapacity を削除する -
GET
: 指定された CSIStorageCapacity を読み取る -
PATCH
: 指定された CSIStorageCapacity を部分的に更新する -
PUT
: 指定された CSIStorageCapacity を置き換える
-
/apis/storage.k8s.io/v1/watch/namespaces/{namespace}/csistoragecapacities/{name}
-
GET
: CSIStorageCapacity 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
4.2.1. /apis/storage.k8s.io/v1/csistoragecapacities
- HTTP メソッド
-
GET
- 説明
- CSIStorageCapacity 種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
4.2.2. /apis/storage.k8s.io/v1/watch/csistoragecapacities
- HTTP メソッド
-
GET
- 説明
- CSIStorageCapacity のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
4.2.3. /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities
- HTTP メソッド
-
DELETE
- 説明
- CSIStorageCapacity のコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- CSIStorageCapacity 種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- CSIStorageCapacity を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
4.2.4. /apis/storage.k8s.io/v1/watch/namespaces/{namespace}/csistoragecapacities
- HTTP メソッド
-
GET
- 説明
- CSIStorageCapacity のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
4.2.5. /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| CSIStorageCapacity の名前 |
- HTTP メソッド
-
DELETE
- 説明
- CSIStorageCapacity を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された CSIStorageCapacity を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された CSIStorageCapacity を部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された CSIStorageCapacity を置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
4.2.6. /apis/storage.k8s.io/v1/watch/namespaces/{namespace}/csistoragecapacities/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| CSIStorageCapacity の名前 |
- HTTP メソッド
-
GET
- 説明
- CSIStorageCapacity 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
第5章 PersistentVolume [v1]
- 説明
- PersistentVolume (PV) は、管理者によってプロビジョニングされたストレージリソースです。これはノードに似ています。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes
- 型
-
object
5.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| PersistentVolumeSpec は永続ボリュームの仕様です。 |
|
| PersistentVolumeStatus は、永続ボリュームの現在のステータスです。 |
5.1.1. .spec
- 説明
- PersistentVolumeSpec は永続ボリュームの仕様です。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| accessModes には、ボリュームのマウント方法がすべて含まれています。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes |
|
| AWS の永続ディスクリソースを表します。 AWS EBS ディスクは、コンテナーにマウントする前に存在している必要があります。また、ディスクは kubelet と同じ AWS ゾーンにある必要があります。AWS EBS ディスクは、読み取り/書き込みとして 1 回だけマウントできます。AWS EBS ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。 |
|
| AzureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。 |
|
| AzureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。 |
| capacity は、永続ボリュームのリソースおよび容量の説明です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity | |
|
| Pod の存続期間中持続する Ceph ファイルシステムマウントを表します。Cephfs ボリュームは所有権管理または SELinux の再ラベル付けをサポートしていません。 |
|
| Openstack の cinder ボリュームリソースを表します。コンテナーにマウントする前に、Cinder ボリュームが存在している必要があります。ボリュームも、kubelet と同じ領域にある必要があります。Cinder ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。 |
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
|
| 外部 CSI ボリュームドライバーによって管理されるストレージを表します (ベータ機能) |
|
| ファイバーチャネルボリュームを表します。ファイバーチャネルボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ファイバーチャネルボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。 |
|
| FlexPersistentVolumeSource は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用の永続ボリュームリソースを表します。 |
|
| Flocker エージェントによってマウントされた Flocker ボリュームを表します。datasetName および datasetUUID の 1 つだけを設定する必要があります。Flocker ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。 |
|
| Google Compute Engine の永続ディスクリソースを表します。 GCE PD は、コンテナーにマウントする前に存在している必要があります。ディスクは、kubelet と同じ GCE プロジェクトおよびゾーンにある必要もあります。GCE PD は、読み取り/書き込みとして 1 回のみマウントできます。また、読み取り専用としては何度でもマウントできます。GCE PD は、所有権管理および SELinux の再ラベル付けをサポートします。 |
|
| Pod の存続期間中続く Glusterfs マウントを表します。Glusterfs ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。 |
|
| Pod にマップされたホストパスを表します。ホストパスボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。 |
|
| ISCSIPersistentVolumeSource は、ISCSI ディスクを表します。ISCSI ボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ISCSI ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。 |
|
| Local は、ノードアフィニティーを備えた直接接続ストレージを表します (ベータ機能) |
|
| mountOptions はマウントオプションのリストです (例: ["ro", "soft"])。検証されていません - 無効な場合、マウントは失敗します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options |
|
| Pod の存続期間中続く NFS マウントを表します。NFS ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。 |
|
| VolumeNodeAffinity は、このボリュームにアクセスできるノードを制限する制約を定義します。 |
|
| persistentVolumeReclaimPolicy は、永続ボリュームの要求が解除されたときに永続ボリュームに何が起こるかを定義します。有効なオプションは Retain (手動で作成された PersistentVolumes のデフォルト)、Delete (動的にプロビジョニングされる PersistentVolumes のデフォルト)、および Recycle (非推奨) です。Recycle は、この PersistentVolume の基礎となるボリュームプラグインでサポートされる必要があります。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
使用可能な列挙値: - |
|
| Photon Controller 永続ディスクリソースを表します。 |
|
| PortworxVolumeSource は、Portworx ボリュームリソースを表します。 |
|
| Pod の存続期間中続く Quobyte マウントを表します。Quobyte ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。 |
|
| Pod の存続時間中続く Rados Block Device マウントを表します。RBD ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。 |
|
| ScaleIOPersistentVolumeSource は、永続的な ScaleIO ボリュームを表します |
|
| storageClassName は、この永続ボリュームが属する StorageClass の名前です。空の値は、このボリュームが StorageClass に属していないことを意味します。 |
|
| StorageOS 永続ボリュームリソースを表します。 |
|
| この永続ボリュームが属する VolumeAttributesClass の名前。空の値は許可されません。このフィールドが設定されていないと、このボリュームはどの VolumeAttributesClass にも属していないことを示します。このフィールドは変更可能であり、ボリュームが新しいクラスに正常に更新された後に CSI ドライバーによって変更できます。バインドされていない PersistentVolume の場合、volumeAttributesClassName はバインドプロセス中にバインドされていない PersistentVolumeClaims と一致します。これはアルファフィールドであり、VolumeAttributesClass 機能を有効にする必要があります。 |
|
| volumeMode は、ボリュームをフォーマットされたファイルシステムで使用するか、または raw ブロック状態のままにするかを定義します。Filesystem の値は、spec に含まれていない場合に暗示されます。
使用可能な列挙値: - |
|
| vSphere ボリュームリソースを表します。 |
5.1.2. .spec.awsElasticBlockStore
- 説明
AWS の永続ディスクリソースを表します。
AWS EBS ディスクは、コンテナーにマウントする前に存在している必要があります。また、ディスクは kubelet と同じ AWS ゾーンにある必要があります。AWS EBS ディスクは、読み取り/書き込みとして 1 回だけマウントできます。AWS EBS ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
- 必須
-
volumeID
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
| partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。 |
|
| readOnly 値 true は、VolumeMounts の readOnly 設定を強制的に実行します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
| volumeID は、AWS の永続ディスクリソースの一意の ID です (Amazon EBS ボリューム)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
5.1.3. .spec.azureDisk
- 説明
- AzureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。
- 型
-
object
- 必須
-
diskName
-
diskURI
-
プロパティー | 型 | 説明 |
---|---|---|
|
| cachingMode はホストキャッシュモードです (None, Read Only, Read Write)。
使用可能な列挙値: - |
|
| diskName は、Blob ストレージ内のデータディスクの名前です。 |
|
| diskURI は、BLOB ストレージ内のデータディスクの URI です |
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| kind での期待値は、Shared (ストレージアカウントごとに複数のブロブディスク)、Dedicated (ストレージアカウントごとにブロブ 1 つ)、Managed (Azure の管理データディスク (管理対象のアベイラビリティーセットのみ)) です。デフォルトは Shared です。
使用可能な列挙値:- |
|
| readOnly。デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
5.1.4. .spec.azureFile
- 説明
- AzureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。
- 型
-
object
- 必須
-
secretName
-
shareName
-
プロパティー | 型 | 説明 |
---|---|---|
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| secretName は、Azure ストレージアカウント名とキーを含むシークレットの名前です。 |
|
| secretNamespace は、Azure Storage Account Name および Key を含むシークレットの namespace で、デフォルトは Pod と同じです。 |
|
| shareName は Azure 共有名です。 |
5.1.5. .spec.cephfs
- 説明
- Pod の存続期間中持続する Ceph ファイルシステムマウントを表します。Cephfs ボリュームは所有権管理または SELinux の再ラベル付けをサポートしていません。
- 型
-
object
- 必須
-
monitors
-
プロパティー | 型 | 説明 |
---|---|---|
|
| monitors は必須: Monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| パスは任意: 完全な Ceph ツリーではなく、マウントされたルートとして使用されます。デフォルトは / です。 |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| secretFile は任意: SecretFile はユーザーのキーリングへのパスです。デフォルトは /etc/ceph/user.secret です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。 |
|
| user は任意: ユーザーは rados ユーザー名、デフォルトは admin です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
5.1.6. .spec.cephfs.secretRef
- 説明
- SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| name は、namespace 内で一意であり、シークレットのリソースを参照します。 |
|
| namespace は、シークレットの名前が一意でなければならないスペースを定義します。 |
5.1.7. .spec.cinder
- 説明
- Openstack の cinder ボリュームリソースを表します。コンテナーにマウントする前に、Cinder ボリュームが存在している必要があります。ボリュームも、kubelet と同じ領域にある必要があります。Cinder ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
- 必須
-
volumeID
-
プロパティー | 型 | 説明 |
---|---|---|
|
| マウントする fsType ファイルシステムタイプ。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。 |
|
| cinder 内のボリュームを識別するために使用される volumeID。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
5.1.8. .spec.cinder.secretRef
- 説明
- SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| name は、namespace 内で一意であり、シークレットのリソースを参照します。 |
|
| namespace は、シークレットの名前が一意でなければならないスペースを定義します。 |
5.1.9. .spec.claimRef
- 説明
- ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
5.1.10. .spec.csi
- 説明
- 外部 CSI ボリュームドライバーによって管理されるストレージを表します (ベータ機能)
- 型
-
object
- 必須
-
driver
-
volumeHandle
-
プロパティー | 型 | 説明 |
---|---|---|
|
| SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。 |
|
| SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。 |
|
| driver は、このボリュームに使用するドライバーの名前です。必須。 |
|
| マウントする fsType。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。 |
|
| SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。 |
|
| SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。 |
|
| SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。 |
|
| ControllerPublishVolumeRequest に渡す readOnly の値。デフォルトは false (読み取り/書き込み) です。 |
|
| 公開するボリュームの volumeAttributes。 |
|
| volumeHandle は、CSI ボリュームプラグインの CreateVolume により返される一意のボリューム名であり、後続のすべての呼び出しでボリュームを参照します。必須。 |
5.1.11. .spec.csi.controllerExpandSecretRef
- 説明
- SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| name は、namespace 内で一意であり、シークレットのリソースを参照します。 |
|
| namespace は、シークレットの名前が一意でなければならないスペースを定義します。 |
5.1.12. .spec.csi.controllerPublishSecretRef
- 説明
- SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| name は、namespace 内で一意であり、シークレットのリソースを参照します。 |
|
| namespace は、シークレットの名前が一意でなければならないスペースを定義します。 |
5.1.13. .spec.csi.nodeExpandSecretRef
- 説明
- SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| name は、namespace 内で一意であり、シークレットのリソースを参照します。 |
|
| namespace は、シークレットの名前が一意でなければならないスペースを定義します。 |
5.1.14. .spec.csi.nodePublishSecretRef
- 説明
- SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| name は、namespace 内で一意であり、シークレットのリソースを参照します。 |
|
| namespace は、シークレットの名前が一意でなければならないスペースを定義します。 |
5.1.15. .spec.csi.nodeStageSecretRef
- 説明
- SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| name は、namespace 内で一意であり、シークレットのリソースを参照します。 |
|
| namespace は、シークレットの名前が一意でなければならないスペースを定義します。 |
5.1.16. .spec.fc
- 説明
- ファイバーチャネルボリュームを表します。ファイバーチャネルボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ファイバーチャネルボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| LUN は任意: FC ターゲットの LUN 番号 |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| targetWWNs は任意: FC ターゲットのワールドワイド名 (WWN) |
|
| wwids は任意: FC ボリュームのワールドワイド ID(wwids)wwids または targetWWN と lun の組み合わせのいずれかを設定する必要がありますが、両方を同時に設定できません。 |
5.1.17. .spec.flexVolume
- 説明
- FlexPersistentVolumeSource は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用の永続ボリュームリソースを表します。
- 型
-
object
- 必須
-
driver
-
プロパティー | 型 | 説明 |
---|---|---|
|
| driver は、このボリュームに使用するドライバーの名前です。 |
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトのファイルシステムは FlexVolume スクリプトに依存します。 |
|
| options は任意: このフィールドには追加のコマンドオプションがあれば保持されます。 |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。 |
5.1.18. .spec.flexVolume.secretRef
- 説明
- SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| name は、namespace 内で一意であり、シークレットのリソースを参照します。 |
|
| namespace は、シークレットの名前が一意でなければならないスペースを定義します。 |
5.1.19. .spec.flocker
- 説明
- Flocker エージェントによってマウントされた Flocker ボリュームを表します。datasetName および datasetUUID の 1 つだけを設定する必要があります。Flocker ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| datasetName はメタデータとして保存されているデータセットの名前です → Flocker のデータセット上の名前は非推奨として扱うようにしてください。 |
|
| datasetUUID は、データセットの UUID です。これは Flocker データセットの一意の識別子です |
5.1.20. .spec.gcePersistentDisk
- 説明
Google Compute Engine の永続ディスクリソースを表します。
GCE PD は、コンテナーにマウントする前に存在している必要があります。ディスクは、kubelet と同じ GCE プロジェクトおよびゾーンにある必要もあります。GCE PD は、読み取り/書き込みとして 1 回のみマウントできます。また、読み取り専用としては何度でもマウントできます。GCE PD は、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
- 必須
-
pdName
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| pdName は、GCE の PD リソースの一意の名前です。GCE でディスクを識別するために使用されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
5.1.21. .spec.glusterfs
- 説明
- Pod の存続期間中続く Glusterfs マウントを表します。Glusterfs ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
- 型
-
object
- 必須
-
endpoints
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| endpoints は、Glusterfs トポロジーの詳細を示すエンドポイント名です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| endpointsNamespace は、Glusterfs エンドポイントを含む namespace です。このフィールドが空の場合、EndpointNamespace はデフォルトでバインドされた PVC と同じ namespace になります。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| path は Glusterfs ボリュームパスです。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| この readOnly は、Glusterfs ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
5.1.22. .spec.hostPath
- 説明
- Pod にマップされたホストパスを表します。ホストパスボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ホスト上のディレクトリーのパス。パスがシンボリックリンクの場合、実際のパスへのリンクをたどります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
| HostPath ボリュームのデフォルトのタイプは "" です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
使用可能な列挙値: - |
5.1.23. .spec.iscsi
- 説明
- ISCSIPersistentVolumeSource は、ISCSI ディスクを表します。ISCSI ボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ISCSI ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
- 必須
-
targetPortal
-
iqn
-
lun
-
プロパティー | 型 | 説明 |
---|---|---|
|
| chapAuthDiscovery は、iSCSI 検出 CHAP 認証をサポートするかどうかを定義します。 |
|
| chapAuthSession は、iSCSI セッション CHAP 認証をサポートするかどうかを定義します。 |
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#iscsi |
|
| initiatorName は、カスタムの iSCSI イニシエーター名です。iscsiInterface と同時に initiatorName を指定すると、接続用に新しい iSCSI インターフェイス <target portal>:<volume name> が作成されます。 |
|
| IQN は、ターゲット iSCSI 修飾名です。 |
|
| iscsiInterface は、iSCSI トランスポートを使用するインターフェイス名です。デフォルトは 'default' (tcp) です。 |
|
| LUN は iSCSI ターゲット Lun 番号です。 |
|
| ポータルは iSCSI ターゲットポータルリストです。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。 |
|
| この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。 |
|
| SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。 |
|
| targetPortal は iSCSI Target Portal です。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。 |
5.1.24. .spec.iscsi.secretRef
- 説明
- SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| name は、namespace 内で一意であり、シークレットのリソースを参照します。 |
|
| namespace は、シークレットの名前が一意でなければならないスペースを定義します。 |
5.1.25. .spec.local
- 説明
- Local は、ノードアフィニティーを備えた直接接続ストレージを表します (ベータ機能)
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。Path がブロックデバイスの場合にのみ適用されます。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルト値は、指定されていないと、ファイルシステムを自動選択します。 |
|
| ノード上のボリュームへのフルパス。これは、ディレクトリーまたはブロックデバイス (ディスク、パーティションなど) のいずれかです。 |
5.1.26. .spec.nfs
- 説明
- Pod の存続期間中続く NFS マウントを表します。NFS ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
- 型
-
object
- 必須
-
server
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| NFS サーバーがエクスポートしているパス。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| ここで readOnly を指定すると、NFS エクスポートが読み取り専用権限で強制的にマウントされます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| server は、NFS サーバーのホスト名または IP アドレスです。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
5.1.27. .spec.nodeAffinity
- 説明
- VolumeNodeAffinity は、このボリュームにアクセスできるノードを制限する制約を定義します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| ノードセレクターは、ノードのセットに対する 1 つ以上のラベルクエリーの結果の和集合を表します。つまり、ノードセレクター用語で表されるセレクターの OR を表します。 |
5.1.28. .spec.nodeAffinity.required
- 説明
- ノードセレクターは、ノードのセットに対する 1 つ以上のラベルクエリーの結果の和集合を表します。つまり、ノードセレクター用語で表されるセレクターの OR を表します。
- 型
-
object
- 必須
-
nodeSelectorTerms
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 必須。ノードセレクター用語のリスト。用語は OR されています。 |
|
| null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。 |
5.1.29. .spec.nodeAffinity.required.nodeSelectorTerms
- 説明
- 必須。ノードセレクター用語のリスト。用語は OR されています。
- 型
-
array
5.1.30. .spec.nodeAffinity.required.nodeSelectorTerms[]
- 説明
- null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| ノードのラベルごとのノードセレクター要件のリスト。 |
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| ノードのフィールドごとのノードセレクター要件のリスト。 |
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
5.1.31. .spec.nodeAffinity.required.nodeSelectorTerms[].matchExpressions
- 説明
- ノードのラベルごとのノードセレクター要件のリスト。
- 型
-
array
5.1.32. .spec.nodeAffinity.required.nodeSelectorTerms[].matchExpressions[]
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| セレクターが適用されるラベルキー。 |
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。
使用可能な列挙値:- |
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
5.1.33. .spec.nodeAffinity.required.nodeSelectorTerms[].matchFields
- 説明
- ノードのフィールドごとのノードセレクター要件のリスト。
- 型
-
array
5.1.34. .spec.nodeAffinity.required.nodeSelectorTerms[].matchFields[]
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| セレクターが適用されるラベルキー。 |
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。
使用可能な列挙値:- |
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
5.1.35. .spec.photonPersistentDisk
- 説明
- Photon Controller 永続ディスクリソースを表します。
- 型
-
object
- 必須
-
pdID
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| pdID は、Photon Controller の永続ディスクを識別する ID です。 |
5.1.36. .spec.portworxVolume
- 説明
- PortworxVolumeSource は、Portworx ボリュームリソースを表します。
- 型
-
object
- 必須
-
volumeID
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fSType は、マウントするファイルシステムタイプを表します。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| volumeID は、Portworx ボリュームを一意に識別します |
5.1.37. .spec.quobyte
- 説明
- Pod の存続期間中続く Quobyte マウントを表します。Quobyte ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
- 型
-
object
- 必須
-
registry
-
volume
-
プロパティー | 型 | 説明 |
---|---|---|
|
| アクセスできるボリュームをマップするグループ。デフォルトは no group です。 |
|
| ここでの readOnly は、Quobyte ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。 |
|
| registry は、host:port ペアの文字列として指定された単一または複数の Quobyte Registry サービスを表し (複数のエントリーはコンマで区切る)、ボリュームの中央レジストリーとして機能します。 |
|
| 動的にプロビジョニングされた Quobyte ボリュームで使用されるバックエンドで指定の Quobyte ボリュームを所有するテナント。値はプラグインにより設定されます。 |
|
| アクセスできるボリュームをマップするグループ。デフォルトは serivceaccount user です。 |
|
| volume は、すでに作成されているクオバイトボリュームを名前で参照する文字列です。 |
5.1.38. .spec.rbd
- 説明
- Pod の存続時間中続く Rados Block Device マウントを表します。RBD ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
- 必須
-
monitors
-
image
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#rbd |
|
| image は rados イメージ名です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| keyring は、RBDUser のキーリングへのパスです。デフォルトは/etc/ceph/keyring です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| pool は rados プール名です。デフォルトは rbd です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。 |
|
| user は rados ユーザー名です。これにより、プール内にイメージを作成できます。デフォルトは admin です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
5.1.39. .spec.rbd.secretRef
- 説明
- SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| name は、namespace 内で一意であり、シークレットのリソースを参照します。 |
|
| namespace は、シークレットの名前が一意でなければならないスペースを定義します。 |
5.1.40. .spec.scaleIO
- 説明
- ScaleIOPersistentVolumeSource は、永続的な ScaleIO ボリュームを表します
- 型
-
object
- 必須
-
gateway
-
system
-
secretRef
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトは "xfs" です。 |
|
| gateway は、ScaleIO API ゲートウェイのホストアドレスです。 |
|
| protectionDomain は、設定されたストレージの ScaleIO 保護ドメインの名前です。 |
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。 |
|
| sslEnabled は、ゲートウェイとの SSL 通信を有効/無効にするフラグです。デフォルトは false です |
|
| storageMode は、ボリュームのストレージを ThickProvisioned にするか ThinProvisioned にするかを示します。デフォルトは ThinProvisioned です。 |
|
| storagePool は、保護ドメインに関連付けられた ScaleIO ストレージプールです。 |
|
| system は、ScaleIO で設定されたストレージシステムの名前です。 |
|
| volumeName は、このボリュームソースに関連付けられている、ScaleIO システムですでに作成されているボリュームの名前です。 |
5.1.41. .spec.scaleIO.secretRef
- 説明
- SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| name は、namespace 内で一意であり、シークレットのリソースを参照します。 |
|
| namespace は、シークレットの名前が一意でなければならないスペースを定義します。 |
5.1.42. .spec.storageos
- 説明
- StorageOS 永続ボリュームリソースを表します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
|
| volumeName は、人間が判読えきる形式の StorageOS ボリュームの名前です。ボリューム名は、ネームスペース内でのみ一意です。 |
|
| volumeNamespace は、StorageOS 内のボリュームのスコープを指定します。namespace が指定されていない場合は、Pod の namespace が使用されます。これにより、Kubernetes の名前スコープを StorageOS 内にミラーリングして、より緊密に統合することができます。VolumeName を任意の名前に設定して、デフォルトの動作をオーバーライドします。StorageOS 内で namespace を使用していない場合は、"デフォルト" に設定します。StorageOS 内に事前に存在しない名前空間が作成されます。 |
5.1.43. .spec.storageos.secretRef
- 説明
- ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
5.1.44. .spec.vsphereVolume
- 説明
- vSphere ボリュームリソースを表します。
- 型
-
object
- 必須
-
volumePath
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| storagePolicyID は、StoragePolicyName に関連付けられたストレージポリシーベースの管理 (SPBM) プロファイル ID です。 |
|
| storagePolicyName は、ストレージポリシーベースの管理 (SPBM) プロファイル名です。 |
|
| volumePath は、vSphere ボリューム vmdk を識別するパスです。 |
5.1.45. .status
- 説明
- PersistentVolumeStatus は、永続ボリュームの現在のステータスです。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
| TIME | lastPhaseTransitionTime は、フェーズが 1 つから別のフェーズに移行した時間であり、ボリュームフェーズが移行するたびに現在の時間に自動的にリセットされます。これはベータフィールドであり、PersistentVolumeLastPhaseTransitionTime 機能を有効にする必要があります (デフォルトで有効)。 |
|
| message は、ボリュームがこの状態にある理由を示す、人が判読できる形式のメッセージです。 |
|
| phase は、ボリュームが使用可能か、クレームにバインドされているか、またはクレームによってリリースされているかを示します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
使用可能な列挙値: - |
|
| reason は、障害を説明する簡単な CamelCase 文字列であり、CLI でのマシン解析と整理された表示を目的としています。 |
5.2. API エンドポイント
以下の API エンドポイントを利用できます。
/api/v1/persistentvolumes
-
DELETE
: PersistentVolume のコレクションを削除する -
GET
: PersistentVolume 種類のオブジェクトをリスト表示または監視する -
POST
: PersistentVolume を作成する
-
/api/v1/watch/persistentvolumes
-
GET
: PersistentVolume のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/persistentvolumes/{name}
-
DELETE
: PersistentVolume を削除する -
GET
: 指定された PersistentVolume を読み取る -
PATCH
: 指定された PersistentVolume を部分的に更新する -
PUT
: 指定された PersistentVolume を置き換える
-
/api/v1/watch/persistentvolumes/{name}
-
GET
: PersistentVolume 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/api/v1/persistentvolumes/{name}/status
-
GET
: 指定された PersistentVolume のステータスを読み取る -
PATCH
: 指定された PersistentVolume のステータスを部分的に更新する -
PUT
: 指定された PersistentVolume のステータスを置き換える
-
5.2.1. /api/v1/persistentvolumes
- HTTP メソッド
-
DELETE
- 説明
- PersistentVolume のコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- PersistentVolume 種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- PersistentVolume を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
5.2.2. /api/v1/watch/persistentvolumes
- HTTP メソッド
-
GET
- 説明
- PersistentVolume のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
5.2.3. /api/v1/persistentvolumes/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| PersistentVolume の名前 |
- HTTP メソッド
-
DELETE
- 説明
- PersistentVolume を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された PersistentVolume を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された PersistentVolume を部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された PersistentVolume を置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
5.2.4. /api/v1/watch/persistentvolumes/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| PersistentVolume の名前 |
- HTTP メソッド
-
GET
- 説明
- PersistentVolume 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
5.2.5. /api/v1/persistentvolumes/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| PersistentVolume の名前 |
- HTTP メソッド
-
GET
- 説明
- 指定された PersistentVolume のステータスを読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された PersistentVolume のステータスを部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された PersistentVolume のステータスを置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第6章 PersistentVolumeClaim [v1]
- 説明
- PersistentVolumeClaim は、永続ボリュームに対するユーザーの要求および要求です。
- 型
-
object
6.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| PersistentVolumeClaimSpec は、ストレージデバイスの一般的な属性を記述し、プロバイダー固有の属性のソースを許可します |
|
| PersistentVolumeClaimStatus は永続ボリューム要求の現在のステータスです。 |
6.1.1. .spec
- 説明
- PersistentVolumeClaimSpec は、ストレージデバイスの一般的な属性を記述し、プロバイダー固有の属性のソースを許可します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| accessModes には、ボリュームに割り当てる必要のあるアクセスモードが含まれます。詳細は、https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 を参照してください。 |
|
| TypedLocalObjectReference には、同じ namespace 内で typed 参照オブジェクトを見つけるのに十分な情報が含まれます。 |
|
| dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これには、空ではない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のオブジェクトを指定できます。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、dataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性を確保するために、dataSourceRef で namespace が指定されておらず、一方が空でもう一方が空でない場合、両方のフィールド (dataSource と dataSourceRef) が自動的に同じ値に設定されます。dataSourceRef で namespace が指定されている場合、dataSource は同じ値に設定されていないため、空にする必要があります。dataSource と dataSourceRef には 3 つの重要な違いがあります。* dataSource では 2 つの特定のタイプのオブジェクトのみが使用できますが、dataSourceRef ではコアオブジェクト以外および PersistentVolumeClaim オブジェクトを使用できます。* dataSource は使用できない値を無視 (ドロップ) しますが、dataSourceRef はすべての値を保持し、使用できない値が指定された場合はエラーを生成します。* dataSource ではローカルオブジェクトのみが使用できますが、dataSourceRef では任意の namespace のオブジェクトを使用できます。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。(アルファ版) dataSourceRef の namespace フィールドを使用するには、CrossNamespaceVolumeDataSource フィーチャーゲートを有効にする必要があります。 |
|
| VolumeResourceRequirements は、ボリュームのストレージリソース要件を説明します。 |
| selector は、バインドを考慮するボリュームに対するラベルクエリーです。 | |
|
| storageClassName は、要求に必要な StorageClass の名前です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
| volumeAttributesClassName は、このクレームで使用される VolumeAttributesClass を設定するために使用できます。指定すると、CSI ドライバーは、対応する VolumeAttributesClass で定義された属性を使用してボリュームを作成または更新します。これは storageClassName とは異なる目的があり、クレームの作成後に変更できます。空の文字列値は、クレームに VolumeAttributesClass が適用されないことを意味しますが、一度設定すると、このフィールドを空の文字列にリセットすることはできません。指定されておらず、PersistentVolumeClaim がバインドされていない場合は、永続ボリュームコントローラーが存在する場合は、デフォルトの VolumeAttributesClass が設定されます。volumeAttributesClass によって参照されるリソースが存在しない場合は、そのようなリソースが存在するまで、この PersistentVolumeClaim は、modifyVolumeStatus フィールドに反映されるように、保留状態に設定されます。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (アルファベット)このフィールドを使用するには、VolumeAttributesClass 機能ゲートを有効にする必要があります。 |
|
| volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。
使用可能な列挙値: - |
|
| volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。 |
6.1.2. .spec.dataSource
- 説明
- TypedLocalObjectReference には、同じ namespace 内で typed 参照オブジェクトを見つけるのに十分な情報が含まれます。
- 型
-
object
- 必須
-
kind
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。 |
|
| kind は参照されているリソースのタイプです。 |
|
| name は、参照されているリソースの名前です。 |
6.1.3. .spec.dataSourceRef
- 説明
- dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これには、空ではない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のオブジェクトを指定できます。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、dataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性を確保するために、dataSourceRef で namespace が指定されておらず、一方が空でもう一方が空でない場合、両方のフィールド (dataSource と dataSourceRef) が自動的に同じ値に設定されます。dataSourceRef で namespace が指定されている場合、dataSource は同じ値に設定されていないため、空にする必要があります。dataSource と dataSourceRef には 3 つの重要な違いがあります。* dataSource では 2 つの特定のタイプのオブジェクトのみが使用できますが、dataSourceRef ではコアオブジェクト以外および PersistentVolumeClaim オブジェクトを使用できます。* dataSource は使用できない値を無視 (ドロップ) しますが、dataSourceRef はすべての値を保持し、使用できない値が指定された場合はエラーを生成します。* dataSource ではローカルオブジェクトのみが使用できますが、dataSourceRef では任意の namespace のオブジェクトを使用できます。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。(アルファ版) dataSourceRef の namespace フィールドを使用するには、CrossNamespaceVolumeDataSource フィーチャーゲートを有効にする必要があります。
- 型
-
object
- 必須
-
kind
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。 |
|
| kind は参照されているリソースのタイプです。 |
|
| name は、参照されているリソースの名前です。 |
|
| Namespace は、参照されるリソースの namespace です。namespace が指定されている場合は、その namespace の所有者が参照を受け入れることができるように、参照された namespace に gateway.networking.k8s.io/ReferenceGrant オブジェクトが必要であることに注意してください。詳細は、ReferenceGrant ドキュメントを参照してください。(アルファ版) このフィールドでは、CrossNamespaceVolumeDataSource フィーチャーゲートを有効にする必要があります。 |
6.1.4. .spec.resources
- 説明
- VolumeResourceRequirements は、ボリュームのストレージリソース要件を説明します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
| limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 | |
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
6.1.5. .status
- 説明
- PersistentVolumeClaimStatus は永続ボリューム要求の現在のステータスです。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| accessModes には、PVC をサポートするボリュームが実際に持つアクセスモードが含まれます。詳細は、https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 を参照してください。 |
|
| allocatedResourceStatuses は、指定された PVC に対してサイズが変更になるリソースのステータスを格納します。キー名は標準の Kubernetes ラベル構文に従います。有効な値は次のいずれかです: * 接頭辞のないキー: - ストレージ - ボリュームの容量。* カスタムリソースでは、"example.com/my-custom-resource" などの実装定義の接頭辞付きの名前を使用する必要があります。上記の値以外では、接頭辞のないキーや kubernetes.io 接頭辞を持つキーは予約済みとみなされるため、使用できません。 ClaimResourceStatus は、次のいずれかの状態になります。- ControllerResizeInProgress: サイズ変更コントローラーがコントロールプレーンでボリュームのサイズ変更を開始したときに設定される状態。- ControllerResizeFailed: サイズ変更コントローラーで端末エラーが発生してサイズ変更が失敗したときに設定される状態。- NodeResizePending: サイズ変更コントローラーがボリュームのサイズ変更を完了したが、ノードでさらにボリュームのサイズ変更が必要な場合に設定される状態。- NodeResizeInProgress: kubelet がボリュームのサイズ変更を開始するときに設定される状態。- NodeResizeFailed: kubelet で端末エラーが発生してサイズ変更が失敗した場合に設定される状態。一時的なエラーでは NodeResizeFailed は設定されません。たとえば、容量を増やすために PVC を拡張する場合、このフィールドは次のいずれかの状態になります。- pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed" このフィールドが設定されていないと、指定された PVC に対してサイズ変更操作が進行中ではないことを意味します。 以前は不明だった resourceName または ClaimResourceStatus を持つ PVC 更新を受信したコントローラーは、設計された目的のためにその更新を無視する必要があります。たとえば、ボリュームの容量のサイズ変更のみを担当するコントローラーは、PVC に関連付けられている他の有効なリソースを変更する PVC 更新を無視する必要があります。 これはアルファフィールドであるため、RecoverVolumeExpansionFailure 機能を有効にする必要があります。 |
| allocatedResources は、PVC に割り当てられたリソース (容量を含む) を追跡します。キー名は標準の Kubernetes ラベル構文に従います。有効な値は次のいずれかです: * 接頭辞のないキー: - ストレージ - ボリュームの容量。* カスタムリソースでは、"example.com/my-custom-resource" などの実装定義の接頭辞付きの名前を使用する必要があります。上記の値以外では、接頭辞のないキーや kubernetes.io 接頭辞を持つキーは予約済みとみなされるため、使用できません。 ここで報告される容量は、ボリューム拡張操作が要求された場合の実際の容量よりも大きくなる可能性があります。ストレージクォータには、allocatedResources と PVC.spec.resources を比較して大きい方の値が使用されます。allocatedResources が設定されていない場合、PVC.spec.resources のみがクォータの計算に使用されます。ボリューム拡張容量要求が下げられ、進行中の拡張操作がなく、実際のボリューム容量が要求された容量以下である場合にのみ、allocatedResources が引き下げられます。 以前は不明だった resourceName を持つ PVC 更新を受信したコントローラーは、設計された目的のため、その更新を無視する必要があります。たとえば、ボリュームの容量のサイズ変更のみを担当するコントローラーは、PVC に関連付けられている他の有効なリソースを変更する PVC 更新を無視する必要があります。 これはアルファフィールドであるため、RecoverVolumeExpansionFailure 機能を有効にする必要があります。 | |
| capacity は、基礎となるボリュームの実際のリソースを表します。 | |
|
| conditions は永続ボリューム要求の現在の条件です。基礎となる永続ボリュームのサイズを変更すると、Condition は 'ResizeStarted' に設定されます。 |
|
| PersistentVolumeClaimCondition での pvc の状態の詳細 |
|
| currentVolumeAttributesClassName は、PVC が使用している VolumeAttributesClass の現在の名前です。設定されていないと、この PersistentVolumeClaim には VolumeAttributeClass が適用されません。これはアルファフィールドであり、VolumeAttributesClass 機能を有効にする必要があります。 |
|
| ModifyVolumeStatus は、ControllerModifyVolume 操作のステータスオブジェクトを表します。 |
|
| phase は PersistentVolumeClaim の現在のフェーズを表します。
使用可能な列挙値: - |
6.1.6. .status.conditions
- 説明
- conditions は永続ボリューム要求の現在の条件です。基礎となる永続ボリュームのサイズを変更すると、Condition は 'ResizeStarted' に設定されます。
- 型
-
array
6.1.7. .status.conditions[]
- 説明
- PersistentVolumeClaimCondition での pvc の状態の詳細
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | 型 | 説明 |
---|---|---|
| TIME | lastProbeTime は、条件を調査した時間です。 |
| TIME | lastTransitionTime は、条件があるステータスから別のステータスに遷移した最後の時間です。 |
|
| message は、最後の遷移に関する詳細を示し、人間が判読できるメッセージです。 |
|
| 一意であり、これは、条件の最後の遷移理由を示す、マシンが理解できる短い文字列である必要があります。"ResizeStarted" と報告された場合は、基礎となる永続ボリュームのサイズが変更されていることを意味します。 |
|
| |
|
|
6.1.8. .status.modifyVolumeStatus
- 説明
- ModifyVolumeStatus は、ControllerModifyVolume 操作のステータスオブジェクトを表します。
- 型
-
object
- 必須
-
status
-
プロパティー | 型 | 説明 |
---|---|---|
|
| status は、ControllerModifyVolume 操作のステータスです。状態は次のいずれかになります: - Pending。Pending は、指定された VolumeAttributesClass が存在しないなど、要件が満たされていないため、PersistentVolumeClaim を変更できないことを示します。- InProgress。InProgress は、ボリュームが変更中であることを示します。- Infeasible。Infeasible は、要求が CSI ドライバーによって無効として拒否されたことを示します。エラーを解決するには、有効な VolumeAttributesClass を指定する必要があります。注記: 将来的に新しいステータスが追加される可能性があります。コンシューマーは不明なステータスをチェックし、適切に失敗する必要があります。
可能な列挙値: - |
|
| targetVolumeAttributesClassName は、現在調整中の PVC の VolumeAttributesClass の名前です。 |
6.2. API エンドポイント
以下の API エンドポイントを利用できます。
/api/v1/persistentvolumeclaims
-
GET
: PersistentVolumeClaim 種類のオブジェクトをリスト表示または監視します。
-
/api/v1/watch/persistentvolumeclaims
-
GET
: PersistentVolumeClaim のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/namespaces/{namespace}/persistentvolumeclaims
-
DELETE
: PersistentVolumeClaim のコレクションを削除する -
GET
: PersistentVolumeClaim 種類のオブジェクトをリスト表示または監視します。 -
POST
: PersistentVolumeClaim を作成します。
-
/api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
-
GET
: PersistentVolumeClaim のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
-
DELETE
: PersistentVolumeClaim を削除する -
GET
: 指定された PersistentVolumeClaim を読み取る -
PATCH
: 指定された PersistentVolumeClaim を部分的に更新する -
PUT
: 指定された PersistentVolumeClaim を置き換える
-
/api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
-
GET
: PersistentVolumeClaim 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
-
GET
: 指定された PersistentVolumeClaim のステータスを読み取る -
PATCH
: 指定された PersistentVolumeClaim のステータスを部分的に更新する -
PUT
: 指定された PersistentVolumeClaim のステータスを置き換える
-
6.2.1. /api/v1/persistentvolumeclaims
- HTTP メソッド
-
GET
- 説明
- PersistentVolumeClaim 種類のオブジェクトをリスト表示または監視します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
6.2.2. /api/v1/watch/persistentvolumeclaims
- HTTP メソッド
-
GET
- 説明
- PersistentVolumeClaim のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
6.2.3. /api/v1/namespaces/{namespace}/persistentvolumeclaims
- HTTP メソッド
-
DELETE
- 説明
- PersistentVolumeClaim のコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- PersistentVolumeClaim 種類のオブジェクトをリスト表示または監視します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- PersistentVolumeClaim の作成
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | 空白 |
6.2.4. /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
- HTTP メソッド
-
GET
- 説明
- PersistentVolumeClaim のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
6.2.5. /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| PersistentVolumeClaim の名前 |
- HTTP メソッド
-
DELETE
- 説明
- PersistentVolumeClaim の削除
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
202 - Accepted | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された PersistentVolumeClaim を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された PersistentVolumeClaim を部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された PersistentVolumeClaim を置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
6.2.6. /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| PersistentVolumeClaim の名前 |
- HTTP メソッド
-
GET
- 説明
- PersistentVolumeClaim 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
6.2.7. /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| PersistentVolumeClaim の名前 |
- HTTP メソッド
-
GET
- 説明
- 指定された PersistentVolumeClaim のステータスを読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された PersistentVolumeClaim のステータスを部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された PersistentVolumeClaim のステータスを置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
第7章 StorageClass [storage.k8s.io/v1]
- 説明
StorageClass は、PersistentVolumes を動的にプロビジョニングできるストレージのクラスのパラメーターを記述します。
StorageClasses は namespace ではありません。etcd に従ったストレージクラスの名前は ObjectMeta.Name にあります。
- 型
-
object
- 必須
-
provisioner
-
7.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| allowVolumeExpansion は、ストレージクラスがボリューム拡張を許可するかどうかを示します。 |
| allowedTopologies は、ボリュームを動的にプロビジョニングできるノードトポロジーを制限します。各ボリュームプラグインは、サポートされている独自のトポロジー仕様を定義します。空の TopologySelectorTerm リストは、トポロジーの制限がないことを意味します。このフィールドは、VolumeScheduling 機能を有効にするサーバーによってのみ適用されます。 | |
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| mountOptions は、このストレージクラスの動的にプロビジョニングされた PersistentVolumes の mountOptions を制御します (例: ["ro", "soft"])。検証されていません - PV のマウントが無効な場合、PV のマウントは単に失敗します。 |
|
| parameters は、このストレージクラスのボリュームを作成する必要があるプロビジョナーのパラメーターを保持します。 |
|
| provisioner は、プロビジョナーのタイプを示します。 |
|
| reclaimPolicy は、このストレージクラスの動的にプロビジョニングされた PersistentVolumes の reclaimPolicy を制御します。デフォルトは Delete です。
使用可能な列挙値: - |
|
| volumeBindingMode は、PersistentVolumeClaims をプロビジョニングしてバインドする方法を示します。設定を解除すると、VolumeBindingImmediate が使用されます。このフィールドは、VolumeScheduling 機能を有効にするサーバーによってのみ適用されます。
使用可能な列挙値: - |
7.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/storage.k8s.io/v1/storageclasses
-
DELETE
: StorageClass のコレクションを削除します -
GET
: StorageClass 種類のオブジェクトをリスト表示または監視する -
POST
: StorageClass を作成する
-
/apis/storage.k8s.io/v1/watch/storageclasses
-
GET
: StorageClass のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/storage.k8s.io/v1/storageclasses/{name}
-
DELETE
: StorageClass を削除する -
GET
: 指定された StorageClass を読み取ります。 -
PATCH
: 指定された StorageClass を部分的に更新します。 -
PUT
: 指定された StorageClass を交換します。
-
/apis/storage.k8s.io/v1/watch/storageclasses/{name}
-
GET
: StorageClass の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
7.2.1. /apis/storage.k8s.io/v1/storageclasses
- HTTP メソッド
-
DELETE
- 説明
- StorageClass のコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- StorageClass 種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- StorageClass を作成します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
7.2.2. /apis/storage.k8s.io/v1/watch/storageclasses
- HTTP メソッド
-
GET
- 説明
- StorageClass のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.2.3. /apis/storage.k8s.io/v1/storageclasses/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| StorageClass の名前 |
- HTTP メソッド
-
DELETE
- 説明
- StorageClass を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された StorageClass を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された StorageClass を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された StorageClass を交換します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
7.2.4. /apis/storage.k8s.io/v1/watch/storageclasses/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| StorageClass の名前 |
- HTTP メソッド
-
GET
- 説明
- StorageClass の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
第8章 StorageState [migration.k8s.io/v1alpha1]
- 説明
- 特定のリソースのストレージの状態。
- 型
-
object
8.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| 保管状態の仕様。 |
|
| ストレージ状態のステータス。 |
8.1.1. .spec
- 説明
- 保管状態の仕様。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| この storageState に関するリソース。 |
8.1.2. .spec.resource
- 説明
- この storageState に関するリソース。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| グループの名前。 |
|
| リソースの名前。 |
8.1.3. .status
- 説明
- ストレージ状態のステータス。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| API サーバーによって提供される検出ドキュメントに示されている、現在のストレージバージョンのハッシュ値。ストレージバージョンは、オブジェクトが永続化される前に変換されるバージョンです。 |
|
| LastHeartbeatTime は、ストレージ移行トリガーコントローラーが検出ドキュメント内のこのリソースのストレージバージョンハッシュをチェックし、このフィールドを更新する最後の時間です。 |
|
| spec.resource のインスタンスを永続化したストレージバージョンのハッシュ値は、まだエンコードされている可能性があります。"Unknown" はリスト内の有効な値であり、デフォルト値です。このフィールドにリストされているすべてのバージョンをサポートしていない、または "Unknown" がリストされている場合は、apiserver バイナリーにアップグレードまたはダウングレードすることは安全ではありません。このリソースのストレージバージョンの移行が完了すると、このフィールドの値は、currentStorageVersionHash のみを含むように調整されます。apiserver がストレージのバージョンを変更すると、新しいストレージのバージョンがリストに追加されます。 |
8.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/migration.k8s.io/v1alpha1/storagestates
-
DELETE
: StorageState のコレクションを削除します。 -
GET
: StorageState 種類のオブジェクトをリスト表示します。 -
POST
: StorageState を作成する
-
/apis/migration.k8s.io/v1alpha1/storagestates/{name}
-
DELETE
: StorageState を削除する -
GET
: 指定された StorageState を読み取ります。 -
PATCH
: 指定された StorageState を部分的に更新します -
PUT
: 指定された StorageState を交換します
-
/apis/migration.k8s.io/v1alpha1/storagestates/{name}/status
-
GET
: 指定された StorageState のステータスを読み取ります。 -
PATCH
: 指定された StorageState のステータスを部分的に更新します。 -
PUT
: 指定された StorageState のステータスを置き換えます。
-
8.2.1. /apis/migration.k8s.io/v1alpha1/storagestates
- HTTP メソッド
-
DELETE
- 説明
- StorageState のコレクションを削除する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- StorageState 種類のオブジェクトをリスト表示する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- StorageState を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
8.2.2. /apis/migration.k8s.io/v1alpha1/storagestates/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| StorageState の名前 |
- HTTP メソッド
-
DELETE
- 説明
- StorageState を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された StorageState を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された StorageState を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された StorageState を交換します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
8.2.3. /apis/migration.k8s.io/v1alpha1/storagestates/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| StorageState の名前 |
- HTTP メソッド
-
GET
- 説明
- 指定された StorageState のステータスを読み取ります。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された StorageState のステータスを部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された StorageState のステータスを置き換えます。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第9章 StorageVersionMigration [migration.k8s.io/v1alpha1]
- 説明
- StorageVersionMigration は、保存されたデータの最新のストレージバージョンへの移行を表します。
- 型
-
object
9.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| 移行の仕様。 |
|
| 移行のステータス。 |
9.1.1. .spec
- 説明
- 移行の仕様。
- 型
-
object
- 必須
-
resource
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 移行するオブジェクトの次のチャンクを取得するためにリストオプションで使用されるトークン。.status.conditions が移行が "Running" であることを示している場合、ユーザーはこのトークンを使用して移行の進行状況を確認できます。 |
|
| 移行中のリソース。移行者は、リソースを提供するエンドポイントにリクエストを送信します。Immutable. |
9.1.2. .spec.resource
- 説明
- 移行中のリソース。移行者は、リソースを提供するエンドポイントにリクエストを送信します。Immutable.
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| グループの名前。 |
|
| リソースの名前。 |
|
| バージョンの名前。 |
9.1.3. .status
- 説明
- 移行のステータス。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 移行の現在の状態に関する最新の利用可能な観察。 |
|
| 特定の時点での移行の状態を説明します。 |
9.1.4. .status.conditions
- 説明
- 移行の現在の状態に関する最新の利用可能な観察。
- 型
-
array
9.1.5. .status.conditions[]
- 説明
- 特定の時点での移行の状態を説明します。
- 型
-
object
- 必須
-
status
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| この状態が最後に更新された時刻。 |
|
| 遷移の詳細を示す人が判読できるメッセージ。 |
|
| 条件の最後の遷移の理由。 |
|
| 状態のステータス (True、False、Unknown のいずれか)。 |
|
| 条件の型。 |
9.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/migration.k8s.io/v1alpha1/storageversionmigrations
-
DELETE
: StorageVersionMigration のコレクションを削除する -
GET
: StorageVersionMigration 種類のオブジェクトをリスト表示する -
POST
: StorageVersionMigration を作成する
-
/apis/migration.k8s.io/v1alpha1/storageversionmigrations/{name}
-
DELETE
: StorageVersionMigration を削除する -
GET
: 指定された StorageVersionMigration を読み取る -
PATCH
: 指定された StorageVersionMigration を部分的に更新する -
PUT
: 指定された StorageVersionMigration を置き換える
-
/apis/migration.k8s.io/v1alpha1/storageversionmigrations/{name}/status
-
GET
: 指定された StorageVersionMigration のステータスを読み取る -
PATCH
: 指定された StorageVersionMigration のステータスを部分的に更新する -
PUT
: 指定された StorageVersionMigration のステータスを置き換える
-
9.2.1. /apis/migration.k8s.io/v1alpha1/storageversionmigrations
- HTTP メソッド
-
DELETE
- 説明
- StorageVersionMigration のコレクションを削除する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- StorageVersionMigration 種類のオブジェクトをリスト表示する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- StorageVersionMigration を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | 空白 |
9.2.2. /apis/migration.k8s.io/v1alpha1/storageversionmigrations/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| StorageVersionMigration の名前 |
- HTTP メソッド
-
DELETE
- 説明
- StorageVersionMigration を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された StorageVersionMigration を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された StorageVersionMigration を部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された StorageVersionMigration を置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
9.2.3. /apis/migration.k8s.io/v1alpha1/storageversionmigrations/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| StorageVersionMigration の名前 |
- HTTP メソッド
-
GET
- 説明
- 指定された StorageVersionMigration のステータスを読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された StorageVersionMigration のステータスを部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された StorageVersionMigration のステータスを置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
第10章 VolumeAttachment [storage.k8s.io/v1]
- 説明
VolumeAttachment は、指定されたボリュームを指定されたノードにアタッチまたはデタッチする意図をキャプチャーします。
VolumeAttachment オブジェクトには namespace がありません。
- 型
-
object
- 必須
-
spec
-
10.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| VolumeAttachmentSpec は、VolumeAttachment リクエストの仕様です。 |
|
| VolumeAttachmentStatus は、VolumeAttachment リクエストのステータスです。 |
10.1.1. .spec
- 説明
- VolumeAttachmentSpec は、VolumeAttachment リクエストの仕様です。
- 型
-
object
- 必須
-
attacher
-
source
-
nodeName
-
プロパティー | 型 | 説明 |
---|---|---|
|
| attacher は、この要求を処理しなければならないボリュームドライバーの名前を示します。これは、GetPluginName() により返される名前です。 |
|
| nodeName は、ボリュームを割り当てる必要があるノードを表します。 |
|
| VolumeAttachmentSource は、接続する必要のあるボリュームを表します。現在は、PersistenVolumes のみが外部アタッチを介して接続でき、今後 Pod でインラインボリュームを許可する可能性があります。正確に 1 つのメンバーを設定できます。 |
10.1.2. .spec.source
- 説明
- VolumeAttachmentSource は、接続する必要のあるボリュームを表します。現在は、PersistenVolumes のみが外部アタッチを介して接続でき、今後 Pod でインラインボリュームを許可する可能性があります。正確に 1 つのメンバーを設定できます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
| inlineVolumeSpec には、Pod のインライン VolumeSource によって定義された永続ボリュームを接続するために必要なすべての情報が含まれています。このフィールドは、CSIMigration 機能の場合にのみ入力されます。Pod のインライン VolumeSource から PersistentVolumeSpec に変換されたフィールドが含まれています。このフィールドはベータレベルであり、CSIMigration 機能を有効にしたサーバーによってのみ尊重されます。 | |
|
| persistentVolumeName は、アタッチする永続ボリュームの名前を表します。 |
10.1.3. .status
- 説明
- VolumeAttachmentStatus は、VolumeAttachment リクエストのステータスです。
- 型
-
object
- 必須
-
attached
-
プロパティー | 型 | 説明 |
---|---|---|
|
| VolumeError は、ボリューム操作中に発生したエラーをキャプチャします。 |
|
| attached は、ボリュームが正常にアタッチされていることを示します。このフィールドは、アタッチ操作を完了するエンティティー、つまり外部アタッチメントによってのみ設定する必要があります。 |
|
| attachmentMetadata には、アタッチが成功したときにアタッチ操作によって返された情報が取り込まれます。これらの情報は、後続の WaitForAttach または Mount 呼び出しに渡す必要があります。このフィールドは、アタッチ操作を完了するエンティティー、つまり外部アタッチメントによってのみ設定する必要があります。 |
|
| VolumeError は、ボリューム操作中に発生したエラーをキャプチャします。 |
10.1.4. .status.attachError
- 説明
- VolumeError は、ボリューム操作中に発生したエラーをキャプチャします。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| message は、アタッチまたはデタッチ操作中に発生したエラーを表します。この文字列はログに記録される可能性があるため、機密情報を含めることはできません。 |
| TIME | time は、エラーが発生した時間を表します。 |
10.1.5. .status.detachError
- 説明
- VolumeError は、ボリューム操作中に発生したエラーをキャプチャします。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| message は、アタッチまたはデタッチ操作中に発生したエラーを表します。この文字列はログに記録される可能性があるため、機密情報を含めることはできません。 |
| TIME | time は、エラーが発生した時間を表します。 |
10.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/storage.k8s.io/v1/volumeattachments
-
DELETE
: VolumeAttachment のコレクションを削除する -
GET
: VolumeAttachment 種類のオブジェクトをリスト表示または監視する -
POST
: VolumeAttachment を作成する
-
/apis/storage.k8s.io/v1/watch/volumeattachments
-
GET
: VolumeAttachment のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/storage.k8s.io/v1/volumeattachments/{name}
-
DELETE
: VolumeAttachment を削除する -
GET
: 指定された VolumeAttachment を読み取る -
PATCH
: 指定された VolumeAttachment を部分的に更新する -
PUT
: 指定された VolumeAttachment を置き換える
-
/apis/storage.k8s.io/v1/watch/volumeattachments/{name}
-
GET
: VolumeAttachment 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/apis/storage.k8s.io/v1/volumeattachments/{name}/status
-
GET
: 指定された VolumeAttachment のステータスを読み取る -
PATCH
: 指定された VolumeAttachment のステータスを部分的に更新する -
PUT
: 指定された VolumeAttachment のステータスを置き換える
-
10.2.1. /apis/storage.k8s.io/v1/volumeattachments
- HTTP メソッド
-
DELETE
- 説明
- VolumeAttachment のコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- VolumeAttachment の種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- VolumeAttachment を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
10.2.2. /apis/storage.k8s.io/v1/watch/volumeattachments
- HTTP メソッド
-
GET
- 説明
- VolumeAttachment のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
10.2.3. /apis/storage.k8s.io/v1/volumeattachments/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| VolumeAttachment の名前 |
- HTTP メソッド
-
DELETE
- 説明
- VolumeAttachment を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された VolumeAttachment を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された VolumeAttachment を部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された VolumeAttachment を置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
10.2.4. /apis/storage.k8s.io/v1/watch/volumeattachments/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| VolumeAttachment の名前 |
- HTTP メソッド
-
GET
- 説明
- VolumeAttachment 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
10.2.5. /apis/storage.k8s.io/v1/volumeattachments/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| VolumeAttachment の名前 |
- HTTP メソッド
-
GET
- 説明
- 指定された VolumeAttachment のステータスを読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された VolumeAttachment のステータスを部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された VolumeAttachment のステータスを置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第11章 VolumeSnapshot [snapshot.storage.k8s.io/v1]
- 説明
- VolumeSnapshot は、永続ボリュームのポイントインタイムスナップショットを作成するか、既存のスナップショットにバインドするためのユーザーの要求です。
- 型
-
object
- 必須
-
spec
-
11.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| spec は、ユーザーが要求するスナップショットの望ましい特性を定義します。詳細: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots 必須。 |
|
| status は、スナップショットの現在の情報を表します。コンシューマーは、このオブジェクトを使用する前に、VolumeSnapshot オブジェクトと VolumeSnapshotContent オブジェクトの間のバインドが成功したことを (VolumeSnapshot オブジェクトと VolumeSnapshotContent オブジェクトの両方が相互にポイントしていることを検証して) 確認する必要があります。 |
11.1.1. .spec
- 説明
- spec は、ユーザーが要求するスナップショットの望ましい特性を定義します。詳細: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots 必須。
- 型
-
object
- 必須
-
source
-
プロパティー | 型 | 説明 |
---|---|---|
|
| source は、スナップショットの作成元を指定します。このフィールドは、作成後は不変です。必須。 |
|
| VolumeSnapshotClassName は、VolumeSnapshot によって要求された VolumeSnapshotClass の名前です。VolumeSnapshotClassName は、デフォルトの SnapshotClass を使用する必要があることを示すために nil のままにすることができます。特定のクラスターには、複数のデフォルトの Volume SnapshotClasses がある場合があります。CSI ドライバーごとに 1 つのデフォルトです。VolumeSnapshot が SnapshotClass を指定しない場合、VolumeSnapshotSource がチェックされ、関連付けられた CSI ドライバーが何であるかが把握され、その CSI ドライバーに関連付けられたデフォルトの VolumeSnapshotClass が使用されます。特定の CSI ドライバーに複数の VolumeSnapshotClass が存在し、複数がデフォルトとしてマークされている場合、CreateSnapshot は失敗し、イベントを生成します。このフィールドには空の文字列は使用できません。 |
11.1.2. .spec.source
- 説明
- source は、スナップショットの作成元を指定します。このフィールドは、作成後は不変です。必須。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| persistentVolumeClaimName は、スナップショットの作成元となるボリュームを表す PersistentVolumeClaim オブジェクトの名前を指定します。この PVC は、VolumeSnapshot オブジェクトと同じ名前空間にあると見なされます。スナップショットが存在せず、作成する必要がある場合は、このフィールドを設定する必要があります。このフィールドは不変です。 |
|
| volumeSnapshotContentName は、既存のボリュームスナップショットを表す既存の VolumeSnapshotContent オブジェクトの名前を指定します。スナップショットがすでに存在し、Kubernetes での表現のみが必要な場合は、このフィールドを設定する必要があります。このフィールドは不変です。 |
11.1.3. .status
- 説明
- status は、スナップショットの現在の情報を表します。コンシューマーは、このオブジェクトを使用する前に、VolumeSnapshot オブジェクトと VolumeSnapshotContent オブジェクトの間のバインドが成功したことを (VolumeSnapshot オブジェクトと VolumeSnapshotContent オブジェクトの両方が相互にポイントしていることを検証して) 確認する必要があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| boundVolumeSnapshotContentName は、この VolumeSnapshot オブジェクトがバインドしようとしている VolumeSnapshotContent オブジェクトの名前です。指定しない場合は、VolumeSnapshot オブジェクトが VolumeSnapshotContent オブジェクトに正常にバインドされていないことを示します。注: セキュリティーの問題を回避するために、コンシューマーは、このオブジェクトを使用する前に、VolumeSnapshot オブジェクトと VolumeSnapshotContent オブジェクトの間のバインドが成功したことを (VolumeSnapshot オブジェクトと VolumeSnapshotContent オブジェクトの両方が相互にポイントしていることを検証して) 確認する必要があります。 |
|
| creationTime は、基盤となるストレージシステムによってポイントインタイムスナップショットが取得されたときのタイムスタンプです。動的スナップショットを作成する場合、このフィールドには、CSI "CreateSnapshot" gRPC 呼び出しから返された "creation_time" 値がスナップショットコントローラーによって入力されます。既存のスナップショットで、ドライバーがサポートしている場合、このフィールドには CSI "ListSnapshots" gRPC 呼び出しから返される "creation_time" 値が入力されます。指定しない場合は、スナップショットの作成時刻が不明であることを示している可能性があります。 |
|
| error は、スナップショットの作成中に最後に観察されたエラーです (存在する場合)。このフィールドは、報告されたエラーのタイプに基づいて、スナップショットが作成されるのを待機し続けるかどうかを決定するために、上位レベルのコントローラー (つまり、アプリケーションコントローラー) に役立つ場合があります。スナップショットの作成中にエラーが発生した場合、スナップショットコントローラーは再試行を続けます。成功すると、このエラーフィールドはクリアされます。 |
|
| readyToUse は、スナップショットを使用してボリュームを復元する準備ができているかどうかを示します。動的スナップショット作成の場合、このフィールドには、CSI "CreateSnapshot" gRPC 呼び出しから返された "ready_to_use" 値がスナップショットコントローラーによって入力されます。既存のスナップショットの場合、ドライバーがサポートしている場合、このフィールドには CSI "ListSnapshots" gRPC 呼び出しから返される "ready_to_use" 値が入力されます。サポートされていない場合、このフィールドは "True" に設定されます。指定しない場合は、スナップショットの準備状態が不明であることを意味します。 |
|
| restoreSize は、このスナップショットからボリュームを作成するのに必要なボリュームの最小サイズを表します。動的スナップショット作成の場合、このフィールドには、CSI "CreateSnapshot" gRPC 呼び出しから返された "size_bytes" 値がスナップショットコントローラーによって入力されます。既存のスナップショットで、ドライバーがサポートしている場合、このフィールドには CSI "ListSnapshots" gRPC 呼び出しから返される "size_bytes" 値が入力されます。このスナップショットからボリュームを復元する場合、ボリュームのサイズは、指定されている場合は restoreSize より小さくしてはなりません。小さくしないと、復元が失敗します。指定しない場合は、サイズが不明であることを示します。 |
|
| VolumeGroupSnapshotName は、この VolumeSnapshot が含まれる VolumeGroupSnapshot の名前です。 |
11.1.4. .status.error
- 説明
- error は、スナップショットの作成中に最後に観察されたエラーです (存在する場合)。このフィールドは、報告されたエラーのタイプに基づいて、スナップショットが作成されるのを待機し続けるかどうかを決定するために、上位レベルのコントローラー (つまり、アプリケーションコントローラー) に役立つ場合があります。スナップショットの作成中にエラーが発生した場合、スナップショットコントローラーは再試行を続けます。成功すると、このエラーフィールドはクリアされます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| message は、指定されている場合、スナップショットの作成中に発生したエラーの詳細を示す文字列です。注: メッセージはログに記録される可能性があり、機密情報を含めることはできません。 |
|
| time は、エラーが発生したときのタイムスタンプです。 |
11.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/snapshot.storage.k8s.io/v1/volumesnapshots
-
GET
: VolumeSnapshot 種類のオブジェクトをリスト表示する
-
/apis/snapshot.storage.k8s.io/v1/namespaces/{namespace}/volumesnapshots
-
DELETE
: VolumeSnapshot のコレクションを削除する -
GET
: VolumeSnapshot 種類のオブジェクトをリスト表示する -
POST
:VolumeSnapshot を作成する
-
/apis/snapshot.storage.k8s.io/v1/namespaces/{namespace}/volumesnapshots/{name}
-
DELETE
: VolumeSnapshot を削除する -
GET
: 指定された VolumeSnapshot を読み取ります。 -
PATCH
: 指定された VolumeSnapshot を部分更新します。 -
PUT
: 指定された VolumeSnapshot を置き換えます。
-
/apis/snapshot.storage.k8s.io/v1/namespaces/{namespace}/volumesnapshots/{name}/status
-
GET
: 指定された VolumeSnapshot の状態を読み取ります。 -
PATCH
: 指定された VolumeSnapshot の部分更新状況です。 -
PUT
: 指定された VolumeSnapshot の状態の置き換えます。
-
11.2.1. /apis/snapshot.storage.k8s.io/v1/volumesnapshots
- HTTP メソッド
-
GET
- 説明
- VolumeSnapshot 種類のオブジェクトをリスト表示する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
11.2.2. /apis/snapshot.storage.k8s.io/v1/namespaces/{namespace}/volumesnapshots
- HTTP メソッド
-
DELETE
- 説明
- VolumeSnapshot のコレクションを削除する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- VolumeSnapshot 種類のオブジェクトをリスト表示する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- VolumeSnapshot の作成
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
11.2.3. /apis/snapshot.storage.k8s.io/v1/namespaces/{namespace}/volumesnapshots/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| VolumeSnapshot の名前 |
- HTTP メソッド
-
DELETE
- 説明
- VolumeSnapshot の削除
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された VolumeSnapshot の読み取り
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された VolumeSnapshot の部分更新
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された VolumeSnapshot を置き換えます。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
11.2.4. /apis/snapshot.storage.k8s.io/v1/namespaces/{namespace}/volumesnapshots/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| VolumeSnapshot の名前 |
- HTTP メソッド
-
GET
- 説明
- 指定された VolumeSnapshot の状態を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された VolumeSnapshot の部分更新状況
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された VolumeSnapshot の状態の置き換え
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第12章 VolumeSnapshotClass [snapshot.storage.k8s.io/v1]
- 説明
- VolumeSnapshotClass は、基礎となるストレージシステムがボリュームスナップショットを作成する際に使用するパラメーターを指定します。VolumeSnapshotClass は、VolumeSnapshot オブジェクトの中でその名前を指定することで使用します。VolumeSnapshotClass は名前なしです。
- 型
-
object
- 必須
-
deletionPolicy
-
driver
-
12.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| eletionPolicy は、VolumeSnapshotClass を介して作成された VolumeSnapshotContent が、そのバインドされた VolumeSnapshot の削除時に削除されるべきかどうかを決定するものです。サポートされる値は、"Retain" および "Delete" です。"Retain" は、VolumeSnapshotContent とそのストレージシステム上の物理的なスナップショットが保持されることを意味すします。"Delete" は、基礎となるストレージシステム上の VolumeSnapshotContent およびその物理スナップショットが削除されることを意味します。必須。 |
|
| driver は、この VolumeSnapshotClass を処理するストレージドライバーの名前です。必須。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| parameters は、スナップショットを作成するためのストレージドライバー固有のパラメーターを含むキーバリューマップです。これらの値は、Kubernetes には不透明です。 |
12.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/snapshot.storage.k8s.io/v1/volumesnapshotclasses
-
DELETE
: VolumeSnapshotClass のコレクションを削除する -
GET
: VolumeSnapshotClass 種類のオブジェクトをリスト表示する -
POST
: VolumeSnapshotClass を作成する
-
/apis/snapshot.storage.k8s.io/v1/volumesnapshotclasses/{name}
-
削除
: VolumeSnapshotClass を削除する -
GET
: 指定された VolumeSnapshotClass を読み取る -
PATCH
: 指定された VolumeSnapshotClass を部分的に更新する -
PUT
: 指定された VolumeSnapshotClass を置き換える
-
12.2.1. /apis/snapshot.storage.k8s.io/v1/volumesnapshotclasses
- HTTP メソッド
-
DELETE
- 説明
- VolumeSnapshotClass のコレクションを削除する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- VolumeSnapshotClass 種類のオブジェクトをリスト表示する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- VolumeSnapshotClass を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
12.2.2. /apis/snapshot.storage.k8s.io/v1/volumesnapshotclasses/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| VolumeSnapshotClass の名前 |
- HTTP メソッド
-
DELETE
- 説明
- VolumeSnapshotClass を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された VolumeSnapshotClass の読み取り
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された VolumeSnapshotClass の部分更新
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された VolumeSnapshotClass の置き換え
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第13章 VolumeSnapshotContent [snapshot.storage.k8s.io/v1]
- 説明
- VolumeSnapshotContent は、基盤となるストレージシステム内の実際の "ディスク上" のスナップショットオブジェクトを表します
- 型
-
object
- 必須
-
spec
-
13.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| spec は、基盤となるストレージシステムによって作成された VolumeSnapshotContent のプロパティーを定義します。必須。 |
|
| status は、スナップショットの現在の情報を表します。 |
13.1.1. .spec
- 説明
- spec は、基盤となるストレージシステムによって作成された VolumeSnapshotContent のプロパティーを定義します。必須。
- 型
-
object
- 必須
-
deletionPolicy
-
driver
-
source
-
volumeSnapshotRef
-
プロパティー | 型 | 説明 |
---|---|---|
|
| deletionPolicy は、バインドされた VolumeSnapshot が削除されたときに、基盤となるストレージシステム上にあるこの VolumeSnapshotContent とその物理スナップショットを削除するかどうかを決定します。サポートされる値は、"Retain" および "Delete" です。"Retain" は、VolumeSnapshotContent とそのストレージシステム上の物理的なスナップショットが保持されることを意味すします。"Delete" は、基礎となるストレージシステム上の VolumeSnapshotContent およびその物理スナップショットが削除されることを意味します。動的にプロビジョニングされたスナップショットの場合、このフィールドは、対応する VolumeSnapshotClass で定義された "DeletionPolicy" フィールドを使用して CSI スナップショットサイドカーによって自動的に入力されます。既存のスナップショットの場合、ユーザーは VolumeSnapshotContent オブジェクトを作成するときにこのフィールドを指定する必要があります。必須。 |
|
| driver は、基盤となるストレージシステムに物理スナップショットを作成するのに使用される CSI ドライバーの名前です。これは、そのドライバーの CSI GetPluginName() 呼び出しによって返される名前と同じである必要があります。必須。 |
|
| source は、スナップショットが動的にプロビジョニングされる (または存在する必要がある) か、すでに存在するかを指定し、Kubernetes オブジェクト表現のみを必要とします。このフィールドは、作成後は不変です。必須。 |
|
| SourceVolumeMode は、スナップショットが作成されるボリュームのモードです。“Filesystem” または “Block” のいずれかを指定できます。指定しない場合は、ソースボリュームのモードが不明であることを示します。このフィールドは不変です。このフィールドはアルファフィールドです。 |
|
| このスナップショットが作成された (または作成される) VolumeSnapshotClass の名前。プロビジョニング後、VolumeSnapshotClass は削除されるか、異なる値のセットで再作成される可能性があるため、スナップショットの作成後に参照しないでください。 |
|
| volumeSnapshotRef は、この VolumeSnapshotContent オブジェクトがバインドされている VolumeSnapshot オブジェクトを指定します。VolumeSnapshot.Spec.VolumeSnapshotContentName フィールドは、双方向バインディングを有効にするために、この VolumeSnapshotContent の名前を参照する必要があります。既存の VolumeSnapshotContent オブジェクトの場合にバインディングを実行するには、VolumeSnapshot オブジェクトの名前および namespace を指定する必要があります。このフィールドは、作成後は不変です。必須。 |
13.1.2. .spec.source
- 説明
- source は、スナップショットが動的にプロビジョニングされる (または存在する必要がある) か、すでに存在するかを指定し、Kubernetes オブジェクト表現のみを必要とします。このフィールドは、作成後は不変です。必須。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| snapshotHandle は、Kubernetes オブジェクト表現が作成された (または作成されるべき) 基盤となるストレージシステム上の既存のスナップショットの CSI "snapshot_id" を指定します。このフィールドは不変です。 |
|
| volumeHandle は、スナップショットを動的に取得するボリュームの CSI "volume_id" を指定します。このフィールドは不変です。 |
13.1.3. .spec.volumeSnapshotRef
- 説明
- volumeSnapshotRef は、この VolumeSnapshotContent オブジェクトがバインドされている VolumeSnapshot オブジェクトを指定します。VolumeSnapshot.Spec.VolumeSnapshotContentName フィールドは、双方向バインディングを有効にするために、この VolumeSnapshotContent の名前を参照する必要があります。既存の VolumeSnapshotContent オブジェクトの場合にバインディングを実行するには、VolumeSnapshot オブジェクトの名前および namespace を指定する必要があります。このフィールドは、作成後は不変です。必須。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。TODO: この設計は最終版ではないので今後このフィールドは変更される可能性があります。 |
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
13.1.4. .status
- 説明
- status は、スナップショットの現在の情報を表します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
creationTime は、基盤となるストレージシステムによってポイントインタイムスナップショットが取得されたときのタイムスタンプです。動的スナップショットが作成された場合、このフィールドには、CSI "CreateSnapshot" gRPC 呼び出しから返された "creation_time" 値が CSI スナップショットサイドカーによって入力されます。既存のスナップショットで、ドライバーがサポートしている場合、このフィールドには CSI "ListSnapshots" gRPC 呼び出しから返される "creation_time" 値が入力されます。指定しない場合は、作成時刻が不明であることを示します。このフィールドの形式は、int64 としてエンコードされた Unix ナノ秒の時間です。Unix では、コマンド |
|
| error は、スナップショットの作成中に最後に観察されたエラーです (存在する場合)。再試行後に成功すると、このエラーフィールドは削除されます。 |
|
| readyToUse は、スナップショットを使用してボリュームを復元する準備ができているかどうかを示します。動的スナップショット作成の場合、このフィールドには、CSI "CreateSnapshot" gRPC 呼び出しから返された "ready_to_use" 値が CSI snapshotter サイドカーによって入力されます。既存のスナップショットの場合、ドライバーがサポートしている場合、このフィールドには CSI "ListSnapshots" gRPC 呼び出しから返される "ready_to_use" 値が入力されます。サポートされていない場合、このフィールドは "True" に設定されます。指定しない場合は、スナップショットの準備状態が不明であることを意味します。 |
|
| restoreSize は、スナップショットの完全なサイズをバイト単位で表します。動的スナップショット作成の場合、このフィールドには、CSI "CreateSnapshot" gRPC 呼び出しから返された "size_bytes" 値が CSI snapshotter サイドカーによって入力されます。既存のスナップショットで、ドライバーがサポートしている場合、このフィールドには CSI "ListSnapshots" gRPC 呼び出しから返される "size_bytes" 値が入力されます。このスナップショットからボリュームを復元する場合、ボリュームのサイズは、指定されている場合は restoreSize より小さくしてはなりません。小さくしないと、復元が失敗します。指定しない場合は、サイズが不明であることを示します。 |
|
| snapshotHandle は、基盤となるストレージシステム上のスナップショットの CSI "snapshot_id" です。指定しない場合は、動的スナップショットの作成が失敗したか、まだ進行中であることを示します。 |
|
| VolumeGroupSnapshotHandle は、基盤となるストレージシステム上のグループスナップショットの CSI "group_snapshot_id" です。 |
13.1.5. .status.error
- 説明
- error は、スナップショットの作成中に最後に観察されたエラーです (存在する場合)。再試行後に成功すると、このエラーフィールドは削除されます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| message は、指定されている場合、スナップショットの作成中に発生したエラーの詳細を示す文字列です。注: メッセージはログに記録される可能性があり、機密情報を含めることはできません。 |
|
| time は、エラーが発生したときのタイムスタンプです。 |
13.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/snapshot.storage.k8s.io/v1/volumesnapshotcontents
-
DELETE
: VolumeSnapshotContent のコレクションを削除する -
GET
: VolumeSnapshotContent 種類のオブジェクトをリスト表示する -
POST
: VolumeSnapshotContent を作成する
-
/apis/snapshot.storage.k8s.io/v1/volumesnapshotcontents/{name}
-
DELETE
: VolumeSnapshotContent を削除する -
GET
: 指定された VolumeSnapshotContent を読み取る -
PATCH
: 指定された VolumeSnapshotContent を部分的に更新する -
PUT
: 指定された VolumeSnapshotContent を置き換える
-
/apis/snapshot.storage.k8s.io/v1/volumesnapshotcontents/{name}/status
-
GET
: 指定された VolumeSnapshotContent のステータスを読み取る -
PATCH
: 指定された VolumeSnapshotContent のステータスを部分的に更新する -
PUT
: 指定された VolumeSnapshotContent のステータスを置き換える
-
13.2.1. /apis/snapshot.storage.k8s.io/v1/volumesnapshotcontents
- HTTP メソッド
-
DELETE
- 説明
- VolumeSnapshotContent のコレクションを削除する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- VolumeSnapshotContent 種類のオブジェクトをリスト表示する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- VolumeSnapshotContent を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | 空白 |
13.2.2. /apis/snapshot.storage.k8s.io/v1/volumesnapshotcontents/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| VolumeSnapshotContent の名前 |
- HTTP メソッド
-
DELETE
- 説明
- VolumeSnapshotContent を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された VolumeSnapshotContent を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された VolumeSnapshotContent の部分更新
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された VolumeSnapshotContent を置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
13.2.3. /apis/snapshot.storage.k8s.io/v1/volumesnapshotcontents/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| VolumeSnapshotContent の名前 |
- HTTP メソッド
-
GET
- 説明
- 指定された VolumeSnapshotContent の状態の読み取り
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された VolumeSnapshotContent の部分更新状況
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された VolumeSnapshotContent の状態の置き換え
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
Legal Notice
Copyright © 2024 Red Hat, Inc.
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.