5.4. CSI ボリュームスナップショット

1. 以下の YAML によって記述される VolumeSnapshotClass オブジェクトを使用してファイルを作成します。

   volumesnapshotclass.yaml

   apiVersion: snapshot.storage.k8s.io/v1
   kind: VolumeSnapshotClass
   metadata:
     name: csi-hostpath-snap
   driver: hostpath.csi.k8s.io 1
   deletionPolicy: Delete

   1

   この VolumeSnapshotClass オブジェクトのスナップショットを作成するために使用される CSI ドライバーの名前。名前は、スナップショットが作成される PVC に対応するストレージクラスの Provisioner フィールドと同じである必要があります。

   注記

   永続ストレージの設定に使用したドライバーによっては、追加のパラメーターが必要になる場合があります。既存の VolumeSnapshotClass オブジェクトを使用することもできます。

2. 以下のコマンドを実行して、直前の手順で保存されたオブジェクトを作成します。

   $ oc create -f volumesnapshotclass.yaml

3. VolumeSnapshot オブジェクトを作成します。

   volumesnapshot-dynamic.yaml

   apiVersion: snapshot.storage.k8s.io/v1
   kind: VolumeSnapshot
   metadata:
     name: mysnap
   spec:
     volumeSnapshotClassName: csi-hostpath-snap 1
     source:
       persistentVolumeClaimName: myclaim 2

   1

   ボリュームスナップショットによる特定クラスの要求。volumeSnapshotClassName 設定がなく、デフォルトのボリュームスナップショットクラスがある場合、スナップショットはデフォルトのボリュームスナップショットクラス名で作成されます。ただし、フィールドがなく、デフォルトのボリュームスナップショットクラスが存在しない場合には、スナップショットは作成されません。

   2

   永続ボリュームにバインドされる PersistentVolumeClaim オブジェクトの名前。これは、スナップショットの作成に使用する内容を定義します。スナップショットの動的プロビジョニングに必要です。

4. 以下のコマンドを実行して、直前の手順で保存されたオブジェクトを作成します。

   $ oc create -f volumesnapshot-dynamic.yaml

1. 上記のようにボリュームスナップショットクラスを定義するだけでなく、volumeSnapshotContentName パラメーターの値をスナップショットのソースとして指定します。

   volumesnapshot-manual.yaml

   apiVersion: snapshot.storage.k8s.io/v1
   kind: VolumeSnapshot
   metadata:
     name: snapshot-demo
   spec:
     source:
       volumeSnapshotContentName: mycontent 1

   1

   事前にプロビジョニングされたスナップショットには、volumeSnapshotContentName パラメーターが必要です。

2. 以下のコマンドを実行して、直前の手順で保存されたオブジェクトを作成します。

   $ oc create -f volumesnapshot-manual.yaml

1. 作成したボリュームスナップショットの詳細を表示するには、以下のコマンドを実行します。

   $ oc describe volumesnapshot mysnap

   以下の例は、mysnap ボリュームスナップショットの詳細を表示します。

   volumesnapshot.yaml

   apiVersion: snapshot.storage.k8s.io/v1
   kind: VolumeSnapshot
   metadata:
     name: mysnap
   spec:
     source:
       persistentVolumeClaimName: myclaim
     volumeSnapshotClassName: csi-hostpath-snap
   status:
     boundVolumeSnapshotContentName: snapcontent-1af4989e-a365-4286-96f8-d5dcd65d78d6 1
     creationTime: "2020-01-29T12:24:30Z" 2
     readyToUse: true 3
     restoreSize: 500Mi

   1

   コントローラーによって作成された実際のストレージコンテンツへのポインター。

   2

   スナップショットが作成された時間。スナップショットには、このタイミングで利用できるボリュームコンテンツが含まれます。

   3

   値が true に設定されている場合、スナップショットを使用して新規 PVC として復元できます。
   値が false に設定されている場合、スナップショットが作成されています。ただし、ストレージバックエンドは、スナップショットを新規ボリュームとして復元できるようにするために、追加のタスクを実行してスナップショットを使用できる状態にする必要があります。たとえば、Amazon Elastic Block Store データを別の低コストの場所に移動する場合があり、これには数分の時間がかかる可能性があります。

2. ボリュームのスナップショットが作成されたことを確認するには、以下のコマンドを実行します。

   $ oc get volumesnapshotcontent

   実際のコンテンツへのポインターが表示されます。boundVolumeSnapshotContentName フィールドにデータが設定される場合、VolumeSnapshotContent オブジェクトが存在し、スナップショットが作成されています。

3. スナップショットの準備が完了していることを確認するには、VolumeSnapshot オブジェクトに readyToUse: true があることを確認します。

手順

1. 以下の例のように、VolumeSnapshotClass オブジェクトで必要な削除ポリシーを指定します。

   volumesnapshotclass.yaml

   apiVersion: snapshot.storage.k8s.io/v1
   kind: VolumeSnapshotClass
   metadata:
     name: csi-hostpath-snap
   driver: hostpath.csi.k8s.io
   deletionPolicy: Delete 1

   1

   ボリュームスナップショットの削除時に Delete 値を設定すると、VolumeSnapshotContent オブジェクトと共に基礎となるスナップショットが削除されます。Retain 値を設定すると、基礎となるスナップショットと VolumeSnapshotContent オブジェクトの両方が残ります。
   Retain 値を設定し、対応する VolumeSnapshotContent オブジェクトを削除せずに VolumeSnapshot オブジェクトを削除すると、コンテンツは残ります。スナップショット自体はストレージバックエンドにも保持されます。

2. 以下のコマンドを入力してボリュームスナップショットを削除します。

   $ oc delete volumesnapshot <volumesnapshot_name>

   出力例

   volumesnapshot.snapshot.storage.k8s.io "mysnapshot" deleted

3. 削除ポリシーが Retain に設定されている場合は、以下のコマンドを入力してボリュームスナップショットのコンテンツを削除します。

   $ oc delete volumesnapshotcontent <volumesnapshotcontent_name>

4. オプション: VolumeSnapshot オブジェクトが正常に削除されていない場合は、以下のコマンドを実行して残されているリソースのファイナライザーを削除し、削除操作を続行できるようにします。

   重要

   永続ボリューム要求またはボリュームスナップショットのコンテンツのいずれかから VolumeSnapshot オブジェクトへの既存の参照がない場合にのみファイナライザーを削除します。--force オプションを使用する場合でも、すべてのファイナライザーが削除されるまで削除操作でスナップショットオブジェクトは削除されません。

   $ oc patch -n $PROJECT volumesnapshot/$NAME --type=merge -p '{"metadata": {"finalizers":null}}'

   出力例

   volumesnapshotclass.snapshot.storage.k8s.io "csi-ocs-rbd-snapclass" deleted

   ファイナライザーが削除され、ボリュームスナップショットが削除されます。

手順

1. 以下のように PVC に VolumeSnapshot データソースを指定します。

   pvc-restore.yaml

   apiVersion: v1
   kind: PersistentVolumeClaim
   metadata:
     name: myclaim-restore
   spec:
     storageClassName: csi-hostpath-sc
     dataSource:
       name: mysnap 1
       kind: VolumeSnapshot 2
       apiGroup: snapshot.storage.k8s.io 3
     accessModes:
       - ReadWriteOnce
     resources:
       requests:
         storage: 1Gi

   1

   ソースとして使用するスナップショットを表す VolumeSnapshot オブジェクトの名前。

   2

   VolumeSnapshot の値に設定する必要があります。

   3

   snapshot.storage.k8s.io の値に設定する必要があります。

2. 以下のコマンドを実行して PVC を作成します。

   $ oc create -f pvc-restore.yaml

3. 以下のコマンドを実行して、復元された PVC が作成されていることを確認します。

   $ oc get pvc

   myclaim-restore などの新規 PVC が表示されます。

手順

1. 次のコマンドを実行して、現在の config map を確認します。

   $ oc -n openshift-cluster-csi-drivers get cm/vsphere-csi-config -o yaml

   出力例

   apiVersion: v1
   data:
     cloud.conf: |+
       # Labels with topology values are added dynamically via operator
       [Global]
       cluster-id = vsphere-01-cwv8p
   
       [VirtualCenter "vcenter.openshift.com"]
       insecure-flag           = true
       datacenters             = DEVQEdatacenter
       migration-datastore-url = ds:///vmfs/volumes/vsan:527320283a8c3163-2faa6dc5949a3a28/
   
   kind: ConfigMap
   metadata:
     creationTimestamp: "2024-03-06T09:46:40Z"
     name: vsphere-csi-config
     namespace: openshift-cluster-csi-drivers
     resourceVersion: "126687"

   この例では、スナップショットのグローバル最大数は設定されていないため、デフォルト値の 3 が適用されます。

2. 次のコマンドを実行してスナップショットの制限を変更します。

   • global スナップショット制限を設定します。

     $ oc patch clustercsidriver/csi.vsphere.vmware.com --type=merge -p '{"spec":{"driverConfig":{"vSphere":{"globalMaxSnapshotsPerBlockVolume": 10}}}}'
     clustercsidriver.operator.openshift.io/csi.vsphere.vmware.com patched

     この例では、グローバル制限が 10 に変更されます (globalMaxSnapshotsPerBlockVolume が 10 に設定されています)。

   • 仮想ボリューム のスナップショット制限を設定します。

     このパラメーターは、仮想ボリュームデータストアのみに制限を設定します。仮想ボリュームの最大スナップショット制限は、設定されている場合はグローバル制約を上書きしますが、設定されていない場合はデフォルトでグローバル制限になります。

     $ oc patch clustercsidriver/csi.vsphere.vmware.com --type=merge -p '{"spec":{"driverConfig":{"vSphere":{"granularMaxSnapshotsPerBlockVolumeInVVOL": 5}}}}'
     clustercsidriver.operator.openshift.io/csi.vsphere.vmware.com patched

     この例では、仮想ボリュームの制限が 5 に変更されます (granularMaxSnapshotsPerBlockVolumeInVVOL が 5 に設定されています)。

   • vSAN スナップショットの制限を設定します。

     このパラメーターは、vSAN データストアのみに制限を設定します。vSAN の最大スナップショット制限は、設定されている場合はグローバル制約をオーバーライドしますが、設定されていない場合はデフォルトでグローバル制限になります。vSAN ESA セットアップでは、最大値 32 を設定できます。

     $ oc patch clustercsidriver/csi.vsphere.vmware.com --type=merge -p '{"spec":{"driverConfig":{"vSphere":{"granularMaxSnapshotsPerBlockVolumeInVSAN": 7}}}}'
     clustercsidriver.operator.openshift.io/csi.vsphere.vmware.com patched

     この例では、vSAN 制限が 7 に変更されます (granularMaxSnapshotsPerBlockVolumeInVSAN が 7 に設定されています)。