Container Service for Kubernetes:kubectl を使用したクラスター内アプリケーションのバックアップと復元

適用範囲/利用シーン

• 権限が不足しているため、Container Service コンソールからバックアップセンターを管理できません。

• ディザスタリカバリおよびバックアップのワークフローを自動化する場合。

注意事項

• バックアップおよび復元タスクは、kubectl の delete コマンドで単純に削除することはできません。詳細については、「手順 4：クラスターバックアップセンターに関連するリソースの削除」をご参照ください。

• migrate-controller コンポーネントを最新の状態に保ってください。詳細については、「コンポーネントの管理」をご参照ください。

• 以下のコード例に記載されている構成パラメーターを削除すると、バックアップおよび復元処理が失敗する可能性があります。

手順 1：バックアップリポジトリの作成

1. バックアップクラスターおよび復元クラスターで、以下の内容を使用して backuplocation.yaml ファイルを作成します。

   apiVersion: csdr.alibabacloud.com/v1beta1
   kind: BackupLocation
   metadata:
     name: <your-backup-location-name>
     namespace: csdr
   spec:
     backupSyncPeriod: 0s
     config:
       network: internal
       region: cn-beijing
     objectStorage:
       bucket: <cnfs-oss-your-bucket-name>
       prefix: <your-subdirectory-name>
     provider: alibabacloud

   その他のパラメーターはデフォルト設定のままにしてください。

   パラメーター	必須	説明
   name	はい	バックアップリポジトリの名前です。この名前は Kubernetes の命名規則に従う必要があります。
   network	はい	OSS バケットへのネットワークアクセスモードです。有効な値は以下のとおりです。 internal：内部アクセスモード。関連付けられたすべてのクラスターおよび OSS バケットは同一リージョン内に存在する必要があります。 public：パブリックアクセスモード。リージョンに関する制限はありません。
   region	はい	OSS バケットが配置されているリージョンです。
   bucket	はい	OSS バケットの名前です。このバケットは事前に作成済みである必要があります。また、名前の先頭は cnfs-oss- で始める必要があります。
   prefix	いいえ	OSS バケット内の任意のサブディレクトリです。指定した場合、バックアップファイルはこのサブディレクトリに保存されます。

2. バックアップクラスターおよび復元クラスターで、以下のコマンドを実行して backuplocation オブジェクトをデプロイします。

   kubectl apply -f backuplocation.yaml

3. バックアップクラスターおよび復元クラスターで、それぞれ以下のコマンドを実行して backuplocation のステータスを確認します。

   kubectl describe backuplocation <your-backup-location-name> -n csdr

   期待される出力は以下のとおりです。

   ...
   Status:
     Last Validation Time:  2022-12-08T04:00:22Z
     Message:               success by csdr-controller
     Phase:                 Available

   上記の期待される出力に示すように、作成されたバックアップリポジトリのステータスは Available であり、これは現在のクラスターが OSS に直接アクセスする権限を持つことを示しています。

手順 2：バックアップジョブの作成

手順 3：復元タスクの作成

1. 復元クラスターで、以下の内容を使用して applicationrestore.yaml ファイルを作成します。

   apiVersion: csdr.alibabacloud.com/v1beta1
   kind: ApplicationRestore
   metadata:
     annotations:    
       csdr.alibabacloud.com/backuplocations: >-
         {"name":"<your-backup-repository-name>","region":"cn-beijing","bucket":"<your-oss-bucket-name>","prefix":"<your-subdirectory-name>","provider":"alibabacloud"}
     name: <your-application-restore-name>
     namespace: csdr
   spec:
     appRestoreOnly: false
     preserveNodePorts: true
     includedNamespaces:
       - default
     includedResources:
       - statefulset
     excludedResources:
       - secret
     convertedarg:
     - convertToStorageClassType: alicloud-disk-topology-alltype
       convertToAccessModes:
       - ReadWriteOnce
       namespace: nas
       persistentVolumeClaim: pvc-nas
     - convertToStorageClassType: alicloud-disk-topology-alltype
       namespace: oss
       persistentVolumeClaim: pvc-oss
     backupName: <your-application-backup-name>
     namespaceMapping:
       <source-namespace>: <target-namespace>
     imageRegistryMapping:
       <old-image-registry>: <new-image-registry>

   その他のパラメーターはデフォルト設定のままにしてください。

   説明

   appRestoreOnly、preserveNodePorts、includedResources、および excludedResources パラメーターは、アプリケーションバックアップでのみサポートされ、データ保護のシナリオでは機能しません。

   パラメーター	必須	説明
   csdr.alibabacloud.com/backuplocations	はい	バックアップが格納されているバックアップリポジトリを指定します。これはリポジトリの構成と一致する必要があります。
   name	はい	復元タスクの名前です。
   appRestoreOnly	いいえ	このパラメーターはアプリケーションバックアップジョブにのみ適用され、データ保護のシナリオでは機能しません。 永続ボリューム（PV）を含むバックアップの場合、このパラメーターは、関連付けられた永続ボリューム要求（PVC）、PV、およびボリュームデータを復元せずにアプリケーションのみを復元するかどうかを指定します。有効な値は以下のとおりです。 true：アプリケーションのみを復元します。バックアップされたアプリケーションのデータソースを変更する必要がある場合は、まず手動で PVC および PV を作成し、その後このパラメーターを true に設定した復元タスクを作成します。 false：アプリケーションおよび関連するストレージデータの両方を復元します。これがデフォルト値です。
   preserveNodePorts	いいえ	このパラメーターはアプリケーションバックアップジョブにのみ適用され、データ保護のシナリオでは機能しません。 バックアップおよび復元クラスターが同一の場合、デフォルト値は false です。これにより、ポートの競合を回避するためにランダムなポート値が割り当てられます。それ以外の場合は、この値を true に設定します。
   includedNamespaces	はい	復元対象の名前空間を指定します。空欄の場合は、バックアップされたすべての名前空間が復元されます。
   includedResources	いいえ	このパラメーターはアプリケーションバックアップジョブにのみ適用され、データ保護のシナリオでは機能しません。 復元対象のクラスターリソースタイプを指定します。 重要 予期しない復元結果を回避するため、includedResources または excludedResources のいずれか一方のみを設定してください。両方のパラメーターが空欄の場合、バックアップされたすべてのリソースタイプが復元されます。
   excludedResources	いいえ	このパラメーターはアプリケーションバックアップジョブにのみ適用され、データ保護のシナリオでは機能しません。 復元対象外のクラスターリソースタイプを指定します。 重要 予期しない復元結果を回避するため、includedResources または excludedResources のいずれか一方のみを設定してください。両方のパラメーターが空欄の場合、バックアップされたすべてのリソースタイプが復元されます。
   backupName	はい	復元対象のバックアップの名前です。スケジュールバックアップ機能を使用する場合、ポイントインタイムバックアップの名前（例：<yourBackupScheduleName>-20221205225845）を指定する必要があります。
   namespaceMapping	いいえ	名前空間を再マップします。有効な値は以下のとおりです。 <backupNamespace>：バックアップタスク作成時に指定したバックアップクラスターの名前空間です。 <restoreNamespace>：バックアップから復元されるリソースの復元先となる復元クラスターの名前空間です。このパラメーターが設定されていない場合、デフォルトで同名の名前空間に復元されます。 説明 <target-namespace> が存在しない場合、新しい名前空間が作成されます。
   imageRegistryMapping	いいえ	イメージレジストリアドレスを再マップします。これは、復元されたアプリケーション内のすべてのイメージについて、アドレスがソースプレフィックスと一致する場合に適用されます。有効な値は以下のとおりです。 <oldImageRegistry>：バックアップ内のアプリケーションの元のイメージレジストリアドレスです。 <newImageRegistry>：復元先のイメージレジストリのアドレスです。このパラメーターを設定しない場合、アプリケーション内のイメージの構成は変更されません。 例： 元のクラスターアプリケーションで使用されるイメージは registry.cn-beijing.aliyuncs.com/my-registry/nginx:v1 であり、これを registry.cn-hangzhou.aliyuncs.com/my-registry/nginx:v1 に変更する必要があります。このフィールドは以下のように構成します。 imageRegistryMapping: "registry.cn-beijing.aliyuncs.com/my-registry/": "registry.cn-hangzhou.aliyuncs.com/my-registry/"
   convertedarg	いいえ	ストレージクラスの変換リストです。これにより、FileSystem 型ボリューム（Object Storage Service (OSS)、Apsara File Storage NAS、CPFS、ローカル記憶域など）のバックアップから、現在のクラスター上のターゲットストレージクラスへ永続ボリューム要求（PVC）を復元できます。たとえば、Apsara File Storage NAS をクラウドディスクに変換できます。 convertToStorageClassType：ターゲットストレージクラスです。これは現在のクラスターにすでに存在している必要があります。現在のバージョンでは、クラウドディスクまたは Apsara File Storage NAS のストレージクラスのみがサポートされています。 namespace：永続ボリューム要求（PVC）が配置されている名前空間です。 persistentVolumeClaim：永続ボリューム要求（PVC）の名前です。 上記のパラメーターは、ストレージクラス変換機能に必須です。 また、変換時に永続ボリューム（PV）のアクセスモードを変更することも可能です。以下のオプションパラメーターを使用します。 convertToAccessModes：ターゲットアクセスモードのリストです。 説明 AccessModes が ReadWriteMany または ReadOnlyMany の PV をクラウドディスクストレージクラスに復元する場合、強制的なディスクデタッチのリスクを回避するために、AccessModes を ReadWriteOnce に変換する必要があります。 kubectl -ncsdr describe <backup-name> コマンドを実行することで、バックアップの永続ボリューム要求（PVC）に関する情報を照会できます。status.resourceList.dataResource.pvcBackupInfo リストの出力において、dataType フィールドはデータの型（FileSystem または Snapshot）を示します。nameSpace および pvcName フィールドは、それぞれ PVC の名前空間および名前です。

2. 復元クラスターで、以下のコマンドを実行して applicationrestore オブジェクトをデプロイします。

   kubectl apply -f applicationrestore.yaml

3. 復元クラスターで、以下のコマンドを実行して復元タスクのステータスを確認します。

   kubectl describe applicationrestore <your-application-restore-name> -n csdr

   期待される出力：

   ...
   Status:
     Completion Timestamp:  2022-12-05T15:52:19Z
     Phase:                 Completed
     Start Timestamp:       2022-12-05T15:52:09Z

   復元タスクのステータスが Inprogress から Completed に変更されると、復元タスクは正常に作成されたことになります。

手順 4：クラスターバックアップセンターのリソース削除

スケジュールバックアッププランの削除

以下のコマンドを実行して BackupSchedule リソースを削除し、スケジュールバックアップを停止します。

kubectl delete backupschedule <your-backup-schedule-name> -n csdr

バックアップジョブまたは復元ジョブの削除

1. 削除対象のタスクが配置されているクラスターで、以下の内容を使用して deleterequest.yaml ファイルを作成します。

   apiVersion: csdr.alibabacloud.com/v1beta1
   kind: DeleteRequest
   metadata:
     name: <object-name-dbr>
     namespace: csdr
   spec:
     deleteObjectName: <object-name>
     deleteObjectType: "Backup"

   その他のパラメーターはデフォルト設定のままにしてください。

   パラメーター	必須	説明
   name	はい	DeleteRequest リソースの名前です。 バックアップジョブを削除する場合：削除する ApplicationBackup リソースの名前に -dbr を追加します。 復元ジョブを削除する場合：削除する ApplicationRestore リソースの名前に -dbr を追加します。
   deleteObjectName	はい	削除対象のリソースの名前です。
   deleteObjectType	はい	削除対象のリソースのタイプです。有効な値は以下のとおりです。 "Backup"：ApplicationBackup バックアップジョブおよび関連するリソースを削除します。 "Restore"：ApplicationRestore 復元タスクおよび関連するリソースを削除します。 説明 バックアップジョブを削除しても、すでにクラスターに同期されたレプリカには影響しません。 復元ジョブを削除しても、すでに復元されたコンテンツには影響しません。

2. 削除対象のタスクが配置されているクラスターで、以下のコマンドを実行して deleterequest 削除リクエストをデプロイします。

   kubectl apply -f deleterequest.yaml

3. 以下のコマンドを実行してリソースのステータスを確認します。

   • バックアップジョブの削除の確認

     • 以下のコマンドを実行してバックアップジョブのステータスを確認します。

       kubectl get applicationbackup <your-application-backup-name> -n csdr

       期待される出力：

       Error from server (NotFound): applicationbackups.csdr.alibabacloud.com "your-application-backup-name" not found

       この出力は、ApplicationBackup リソースが削除されたことを示しています。

     • 以下のコマンドを実行して DeleteRequest リソースのステータスを確認します。

       kubectl get deleterequest <your-application-backup-name-dbr> -n csdr

       期待される出力：

       Error from server (NotFound): deleterequests.csdr.alibabacloud.com "your-application-backup-name-dbr" not found

       この出力は、関連する DeleteRequest リソースも自動的に削除されたことを示しています。

   • 復元ジョブの削除の確認

     • 以下のコマンドを実行して復元ジョブのステータスを確認します。

       kubectl get applicationrestore <your-application-restore-name> -n csdr

       期待される出力：

       Error from server (NotFound): applicationrestores.csdr.alibabacloud.com "your-application-restore-name" not found

       この出力は、ApplicationRestore リソースが削除されたことを示しています。

     • 以下のコマンドを実行して DeleteRequest リソースのステータスを確認します。

       kubectl get deleterequest <your-application-restore-name-dbr> -n csdr

       期待される出力：

       Error from server (NotFound): deleterequests.csdr.alibabacloud.com "your-application-restore-name-dbr" not found

       この出力は、関連する DeleteRequest リソースも自動的に削除されたことを示しています。

関連ドキュメント

• コンソールでクラスター内アプリケーションのバックアップおよび移行を行う場合は、以下のドキュメントをご参照ください。

  • クラスター内アプリケーションのバックアップおよび復元

  • 同一リージョン内のクラスター間でのアプリケーション移行

  • 異なるリージョン間のクラスター間でのアプリケーション移行

• 異なるストレージプラグインまたは Kubernetes バージョンを備えたクラスター間でアプリケーションを移行する場合は、「バックアップセンターを使用した旧バージョン Kubernetes クラスターからのアプリケーション移行」をご参照ください。

• Terraform を使用したアプリケーションのバックアップおよび復元