Red Hat Ansible Automation Platform Operator バックアップおよびリカバリーガイド

Red Hat Ansible Automation Platform 2.4

OpenShift Container Platform 上の Ansible Automation Platform Operator のバックアップとリカバリーによりデータ損失を保護する

Red Hat Customer Content Services

概要

このガイドでは、OpenShift Container Platform で Red Hat Ansible Automation Platform オペレーターのインストールをバックアップおよびリカバリーするための手順と参照情報を提供します。

はじめに

Red Hat Ansible Automation Platform に興味をお持ちいただきありがとうございます。Ansible Automation Platform は、Ansible を装備した環境に、制御、ナレッジ、委譲の機能を追加して、チームが複雑かつ複数層のデプロイメントを管理できるように支援する商用サービスです。

このガイドの手順を使用して、障害が発生した場合に Red Hat Ansible Automation Platform デプロイメントを復旧するために使用できるバックアップリソースを作成します。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、Red Hat CTO である Chris Wright のメッセージ をご覧ください。

Red Hat ドキュメントへのフィードバック (英語のみ)

技術的な内容に関するフィードバックをお寄せいただきありがとうございます。皆様のご意見をお待ちしています。コメントの追加、Insights の提供、誤字の修正、および質問を行う必要がある場合は、ドキュメントで直接行うこともできます。

注記

Red Hat アカウントがあり、カスタマーポータルにログインしている必要があります。

カスタマーポータルからドキュメントのフィードバックを送信するには、以下の手順を実施します。

  1. Multi-page HTML 形式を選択します。
  2. ドキュメントの右上にある Feedback ボタンをクリックします。
  3. フィードバックを提供するテキストのセクションを強調表示します。
  4. 強調表示されたテキストの横にある Add Feedback ダイアログをクリックします。
  5. ページの右側のテキストボックスにフィードバックを入力し、Submit をクリックします。

フィードバックを送信すると、自動的に問題の追跡が作成されます。Submit をクリックすると表示されるリンクを開き、問題の監視を開始するか、さらにコメントを追加します。

第1章 Red Hat Ansible Automation Platform のバックアップと復元

予期しないデータ損失やアプリケーションエラーから保護するには、Red Hat Ansible Automation Platform デプロイメントの定期的なバックアップを実行することが重要です。データ損失の防止に加えて、バックアップを使用すると、別のデプロイメント状態にフォールバックできます。

1.1. バックアップおよびリカバリーについて

Red Hat は、データの損失を防ぐために、Red Hat OpenShift Container Platform 環境で Red Hat Ansible Automation Platform のデプロイメントをバックアップすることが推奨されます。

Red Hat Ansible Automation Platform デプロイメントのバックアップリソースには、以下が含まれます。

  • Ansible Automation Platform カスタムリソースオブジェクトの spec セクションにおける特定値のカスタムデプロイメント
  • postgresql データベースのバックアップ
  • secret_key、admin_password、および broadcast_websocket シークレット
  • データベースの設定
注記

機密情報が含まれている可能性があるため、バックアップリソースを必ず保護してください。

1.1.1. バックアップの推奨事項

データ損失から復旧するには、定期的に Red Hat Ansible Automation Platform デプロイメントのバックアップリソースを計画して作成する必要があります。少なくとも、Red Hat は、以下の状況で Red Hat Ansible Automation Platform のデプロイメントをバックアップすることを推奨しています。

  • Red Hat Ansible Automation Platform デプロイメントをアップグレードする前に
  • Openshift クラスターをアップグレードする前に
  • 1 週間に 1 回。これは、環境が自動アップグレード用に設定されている場合に特に重要です。

第2章 Red Hat Ansible Automation Platform バックアップリソースの作成

Red Hat Ansible Automation Platform デプロイメントのバックアップには、デプロイされた Automation Hub および自動化コントローラーインスタンスのバックアップリソースの作成が含まれます。以下の手順を使用して、Red Hat Ansible Automation Platform デプロイメントのバックアップリソースを作成します。

2.1. 自動化コントローラーのデプロイメントのバックアップ

この手順を使用して、ジョブ、インベントリー、認証情報を含むコントローラーのデプロイメントをバックアップします。

前提条件

  • Openshift クラスターで認証されている。
  • Ansible Automation Platform Operator がクラスターにインストールされている。
  • 自動化コントローラーが Ansible Automation Platform Operator を使用してデプロイされている。

手順

  1. Red Hat OpenShift Container Platform にログインします。
  2. Operators → Installed Operators に移動します。
  3. プロジェクトの namespace にインストールされている Ansible Automation Platform Operator を選択します。
  4. Automation Controller Backup タブを選択します。
  5. Create AutomationControllerBackup をクリックします。
  6. バックアップの Name を入力します。
  7. バックアップされているデプロイされた Ansible Automation Platform インスタンスの デプロイメント名 を入力します。たとえば、Automation controlle のバックアップが必要で、デプロイメント名が aap-controller の場合は、デプロイメント名 フィールドに 'aap-controller' と入力します。

  8. 事前に作成したカスタムの pvc を使用する必要がある場合は、以下を行います。

    1. 必要に応じて、バックアップ永続ボリュームクレーム の名前を入力します。

    2. 必要に応じて、バックアップ PVC ストレージ要件 と バックアップ PVC ストレージクラス を入力します。

      注記

      pvc やストレージクラスが指定されていない場合は、クラスターのデフォルトのストレージクラスを使用して pvc が作成されます。

    3. 大規模なデータベースがある場合は、それに応じて、バックアップ管理 Pod のリソース要件 でストレージ要求を指定します。

      注記

      postgres Pod 内で次のコマンドを実行すると、既存の postgres データベースデータディレクトリーのサイズを確認できます。 

      $ df -h | grep "/var/lib/pgsql/data"

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

    指定したデプロイメントのバックアップ tarball が作成され、データの復旧またはデプロイメントのロールバックに使用できます。今後のバックアップは、同じ pvc の別の tar ファイルに保存されます。

2.2. Automation Hub のデプロイのバックアップ

この手順を使用して、ホストされているすべての Ansible コンテンツを含むハブのデプロイメントをバックアップします。

前提条件

  • Openshift クラスターで認証されている。
  • Ansible Automation Platform Operator がクラスターにインストールされている。
  • Automation Hub が Ansible Automation Platform Operator を使用してデプロイされている。

手順

  1. Red Hat OpenShift Container Platform にログインします。
  2. Operators → Installed Operators に移動します。
  3. プロジェクトの namespace にインストールされている Ansible Automation Platform Operator を選択します。
  4. Automation Hub Backup タブを選択します。
  5. Create AutomationHubBackup をクリックします。
  6. バックアップの Name を入力します。
  7. バックアップされているデプロイされた Ansible Automation Platform インスタンスの デプロイメント名 を入力します。たとえば、Automation Hub のバックアップが必要で、デプロイメント名が aap-hub の場合は、デプロイメント名 フィールドに 'aap-hub' と入力します。

  8. 事前に作成したカスタムの pvc を使用する必要がある場合は、以下を行います。

    1. 必要に応じて、Backup persistent volume claim、Backup persistent volume claim namespace、Backup PVC storage requirements、および Backup PVC storage class の名前を入力します。

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

    指定したデプロイメントのバックアップが作成され、データの復旧またはデプロイメントのロールバックに使用できます。

第3章 Red Hat Ansible Automation Platform デプロイメントのリカバリー

システムに関する情報を失ったり、アップグレードで問題が発生した場合は、デプロイインスタンスのバックアップリソースを使用できます。以下の手順を使用して、自動化コントローラーおよび Automation Hub のデプロイメントファイルをリカバリーします。

3.1. 自動化コントローラーのデプロイメントのリカバリー

この手順を使用して、以前のコントローラーのデプロイメントを AutomationControllerBackup から復元します。指定したデプロイメント名は、作成される新しい AutomationController カスタムリソースの名前になります。

注記

新しい AutomationController カスタムリソースに指定された名前は、既存のデプロイと一致しない必要があります。そうしないと、復旧プロセスが失敗します。指定された名前が既存のデプロイメントと一致しない場合は、問題を解決する手順について、トラブルシューティング を参照してください。

前提条件

  • Openshift クラスターで認証されている。
  • 自動化コントローラーがクラスターにデプロイされている。
  • AutomationControllerBackup が、クラスター内の PVC で利用できる。

手順

  1. Red Hat OpenShift Container Platform にログインします。
  2. Operators → Installed Operators に移動します。
  3. プロジェクトの namespace にインストールされている Ansible Automation Platform Operator を選択します。
  4. Automation Controller Restore タブを選択します。
  5. Create AutomationControllerRestore をクリックします。
  6. リカバリーデプロイメントの Name を入力します。

  7. 復元された配置の New Deployment name を入力します。

    注記

    これは、元のデプロイメント名とは異なる必要があります。

  8. Backup source to restore from を選択します。バックアップ CR が推奨されます。
  9. AutomationControllerBackup オブジェクトの Backup Name を入力します。

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

    新しいデプロイメントが作成され、バックアップが復元されます。データベースのサイズにもよりますが、これには約 5 ~ 15 分かかります。

3.2. Automation Hub のデプロイの復旧

この手順を使用して、以前のハブデプロイを namespace に復元します。指定したデプロイ名は、作成される新しい AutomationHub カスタムリソースの名前になります。

注記

新しい AutomationHub カスタムリソースに指定された名前は、既存のデプロイと一致しない必要があります。そうしないと、復旧プロセスが失敗します。

前提条件

  • Openshift クラスターで認証されている。
  • Automation Hub がクラスターにデプロイされている。
  • AutomationHubBackup がクラスター内の PVC で利用できる。

手順

  1. Red Hat OpenShift Container Platform にログインします。
  2. Operators → Installed Operators に移動します。
  3. プロジェクトの namespace にインストールされている Ansible Automation Platform Operator を選択します。
  4. Automation Hub Restore タブを選択します。
  5. Create AutomationHubRestore をクリックします。
  6. リカバリーデプロイメントの Name を入力します。
  7. Backup source to restore を選択します。バックアップ CR が推奨されます。
  8. AutomationHubBackup オブジェクトの Backup Name を入力します。

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

    新しいデプロイメントが作成され、バックアップが復元されます。

第4章 トラブルシューティング

この情報を使用して、バックアップおよびリカバリー中の問題を診断および解決します。

4.1. Automation controller のカスタムリソースの名前が既存のデプロイと同じ場合

新しい AutomationController カスタムリソースに指定された名前は、既存のデプロイと一致しない必要があります。そうしないと、復旧プロセスが失敗します。

AutomationController カスタマーリソースが既存のデプロイメントと一致する場合は、次の手順を実行して問題を解決します。

手順

  1. 既存の AutomationController と関連する postgres PVC を削除します。 

    oc delete automationcontroller <YOUR_DEPLOYMENT_NAME> -n <YOUR_NAMESPACE>

oc delete pvc postgres-13-<YOUR_DEPLOYMENT_NAME>-13-0 -n <YOUR_NAMESPACE>

  2. 同じ deployment_name で AutomationControllerRestore を使用します。 

    oc apply -f restore.yaml

法律上の通知

Copyright © 2023 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.