第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 は、エラーが発生したときのタイムスタンプです。 |