5.13. OpenShift Virtualization を使用した OADP の設定

手順

1. ストレージプロバイダーの指示に従って、OADP Operator をインストールします。
2. kubevirt および openshift OADP プラグインを使用して Data Protection Application (DPA) をインストールします。

3. Backup カスタムリソース (CR) を作成して、仮想マシンをバックアップします。

   警告

   Red Hat のサポート対象は、次のオプションに限られています。

   • CSI バックアップ
   • DataMover による CSI バックアップ

   Restore CR を作成して Backup CR を復元します。

手順

1. Ecosystem Installed Operators をクリックし、OADPOperator を選択します。
2. Provided APIs で、DataProtectionApplication ボックスの Create instance をクリックします。

3. YAML View をクリックして、DataProtectionApplication マニフェストのパラメーターを更新します。

   apiVersion: oadp.openshift.io/v1alpha1
   kind: DataProtectionApplication
   metadata:
     name: <dpa_sample>
     namespace: openshift-adp
   spec:
     configuration:
       velero:
         defaultPlugins:
           - kubevirt
           - gcp
           - csi
           - openshift
         resourceTimeout: 10m
       nodeAgent:
         enable: true
         uploaderType: kopia
         podConfig:
           nodeSelector: <node_selector>
     backupLocations:
       - velero:
           provider: gcp
           default: true
           credential:
             key: cloud
             name: <default_secret>
           objectStorage:
             bucket: <bucket_name>
             prefix: <prefix>

   ここでは、以下のようになります。

   namespace

   OADP のデフォルトの名前空間である openshift-adp を指定します。namespace は変数であり、設定可能です。

   kubevirt

   OpenShift 仮想化には kubevirt プラグインが必須であることを指定します。

   gcp

   バックアッププロバイダー (例: gcp) 用のプラグインを指定します (存在する場合)。

   csi

   CSI スナップショットを使用して PV をバックアップするには、csi プラグインが必須であることを指定します。csi プラグインは、Velero CSI ベータスナップショット API を使用します。スナップショットの場所を設定する必要はありません。

   openshift

   openshift プラグインが必須であることを指定します。

   リソースタイムアウト

   Velero CRD の可用性、ボリュームスナップショットの削除、バックアップリポジトリーの可用性など、複数の Velero リソースについてタイムアウトが発生するまでの待機時間を分単位で指定します。デフォルトは 10m です。

   ノードエージェント

   管理要求をサーバーにルーティングする管理エージェントを指定します。

   enable

   nodeAgent を有効にして File System Backup を実行する場合は、この値を true に設定します。

   アップローダータイプ

   アップローダーの種類を指定します。組み込み DataMover を使用するには、アップローダーとして kopia と入力します。nodeAgent はデーモンセットをデプロイします。これは、nodeAgent Pod が各ワーキングノード上で実行されることを意味します。File System Backup を設定するには、spec.defaultVolumesToFsBackup: true を Backup CR に追加します。

   nodeSelector

   Kopia が利用可能なノードを指定します。デフォルトでは、Kopia はすべてのノードで実行されます。

   provider

   バックアッププロバイダーを指定します。

   name

   バックアッププロバイダーにデフォルトのプラグインを使用する場合、シークレット の正しいデフォルト名を指定します。たとえば、cloud-credentials-gcp など です。カスタム名を指定すると、そのカスタム名がバックアップの場所に使用されます。Secret 名を指定しない場合は、デフォルトの名前が使用されます。

   bucket

   バックアップの保存場所としてバケットを指定します。バケットが Velero バックアップ専用のバケットでない場合は、接頭辞を指定する必要があります。

   prefix

   バケットが複数の用途で使用される場合、Velero バックアップのプレフィックスを指定します。たとえば、velero など です。

4. Create をクリックします。

検証

1. 次のコマンドを実行して OpenShift API for Data Protection (OADP) リソースを表示し、インストールを検証します。

   $ oc get all -n openshift-adp

   NAME                                                     READY   STATUS    RESTARTS   AGE
   pod/oadp-operator-controller-manager-67d9494d47-6l8z8    2/2     Running   0          2m8s
   pod/node-agent-9cq4q                                     1/1     Running   0          94s
   pod/node-agent-m4lts                                     1/1     Running   0          94s
   pod/node-agent-pv4kr                                     1/1     Running   0          95s
   pod/velero-588db7f655-n842v                              1/1     Running   0          95s
   
   NAME                                                       TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)    AGE
   service/oadp-operator-controller-manager-metrics-service   ClusterIP   172.30.70.140    <none>        8443/TCP   2m8s
   service/openshift-adp-velero-metrics-svc                   ClusterIP   172.30.10.0      <none>        8085/TCP   8h
   
   NAME                        DESIRED   CURRENT   READY   UP-TO-DATE   AVAILABLE   NODE SELECTOR   AGE
   daemonset.apps/node-agent    3         3         3       3            3           <none>          96s
   
   NAME                                                READY   UP-TO-DATE   AVAILABLE   AGE
   deployment.apps/oadp-operator-controller-manager    1/1     1            1           2m9s
   deployment.apps/velero                              1/1     1            1           96s
   
   NAME                                                           DESIRED   CURRENT   READY   AGE
   replicaset.apps/oadp-operator-controller-manager-67d9494d47    1         1         1       2m9s
   replicaset.apps/velero-588db7f655                              1         1         1       96s

2. 次のコマンドを実行して、DataProtectionApplication (DPA) が調整されていることを確認します。

   $ oc get dpa dpa-sample -n openshift-adp -o jsonpath='{.status}'

   {"conditions":[{"lastTransitionTime":"2023-10-27T01:23:57Z","message":"Reconcile complete","reason":"Complete","status":"True","type":"Reconciled"}]}

3. type が Reconciled に設定されていることを確認します。

4. 次のコマンドを実行して、Backup Storage Location を確認し、PHASE が Available であることを確認します。

   $ oc get backupstoragelocations.velero.io -n openshift-adp

   NAME           PHASE       LAST VALIDATED   AGE     DEFAULT
   dpa-sample-1   Available   1s               3d16h   true

手順

1. 次の例に示すように、Backup CR を設定します。

   Backup CR の例

   apiVersion: velero.io/v1
   kind: Backup
   metadata:
     name: vmbackupsingle
     namespace: openshift-adp
   spec:
     snapshotMoveData: true
     includedNamespaces:
     - <vm_namespace>
     labelSelector:
       matchLabels:
         app: <vm_app_name>
     storageLocation: <backup_storage_location_name>

   ここでは、以下のようになります。

   vm_namespace

   仮想マシンを作成した名前空間の名前を指定します。

   vm_app_name

   バックアップが必要な仮想マシン名を指定します。

   バックアップストレージの場所名

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

2. Backup CR を作成するには、次のコマンドを実行します。

   $ oc apply -f <backup_cr_file_name>

   ここでは、以下のようになります。

   バックアップ CR ファイル名

   バックアップ CR ファイルの名前を指定します。

手順

1. 次の例に示すように、Restore CR を設定します。

   Restore CR の例

   apiVersion: velero.io/v1
   kind: Restore
   metadata:
     name: vmrestoresingle
     namespace: openshift-adp
   spec:
     backupName: vmbackupsingle
     restorePVs: true

   ここでは、以下のようになります。

   VM バックアップシングル

   1 つの仮想マシンのバックアップ名を指定します。

2. 1 つの仮想マシンを復元するには、次のコマンドを実行します。

   $ oc apply -f <restore_cr_file_name>

   ここでは、以下のようになります。

   復元 CR ファイル名

   復元 CR ファイルの名前を指定します。

   注記

   仮想マシンのバックアップを復元すると、復元に割り当てられた Ceph Storage 容量が予想よりも高いことに気付く場合があります。この動作は、kubevirt の復元中、および仮想マシンのボリュームタイプが block の場合にのみ発生します。

   rbd sparsify ツールを使用して、ターゲットボリューム上のスペースを再利用します。詳細は、ターゲットボリューム上のスペースの再利用 を参照してください。

手順

1. 多数の仮想マシンのバックアップを作成する前に、次のコマンドを実行して仮想マシンにラベルが付けられていることを確認します。

   $ oc label vm <vm_name> app=<vm_name> -n openshift-adp

2. 次の例に示すように、Restore CR でラベルセレクターを設定します。

   Restore CR の例

   apiVersion: velero.io/v1
   kind: Restore
   metadata:
     name: singlevmrestore
     namespace: openshift-adp
   spec:
     backupName: multiplevmbackup
     restorePVs: true
     LabelSelectors:
       - matchLabels:
           kubevirt.io/created-by: <datavolume_uid>
       - matchLabels:
           app: <vm_name>

   ここでは、以下のようになります。

   データボリューム UID

   復元する仮想マシンの データボリューム の UID を指定します。たとえば、b6…​53a-ddd7-4d9d-9407-a0c…​e5 です。

   VM 名

   復元したい仮想マシンの名前を指定します。たとえば、test-vm です。

3. 仮想マシンを復元するには、次のコマンドを実行します。

   $ oc apply -f <restore_cr_file_name>

   ここでは、以下のようになります。

   復元 CR ファイル名

   復元 CR ファイルの名前を指定します。

検証

1. 次のコマンドを実行して、ノードエージェントのセキュリティーコンテキストが非 root として実行するように設定され、root ファイルシステムが readOnly あることを確認します。

   $ oc get daemonset node-agent -o yaml

   出力例は次のとおりです。

   apiVersion: apps/v1
   kind: DaemonSet
   metadata:
     ...
     name: node-agent
     namespace: openshift-adp
     ...
   spec:
     ...
     template:
       metadata:
         ...
       spec:
         containers:
         ...
           securityContext:
             allowPrivilegeEscalation: false
             capabilities:
               drop:
               - ALL
             privileged: false
             readOnlyRootFilesystem: true
           ...
         nodeSelector:
           kubernetes.io/os: linux
         os:
           name: linux
         restartPolicy: Always
         schedulerName: default-scheduler
         securityContext:
           runAsNonRoot: true
           seccompProfile:
             type: RuntimeDefault
         serviceAccount: velero
         serviceAccountName: velero
         ....

   ここでは、以下のようになります。

   allowPrivilegeEscalation

   allowPrivilegeEscalation フィールドが false であることを指定します。

   privileged

   特権 フィールドが false であることを指定します。

   readOnlyRootFilesystem

   ルートファイルシステムが読み取り専用であることを指定します。

   runAsNonRoot

   ノードエージェントを非 root ユーザーとして実行することを指定します。

手順

1. カスタムラベルを追加して、選択した任意のノードでノードエージェントを実行します。

   $ oc label node/<node_name> node-role.kubernetes.io/nodeAgent=""

   注記

   指定したラベルが、各ノードのラベルと一致する必要があります。

2. ノードのラベル付けに使用したのと同じカスタムラベルを DPA.spec.configuration.nodeAgent.podConfig.nodeSelector フィールドで使用します。

   configuration:
     nodeAgent:
       enable: true
       podConfig:
         nodeSelector:
           node-role.kubernetes.io/nodeAgent: ""

   次の例は nodeSelector のアンチパターンです。この例は、node-role.kubernetes.io/infra: "" と node-role.kubernetes.io/worker: "" の両方のラベルがノードに存在しない限り機能しません。

       configuration:
         nodeAgent:
           enable: true
           podConfig:
             nodeSelector:
               node-role.kubernetes.io/infra: ""
               node-role.kubernetes.io/worker: ""

手順

1. 特定のノードに対して同時実行を使用する場合は、それらのノードにラベルを追加します。

   $ oc label node/<node_name> label.io/instance-type='large'

2. DPA インスタンスの同時実行フィールドを設定します。

     configuration:
       nodeAgent:
         enable: true
         uploaderType: kopia
         loadConcurrency:
           globalConfig: 1
           perNodeConfig:
           - nodeSelector:
                 matchLabels:
                    label.io/instance-type: large
             number: 3

   ここでは、以下のようになります。

   globalConfig

   グローバル同時接続数を指定します。デフォルト値は 1 です。これは同時実行がなく、1 つの負荷のみが許可されることを意味します。globalConfig 値に制限はありません。

   label.io/instance-type

   ノードごとの同時実行性を示すラベルを指定します。

   number

   ノードごとの同時接続数を指定します。たとえば、インスタンスのタイプとサイズに基づき、ノードごとに多数の同時実行数を指定できます。ノードごとの同時実行数の範囲は、グローバル同時実行数と同じです。設定ファイルにノードごとの同時実行数とグローバル同時実行数が含まれている場合、ノードごとの同時実行数が優先されます。