5.8. IBM Cloud を使用した OADP の設定

手順

1. 次のコマンドを実行して、IBM Cloud Object Storage (COS) プラグインをインストールします。

   $ ibmcloud plugin install cos -f

2. 次のコマンドを実行してバケット名を設定します。

   $ BUCKET=<bucket_name>

3. 次のコマンドを実行してバケットリージョンを設定します。

   $ REGION=<bucket_region>

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

   <bucket_region>

   バケットリージョンを指定します。たとえば、eu-gb。

4. 次のコマンドを実行してリソースグループを作成します。

   $ ibmcloud resource group-create <resource_group_name>

5. 次のコマンドを実行して、ターゲットリソースグループを設定します。

   $ ibmcloud target -g <resource_group_name>

6. 次のコマンドを実行して、ターゲットリソースグループが正しく設定されていることを確認します。

   $ ibmcloud target

   出力例

   API endpoint:     https://cloud.ibm.com
   Region:
   User:             test-user
   Account:          Test Account (fb6......e95) <-> 2...122
   Resource group:   Default

   出力例では、リソースグループは Default に設定されています。

7. 次のコマンドを実行してリソースグループ名を設定します。

   $ RESOURCE_GROUP=<resource_group>

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

   < リソースグループ >

   リソースグループ名を指定します。たとえば、default。

8. 次のコマンドを実行して、IBM Cloud service-instance リソースを作成します。

   $ ibmcloud resource service-instance-create \
   <service_instance_name> \
   <service_name> \
   <service_plan> \
   <region_name>

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

   < サービスインスタンス名 >

   サービスインスタンス リソースの名前を指定します。

   < サービス名 >

   サービス名を指定します。または、サービス ID を指定することもできます。

   < サービスプラン >

   IBM Cloud アカウントのサービスプランを指定します。

   < 地域名 >

   リージョン名を指定します。

   以下のコマンド例を参照してください。

   $ ibmcloud resource service-instance-create test-service-instance cloud-object-storage \
   standard \
   global \
   -d premium-global-deployment

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

   クラウドオブジェクトストレージ

   サービス名を指定します。

   -d プレミアムグローバルデプロイメント

   デプロイメント名を指定します。

9. 次のコマンドを実行して、サービスインスタンス ID を抽出します。

   $ SERVICE_INSTANCE_ID=$(ibmcloud resource service-instance test-service-instance --output json | jq -r '.[0].id')

10. 次のコマンドを実行して COS バケットを作成します。

    $ ibmcloud cos bucket-create \
    --bucket $BUCKET \
    --ibm-service-instance-id $SERVICE_INSTANCE_ID \
    --region $REGION

    $BUCKET、$SERVICE_INSTANCE_ID、$REGION などの変数は、以前に設定した値に置き換えられます。

11. 次のコマンドを実行して HMAC 認証情報を作成します。

    $ ibmcloud resource service-key-create test-key Writer --instance-name test-service-instance --parameters {\"HMAC\":true}

12. HMAC 認証情報からアクセスキー ID とシークレットアクセスキーを抽出し、credentials-velero ファイルに保存します。credentials-velero ファイルを使用して、Backup Storage Location の secret を作成できます。以下のコマンドを実行します。

    $ cat > credentials-velero << __EOF__
    [default]
    aws_access_key_id=$(ibmcloud resource service-key test-key -o json  | jq -r '.[0].credentials.cos_hmac_keys.access_key_id')
    aws_secret_access_key=$(ibmcloud resource service-key test-key -o json  | jq -r '.[0].credentials.cos_hmac_keys.secret_access_key')
    __EOF__

手順

1. Backup Storage Location の credentials-velero ファイルをクラウドプロバイダーに適した形式で作成します。

2. デフォルト名で Secret カスタムリソース (CR) を作成します。

   $ oc create secret generic cloud-credentials -n openshift-adp --from-file cloud=credentials-velero

   Secret は、Data Protection Application をインストールするときに、DataProtectionApplication CR の spec.backupLocations.credential ブロックで参照されます。

手順

1. スナップショットの場所の credentials-velero ファイルをクラウドプロバイダーに適した形式で作成します。

2. デフォルト名でスナップショットの場所の Secret を作成します。

   $ oc create secret generic cloud-credentials -n openshift-adp --from-file cloud=credentials-velero

3. オブジェクトストレージに適した形式で、バックアップロケーションの credentials-velero ファイルを作成します。

4. カスタム名を使用してバックアップロケーションの Secret を作成します。

   $ oc create secret generic <custom_secret> -n openshift-adp --from-file cloud=credentials-velero

5. 次の例のように、カスタム名の Secret を DataProtectionApplication に追加します。

   apiVersion: oadp.openshift.io/v1alpha1
   kind: DataProtectionApplication
   metadata:
     name: <dpa_sample>
     namespace: openshift-adp
   spec:
   ...
     backupLocations:
       - velero:
           provider: <provider>
           default: true
           credential:
             key: cloud
             name: <custom_secret>
           objectStorage:
             bucket: <bucket_name>
             prefix: <prefix>

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

   カスタムシークレット

   バックアップ場所を指定する Secret に、カスタム名を指定します。

手順

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

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

   apiVersion: oadp.openshift.io/v1alpha1
   kind: DataProtectionApplication
   metadata:
     namespace: openshift-adp
     name: <dpa_name>
   spec:
     configuration:
       velero:
         defaultPlugins:
         - openshift
         - aws
         - csi
     backupLocations:
       - velero:
           provider: aws
           default: true
           objectStorage:
             bucket: <bucket_name>
             prefix: velero
           config:
             insecureSkipTLSVerify: 'true'
             profile: default
             region: <region_name>
             s3ForcePathStyle: 'true'
             s3Url: <s3_url>
           credential:
             key: cloud
             name: cloud-credentials

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

   provider

   IBM Cloud をバックアップストレージの場所として使用する場合に、プロバイダーが aws であることを指定します。

   bucket

   IBM Cloud Object Storage (COS) バケット名を指定します。

   region

   COS リージョン名を指定します。例: eu-gb。

   s3Url

   COS バケットの S3 URL を指定します。たとえば、http://s3.eu-gb.cloud-object-storage.appdomain.cloud です。ここで、eu-gb はリージョン名です。バケットのリージョンに応じてリージョン名を置き換えます。

   name

   HMAC 認証情報に含まれるアクセスキーとシークレットアクセスキーを使用して作成したシークレットの名前を指定します。

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. カスタムラベルを追加して、選択した任意のノードでノードエージェントを実行します。

   $ 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

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

手順

1. 複数の BackupStorageLocation CR を使用して DataProtectionApplication CR を設定します。以下の例を参照してください。

   DPA の例

   apiVersion: oadp.openshift.io/v1alpha1
   kind: DataProtectionApplication
   #...
   backupLocations:
     - name: aws
       velero:
         provider: aws
         default: true
         objectStorage:
           bucket: <bucket_name>
           prefix: <prefix>
         config:
           region: <region_name>
           profile: "default"
         credential:
           key: cloud
           name: cloud-credentials
     - name: odf
       velero:
         provider: aws
         default: false
         objectStorage:
           bucket: <bucket_name>
           prefix: <prefix>
         config:
           profile: "default"
           region: <region_name>
           s3Url: <url>
           insecureSkipTLSVerify: "true"
           s3ForcePathStyle: "true"
         credential:
           key: cloud
           name: <custom_secret_name_odf>
   #...

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

   名前: aws

   最初の BSL の名前を指定します。

   デフォルト: true

   この BSL がデフォルトの BSL であることを示します。Backup CR に BSL が設定されていない場合は、デフォルトの BSL が使用されます。デフォルトとして設定できる BSL は 1 つだけです。

   <bucket_name>

   バケット名を指定します。

   <prefix>

   Velero バックアップのプレフィックスを指定します。たとえば、velero。

   < 地域名 >

   バケットの AWS リージョンを指定します。

   クラウド認証情報

   作成したデフォルトの Secret オブジェクトの名前を指定します。

   名前: odf

   2 番目の BSL の名前を指定します。

   <url>

   S3 エンドポイントの URL を指定します。

   <custom_secret_name_odf>

   シークレット の正しい名前を指定します。たとえば、custom_secret_name_odf。Secret 名を指定しない場合は、デフォルトの名前が使用されます。

2. バックアップ CR で使用する BSL を指定します。以下の例を参照してください。

   バックアップ CR の例

   apiVersion: velero.io/v1
   kind: Backup
   # ...
   spec:
     includedNamespaces:
     - <namespace>
     storageLocation: <backup_storage_location>
     defaultVolumesToFsBackup: true

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

   <namespace>

   バックアップする名前空間を指定します。

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

   保存場所を指定します。

手順

1. nodeAgent を無効にするには、enable フラグを false に設定します。以下の例を参照してください。

   DataProtectionApplication CR の例

   # ...
   configuration:
     nodeAgent:
       enable: false
       uploaderType: kopia
   # ...

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

   enable

   ノードエージェントを有効にします。

2. nodeAgent を有効にするには、enable フラグを true に設定します。以下の例を参照してください。

   DataProtectionApplication CR の例

   # ...
   configuration:
     nodeAgent:
       enable: true
       uploaderType: kopia
   # ...

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

   enable

   ノードエージェントを有効にします。

   ジョブをセットアップして、DataProtectionApplication CR の nodeAgent フィールドを有効または無効にすることができます。詳細は、「ジョブの使用による Pod でのタスクの実行」を参照してください。