4.4. バックアップおよび復元

手順

1. 次のコマンドを入力して、backupStorageLocations CR を取得します。

   $ oc get backupStorageLocations

   Copy to Clipboard Toggle word wrap

   出力例

   NAME              PHASE       LAST VALIDATED   AGE   DEFAULT
   velero-sample-1   Available   11s              31m

   Copy to Clipboard Toggle word wrap

2. 次の例のように、Backup CR を作成します。

   apiVersion: velero.io/v1
   kind: Backup
   metadata:
     name: <backup>
     labels:
       velero.io/storage-location: default
     namespace: openshift-adp
   spec:
     hooks: {}
     includedNamespaces:
     - <namespace> 

   1

   
     includedResources: [] 

   2

   
     excludedResources: [] 

   3

   
     storageLocation: <velero-sample-1> 

   4

   
     ttl: 720h0m0s
     labelSelector: 

   5

   
       matchLabels:
         app=<label_1>
         app=<label_2>
         app=<label_3>
     orLabelSelectors: 

   6

   
     - matchLabels:
         app=<label_1>
         app=<label_2>
         app=<label_3>

   Copy to Clipboard Toggle word wrap

   1

   バックアップする namespace の配列を指定します。

   2

   オプション: バックアップに含めるリソースの配列を指定します。リソースは、ショートカット (Pods は po など) または完全修飾の場合があります。指定しない場合、すべてのリソースが含まれます。

   3

   オプション: バックアップから除外するリソースの配列を指定します。リソースは、ショートカット (Pods は po など) または完全修飾の場合があります。

   4

   backupStorageLocations CR の名前を指定します。

   5

   指定したラベルを すべて 持つバックアップリソースの {key,value} ペアのマップ。

   6

   指定したラベルを 1 つ以上 持つバックアップリソースの {key,value} ペアのマップ。

3. Backup CR のステータスが Completed したことを確認します。

   $ oc get backup -n openshift-adp <backup> -o jsonpath='{.status.phase}'

   Copy to Clipboard Toggle word wrap

手順

1. 次のように .yaml ファイルを作成して、Restic シークレットを設定します。

   apiVersion: v1
   kind: Secret
   metadata:
     name: <secret_name>
     namespace: openshift-adp
   type: Opaque
   stringData:
     RESTIC_PASSWORD: <secure_restic_password>

   Copy to Clipboard Toggle word wrap
   注記

   デフォルトでは、Operator は dm-credential という名前のシークレットを探します。別の名前を使用している場合は、dpa.spec.features.dataMover.credentialName を使用して、データ保護アプリケーション (DPA) CR で名前を指定する必要があります。

2. 次の例のような DPA CR を作成します。デフォルトのプラグインには CSI が含まれています。

   データ保護アプリケーション (DPA) CR の例

   apiVersion: oadp.openshift.io/v1alpha1
   kind: DataProtectionApplication
   metadata:
     name: velero-sample
     namespace: openshift-adp
   spec:
     features:
       dataMover:
         enable: true
         credentialName: <secret_name> 

   1

   
     backupLocations:
       - velero:
           config:
             profile: default
             region: us-east-1
           credential:
             key: cloud
             name: cloud-credentials
           default: true
           objectStorage:
             bucket: <bucket_name>
             prefix: <bucket_prefix>
           provider: aws
     configuration:
       restic:
         enable: <true_or_false>
       velero:
         defaultPlugins:
           - openshift
           - aws
           - csi

   Copy to Clipboard Toggle word wrap

   1

   前のステップの Restic シークレット名を追加します。これが行われない場合、デフォルトのシークレット名 dm-credential が使用されます。

   OADP Operator は、2 つのカスタムリソース定義 (CRD)、VolumeSnapshotBackup および VolumeSnapshotRestore をインストールします。

   VolumeSnapshotBackup CRD の例

   apiVersion: datamover.oadp.openshift.io/v1alpha1
   kind: VolumeSnapshotBackup
   metadata:
     name: <vsb_name>
     namespace: <namespace_name> 

   1

   
   spec:
     volumeSnapshotContent:
       name: <snapcontent_name>
     protectedNamespace: <adp_namespace>
     resticSecretRef:
       name: <restic_secret_name>

   Copy to Clipboard Toggle word wrap

   1

   ボリュームスナップショットが存在する namespace を指定します。

   VolumeSnapshotRestore CRD の例

   apiVersion: datamover.oadp.openshift.io/v1alpha1
   kind: VolumeSnapshotRestore
   metadata:
     name: <vsr_name>
     namespace: <namespace_name> 

   1

   
   spec:
     protectedNamespace: <protected_ns> 

   2

   
     resticSecretRef:
       name: <restic_secret_name>
     volumeSnapshotMoverBackupRef:
       sourcePVCData:
         name: <source_pvc_name>
         size: <source_pvc_size>
       resticrepository: <your_restic_repo>
       volumeSnapshotClassName: <vsclass_name>

   Copy to Clipboard Toggle word wrap

   1

   ボリュームスナップショットが存在する namespace を指定します。

   2

   Operator がインストールされている namespace を指定します。デフォルトは openshift-adp です。

3. 次の手順を実行して、ボリュームスナップショットをバックアップできます。

   1. バックアップ CR を作成します。

      apiVersion: velero.io/v1
      kind: Backup
      metadata:
        name: <backup_name>
        namespace: <protected_ns> 

      1

      
      spec:
        includedNamespaces:
        - <app_ns>
        storageLocation: velero-sample-1

      Copy to Clipboard Toggle word wrap

      1

      Operator がインストールされている namespace を指定します。デフォルトの namespace は openshift-adp です。

   2. 次のコマンドを入力して、最大 10 分待機し、VolumeSnapshotBackup CR のステータスが Completed かどうかを確認します。

      $ oc get vsb -n <app_ns>

      Copy to Clipboard Toggle word wrap

      $ oc get vsb <vsb_name> -n <app_ns> -o jsonpath="{.status.phase}"

      Copy to Clipboard Toggle word wrap

      DPA で設定されたオブジェクトストアにスナップショットが作成されます。

      注記

      VolumeSnapshotBackup CR のステータスが Failed になった場合は、トラブルシューティングのために Velero ログを参照してください。

4. 次の手順を実行して、ボリュームスナップショットを復元できます。

   1. アプリケーションの namespace と、Velero CSI プラグインによって作成された volumeSnapshotContent を削除します。

   2. Restore CR を作成し、restorePVs を true に設定します。

      Restore CR の例

      apiVersion: velero.io/v1
      kind: Restore
      metadata:
        name: <restore_name>
        namespace: <protected_ns>
      spec:
        backupName: <previous_backup_name>
        restorePVs: true

      Copy to Clipboard Toggle word wrap

   3. 最大 10 分間待機し、次のコマンドを入力して、VolumeSnapshotRestore CR ステータスが Completed であるかどうかを確認します。

      $ oc get vsr -n <app_ns>

      Copy to Clipboard Toggle word wrap

      $ oc get vsr <vsr_name> -n <app_ns> -o jsonpath="{.status.phase}"

      Copy to Clipboard Toggle word wrap

   4. アプリケーションデータとリソースが復元されたかどうかを確認します。

      注記

      VolumeSnapshotRestore CR のステータスが失敗になった場合は、トラブルシューティングのために Velero ログを参照してください。

手順

1. backupStorageLocations CR を取得します。

   $ oc get backupStorageLocations

   Copy to Clipboard Toggle word wrap

   出力例

   NAME              PHASE       LAST VALIDATED   AGE   DEFAULT
   velero-sample-1   Available   11s              31m

   Copy to Clipboard Toggle word wrap

2. 次の例のように、Schedule CR を作成します。

   $ cat << EOF | oc apply -f -
   apiVersion: velero.io/v1
   kind: Schedule
   metadata:
     name: <schedule>
     namespace: openshift-adp
   spec:
     schedule: 0 7 * * * 

   1

   
     template:
       hooks: {}
       includedNamespaces:
       - <namespace> 

   2

   
       storageLocation: <velero-sample-1> 

   3

   
       defaultVolumesToRestic: true 

   4

   
       ttl: 720h0m0s
   EOF

   Copy to Clipboard Toggle word wrap

   1

   バックアップをスケジュールするための cron 式。たとえば、毎日 7:00 にバックアップを実行する場合は 0 7 * * * です。

   2

   バックアップを作成する namespace の配列。

   3

   backupStorageLocations CR の名前。

   4

   オプション: Restic を使用してボリュームをバックアップする場合は、キーと値のペア defaultVolumesToRestic: true を追加します。

3. スケジュールされたバックアップの実行後に、Schedule CR のステータスが Completed となっていることを確認します。

   $ oc get schedule -n openshift-adp <schedule> -o jsonpath='{.status.phase}'

   Copy to Clipboard Toggle word wrap

手順

1. 次の例のように、Restore CR を作成します。

   apiVersion: velero.io/v1
   kind: Restore
   metadata:
     name: <restore>
     namespace: openshift-adp
   spec:
     backupName: <backup> 

   1

   
     includedResources: [] 

   2

   
     excludedResources:
     - nodes
     - events
     - events.events.k8s.io
     - backups.velero.io
     - restores.velero.io
     - resticrepositories.velero.io
     restorePVs: true 

   3

   Copy to Clipboard Toggle word wrap

   1

   Backup CR の名前

   2

   オプション: 復元プロセスに含めるリソースの配列を指定します。リソースは、ショートカット (Pods は po など) または完全修飾の場合があります。指定しない場合、すべてのリソースが含まれます。

   3

   オプション: RestorePVs パラメーターを false に設定すると、コンテナーストレージインターフェイス (CSI) スナップショットの VolumeSnapshot から、または VolumeSnaphshotLocation が設定されている場合はネイティブスナップショットからの PersistentVolumes の復元をオフにすることができます。

2. 次のコマンドを入力して、Restore CR のステータスが Completed であることを確認します。

   $ oc get restore -n openshift-adp <restore> -o jsonpath='{.status.phase}'

   Copy to Clipboard Toggle word wrap

3. 次のコマンドを入力して、バックアップリソースが復元されたことを確認します。

   $ oc get all -n <namespace> 

   1

   Copy to Clipboard Toggle word wrap

   1

   バックアップした namespace。

4. Restic を使用して DeploymentConfig オブジェクトを復元する場合、または復元後のフックを使用する場合は、次のコマンドを入力して dc-restic-post-restore.sh クリーンアップスクリプトを実行します。

   $ bash dc-restic-post-restore.sh <restore-name>

   Copy to Clipboard Toggle word wrap
   注記

   復元プロセスの過程で、OADP Velero プラグインは、DeploymentConfig オブジェクトをスケールダウンし、Pod をスタンドアロン Pod として復元して、クラスターが復元された DeploymentConfig Pod を復元時にすぐに削除しないようにし、Restic および復元後のフックを完了できるようにします。復元された Pod でのアクション。クリーンアップスクリプトは、これらの切断された Pod を削除し、DeploymentConfig オブジェクトを適切な数のレプリカに戻します。

   例4.1 dc-restic-post-restore.sh クリーンアップスクリプト

   #!/bin/bash
   set -e
   
   # if sha256sum exists, use it to check the integrity of the file
   if command -v sha256sum >/dev/null 2>&1; then
     CHECKSUM_CMD="sha256sum"
   else
     CHECKSUM_CMD="shasum -a 256"
   fi
   
   label_name () {
       if [ "${#1}" -le "63" ]; then
   	echo $1
   	return
       fi
       sha=$(echo -n $1|$CHECKSUM_CMD)
       echo "${1:0:57}${sha:0:6}"
   }
   
   OADP_NAMESPACE=${OADP_NAMESPACE:=openshift-adp}
   
   if [[ $# -ne 1 ]]; then
       echo "usage: ${BASH_SOURCE} restore-name"
       exit 1
   fi
   
   echo using OADP Namespace $OADP_NAMESPACE
   echo restore: $1
   
   label=$(label_name $1)
   echo label: $label
   
   echo Deleting disconnected restore pods
   oc delete pods -l oadp.openshift.io/disconnected-from-dc=$label
   
   for dc in $(oc get dc --all-namespaces -l oadp.openshift.io/replicas-modified=$label -o jsonpath='{range .items[*]}{.metadata.namespace}{","}{.metadata.name}{","}{.metadata.annotations.oadp\.openshift\.io/original-replicas}{","}{.metadata.annotations.oadp\.openshift\.io/original-paused}{"\n"}')
   do
       IFS=',' read -ra dc_arr <<< "$dc"
       if [ ${#dc_arr[0]} -gt 0 ]; then
   	echo Found deployment ${dc_arr[0]}/${dc_arr[1]}, setting replicas: ${dc_arr[2]}, paused: ${dc_arr[3]}
   	cat <<EOF | oc patch dc  -n ${dc_arr[0]} ${dc_arr[1]} --patch-file /dev/stdin
   spec:
     replicas: ${dc_arr[2]}
     paused: ${dc_arr[3]}
   EOF
       fi
   done

   Copy to Clipboard Toggle word wrap