Red Hat Ansible Automation Platform インストールガイド

Red Hat Ansible Automation Platform 2.1

Red Hat Ansible Automation Platform でサポートされるインストールシナリオの手順および参考情報

Red Hat Customer Content Services

概要

フィードバックの提供:
このドキュメントを改善するための提案がある場合、またはエラーを見つけた場合は、テクニカルサポート (https://access.redhat.com) に連絡し、Docs コンポーネントを使用して Ansible Automation Platform Jira プロジェクトで issue を作成してください。

はじめに

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

このガイドでは、Ansible Automation Platform のインストールにおけるインストール要件およびプロセスを説明します。このガイドの更新により、Ansible Automation Platform の最新リリースの情報が追加されました。

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

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

第1章 Red Hat Ansible Automation Platform インストールの計画

本セクションを使用すると、Red Hat Ansible Automation Platform インストールの計画に役立ちます。インストールの前に、セットアップインストーラー、システム要件、およびサポートされるインストールシナリオに関する情報を確認してください。

1.1. Red Hat Ansible Automation Platform のシステム要件

この情報を使用して、Red Hat Ansible Automation Platform のインストールを計画し、ユースケースに適した自動化メッシュトポロジーを設計します。

お使いのシステムは、Red Hat Ansible Automation Platform をインストールして実行するために、以下の最小システム要件を満たしている必要があります。

表1.1 ベースシステム

 必須注記

サブスクリプション

有効な Red Hat Ansible Automation Platform

 

OS

Red Hat Enterprise Linux 8.4 以降 64 ビット(x86)

 

Ansible

バージョン 2.11 が必要

Ansible がシステムにまだ存在しない場合、セットアップ Playbook は ansible-core 2.12 をインストールします。

Python

3.8 以降

 

プロジェクトの更新およびコレクションを使用するには、以下が必要です。

  • 以下のドメイン名が、接続成功のファイアウォールまたはプロキシーの許可リストに含まれており、Automation Hub または Galaxy サーバーからコレクションをダウンロードするようにしてください。

    • galaxy.ansible.com
    • cloud.redhat.com
    • console.redhat.com
    • sso.redhat.com
  • 自己署名証明書または Red Hat ドメインを使用する場合に SSL インスペクションを無効にする必要があります。

1.1.1. Automation Controller

Automation Controller は分散システムであり、このシステムでは、異なるソフトウェアコンポーネントを同じ場所に配置したり、複数のコンピュートノードにデプロイしたりすることができます。インストーラーでは、ユーザーがユースケースに適したトポロジーを設計できるように、ノードタイプの制御、ハイブリッド、実行、およびホップが抽象化として提供されます。以下の表には、ノードのサイジングに関する推奨事項をまとめています。

注記

ホップノード以外のノードで、実行環境のストレージ用に、最低 20 GB を /home/awx に割り当てます。

Execution nodes

Required

Notes

RAM

16 GB

 

CPU

4

  • 自動化を実行します。メモリーと CPU を増やし、フォークを多く実行できるように容量を増加します。

Control nodes

Required

Notes

RAM

16 GB

 

CPU

4

  • イベントを処理し、プロジェクト更新およびクリーンアップジョブを含むクラスタージョブを実行します。CPU およびメモリーを増やすと、ジョブイベントの処理に役立ちます。

Hybrid nodes

Required

Notes

RAM

16 GB

  • 実行ノードとコントロールノードの RAM に関する注意事項は、このノードタイプにも適用されます。

CPU

4

  • 自動化ジョブとクラスタージョブの両方を実行します。実行ノードとコントロールノードの CPU に関する注意事項は、このノードタイプにも適用されます。

Hop nodes

Required

Notes

RAM

16 GB

 

CPU

4

  • Automation Mesh の別の部分にトラフィックをルーティングします (たとえば、bastion ホストを別のネットワークにすることもできます)。RAM はスループットに影響を与える可能性があり、CPU アクティビティーは低くなります。ネットワーク帯域幅およびレイテンシーは通常、RAM/CPU のいずれかよりも重要な要素です。

ディスク: サービスノード

40 GB の専用ハードディスクスペース

  • automation controller: ファイルおよび作業ディレクトリーのストレージ用に、/var/ に最低 20 GB を割り当てます。
  • ストレージボリュームは、最低ベースラインとして IOPS が 1500 となるようにする必要があります。
  • プロジェクトは、制御およびハイブリッドに保存され、ジョブの期間中も実行ノードに保存されます。クラスターに大規模なプロジェクトが多数ある場合は、ディスク領域のエラーを回避するために、/var/lib/awx/projects に 2 倍の GB を追加することを検討してください。

Database node

Required

Notes

RAM

16 GB

 

CPU

4

 

ディスク

20 GB の専用ハードディスクスペース

  • 専用ハードディスクの最小容量は 20 GB です。
  • 150 GB 以上を推奨
  • ストレージボリュームは、ベースライン IOPS を高くする (1500 以上) 必要があります。

ブラウザー

Mozilla Firefox または Google Chrome の現行のサポートバージョン

 

データベース

PostgreSQL バージョン 12

 

関連情報

  • Automation Controller の使用を許可するには、Import a subscription を参照してください。

表1.2 Automation Hub

 必須注記

RAM

最小 8GB

  • 8 GB のメモリー (Vagrant 試用版のインストールに推奨される最小要件)
  • 8 GB メモリー (外部のスタンドアロン PostgreSQL データベースの最小要件)
  • 設定のフォークに基づく容量については、追加情報を参照してください。

CPU

最小 2 つ

  • 設定のフォークに基づく容量については、追加情報を参照してください。

ディスク: サービスノード

60 GB の専用ハードディスクスペース

  • ストレージボリュームは、最低ベースラインとして IOPS が 1500 となるようにする必要があります。

Database node

Required

Notes

RAM

16 GB

 

CPU

4

 

ディスク

20 GB の専用ハードディスクスペース

  • 専用ハードディスクの最小容量は 20 GB です。
  • 150 GB 以上を推奨
  • ストレージボリュームは、ベースライン IOPS を高くする (1500 以上) 必要があります。

ブラウザー

Mozilla Firefox または Google Chrome の現行のサポートバージョン

 

データベース

PostgreSQL バージョン 12

 
注記
  • すべての自動化コントローラーデータはデータベースに保存されます。データベースストレージは、マネージドホストの数、ジョブ実行数、ファクトキャッシュに保存されているファクトの数、および個別ジョブのタスク数と共に増加します。たとえば、ホスト 250 台で 1 時間ごと (1 日に 24 回) に 20 個のタスクの Playbook を実行する場合は、毎週 800000 を超えるイベントを保存します。
  • データベースに十分な容量が確保されていない場合は、以前のジョブ実行やファクトを定期的に消去する必要があります。管理ジョブ を参照してください。Automation Controller Administration Guide 詳細情報

Amazon EC2

  • インスタンスのサイズは m5.large 以上
  • ホスト 100 台以上ある場合には m4.xlarge 以上

Red Hat Ansible Automation Platform 要件に関する注意点

  • 実際の RAM 要件は、同時に管理するホストの Automation Controller の数により異なります (これはジョブテンプレートまたはシステムの ansible.cfg ファイルの forks パラメーターによって制御されます)。リソースの競合の可能性を回避するには、Ansible は 10 個のフォークごとに 1 GB のメモリーと、Automation Controller 用に 2 GB の予約を行うことを推奨します。詳細は、Automation Controller Capacity Determination and Job impact を参照してください。forks が 400 に設定されている場合は、42 GB のメモリーが推奨されます。
  • より多くのホストにも対応できますが、フォーク数がホストの総数より少ない場合は、ホスト間でより多くのパスが必要になります。これらの RAM の制限は、ローリング更新を使用する場合、または構成を要求する各システムがキューに入り、可能な限り迅速に処理される Automation Controller に組み込まれたプロビジョニングコールバックシステムを使用する場合、または、Automation Controller が AMI などのイメージを作成または展開している場合は回避されます。これらはすべて、より大規模な環境を管理するための優れたアプローチです。詳細な質問は、Red Hat カスタマーポータル (https://access.redhat.com/) から Ansible サポートにお問い合わせください。
  • Ansible Automation Platform が管理するシステムの要件は Ansible と同じです。Ansible の スタートガイド を参照してください。User Guide

PostgreSQL の主な変更

Red Hat Ansible Automation Platform は PostgreSQL 12 を使用します。

  • PostgreSQL ユーザーパスワードは、データベースに保存する前に SCRAM-SHA-256 のセキュアハッシュアルゴリズムでハッシュ化されます。
  • PostgreSQL 12 ではユーザーのパスワードをより安全に保存できるため、インストール時にインベントリーファイルに pg_hashed_password を指定する必要がなくなりました。インストーラーのインベントリーファイルでパスワードを指定した場合 (pg_password) に、このパスワードは、インストールプロセスの一部として PostgreSQL により SCRAM-SHA-256 にハッシュ化されます。DO NOT セットアップが失敗する可能性があるため、pg_password には特殊文字を使用してください。
  • 自動化コントローラーおよび自動化ハブは、3.8 で PostgreSQL の Software Collections バージョンを使用しているため、データベースにアクセスするために rh-postgresql10 scl を有効にする必要があります。管理者は awx-manage dbshell コマンドを使用して、PostgreSQL SCL を自動的に有効にできます。
  • 自動化コントローラーのインスタンスがデータベースにアクセスできるかどうかを判断する必要がある場合は、awx-manage check_db コマンドで実行できます。

PostgreSQL の設定

必要に応じて、PostgreSQL データベースを、Red Hat Ansible Automation Platform インストーラーで管理されていない個別ノードとして設定できます。Ansible Automation Platform インストーラーがデータベースサーバーを管理する場合は、大半のワークロードで一般的に推奨されているデフォルト値を使用してサーバーを設定します。ただし、スタンドアロンのデータベースサーバーノードの PostgreSQL 設定を調整できます。ansible_memtotal_mb は、データベースサーバーの合計メモリーサイズになります。

max_connections == 1024
shared_buffers == ansible_memtotal_mb*0.3
work_mem == ansible_memtotal_mb*0.03
maintenance_work_mem == ansible_memtotal_mb*0.04

PostgreSQL サーバーのチューニングに関する詳細は、PostgreSQL のドキュメント を参照してください。

Ansible のソフトウェア要件

Red Hat Ansible Automation Platform は Ansible Playbook に依存しており、Automation Controller をインストールする前に最新の安定したバージョンの Ansible をインストールする必要がありますが、Ansible の手動インストールは不要になりました。

新規インストール時に、自動化コントローラーは Ansible 2.11 の最新のリリースパッケージをインストールします。

バンドルの Ansible Automation Platform インストールを実行する場合は、インストールプログラムにより、バンドルから Ansible (およびその依存関係) のインストールが試行されます。

Ansible を自身でインストールすることにした場合、Ansible Automation Platform インストールプログラムは Ansible がインストールされていることを検出して、再インストールを試行しません。Red Hat Ansible Automation Platform が正しく機能するようにするには、yum などのパッケージマネージャーを使用して Ansible をインストールし、最新の安定したバージョンをインストールする必要があります。|at| バージョン 3.8 以降には、Ansible バージョン 2.9 が必要です。

1.2. Red Hat Ansible Automation Platform インストーラーの選択および取得

Red Hat Enterprise Linux 環境のインターネット接続に基づいて、必要な Ansible Automation Platform インストーラーを選択します。以下のシナリオを確認し、ニーズを満たす Red Hat Ansible Automation Platform インストーラーを決定してください。

注記

Red Hat カスタマーポータルで Red Hat Ansible Automation Platform インストーラーのダウンロードにアクセスするには、有効な Red Hat カスタマーアカウントが必要です。

インターネットアクセスを使用したインストール

Red Hat Enterprise Linux 環境がインターネットに接続している場合は、Ansible Automation Platform インストーラーを選択します。インターネットアクセスを使用してインストールすると、必要な最新のリポジトリー、パッケージ、および依存関係が取得されます。

  1. https://access.redhat.com/downloads/content/480 に移動します。
  2. Download Now をクリックして、Ansible Automation Platform <latest-version> Setup
  3. ファイルをデプロイメントします。

    $ tar xvzf ansible-automation-platform-setup-<latest-version>.tar.gz

インターネットアクセスなしでのインストール

Red Hat Ansible Automation Platform を使用する Bundle インターネットにアクセスできない場合、またはオンラインリポジトリーから個別のコンポーネントと依存関係をインストールしたくない場合は、インストーラーを使用してください。Red Hat Enterprise Linux リポジトリーへのアクセスは依然として必要です。その他の依存関係はすべて tar アーカイブに含まれます。

  1. https://access.redhat.com/downloads/content/480 に移動します。
  2. Download Now をクリックして、Ansible Automation Platform <latest-version> Setup Bundle
  3. ファイルをデプロイメントします。

    $ tar xvzf ansible-automation-platform-setup-bundle-<latest-version>.tar.gz

1.3. Red Hat Ansible Automation Platform サブスクリプションの割り当て

must Red Hat Ansible Automation Platform をインストールする前に、すべてのノードに有効なサブスクリプションが割り当てられている必要があります。Ansible Automation Platform サブスクリプションを割り当てると、インストールを続行するのに必要なサブクリプションのみのリソースにアクセスできます。

注記

Red Hat アカウントで Simple Content Access Mode を有効にしている場合は、サブスクリプションを割り当てる必要はありません。有効にした場合は、Ansible Automation Platform をインストールする前にシステムを Red Hat Subscription Management (RHSM) または Satellite に登録する必要があります。詳細は、Simple Content Access Mode を参照してください。

手順

  1. Red Hat Ansible Automation Platform サブスクリプションの pool_id を取得します。

    # subscription-manager list --available --all | grep "Ansible Automation Platform" -B 3 -A 6

    出力例 subsciption-manager list コマンド。Pool ID: セクションの説明に従って pool_id を取得します。

    Subscription Name: Red Hat Ansible Automation, Premium (5000 Managed Nodes)
      Provides: Red Hat Ansible Engine
      Red Hat Ansible Automation Platform
      SKU: MCT3695
      Contract: ````
      Pool ID: <pool_id>
      Provides Management: No
      Available: 4999
      Suggested: 1
  2. サブスクリプションを割り当てます。

    # subscription-manager attach --pool=<pool_id>

これで、Red Hat Ansible Automation Platform サブスクリプションがすべてのノードに割り当てられました。

検証

  • サブスクリプションが正常に割り当てられたことを確認します。
# subscription-manager list --consumed

トラブルシューティング

  • Ansible Automation Platform インストーラーにバンドルされている特定のパッケージが見つからない場合、または Repositories disabled by configuration メッセージが表示されたら、次のコマンドを使用してリポジトリーを有効にしてみてください。

    subscription-manager repos --enable ansible-automation-platform-2.1-for-rhel-8-x86_64-rpms

1.4. サポート対象のインストールシナリオ

Red Hat は、Red Hat Ansible Automation Platform 向けに以下のインストールシナリオをサポートします。

1.4.1. 同一ノード上にあるデータベースを持つスタンドアロン Automation Controller またはインストーラー以外が管理するデータベース

このシナリオでは、1 台のマシンに Web フロントエンド、REST API バックエンド、データベースを含む Automation Controller のインストールが含まれます。PostgreSQL をインストールし、そのデータベースとして使用するように Automation Controller を設定します。これは、標準の Automation Controller のインストールシナリオとみなされます。

同じノード上のデータベースを使用した Automation Controller のインストール を参照してください。Installing Red Hat Ansible Automation Platform components on a single machine

1.4.2. 外部管理データベースが設定されたスタンドアロン Automation Controller

このシナリオでは、単一のマシンに Automation Controller サーバーをインストールし、リモート PostgreSQL インスタンスとの通信をデータベースとして設定します。このリモート PostgreSQL は、管理するサーバーを使用することも、Amazon RDS などのクラウドサービスで提供することも可能です。

外部マネージドデータベースを使用した Automation Controller のインストール を参照してください。Installing Red Hat Ansible Automation Platform components on a single machine

1.4.3. 同じノード上にあるデータベースまたはインストーラー以外が管理するデータベースを使用するスタンドアロン Automation Hub

このシナリオでは、1 台のマシンに Web フロントエンド、REST API バックエンド、データベースなど、Automation Hub のインストールが含まれます。PostgreSQL をインストールし、そのデータベースとして使用するように Automation Hub を設定します。

同じノードにデータベースを使用して Automation Hub をインストールするを 参照してください。 Installing Red Hat Ansible Automation Platform components on a single machine

1.4.4. 外部管理データベースを使用するスタンドアロン Automation Hub

このシナリオでは、1 台のマシンに Automation Hub サーバーをインストールし、Red Hat Ansible Automation Platform インストーラーが管理するリモート PostgreSQL データベースをインストールします。

外部データベースを使用した Automation Hub のインストール を参照してください。Installing Red Hat Ansible Automation Platform components on a single machine

1.4.5. Automation Controller ノードまたはインストーラー以外が管理するデータベースを使用したプラットフォームインストール

このシナリオには、Automation Controller ノードにあるデータベース、またはインストーラー以外が管理するデータベースを使用した Automation Controller および Automation Hub のインストールが含まれます。

Automation Controller ノードまたは非インストーラーマネージドデータベース上のデータベースを使用した Red Hat Ansible Automation Platform のインストール を参照してください。Installing Red Hat Ansible Automation Platform

1.4.6. 外部管理データベースを使用したプラットフォームのインストール

このシナリオでは、Automation Controller と Automation Hub をインストールし、リモートの PostgreSQL インスタンスとの通信をデータベースとして設定します。このリモート PostgreSQL は、管理するサーバーを使用することも、Amazon RDS などのクラウドサービスで提供することも可能です。

外部マネージドデータベースを使用した Red Hat Ansible Automation Platform のインストール を参照してください。Installing Red Hat Ansible Automation Platform

1.4.7. 外部管理データベースを使用した複数マシンのクラスターのインストール

このシナリオでは、複数の Automation Controller ノードおよび Automation Hub インスタンスをインストールし、リモート PostgreSQL インスタンスとの通信をデータベースとして設定します。このリモート PostgreSQL は、管理するサーバーを使用することも、Amazon RDS などのクラウドサービスで提供することも可能です。このシナリオでは、すべての Automation Controller がアクティブでジョブを実行でき、すべてのノードが HTTP 要求を受信できます。

注記
  • クラスター設定で実行するには、Automation Controller が外部のものである必要があります。PostgreSQL はプライマリーまたはセカンダリーの Tower ノードの 1 つではないマシンにインストールする必要があります。冗長設定の場合、リモート PostgreSQL のバージョン要件は次のとおりです。PostgreSQL 12

    • クラスター化の設定に関する情報は、クラスタリング を参照してください。
  • [automationhub] ホストの到達可能な IP アドレスを指定して、ユーザーが別のノードから Private Automation Hub のコンテンツを同期できるようにします。

外部マネージドデータベースを使用したマルチノード Red Hat Ansible Automation Platform のインストール を参照してください。Multi-machine cluster installation

第2章 Red Hat Ansible Automation Platform コンポーネントの単一マシンへのインストール

Red Hat Ansible Automation Platform コンポーネントは、以下のサポートされるシナリオのいずれかで 1 台のマシンにインストールすることができます。

2.1. データベースを使用した同一ノードへの Automation Controller のインストール

これらの手順に従って、同じノード上にデータベースを使用する Automation Controller のスタンドアロンインスタンス、またはインストーラー以外が管理するデータベースをインストールできます。このシナリオでは、1 台のマシンに Web フロントエンド、REST API バックエンド、データベースを含む Automation Controller のインストールが含まれます。PostgreSQL をインストールし、そのデータベースとして使用するように Automation Controller を設定します。これは、標準の Automation Controller のインストールシナリオとみなされます。

2.1.1. 前提条件

2.1.2. Red Hat Ansible Automation Platform インストーラーのインベントリーファイルの編集

Red Hat Ansible Automation Platform インストーラーのインベントリーファイルを使用して、インストールシナリオを指定できます。

注記
  • の使用external databases: インベントリーファイルのデータベースセクションが正しく設定されていることを確認してください。
  • [automationhub] グループに自動化ハブの情報を追加します。
  • Automation Hub と自動化コントローラーは、同じノードにインストールできません。
  • 自動化コントローラーは、使用するデータベースのレプリケーションやフェイルオーバーを設定しません。自動化コントローラーは、所有するレプリケーションと連携する必要があります。
  • パフォーマンス上の理由から、データベースサーバーは、自動化コントローラーサーバーと同じネットワーク上または同じデータセンターに置く必要があります。
  • Ansible Automation Platform をインストールするにはコンテナーレジストリーサービスが必要です。コンテナーレジストリーにアクセスできると、自動化実行環境を Ansible Automation Platform に読み込み、Ansible Playbook およびロール実行する一貫性のあるコンテナー化された環境を提供できます。デフォルトでは、Ansible Automation Platform は Red Hat レジストリーサービスアカウントを必要とする registry.redhat.io を使用します。レジストリーサービスアカウントの作成については、レジストリーサービスアカウントの作成 を参照してください。
  • upgrading an existing cluster: クラスターをアップグレードするときに、既存のインスタンスまたはインスタンスグループを除外するようにクラスターを再設定する必要がある場合があります。インベントリーファイルからインスタンスまたはインスタンスグループを省略すると、クラスターからインスタンスを削除するだけでは不十分です。インベントリーファイルからインスタンスまたはインスタンスグループを除外する他に、アップグレードを開始する前に、インスタンスまたはインスタンスグループのプロビジョニングを解除する 必要もあります。解除しないと、省略されたインスタンスまたはインスタンスグループはクラスターと通信し続けます。これにより、アップグレード中に Tower サービスに関する問題が生じる可能性があります。
  • clustered installations: クラスター化されたセットアップを作成している場合は、localhost をすべてのインスタンスのホスト名または IP アドレスに置き換える必要があります。すべてのノードまたはインスタンスが、このホスト名やアドレスを使用して他のノードに到達できるようにする必要があります。つまり、いずれかのノードで localhost ansible_connection=local を使用することができません。また、すべてのノードがホスト名と同じ形式を使用する必要があります。
重要
  • リモートマシンへの root アクセスが必要です。Ansible では、これはさまざまな方法で実行できます。
  • ansible_user=root ansible_ssh_pass="your_password_here" インベントリーのホスト変数またはグループ変数
  • ansible_user=root ansible_ssh_private_key_file="path_to_your_keyfile.pem" インベントリーのホスト変数またはグループ変数
  • ANSIBLE_BECOME_METHOD='sudo' ANSIBLE_BECOME=True ./setup.sh

become プラグインの詳細は、特権昇格について を参照してください。

手順

  1. インストーラーに移動します。

    1. [バンドルのインストーラー]

      $ cd ansible-automation-platform-setup-bundle-<latest-version>
    2. [オンラインインストーラー]

      $ cd ansible-automation-platform-setup-<latest-version>
  2. テキストエディターで inventory ファイルを開きます。
  3. inventory ファイルのパラメーターを編集して、インストールシナリオを指定します。以下の例に従ってください。

2.1.3. Red Hat Ansible Automation Platform の単一ノードインベントリーファイルの例

以下の例では、Automation Controller の単一ノードインストールにインベントリーファイルを追加する方法を説明します。

重要
  • pg_password には特殊文字を使用しないでください。これにより、設定が失敗する場合があります。
  • registry_username および registry_password に Red Hat Registry Service Account の認証情報を入力し、Red Hat コンテナーレジストリーにリンクします。
[automationcontroller]
127.0.0.1 ansible_connection=local 1

[database]

[all:vars]
admin_password='<password>'

pg_host=''
pg_port=''

pg_database='awx'
pg_username='awx'
pg_password='<password>'

registry_url='registry.redhat.io'
registry_username='<registry username>'
registry_password='<registry password>'
1
これは FQDN/IP として設定する必要があります。

2.1.4. 追加のインベントリーファイル変数

インベントリーファイルに追加変数を追加して、Red Hat Ansible Automation Platform インストールをさらに設定できます。これらの設定では、Red Hat Ansible Automation Platform 管理用のさまざまなオプション機能を追加します。テキストエディターを使用して inventory ファイルを編集して、これらの変数を追加します。

表2.1 追加のインベントリーファイル変数

変数説明デフォルト

GALAXY_ENABLE_API_ACCESS_LOG

True に設定すると、/var/log/galaxy_api_access.log にログファイルが作成され、ユーザー名や IP アドレスなど、プラットフォームに対して行われたすべてのユーザーアクションが記録されます。

False

  • API アクセスログを有効にするには、変数をインベントリーに追加し、フラグを true に設定します。
[all:vars:]
admin_password = 'password'

pg_host=''
pg_port=''

GALAXY_ENABLE_API_ACCESS_LOG=true

2.1.5. 設定スクリプトフラグおよび追加変数

設定スクリプトを実行して Automation Controller をインストールする場合に、フラグおよび追加変数を指定することもできます。

表2.2 フラグ

引数説明

-h

ヘルプメッセージを表示して終了します。

-i INVENTORY_FILE

Ansible インベントリーファイルへのパス (デフォルト: inventory)

-e EXTRA_VARS

追加の Ansible 変数を key=value または YAML/JSON として設定します。

-b

インストールの代わりにデータベースのバックアップを実行します。

-r

インストールの代わりにデータベースの復元を行います。

-k

生成 and SECRET_KEY の配布

-- の区切り文字を使用して、適用する Ansible 引数を追加します。たとえば、./setup.sh -i my_awesome_inventory.yml -e matburt_is_country_gold=True — -K となります。

注記
  • -r を渡してデータベース復元を実行する場合は、EXTRA_VARS でデフォルト以外のパスを指定しない限り、デフォルト復元パスが使用されます。復元パスを指定する EXTRA_VAR を渡す以下の例を参照してください。

    ./setup.sh -e 'restore_backup_file=/path/to/nondefault/location' -r
  • -e bundle_install=false を渡すと、オンラインインストールを強制的に実行できます。

    $ ./setup.sh -e bundle_install=false

表2.3 追加変数

変数説明デフォルト

upgrade_ansible_with_tower

Automation Controller のインストール時に、Ansible も最新の状態であることを確認します。

False

create_preload_data

Tower のインストール時に、デモ組織、プロジェクト、認証情報、ジョブテンプレートなども作成します。

True

bundle_install_folder

バンドルからインストールする場合に、バンドルされているリポジトリーを配置する場所

var/lib/tower-bundle

nginx_disable_https

nginx で HTTPS トラフィックを無効にします。HTTPS の負荷をロードバランサーに分散する場合に便利です。

False

nginx_disable_hsts

Web セキュリティーポリシーメカニズム HSTS を無効にします。

False

nginx_http_port

nginx が HTTP をリッスンするように設定するポート

80

nginx_https_port

nginx が HTTPS をリッスンするように設定するポート

443

backup_dir

バックアップ時に使用する一時的な場所

/var/backups/tower/

restore_backup_file

復元元として使用する別のバックアップファイルを指定します。

なし

required_ram

Tower のインストールに必要な最小メモリー (テストインストールの場合に限り変更してください)

3750

min_open_fds

表示ファイルの説明に使用できる最小リソース (テストインストールの場合に限り変更してください)

なし

ignore_preflight_errors

プリフライトチェックを無視します。これはテンプレートや他のシステム以外のイメージにインストールするときに便利です (required_ram および min_open_fds をオーバーライドします)。

False

  • コアをアップグレードするには、以下を実行します。
./setup.sh -e upgrade_ansible_with_tower=1
  • nginx で処理する https を無効化するには、以下を実行します。
./setup.sh -e nginx_disable_https=true
  • バックアップファイルから復元時にデフォルトではないパスを指定する場合は、以下を実行します。
./setup.sh -e 'restore_backup_file=/path/to/nondefault/location' -r

2.1.6. Red Hat Ansible Automation Platform インストーラー設定スクリプトの実行

Private Automation Hub のインストールに必要なパラメーターを使用して inventory ファイルを更新したら、setup スクリプトを実行ができます。

手順

  1. setup.sh スクリプトを実行します。

    $ ./setup.sh

インストールが開始します。

2.1.7. Automation Controller インストールの確認

インストールが完了したら、inventory ファイルに挿入した管理者認証情報でログインして、Automation Controller が正常にインストールしたことを確認できます。

手順

  1. inventory ファイルのAutomation Controller ノードに指定した IP アドレスに移動します。
  2. inventory ファイルに設定した管理者認証情報を使用してログインします。
注記

Automation Controller サーバーには、ポート 80 からアクセスできます。https://<TOWER_SERVER_NAME>/ ただし、ポート 443 にリダイレクトされるため、443 も使用できる必要があります。

重要

インストールに失敗し、Red Hat Ansible Automation Platform の有効なライセンスを購入済みのお客様は、Red Hat カスタマーポータル (https://access.redhat.com/) から Ansible までお問い合せください。

自動化コントローラーへのログインに成功すると、Red Hat Ansible Automation Platform 2.1 のインストールが完了します。

2.1.7.1. 追加の Automation Controller の設定とリソース

追加のAutomation Controller の設定については、以下の資料を参照してください。

表2.4 Automation Controller を設定するための資料

リンク説明

Automation Controller クイックセットアップガイド

Automation Controller を設定して最初の Playbook を実行します。

Automation Controller 管理ガイド

カスタマースクリプト、管理ジョブなどを使用して Automation Controller の管理を設定します。

Red Hat Ansible Automation Platform のプロキシーサポートの設定

プロキシーサーバーを使用して Automation Controller を設定します。

ユーザビリティーアナリティクスおよび Automation Controller からのデータ収集の管理

Red Hat と共有する Automation Controller の情報を管理します。

Automation Controller ユーザーガイド

Automation Controller の機能をより詳細に確認します。

2.1.8. Ansible Automation Platform 2.1 の次のステップ

Ansible Automation Platform を初めて使用するユーザーの場合でも、以前の Ansible コンテンツを最新版をインストールした Red Hat Ansible Automation Platform に移行する予定の既存の管理者の場合でも、次の手順を確認して、Ansible Automation Platform 2.1 の新機能を活用し始めてみてください。

2.1.8.1. Ansible Automation Platform 2.1 へのデータの移行

Ansible Automation Platform 2.1 へのアップグレードを完了しようとしているプラットフォーム管理者の場合には、データを新しいインスタンスに移行するために追加の手順が必要になる場合があります。

2.1.8.1.1. 従来の仮想環境 (venvs) から自動化実行環境への移行

Ansible Automation Platform 2.1 は、カスタム Python 仮想環境 (venvs) よりも、自動化実行環境 (Ansible 自動化の実行とスケーリングに必要なコンポーネントをパッケージ化するコンテナー化されたイメージ) を優先するようになっています。これには、Ansible Core、Ansible Content Collections、Python の依存関係、Red Hat Enterprise Linux UBI 8、およびその他のパッケージの依存関係が含まれます。

venv を実行環境に移行する場合は、(1) awx-manage コマンドを使用して、元のインスタンスから venv のリストを一覧表示してエクスポートし、(2) ansible-builder を使用して実行環境を作成する必要があります。詳細は、自動化実行環境へのアップグレードガイド および Ansible ビルダーガイド を参照してください。

2.1.8.1.2. Ansible Builder を使用した Ansible Engine 2.9 イメージへの移行

Ansible Automation Platform 2.1 で使用するために Ansible Engine 2.9 イメージを移行するには、ansible-builder ツールで、自動化実行環境で使用するためにイメージ (カスタムプラグインおよび依存関係を含む) を再構築するプロセスを自動化します。Ansible Builder を使用して実行環境を構築する方法の詳細は、Ansible Builder ガイド を参照してください。

2.1.8.1.3. Ansible Core 2.12 への移行

Ansible Core 2.12 にアップグレードする場合に、最新版の Ansible Core でサポートされるようにするには、Playbook、プラグイン、または Ansible インフラストラクチャーの他の部分を更新する必要があります。Ansible Core 2.12 との互換性を確保するために Ansible コンテンツを更新する手順については、Ansible-core2.12 Porting Guide を参照してください。

2.1.8.2. 自動化メッシュを使用した自動化スケールアップ

Red Hat Ansible Automation Platform の自動化メッシュコンポーネントは、マルチサイトのデプロイメント全体に自動化を分散するプロセスを簡素化します。IT 環境が複数に分離されている企業の場合、自動化メッシュは、ピアツーピアメッシュ通信ネットワークを使用して実行ノード全体に自動化をデプロイしてスケールアップするための一貫性があり、信頼性の高い方法を提供します。

バージョン 1.x から最新バージョンの Ansible Automation Platform にアップグレードする場合は、データをレガシーの分離ノードから自動化メッシュに必要な実行ノードに移行する必要があります。ハイブリッドノードとコントロールノードのネットワークを計画して、Ansible Automation Platform インストーラーにあるインベントリーファイルを編集して、メッシュ関連の値を各実行ノードに割り当てることで、自動化メッシュを実装できます。

分離ノードから実行ノードに移行する方法については、upgrade & migration guide

自動化メッシュと、ご使用の環境に合わせて自動化メッシュを設計するさまざまな方法については、Red Hat Ansible Automation Platform 化メッシュガイド を参照してください。

2.2. 外部管理データベースを備えた Automation Controller のインストール

以下の手順を使用して、リモート PostgreSQL インスタンスをデータベースとして通信するように設定された 1 台のマシンにスタンドアロンの Automation Controller サーバーをインストールできます。このリモート PostgreSQL は、管理するサーバーを使用することも、Amazon RDS などのクラウドサービスで提供することも可能です。

2.2.1. 前提条件

2.2.2. Red Hat Ansible Automation Platform インストーラーのインベントリーファイルの編集

Red Hat Ansible Automation Platform インストーラーのインベントリーファイルを使用して、インストールシナリオを指定できます。

注記
  • の使用external databases: インベントリーファイルのデータベースセクションが正しく設定されていることを確認してください。
  • [automationhub] グループに自動化ハブの情報を追加します。
  • Automation Hub と自動化コントローラーは、同じノードにインストールできません。
  • 自動化コントローラーは、使用するデータベースのレプリケーションやフェイルオーバーを設定しません。自動化コントローラーは、所有するレプリケーションと連携する必要があります。
  • パフォーマンス上の理由から、データベースサーバーは、自動化コントローラーサーバーと同じネットワーク上または同じデータセンターに置く必要があります。
  • Ansible Automation Platform をインストールするにはコンテナーレジストリーサービスが必要です。コンテナーレジストリーにアクセスできると、自動化実行環境を Ansible Automation Platform に読み込み、Ansible Playbook およびロール実行する一貫性のあるコンテナー化された環境を提供できます。デフォルトでは、Ansible Automation Platform は Red Hat レジストリーサービスアカウントを必要とする registry.redhat.io を使用します。レジストリーサービスアカウントの作成については、レジストリーサービスアカウントの作成 を参照してください。
  • upgrading an existing cluster: クラスターをアップグレードするときに、既存のインスタンスまたはインスタンスグループを除外するようにクラスターを再設定する必要がある場合があります。インベントリーファイルからインスタンスまたはインスタンスグループを省略すると、クラスターからインスタンスを削除するだけでは不十分です。インベントリーファイルからインスタンスまたはインスタンスグループを除外する他に、アップグレードを開始する前に、インスタンスまたはインスタンスグループのプロビジョニングを解除する 必要もあります。解除しないと、省略されたインスタンスまたはインスタンスグループはクラスターと通信し続けます。これにより、アップグレード中に Tower サービスに関する問題が生じる可能性があります。
  • clustered installations: クラスター化されたセットアップを作成している場合は、localhost をすべてのインスタンスのホスト名または IP アドレスに置き換える必要があります。すべてのノードまたはインスタンスが、このホスト名やアドレスを使用して他のノードに到達できるようにする必要があります。つまり、いずれかのノードで localhost ansible_connection=local を使用することができません。また、すべてのノードがホスト名と同じ形式を使用する必要があります。
重要
  • リモートマシンへの root アクセスが必要です。Ansible では、これはさまざまな方法で実行できます。
  • ansible_user=root ansible_ssh_pass="your_password_here" インベントリーのホスト変数またはグループ変数
  • ansible_user=root ansible_ssh_private_key_file="path_to_your_keyfile.pem" インベントリーのホスト変数またはグループ変数
  • ANSIBLE_BECOME_METHOD='sudo' ANSIBLE_BECOME=True ./setup.sh

become プラグインの詳細は、特権昇格について を参照してください。

手順

  1. インストーラーに移動します。

    1. [バンドルのインストーラー]

      $ cd ansible-automation-platform-setup-bundle-<latest-version>
    2. [オンラインインストーラー]

      $ cd ansible-automation-platform-setup-<latest-version>
  2. テキストエディターで inventory ファイルを開きます。
  3. inventory ファイルのパラメーターを編集して、インストールシナリオを指定します。以下の例に従ってください。

2.2.3. 外部管理データベースを使用するスタンドアロン Automation Controller のインベントリーファイル例

以下の例では、外部データベースを使用して Automation Controller のインストールをデプロイするためのインベントリーファイルの設定方法を説明します。

重要
  • pg_password には特殊文字を使用しないでください。これにより、設定が失敗する場合があります。
  • registry_username および registry_password に Red Hat Registry Service Account の認証情報を入力し、Red Hat コンテナーレジストリーにリンクします。
[automationcontroller]
127.0.0.1 ansible_connection=local


[database]
database.example.com

[all:vars]
admin_password='<password>'
pg_password='<password>'

pg_host='database.example.com'
pg_port='5432'

pg_database='awx'
pg_username='awx'

registry_url='registry.redhat.io'
registry_username='<registry username>'
registry_password='<registry password>'

2.2.4. 追加のインベントリーファイル変数

インベントリーファイルに追加変数を追加して、Red Hat Ansible Automation Platform インストールをさらに設定できます。これらの設定では、Red Hat Ansible Automation Platform 管理用のさまざまなオプション機能を追加します。テキストエディターを使用して inventory ファイルを編集して、これらの変数を追加します。

表2.5 追加のインベントリーファイル変数

変数説明デフォルト

GALAXY_ENABLE_API_ACCESS_LOG

True に設定すると、/var/log/galaxy_api_access.log にログファイルが作成され、ユーザー名や IP アドレスなど、プラットフォームに対して行われたすべてのユーザーアクションが記録されます。

False

  • API アクセスログを有効にするには、変数をインベントリーに追加し、フラグを true に設定します。
[all:vars:]
admin_password = 'password'

pg_host=''
pg_port=''

GALAXY_ENABLE_API_ACCESS_LOG=true

2.2.5. 設定スクリプトフラグおよび追加変数

設定スクリプトを実行して Automation Controller をインストールする場合に、フラグおよび追加変数を指定することもできます。

表2.6 フラグ

引数説明

-h

ヘルプメッセージを表示して終了します。

-i INVENTORY_FILE

Ansible インベントリーファイルへのパス (デフォルト: inventory)

-e EXTRA_VARS

追加の Ansible 変数を key=value または YAML/JSON として設定します。

-b

インストールの代わりにデータベースのバックアップを実行します。

-r

インストールの代わりにデータベースの復元を行います。

-k

生成 and SECRET_KEY の配布

-- の区切り文字を使用して、適用する Ansible 引数を追加します。たとえば、./setup.sh -i my_awesome_inventory.yml -e matburt_is_country_gold=True — -K となります。

注記
  • -r を渡してデータベース復元を実行する場合は、EXTRA_VARS でデフォルト以外のパスを指定しない限り、デフォルト復元パスが使用されます。復元パスを指定する EXTRA_VAR を渡す以下の例を参照してください。

    ./setup.sh -e 'restore_backup_file=/path/to/nondefault/location' -r
  • -e bundle_install=false を渡すと、オンラインインストールを強制的に実行できます。

    $ ./setup.sh -e bundle_install=false

表2.7 追加変数

変数説明デフォルト

upgrade_ansible_with_tower

Automation Controller のインストール時に、Ansible も最新の状態であることを確認します。

False

create_preload_data

Tower のインストール時に、デモ組織、プロジェクト、認証情報、ジョブテンプレートなども作成します。

True

bundle_install_folder

バンドルからインストールする場合に、バンドルされているリポジトリーを配置する場所

var/lib/tower-bundle

nginx_disable_https

nginx で HTTPS トラフィックを無効にします。HTTPS の負荷をロードバランサーに分散する場合に便利です。

False

nginx_disable_hsts

Web セキュリティーポリシーメカニズム HSTS を無効にします。

False

nginx_http_port

nginx が HTTP をリッスンするように設定するポート

80

nginx_https_port

nginx が HTTPS をリッスンするように設定するポート

443

backup_dir

バックアップ時に使用する一時的な場所

/var/backups/tower/

restore_backup_file

復元元として使用する別のバックアップファイルを指定します。

なし

required_ram

Tower のインストールに必要な最小メモリー (テストインストールの場合に限り変更してください)

3750

min_open_fds

表示ファイルの説明に使用できる最小リソース (テストインストールの場合に限り変更してください)

なし

ignore_preflight_errors

プリフライトチェックを無視します。これはテンプレートや他のシステム以外のイメージにインストールするときに便利です (required_ram および min_open_fds をオーバーライドします)。

False

  • コアをアップグレードするには、以下を実行します。
./setup.sh -e upgrade_ansible_with_tower=1
  • nginx で処理する https を無効化するには、以下を実行します。
./setup.sh -e nginx_disable_https=true
  • バックアップファイルから復元時にデフォルトではないパスを指定する場合は、以下を実行します。
./setup.sh -e 'restore_backup_file=/path/to/nondefault/location' -r

2.2.6. Red Hat Ansible Automation Platform インストーラー設定スクリプトの実行

Private Automation Hub のインストールに必要なパラメーターを使用して inventory ファイルを更新したら、setup スクリプトを実行ができます。

手順

  1. setup.sh スクリプトを実行します。

    $ ./setup.sh

インストールが開始します。

2.2.7. Automation Controller インストールの確認

インストールが完了したら、inventory ファイルに挿入した管理者認証情報でログインして、Automation Controller が正常にインストールしたことを確認できます。

手順

  1. inventory ファイルのAutomation Controller ノードに指定した IP アドレスに移動します。
  2. inventory ファイルに設定した管理者認証情報を使用してログインします。
注記

Automation Controller サーバーには、ポート 80 からアクセスできます。https://<TOWER_SERVER_NAME>/ ただし、ポート 443 にリダイレクトされるため、443 も使用できる必要があります。

重要

インストールに失敗し、Red Hat Ansible Automation Platform の有効なライセンスを購入済みのお客様は、Red Hat カスタマーポータル (https://access.redhat.com/) から Ansible までお問い合せください。

自動化コントローラーへのログインに成功すると、Red Hat Ansible Automation Platform 2.1 のインストールが完了します。

2.2.7.1. 追加の Automation Controller の設定とリソース

追加のAutomation Controller の設定については、以下の資料を参照してください。

表2.8 Automation Controller を設定するための資料

リンク説明

Automation Controller クイックセットアップガイド

Automation Controller を設定して最初の Playbook を実行します。

Automation Controller 管理ガイド

カスタマースクリプト、管理ジョブなどを使用して Automation Controller の管理を設定します。

Red Hat Ansible Automation Platform のプロキシーサポートの設定

プロキシーサーバーを使用して Automation Controller を設定します。

ユーザビリティーアナリティクスおよび Automation Controller からのデータ収集の管理

Red Hat と共有する Automation Controller の情報を管理します。

Automation Controller ユーザーガイド

Automation Controller の機能をより詳細に確認します。

2.2.8. Ansible Automation Platform 2.1 の次のステップ

Ansible Automation Platform を初めて使用するユーザーの場合でも、以前の Ansible コンテンツを最新版をインストールした Red Hat Ansible Automation Platform に移行する予定の既存の管理者の場合でも、次の手順を確認して、Ansible Automation Platform 2.1 の新機能を活用し始めてみてください。

2.2.8.1. Ansible Automation Platform 2.1 へのデータの移行

Ansible Automation Platform 2.1 へのアップグレードを完了しようとしているプラットフォーム管理者の場合には、データを新しいインスタンスに移行するために追加の手順が必要になる場合があります。

2.2.8.1.1. 従来の仮想環境 (venvs) から自動化実行環境への移行

Ansible Automation Platform 2.1 は、カスタム Python 仮想環境 (venvs) よりも、自動化実行環境 (Ansible 自動化の実行とスケーリングに必要なコンポーネントをパッケージ化するコンテナー化されたイメージ) を優先するようになっています。これには、Ansible Core、Ansible Content Collections、Python の依存関係、Red Hat Enterprise Linux UBI 8、およびその他のパッケージの依存関係が含まれます。

venv を実行環境に移行する場合は、(1) awx-manage コマンドを使用して、元のインスタンスから venv のリストを一覧表示してエクスポートし、(2) ansible-builder を使用して実行環境を作成する必要があります。詳細は、自動化実行環境へのアップグレードガイド および Ansible ビルダーガイド を参照してください。

2.2.8.1.2. Ansible Builder を使用した Ansible Engine 2.9 イメージへの移行

Ansible Automation Platform 2.1 で使用するために Ansible Engine 2.9 イメージを移行するには、ansible-builder ツールで、自動化実行環境で使用するためにイメージ (カスタムプラグインおよび依存関係を含む) を再構築するプロセスを自動化します。Ansible Builder を使用して実行環境を構築する方法の詳細は、Ansible Builder ガイド を参照してください。

2.2.8.1.3. Ansible Core 2.12 への移行

Ansible Core 2.12 にアップグレードする場合に、最新版の Ansible Core でサポートされるようにするには、Playbook、プラグイン、または Ansible インフラストラクチャーの他の部分を更新する必要があります。Ansible Core 2.12 との互換性を確保するために Ansible コンテンツを更新する手順については、Ansible-core2.12 Porting Guide を参照してください。

2.2.8.2. 自動化メッシュを使用した自動化スケールアップ

Red Hat Ansible Automation Platform の自動化メッシュコンポーネントは、マルチサイトのデプロイメント全体に自動化を分散するプロセスを簡素化します。IT 環境が複数に分離されている企業の場合、自動化メッシュは、ピアツーピアメッシュ通信ネットワークを使用して実行ノード全体に自動化をデプロイしてスケールアップするための一貫性があり、信頼性の高い方法を提供します。

バージョン 1.x から最新バージョンの Ansible Automation Platform にアップグレードする場合は、データをレガシーの分離ノードから自動化メッシュに必要な実行ノードに移行する必要があります。ハイブリッドノードとコントロールノードのネットワークを計画して、Ansible Automation Platform インストーラーにあるインベントリーファイルを編集して、メッシュ関連の値を各実行ノードに割り当てることで、自動化メッシュを実装できます。

分離ノードから実行ノードに移行する方法については、upgrade & migration guide

自動化メッシュと、ご使用の環境に合わせて自動化メッシュを設計するさまざまな方法については、Red Hat Ansible Automation Platform 化メッシュガイド を参照してください。

2.3. データベースを使用した同一ノードへの Automation Hub のインストール

これらの手順に従って、同じノード上のデータベース、またはインストーラー以外が管理するデータベースを使用して Automation Hub のスタンドアロンインスタンスをインストールできます。

2.3.1. 前提条件

2.3.2. Red Hat Ansible Automation Platform インストール設定

Automation Hub のインストール時に、以下の設定を使用できます。

  • automationhub_importer_settings: galaxy-importer に渡す設定および設定のディクショナリー。/etc/galaxy-importer/galaxy-importer.cfg で終了します。
  • automationhub_require_content_approval: コレクションが利用可能になる前に、自動化ハブが承認メカニズムを適用するかどうか。
  • automationhub_disable_https: TLS を有効にして自動化ハブをデプロイするかどうか。
  • automationhub_disable_hsts: 自動化ハブが HTTP Strict Transport Security (HSTS) の Web セキュリティーポリシーメカニズムを有効にしてデプロイする必要があるかどうか。
  • automationhub_ssl_validate_certs: デフォルトでは、プラットフォームは自己署名証明書を使用してデプロイするため、自動化ハブが自らを要求する際に証明書を検証するかどうか (デフォルト = False)。
  • automationhub_ssl_cert: web_server_ssl_cert と同じですが、自動化ハブの UI と API 用。
  • automationhub_ssl_key: 自動化ハブの UI と API 用の web_server_ssl_key と同じです。
  • automationhub_backup_collections: オートメーションハブは、/var/lib/pulp のアーティファクトを提供します。デフォルトでは、これは true に設定され、自動化コントローラーはデフォルトでアーティファクトを自動的にバックアップします。パーティション (LVM、NFS、CephFS など) がそこにマウントされている場合、企業組織は常にバックアップされるようになります。この場合は、automationhub_backup_collections = false を設定すると、バックアップまたは復元プロセスでは /var/lib/pulp をバックアップまたは復元する必要はありません。

2.3.3. Red Hat Ansible Automation Platform インストーラーのインベントリーファイルの編集

Red Hat Ansible Automation Platform インストーラーのインベントリーファイルを使用して、インストールシナリオを指定できます。

注記
  • の使用external databases: インベントリーファイルのデータベースセクションが正しく設定されていることを確認してください。
  • [automationhub] グループに自動化ハブの情報を追加します。
  • Automation Hub と自動化コントローラーは、同じノードにインストールできません。
  • 自動化コントローラーは、使用するデータベースのレプリケーションやフェイルオーバーを設定しません。自動化コントローラーは、所有するレプリケーションと連携する必要があります。
  • パフォーマンス上の理由から、データベースサーバーは、自動化コントローラーサーバーと同じネットワーク上または同じデータセンターに置く必要があります。
  • Ansible Automation Platform をインストールするにはコンテナーレジストリーサービスが必要です。コンテナーレジストリーにアクセスできると、自動化実行環境を Ansible Automation Platform に読み込み、Ansible Playbook およびロール実行する一貫性のあるコンテナー化された環境を提供できます。デフォルトでは、Ansible Automation Platform は Red Hat レジストリーサービスアカウントを必要とする registry.redhat.io を使用します。レジストリーサービスアカウントの作成については、レジストリーサービスアカウントの作成 を参照してください。
  • upgrading an existing cluster: クラスターをアップグレードするときに、既存のインスタンスまたはインスタンスグループを除外するようにクラスターを再設定する必要がある場合があります。インベントリーファイルからインスタンスまたはインスタンスグループを省略すると、クラスターからインスタンスを削除するだけでは不十分です。インベントリーファイルからインスタンスまたはインスタンスグループを除外する他に、アップグレードを開始する前に、インスタンスまたはインスタンスグループのプロビジョニングを解除する 必要もあります。解除しないと、省略されたインスタンスまたはインスタンスグループはクラスターと通信し続けます。これにより、アップグレード中に Tower サービスに関する問題が生じる可能性があります。
  • clustered installations: クラスター化されたセットアップを作成している場合は、localhost をすべてのインスタンスのホスト名または IP アドレスに置き換える必要があります。すべてのノードまたはインスタンスが、このホスト名やアドレスを使用して他のノードに到達できるようにする必要があります。つまり、いずれかのノードで localhost ansible_connection=local を使用することができません。また、すべてのノードがホスト名と同じ形式を使用する必要があります。
重要
  • リモートマシンへの root アクセスが必要です。Ansible では、これはさまざまな方法で実行できます。
  • ansible_user=root ansible_ssh_pass="your_password_here" インベントリーのホスト変数またはグループ変数
  • ansible_user=root ansible_ssh_private_key_file="path_to_your_keyfile.pem" インベントリーのホスト変数またはグループ変数
  • ANSIBLE_BECOME_METHOD='sudo' ANSIBLE_BECOME=True ./setup.sh

become プラグインの詳細は、特権昇格について を参照してください。

手順

  1. インストーラーに移動します。

    1. [バンドルのインストーラー]

      $ cd ansible-automation-platform-setup-bundle-<latest-version>
    2. [オンラインインストーラー]

      $ cd ansible-automation-platform-setup-<latest-version>
  2. テキストエディターで inventory ファイルを開きます。
  3. inventory ファイルのパラメーターを編集して、インストールシナリオを指定します。以下の例に従ってください。

2.3.4. スタンドアロンの Automation Hub のインベントリーファイルの例

以下の例では、Automation Hub のスタンドアロンインスタンスをデプロイするためにインベントリーファイルを設定する方法を説明します。

重要
  • Red Hat Ansible Automation Platform または自動化ハブの場合: [automationhub] グループに自動化ハブホストを追加します。自動化コントローラーと Automation Hub を同じノードにインストールすることはできません。
  • [automationhub] ホストに到達可能な IP アドレスまたは完全修飾ドメイン名 (FDQN) を指定して、ユーザーが別のノードから自動化ハブのコンテンツを同期してインストールできるようにします。「localhost」は使用しないでください。
  • registry_username および registry_password に Red Hat Registry Service Account の認証情報を入力し、Red Hat コンテナーレジストリーにリンクします。
[automationcontroller]


[automationhub]
<FQDN> ansible_connection=local

[all:vars]
registry_url='registry.redhat.io'
registry_username='<registry username>'
registry_password='<registry password>'

automationhub_admin_password= <PASSWORD>

automationhub_pg_host=''
automationhub_pg_port=''

automationhub_pg_database='automationhub'
automationhub_pg_username='automationhub'
automationhub_pg_password=<PASSWORD>
automationhub_pg_sslmode='prefer'

# The default install will deploy a TLS enabled Automation Hub.
# If for some reason this is not the behavior wanted one can
# disable TLS enabled deployment.
#
# automationhub_disable_https = False
# The default install will generate self-signed certificates for the Automation
# Hub service. If you are providing valid certificate via automationhub_ssl_cert
# and automationhub_ssl_key, one should toggle that value to True.
#
# automationhub_ssl_validate_certs = False
# SSL-related variables
# If set, this will install a custom CA certificate to the system trust store.
# custom_ca_cert=/path/to/ca.crt
# Certificate and key to install in Automation Hub node
# automationhub_ssl_cert=/path/to/automationhub.cert
# automationhub_ssl_key=/path/to/automationhub.key

2.3.5. 追加のインベントリーファイル変数

インベントリーファイルに追加変数を追加して、Red Hat Ansible Automation Platform インストールをさらに設定できます。これらの設定では、Red Hat Ansible Automation Platform 管理用のさまざまなオプション機能を追加します。テキストエディターを使用して inventory ファイルを編集して、これらの変数を追加します。

表2.9 追加のインベントリーファイル変数

変数説明デフォルト

GALAXY_ENABLE_API_ACCESS_LOG

True に設定すると、/var/log/galaxy_api_access.log にログファイルが作成され、ユーザー名や IP アドレスなど、プラットフォームに対して行われたすべてのユーザーアクションが記録されます。

False

  • API アクセスログを有効にするには、変数をインベントリーに追加し、フラグを true に設定します。
[all:vars:]
admin_password = 'password'

pg_host=''
pg_port=''

GALAXY_ENABLE_API_ACCESS_LOG=true

2.3.6. 設定スクリプトフラグおよび追加変数

設定スクリプトを実行して Automation Controller をインストールする場合に、フラグおよび追加変数を指定することもできます。

表2.10 フラグ

引数説明

-h

ヘルプメッセージを表示して終了します。

-i INVENTORY_FILE

Ansible インベントリーファイルへのパス (デフォルト: inventory)

-e EXTRA_VARS

追加の Ansible 変数を key=value または YAML/JSON として設定します。

-b

インストールの代わりにデータベースのバックアップを実行します。

-r

インストールの代わりにデータベースの復元を行います。

-k

生成 and SECRET_KEY の配布

-- の区切り文字を使用して、適用する Ansible 引数を追加します。たとえば、./setup.sh -i my_awesome_inventory.yml -e matburt_is_country_gold=True — -K となります。

注記
  • -r を渡してデータベース復元を実行する場合は、EXTRA_VARS でデフォルト以外のパスを指定しない限り、デフォルト復元パスが使用されます。復元パスを指定する EXTRA_VAR を渡す以下の例を参照してください。

    ./setup.sh -e 'restore_backup_file=/path/to/nondefault/location' -r
  • -e bundle_install=false を渡すと、オンラインインストールを強制的に実行できます。

    $ ./setup.sh -e bundle_install=false

表2.11 追加変数

変数説明デフォルト

upgrade_ansible_with_tower

Automation Controller のインストール時に、Ansible も最新の状態であることを確認します。

False

create_preload_data

Tower のインストール時に、デモ組織、プロジェクト、認証情報、ジョブテンプレートなども作成します。

True

bundle_install_folder

バンドルからインストールする場合に、バンドルされているリポジトリーを配置する場所

var/lib/tower-bundle

nginx_disable_https

nginx で HTTPS トラフィックを無効にします。HTTPS の負荷をロードバランサーに分散する場合に便利です。

False

nginx_disable_hsts

Web セキュリティーポリシーメカニズム HSTS を無効にします。

False

nginx_http_port

nginx が HTTP をリッスンするように設定するポート

80

nginx_https_port

nginx が HTTPS をリッスンするように設定するポート

443

backup_dir

バックアップ時に使用する一時的な場所

/var/backups/tower/

restore_backup_file

復元元として使用する別のバックアップファイルを指定します。

なし

required_ram

Tower のインストールに必要な最小メモリー (テストインストールの場合に限り変更してください)

3750

min_open_fds

表示ファイルの説明に使用できる最小リソース (テストインストールの場合に限り変更してください)

なし

ignore_preflight_errors

プリフライトチェックを無視します。これはテンプレートや他のシステム以外のイメージにインストールするときに便利です (required_ram および min_open_fds をオーバーライドします)。

False

  • コアをアップグレードするには、以下を実行します。
./setup.sh -e upgrade_ansible_with_tower=1
  • nginx で処理する https を無効化するには、以下を実行します。
./setup.sh -e nginx_disable_https=true
  • バックアップファイルから復元時にデフォルトではないパスを指定する場合は、以下を実行します。
./setup.sh -e 'restore_backup_file=/path/to/nondefault/location' -r

2.3.7. Red Hat Ansible Automation Platform インストーラー設定スクリプトの実行

Private Automation Hub のインストールに必要なパラメーターを使用して inventory ファイルを更新したら、setup スクリプトを実行ができます。

手順

  1. setup.sh スクリプトを実行します。

    $ ./setup.sh

インストールが開始します。

2.3.8. Automation Hub のインストールの確認

インストールが完了したら、inventory ファイルに挿入した管理者認証情報でログインして、自動化ハブが正常にインストールしたことを確認できます。

手順

  1. inventory ファイルの自動化ハブノードに指定した IP アドレスに移動します。
  2. inventory ファイルに設定した管理者認証情報を使用してログインします。
重要

インストールに失敗し、Red Hat Ansible Automation Platform の有効なライセンスを購入済みのお客様は、Red Hat カスタマーポータル (https://access.redhat.com/) から Ansible までお問い合せください。

Automation Hub へのログインが成功すると、Red Hat Ansible Automation Platform 2.1 のインストールが完了します。

2.3.8.1. 追加の Automation Hub の設定とリソース

追加の Automation Hub 設定については、以下のリソースを参照してください。

表2.12 Automation Controller を設定するための資料

リンク説明

Private Automation Hub でのユーザーアクセスの管理

Automation Hub のユーザーアクセスを設定します。

Automation Hub での Red Hat 認定コレクションおよび Ansible Galaxy コレクションの管理

Automation Hub にコンテンツを追加します。

Automation Hub でのプロプライエタリーコンテンツコレクションの公開

Automation Hub で社内で開発したコレクションを公開します。

2.3.9. Ansible Automation Platform 2.1 の次のステップ

Ansible Automation Platform を初めて使用するユーザーの場合でも、以前の Ansible コンテンツを最新版をインストールした Red Hat Ansible Automation Platform に移行する予定の既存の管理者の場合でも、次の手順を確認して、Ansible Automation Platform 2.1 の新機能を活用し始めてみてください。

2.3.9.1. Ansible Automation Platform 2.1 へのデータの移行

Ansible Automation Platform 2.1 へのアップグレードを完了しようとしているプラットフォーム管理者の場合には、データを新しいインスタンスに移行するために追加の手順が必要になる場合があります。

2.3.9.1.1. 従来の仮想環境 (venvs) から自動化実行環境への移行

Ansible Automation Platform 2.1 は、カスタム Python 仮想環境 (venvs) よりも、自動化実行環境 (Ansible 自動化の実行とスケーリングに必要なコンポーネントをパッケージ化するコンテナー化されたイメージ) を優先するようになっています。これには、Ansible Core、Ansible Content Collections、Python の依存関係、Red Hat Enterprise Linux UBI 8、およびその他のパッケージの依存関係が含まれます。

venv を実行環境に移行する場合は、(1) awx-manage コマンドを使用して、元のインスタンスから venv のリストを一覧表示してエクスポートし、(2) ansible-builder を使用して実行環境を作成する必要があります。詳細は、自動化実行環境へのアップグレードガイド および Ansible ビルダーガイド を参照してください。

2.3.9.1.2. Ansible Builder を使用した Ansible Engine 2.9 イメージへの移行

Ansible Automation Platform 2.1 で使用するために Ansible Engine 2.9 イメージを移行するには、ansible-builder ツールで、自動化実行環境で使用するためにイメージ (カスタムプラグインおよび依存関係を含む) を再構築するプロセスを自動化します。Ansible Builder を使用して実行環境を構築する方法の詳細は、Ansible Builder ガイド を参照してください。

2.3.9.1.3. Ansible Core 2.12 への移行

Ansible Core 2.12 にアップグレードする場合に、最新版の Ansible Core でサポートされるようにするには、Playbook、プラグイン、または Ansible インフラストラクチャーの他の部分を更新する必要があります。Ansible Core 2.12 との互換性を確保するために Ansible コンテンツを更新する手順については、Ansible-core2.12 Porting Guide を参照してください。

2.3.9.2. 自動化メッシュを使用した自動化スケールアップ

Red Hat Ansible Automation Platform の自動化メッシュコンポーネントは、マルチサイトのデプロイメント全体に自動化を分散するプロセスを簡素化します。IT 環境が複数に分離されている企業の場合、自動化メッシュは、ピアツーピアメッシュ通信ネットワークを使用して実行ノード全体に自動化をデプロイしてスケールアップするための一貫性があり、信頼性の高い方法を提供します。

バージョン 1.x から最新バージョンの Ansible Automation Platform にアップグレードする場合は、データをレガシーの分離ノードから自動化メッシュに必要な実行ノードに移行する必要があります。ハイブリッドノードとコントロールノードのネットワークを計画して、Ansible Automation Platform インストーラーにあるインベントリーファイルを編集して、メッシュ関連の値を各実行ノードに割り当てることで、自動化メッシュを実装できます。

分離ノードから実行ノードに移行する方法については、upgrade & migration guide

自動化メッシュと、ご使用の環境に合わせて自動化メッシュを設計するさまざまな方法については、Red Hat Ansible Automation Platform 化メッシュガイド を参照してください。

2.4. 外部データベースを使用した Automation Hub のインストール

以下の手順に従って、外部の管理データベースを使用して、Automation Hub のスタンドアロンインスタンスをインストールできます。これにより、Automation Hub サーバーが単一のマシンにインストールされ、Ansible Automation Platform インストーラーを使用してリモート PostgreSQL データベースがインストールされます。

2.4.1. 前提条件

2.4.2. Red Hat Ansible Automation Platform インストール設定

Automation Hub のインストール時に、以下の設定を使用できます。

  • automationhub_importer_settings: galaxy-importer に渡す設定および設定のディクショナリー。/etc/galaxy-importer/galaxy-importer.cfg で終了します。
  • automationhub_require_content_approval: コレクションが利用可能になる前に、自動化ハブが承認メカニズムを適用するかどうか。
  • automationhub_disable_https: TLS を有効にして自動化ハブをデプロイするかどうか。
  • automationhub_disable_hsts: 自動化ハブが HTTP Strict Transport Security (HSTS) の Web セキュリティーポリシーメカニズムを有効にしてデプロイする必要があるかどうか。
  • automationhub_ssl_validate_certs: デフォルトでは、プラットフォームは自己署名証明書を使用してデプロイするため、自動化ハブが自らを要求する際に証明書を検証するかどうか (デフォルト = False)。
  • automationhub_ssl_cert: web_server_ssl_cert と同じですが、自動化ハブの UI と API 用。
  • automationhub_ssl_key: 自動化ハブの UI と API 用の web_server_ssl_key と同じです。
  • automationhub_backup_collections: オートメーションハブは、/var/lib/pulp のアーティファクトを提供します。デフォルトでは、これは true に設定され、自動化コントローラーはデフォルトでアーティファクトを自動的にバックアップします。パーティション (LVM、NFS、CephFS など) がそこにマウントされている場合、企業組織は常にバックアップされるようになります。この場合は、automationhub_backup_collections = false を設定すると、バックアップまたは復元プロセスでは /var/lib/pulp をバックアップまたは復元する必要はありません。

2.4.3. Red Hat Ansible Automation Platform インストーラーのインベントリーファイルの編集

Red Hat Ansible Automation Platform インストーラーのインベントリーファイルを使用して、インストールシナリオを指定できます。

注記
  • の使用external databases: インベントリーファイルのデータベースセクションが正しく設定されていることを確認してください。
  • [automationhub] グループに自動化ハブの情報を追加します。
  • Automation Hub と自動化コントローラーは、同じノードにインストールできません。
  • 自動化コントローラーは、使用するデータベースのレプリケーションやフェイルオーバーを設定しません。自動化コントローラーは、所有するレプリケーションと連携する必要があります。
  • パフォーマンス上の理由から、データベースサーバーは、自動化コントローラーサーバーと同じネットワーク上または同じデータセンターに置く必要があります。
  • Ansible Automation Platform をインストールするにはコンテナーレジストリーサービスが必要です。コンテナーレジストリーにアクセスできると、自動化実行環境を Ansible Automation Platform に読み込み、Ansible Playbook およびロール実行する一貫性のあるコンテナー化された環境を提供できます。デフォルトでは、Ansible Automation Platform は Red Hat レジストリーサービスアカウントを必要とする registry.redhat.io を使用します。レジストリーサービスアカウントの作成については、レジストリーサービスアカウントの作成 を参照してください。
  • upgrading an existing cluster: クラスターをアップグレードするときに、既存のインスタンスまたはインスタンスグループを除外するようにクラスターを再設定する必要がある場合があります。インベントリーファイルからインスタンスまたはインスタンスグループを省略すると、クラスターからインスタンスを削除するだけでは不十分です。インベントリーファイルからインスタンスまたはインスタンスグループを除外する他に、アップグレードを開始する前に、インスタンスまたはインスタンスグループのプロビジョニングを解除する 必要もあります。解除しないと、省略されたインスタンスまたはインスタンスグループはクラスターと通信し続けます。これにより、アップグレード中に Tower サービスに関する問題が生じる可能性があります。
  • clustered installations: クラスター化されたセットアップを作成している場合は、localhost をすべてのインスタンスのホスト名または IP アドレスに置き換える必要があります。すべてのノードまたはインスタンスが、このホスト名やアドレスを使用して他のノードに到達できるようにする必要があります。つまり、いずれかのノードで localhost ansible_connection=local を使用することができません。また、すべてのノードがホスト名と同じ形式を使用する必要があります。
重要
  • リモートマシンへの root アクセスが必要です。Ansible では、これはさまざまな方法で実行できます。
  • ansible_user=root ansible_ssh_pass="your_password_here" インベントリーのホスト変数またはグループ変数
  • ansible_user=root ansible_ssh_private_key_file="path_to_your_keyfile.pem" インベントリーのホスト変数またはグループ変数
  • ANSIBLE_BECOME_METHOD='sudo' ANSIBLE_BECOME=True ./setup.sh

become プラグインの詳細は、特権昇格について を参照してください。

手順

  1. インストーラーに移動します。

    1. [バンドルのインストーラー]

      $ cd ansible-automation-platform-setup-bundle-<latest-version>
    2. [オンラインインストーラー]

      $ cd ansible-automation-platform-setup-<latest-version>
  2. テキストエディターで inventory ファイルを開きます。
  3. inventory ファイルのパラメーターを編集して、インストールシナリオを指定します。以下の例に従ってください。

2.4.4. スタンドアロンの Automation Hub のインベントリーファイルの例

以下の例では、Automation Hub のスタンドアロンインスタンスをデプロイするためにインベントリーファイルを設定する方法を説明します。

重要
  • Red Hat Ansible Automation Platform または Automation Hub の場合: [automationhub] グループに Automation Hub ホストを追加します。自動化コントローラーと Automation Hub を同じノードにインストールすることはできません。
  • [automationhub] ホストに到達可能な IP アドレスまたは完全修飾ドメイン名 (FDQN) を指定して、ユーザーが別のノードから自動化ハブのコンテンツを同期してインストールできるようにします。「localhost」は使用しないでください。
  • registry_username および registry_password に Red Hat Registry Service Account の認証情報を入力し、Red Hat コンテナーレジストリーにリンクします。
[automationcontroller]


[automationhub]
<FQDN> ansible_connection=local

[database]
host2

[all:vars]
registry_url='registry.redhat.io'
registry_username='<registry username>'
registry_password='<registry password>'

automationhub_admin_password= <PASSWORD>

automationhub_pg_host=''
automationhub_pg_port=''

automationhub_pg_database='automationhub'
automationhub_pg_username='automationhub'
automationhub_pg_password=<PASSWORD>
automationhub_pg_sslmode='prefer'

# The default install will deploy a TLS enabled Automation Hub.
# If for some reason this is not the behavior wanted one can
# disable TLS enabled deployment.
#
# automationhub_disable_https = False
# The default install will generate self-signed certificates for the Automation
# Hub service. If you are providing valid certificate via automationhub_ssl_cert
# and automationhub_ssl_key, one should toggle that value to True.
#
# automationhub_ssl_validate_certs = False
# SSL-related variables
# If set, this will install a custom CA certificate to the system trust store.
# custom_ca_cert=/path/to/ca.crt
# Certificate and key to install in Automation Hub node
# automationhub_ssl_cert=/path/to/automationhub.cert
# automationhub_ssl_key=/path/to/automationhub.key

2.4.5. 追加のインベントリーファイル変数

インベントリーファイルに追加変数を追加して、Red Hat Ansible Automation Platform インストールをさらに設定できます。これらの設定では、Red Hat Ansible Automation Platform 管理用のさまざまなオプション機能を追加します。テキストエディターを使用して inventory ファイルを編集して、これらの変数を追加します。

表2.13 追加のインベントリーファイル変数

変数説明デフォルト

GALAXY_ENABLE_API_ACCESS_LOG

True に設定すると、/var/log/galaxy_api_access.log にログファイルが作成され、ユーザー名や IP アドレスなど、プラットフォームに対して行われたすべてのユーザーアクションが記録されます。

False

  • API アクセスログを有効にするには、変数をインベントリーに追加し、フラグを true に設定します。
[all:vars:]
admin_password = 'password'

pg_host=''
pg_port=''

GALAXY_ENABLE_API_ACCESS_LOG=true

2.4.6. 設定スクリプトフラグおよび追加変数

設定スクリプトを実行して Automation Controller をインストールする場合に、フラグおよび追加変数を指定することもできます。

表2.14 フラグ

引数説明

-h

ヘルプメッセージを表示して終了します。

-i INVENTORY_FILE

Ansible インベントリーファイルへのパス (デフォルト: inventory)

-e EXTRA_VARS

追加の Ansible 変数を key=value または YAML/JSON として設定します。

-b

インストールの代わりにデータベースのバックアップを実行します。

-r

インストールの代わりにデータベースの復元を行います。

-k

生成 and SECRET_KEY の配布

-- の区切り文字を使用して、適用する Ansible 引数を追加します。たとえば、./setup.sh -i my_awesome_inventory.yml -e matburt_is_country_gold=True — -K となります。

注記
  • -r を渡してデータベース復元を実行する場合は、EXTRA_VARS でデフォルト以外のパスを指定しない限り、デフォルト復元パスが使用されます。復元パスを指定する EXTRA_VAR を渡す以下の例を参照してください。

    ./setup.sh -e 'restore_backup_file=/path/to/nondefault/location' -r
  • -e bundle_install=false を渡すと、オンラインインストールを強制的に実行できます。

    $ ./setup.sh -e bundle_install=false

表2.15 追加変数

変数説明デフォルト

upgrade_ansible_with_tower

Automation Controller のインストール時に、Ansible も最新の状態であることを確認します。

False

create_preload_data

Tower のインストール時に、デモ組織、プロジェクト、認証情報、ジョブテンプレートなども作成します。

True

bundle_install_folder

バンドルからインストールする場合に、バンドルされているリポジトリーを配置する場所

var/lib/tower-bundle

nginx_disable_https

nginx で HTTPS トラフィックを無効にします。HTTPS の負荷をロードバランサーに分散する場合に便利です。

False

nginx_disable_hsts

Web セキュリティーポリシーメカニズム HSTS を無効にします。

False

nginx_http_port

nginx が HTTP をリッスンするように設定するポート

80

nginx_https_port

nginx が HTTPS をリッスンするように設定するポート

443

backup_dir

バックアップ時に使用する一時的な場所

/var/backups/tower/

restore_backup_file

復元元として使用する別のバックアップファイルを指定します。

なし

required_ram

Tower のインストールに必要な最小メモリー (テストインストールの場合に限り変更してください)

3750

min_open_fds

表示ファイルの説明に使用できる最小リソース (テストインストールの場合に限り変更してください)

なし

ignore_preflight_errors

プリフライトチェックを無視します。これはテンプレートや他のシステム以外のイメージにインストールするときに便利です (required_ram および min_open_fds をオーバーライドします)。

False

  • コアをアップグレードするには、以下を実行します。
./setup.sh -e upgrade_ansible_with_tower=1
  • nginx で処理する https を無効化するには、以下を実行します。
./setup.sh -e nginx_disable_https=true
  • バックアップファイルから復元時にデフォルトではないパスを指定する場合は、以下を実行します。
./setup.sh -e 'restore_backup_file=/path/to/nondefault/location' -r

2.4.7. Red Hat Ansible Automation Platform インストーラー設定スクリプトの実行

Private Automation Hub のインストールに必要なパラメーターを使用して inventory ファイルを更新したら、setup スクリプトを実行ができます。

手順

  1. setup.sh スクリプトを実行します。

    $ ./setup.sh

インストールが開始します。

2.4.8. Automation Controller インストールの確認

インストールが完了したら、inventory ファイルに挿入した管理者認証情報でログインして、Automation Controller が正常にインストールしたことを確認できます。

手順

  1. inventory ファイルのAutomation Controller ノードに指定した IP アドレスに移動します。
  2. inventory ファイルに設定した管理者認証情報を使用してログインします。
注記

Automation Controller サーバーには、ポート 80 からアクセスできます。https://<TOWER_SERVER_NAME>/ ただし、ポート 443 にリダイレクトされるため、443 も使用できる必要があります。

重要

インストールに失敗し、Red Hat Ansible Automation Platform の有効なライセンスを購入済みのお客様は、Red Hat カスタマーポータル (https://access.redhat.com/) から Ansible までお問い合せください。

自動化コントローラーへのログインに成功すると、Red Hat Ansible Automation Platform 2.1 のインストールが完了します。

2.4.8.1. 追加の Automation Hub の設定とリソース

追加の Automation Hub 設定については、以下のリソースを参照してください。

表2.16 Automation Controller を設定するための資料

リンク説明

Private Automation Hub でのユーザーアクセスの管理

Automation Hub のユーザーアクセスを設定します。

Automation Hub での Red Hat 認定コレクションおよび Ansible Galaxy コレクションの管理

Automation Hub にコンテンツを追加します。

Automation Hub でのプロプライエタリーコンテンツコレクションの公開

Automation Hub で社内で開発したコレクションを公開します。

2.4.9. Ansible Automation Platform 2.1 の次のステップ

Ansible Automation Platform を初めて使用するユーザーの場合でも、以前の Ansible コンテンツを最新版をインストールした Red Hat Ansible Automation Platform に移行する予定の既存の管理者の場合でも、次の手順を確認して、Ansible Automation Platform 2.1 の新機能を活用し始めてみてください。

2.4.9.1. Ansible Automation Platform 2.1 へのデータの移行

Ansible Automation Platform 2.1 へのアップグレードを完了しようとしているプラットフォーム管理者の場合には、データを新しいインスタンスに移行するために追加の手順が必要になる場合があります。

2.4.9.1.1. 従来の仮想環境 (venvs) から自動化実行環境への移行

Ansible Automation Platform 2.1 は、カスタム Python 仮想環境 (venvs) よりも、自動化実行環境 (Ansible 自動化の実行とスケーリングに必要なコンポーネントをパッケージ化するコンテナー化されたイメージ) を優先するようになっています。これには、Ansible Core、Ansible Content Collections、Python の依存関係、Red Hat Enterprise Linux UBI 8、およびその他のパッケージの依存関係が含まれます。

venv を実行環境に移行する場合は、(1) awx-manage コマンドを使用して、元のインスタンスから venv のリストを一覧表示してエクスポートし、(2) ansible-builder を使用して実行環境を作成する必要があります。詳細は、自動化実行環境へのアップグレードガイド および Ansible ビルダーガイド を参照してください。

2.4.9.1.2. Ansible Builder を使用した Ansible Engine 2.9 イメージへの移行

Ansible Automation Platform 2.1 で使用するために Ansible Engine 2.9 イメージを移行するには、ansible-builder ツールで、自動化実行環境で使用するためにイメージ (カスタムプラグインおよび依存関係を含む) を再構築するプロセスを自動化します。Ansible Builder を使用して実行環境を構築する方法の詳細は、Ansible Builder ガイド を参照してください。

2.4.9.1.3. Ansible Core 2.12 への移行

Ansible Core 2.12 にアップグレードする場合に、最新版の Ansible Core でサポートされるようにするには、Playbook、プラグイン、または Ansible インフラストラクチャーの他の部分を更新する必要があります。Ansible Core 2.12 との互換性を確保するために Ansible コンテンツを更新する手順については、Ansible-core2.12 Porting Guide を参照してください。

2.4.9.2. 自動化メッシュを使用した自動化スケールアップ

Red Hat Ansible Automation Platform の自動化メッシュコンポーネントは、マルチサイトのデプロイメント全体に自動化を分散するプロセスを簡素化します。IT 環境が複数に分離されている企業の場合、自動化メッシュは、ピアツーピアメッシュ通信ネットワークを使用して実行ノード全体に自動化をデプロイしてスケールアップするための一貫性があり、信頼性の高い方法を提供します。

バージョン 1.x から最新バージョンの Ansible Automation Platform にアップグレードする場合は、データをレガシーの分離ノードから自動化メッシュに必要な実行ノードに移行する必要があります。ハイブリッドノードとコントロールノードのネットワークを計画して、Ansible Automation Platform インストーラーにあるインベントリーファイルを編集して、メッシュ関連の値を各実行ノードに割り当てることで、自動化メッシュを実装できます。

分離ノードから実行ノードに移行する方法については、upgrade & migration guide

自動化メッシュと、ご使用の環境に合わせて自動化メッシュを設計するさまざまな方法については、Red Hat Ansible Automation Platform 化メッシュガイド を参照してください。

第3章 Red Hat Ansible Automation Platform のインストール

Red Hat Ansible Automation Platform のインストールには、Automation Controller と Automation Hub のデプロイが含まれます。

重要

Ansible Automation Platform インストーラーを使用すると、デプロイできます。only one インベントリーごとの Automation Hub。Automation Hub のスタンドアロンインスタンスには Ansible Automation Platform インストーラーを使用し、任意の数の異なるインベントリーでインストーラーを実行して、複数の Automation Hub をデプロイできます。

このインストールオプションには、サポート対象のシナリオが 2 つ含まれています。

3.1. Automation Controller ノードまたはインストーラー以外が管理するデータベースを使用した Red Hat Ansible Automation Platform のインストール

この手順に従って、Automation Controller ノード上のデータベース、またはインストーラー以外が管理するデータベースを使用して、Red Hat Ansible Automation Platform (Automation Controller および Automation Hub の両方) をインストールできます。

3.1.1. 前提条件

3.1.2. Red Hat Ansible Automation Platform インストール設定

Automation Hub のインストール時に、以下の設定を使用できます。

  • automationhub_importer_settings: galaxy-importer に渡す設定および設定のディクショナリー。/etc/galaxy-importer/galaxy-importer.cfg で終了します。
  • automationhub_require_content_approval: コレクションが利用可能になる前に、自動化ハブが承認メカニズムを適用するかどうか。
  • automationhub_disable_https: TLS を有効にして自動化ハブをデプロイするかどうか。
  • automationhub_disable_hsts: 自動化ハブが HTTP Strict Transport Security (HSTS) の Web セキュリティーポリシーメカニズムを有効にしてデプロイする必要があるかどうか。
  • automationhub_ssl_validate_certs: デフォルトでは、プラットフォームは自己署名証明書を使用してデプロイするため、自動化ハブが自らを要求する際に証明書を検証するかどうか (デフォルト = False)。
  • automationhub_ssl_cert: web_server_ssl_cert と同じですが、自動化ハブの UI と API 用。
  • automationhub_ssl_key: 自動化ハブの UI と API 用の web_server_ssl_key と同じです。
  • automationhub_backup_collections: オートメーションハブは、/var/lib/pulp のアーティファクトを提供します。デフォルトでは、これは true に設定され、自動化コントローラーはデフォルトでアーティファクトを自動的にバックアップします。パーティション (LVM、NFS、CephFS など) がそこにマウントされている場合、企業組織は常にバックアップされるようになります。この場合は、automationhub_backup_collections = false を設定すると、バックアップまたは復元プロセスでは /var/lib/pulp をバックアップまたは復元する必要はありません。

3.1.3. Red Hat Ansible Automation Platform インストーラーのインベントリーファイルの編集

Red Hat Ansible Automation Platform インストーラーのインベントリーファイルを使用して、インストールシナリオを指定できます。

注記
  • の使用external databases: インベントリーファイルのデータベースセクションが正しく設定されていることを確認してください。
  • [automationhub] グループに自動化ハブの情報を追加します。
  • Automation Hub と自動化コントローラーは、同じノードにインストールできません。
  • 自動化コントローラーは、使用するデータベースのレプリケーションやフェイルオーバーを設定しません。自動化コントローラーは、所有するレプリケーションと連携する必要があります。
  • パフォーマンス上の理由から、データベースサーバーは、自動化コントローラーサーバーと同じネットワーク上または同じデータセンターに置く必要があります。
  • Ansible Automation Platform をインストールするにはコンテナーレジストリーサービスが必要です。コンテナーレジストリーにアクセスできると、自動化実行環境を Ansible Automation Platform に読み込み、Ansible Playbook およびロール実行する一貫性のあるコンテナー化された環境を提供できます。デフォルトでは、Ansible Automation Platform は Red Hat レジストリーサービスアカウントを必要とする registry.redhat.io を使用します。レジストリーサービスアカウントの作成については、レジストリーサービスアカウントの作成 を参照してください。
  • upgrading an existing cluster: クラスターをアップグレードするときに、既存のインスタンスまたはインスタンスグループを除外するようにクラスターを再設定する必要がある場合があります。インベントリーファイルからインスタンスまたはインスタンスグループを省略すると、クラスターからインスタンスを削除するだけでは不十分です。インベントリーファイルからインスタンスまたはインスタンスグループを除外する他に、アップグレードを開始する前に、インスタンスまたはインスタンスグループのプロビジョニングを解除する 必要もあります。解除しないと、省略されたインスタンスまたはインスタンスグループはクラスターと通信し続けます。これにより、アップグレード中に Tower サービスに関する問題が生じる可能性があります。
  • clustered installations: クラスター化されたセットアップを作成している場合は、localhost をすべてのインスタンスのホスト名または IP アドレスに置き換える必要があります。すべてのノードまたはインスタンスが、このホスト名やアドレスを使用して他のノードに到達できるようにする必要があります。つまり、いずれかのノードで localhost ansible_connection=local を使用することができません。また、すべてのノードがホスト名と同じ形式を使用する必要があります。
重要
  • リモートマシンへの root アクセスが必要です。Ansible では、これはさまざまな方法で実行できます。
  • ansible_user=root ansible_ssh_pass="your_password_here" インベントリーのホスト変数またはグループ変数
  • ansible_user=root ansible_ssh_private_key_file="path_to_your_keyfile.pem" インベントリーのホスト変数またはグループ変数
  • ANSIBLE_BECOME_METHOD='sudo' ANSIBLE_BECOME=True ./setup.sh

become プラグインの詳細は、特権昇格について を参照してください。

手順

  1. インストーラーに移動します。

    1. [バンドルのインストーラー]

      $ cd ansible-automation-platform-setup-bundle-<latest-version>
    2. [オンラインインストーラー]

      $ cd ansible-automation-platform-setup-<latest-version>
  2. テキストエディターで inventory ファイルを開きます。
  3. inventory ファイルのパラメーターを編集して、インストールシナリオを指定します。以下の例に従ってください。

3.1.4. Automation Controller ノードまたはインストーラー以外が管理するデータベースのインベントリーファイル例

この例では、Red Hat Ansible Automation Platform をインストールするためにインベントリーファイルを設定する方法を説明します。このインストールインベントリーファイルには、Automation Controller ノードにあるデータベース、またはインストーラー以外が管理するデータベースを使用した Automation Controller および Automation Hub のインストールが含まれます。

重要
  • Automation Controller と Automation Hub を同じノードにインストールすることはできません。
  • [automationhub] ホストの到達可能な IP アドレスを指定して、ユーザーが別のノードから Private Automation Hub のコンテンツを同期できるようにします。
  • registry_username および registry_password に Red Hat Registry Service Account の認証情報を入力し、Red Hat コンテナーレジストリーにリンクします。
[automationcontroller]
controller.acme.org

[automationhub]
automationhub.acme.org

[all:vars]
admin_password='<password>'
pg_host=''
pg_port=''
pg_database='awx'
pg_username='awx'
pg_password='<password>'
pg_sslmode='prefer'  # set to 'verify-full' for client-side enforced SSL

registry_url='registry.redhat.io'
registry_username='<registry username>'
registry_password='<registry password>'

# Automation Hub Configuration
#
automationhub_admin_password='<password>'
automationhub_pg_host='controller.acme.org'
automationhub_pg_port='5432'
automationhub_pg_database='automationhub'
automationhub_pg_username='automationhub'
automationhub_pg_password='<password>'
automationhub_pg_sslmode='prefer'

# The default install will deploy a TLS enabled Automation Hub.
# If for some reason this is not the behavior wanted one can
# disable TLS enabled deployment.
#
# automationhub_disable_https = False
# The default install will generate self-signed certificates for the Automation
# Hub service. If you are providing valid certificate via automationhub_ssl_cert
# and automationhub_ssl_key, one should toggle that value to True.
#
# automationhub_ssl_validate_certs = False
# SSL-related variables
# If set, this will install a custom CA certificate to the system trust store.
# custom_ca_cert=/path/to/ca.crt
# Certificate and key to install in nginx for the web UI and API
# web_server_ssl_cert=/path/to/tower.cert
# web_server_ssl_key=/path/to/tower.key
# Certificate and key to install in Automation Hub node
# automationhub_ssl_cert=/path/to/automationhub.cert
# automationhub_ssl_key=/path/to/automationhub.key
# Server-side SSL settings for PostgreSQL (when we are installing it).
# postgres_use_ssl=False
# postgres_ssl_cert=/path/to/pgsql.crt
# postgres_ssl_key=/path/to/pgsql.key

3.1.5. 設定スクリプトフラグおよび追加変数

設定スクリプトを実行して Automation Controller をインストールする場合に、フラグおよび追加変数を指定することもできます。

表3.1 フラグ

引数説明

-h

ヘルプメッセージを表示して終了します。

-i INVENTORY_FILE

Ansible インベントリーファイルへのパス (デフォルト: inventory)

-e EXTRA_VARS

追加の Ansible 変数を key=value または YAML/JSON として設定します。

-b

インストールの代わりにデータベースのバックアップを実行します。

-r

インストールの代わりにデータベースの復元を行います。

-k

生成 and SECRET_KEY の配布

-- の区切り文字を使用して、適用する Ansible 引数を追加します。たとえば、./setup.sh -i my_awesome_inventory.yml -e matburt_is_country_gold=True — -K となります。

注記
  • -r を渡してデータベース復元を実行する場合は、EXTRA_VARS でデフォルト以外のパスを指定しない限り、デフォルト復元パスが使用されます。復元パスを指定する EXTRA_VAR を渡す以下の例を参照してください。

    ./setup.sh -e 'restore_backup_file=/path/to/nondefault/location' -r
  • -e bundle_install=false を渡すと、オンラインインストールを強制的に実行できます。

    $ ./setup.sh -e bundle_install=false

表3.2 追加変数

変数説明デフォルト

upgrade_ansible_with_tower

Automation Controller のインストール時に、Ansible も最新の状態であることを確認します。

False

create_preload_data

Tower のインストール時に、デモ組織、プロジェクト、認証情報、ジョブテンプレートなども作成します。

True

bundle_install_folder

バンドルからインストールする場合に、バンドルされているリポジトリーを配置する場所

var/lib/tower-bundle

nginx_disable_https

nginx で HTTPS トラフィックを無効にします。HTTPS の負荷をロードバランサーに分散する場合に便利です。

False

nginx_disable_hsts

Web セキュリティーポリシーメカニズム HSTS を無効にします。

False

nginx_http_port

nginx が HTTP をリッスンするように設定するポート

80

nginx_https_port

nginx が HTTPS をリッスンするように設定するポート

443

backup_dir

バックアップ時に使用する一時的な場所

/var/backups/tower/

restore_backup_file

復元元として使用する別のバックアップファイルを指定します。

なし

required_ram

Tower のインストールに必要な最小メモリー (テストインストールの場合に限り変更してください)

3750

min_open_fds

表示ファイルの説明に使用できる最小リソース (テストインストールの場合に限り変更してください)

なし

ignore_preflight_errors

プリフライトチェックを無視します。これはテンプレートや他のシステム以外のイメージにインストールするときに便利です (required_ram および min_open_fds をオーバーライドします)。

False

  • コアをアップグレードするには、以下を実行します。
./setup.sh -e upgrade_ansible_with_tower=1
  • nginx で処理する https を無効化するには、以下を実行します。
./setup.sh -e nginx_disable_https=true
  • バックアップファイルから復元時にデフォルトではないパスを指定する場合は、以下を実行します。
./setup.sh -e 'restore_backup_file=/path/to/nondefault/location' -r

3.1.6. Red Hat Ansible Automation Platform インストーラー設定スクリプトの実行

Private Automation Hub のインストールに必要なパラメーターを使用して inventory ファイルを更新したら、setup スクリプトを実行ができます。

手順

  1. setup.sh スクリプトを実行します。

    $ ./setup.sh

インストールが開始します。

3.1.7. Automation Controller インストールの確認

インストールが完了したら、inventory ファイルに挿入した管理者認証情報でログインして、Automation Controller が正常にインストールしたことを確認できます。

手順

  1. inventory ファイルのAutomation Controller ノードに指定した IP アドレスに移動します。
  2. inventory ファイルに設定した管理者認証情報を使用してログインします。
注記

Automation Controller サーバーには、ポート 80 からアクセスできます。https://<TOWER_SERVER_NAME>/ ただし、ポート 443 にリダイレクトされるため、443 も使用できる必要があります。

重要

インストールに失敗し、Red Hat Ansible Automation Platform の有効なライセンスを購入済みのお客様は、Red Hat カスタマーポータル (https://access.redhat.com/) から Ansible までお問い合せください。

自動化コントローラーへのログインに成功すると、Red Hat Ansible Automation Platform 2.1 のインストールが完了します。

3.1.7.1. 追加の Automation Controller の設定とリソース

追加のAutomation Controller の設定については、以下の資料を参照してください。

表3.3 Automation Controller を設定するための資料

リンク説明

Automation Controller クイックセットアップガイド

Automation Controller を設定して最初の Playbook を実行します。

Automation Controller 管理ガイド

カスタマースクリプト、管理ジョブなどを使用して Automation Controller の管理を設定します。

Red Hat Ansible Automation Platform のプロキシーサポートの設定

プロキシーサーバーを使用して Automation Controller を設定します。

ユーザビリティーアナリティクスおよび Automation Controller からのデータ収集の管理

Red Hat と共有する Automation Controller の情報を管理します。

Automation Controller ユーザーガイド

Automation Controller の機能をより詳細に確認します。

3.1.8. Automation Hub のインストールの確認

インストールが完了したら、inventory ファイルに挿入した管理者認証情報でログインして、自動化ハブが正常にインストールしたことを確認できます。

手順

  1. inventory ファイルの自動化ハブノードに指定した IP アドレスに移動します。
  2. inventory ファイルに設定した管理者認証情報を使用してログインします。
重要

インストールに失敗し、Red Hat Ansible Automation Platform の有効なライセンスを購入済みのお客様は、Red Hat カスタマーポータル (https://access.redhat.com/) から Ansible までお問い合せください。

Automation Hub へのログインが成功すると、Red Hat Ansible Automation Platform 2.1 のインストールが完了します。

3.1.8.1. 追加の Automation Hub の設定とリソース

追加の Automation Hub 設定については、以下のリソースを参照してください。

表3.4 Automation Controller を設定するための資料

リンク説明

Private Automation Hub でのユーザーアクセスの管理

Automation Hub のユーザーアクセスを設定します。

Automation Hub での Red Hat 認定コレクションおよび Ansible Galaxy コレクションの管理

Automation Hub にコンテンツを追加します。

Automation Hub でのプロプライエタリーコンテンツコレクションの公開

Automation Hub で社内で開発したコレクションを公開します。

3.1.9. Ansible Automation Platform 2.1 の次のステップ

Ansible Automation Platform を初めて使用するユーザーの場合でも、以前の Ansible コンテンツを最新版をインストールした Red Hat Ansible Automation Platform に移行する予定の既存の管理者の場合でも、次の手順を確認して、Ansible Automation Platform 2.1 の新機能を活用し始めてみてください。

3.1.9.1. Ansible Automation Platform 2.1 へのデータの移行

Ansible Automation Platform 2.1 へのアップグレードを完了しようとしているプラットフォーム管理者の場合には、データを新しいインスタンスに移行するために追加の手順が必要になる場合があります。

3.1.9.1.1. 従来の仮想環境 (venvs) から自動化実行環境への移行

Ansible Automation Platform 2.1 は、カスタム Python 仮想環境 (venvs) よりも、自動化実行環境 (Ansible 自動化の実行とスケーリングに必要なコンポーネントをパッケージ化するコンテナー化されたイメージ) を優先するようになっています。これには、Ansible Core、Ansible Content Collections、Python の依存関係、Red Hat Enterprise Linux UBI 8、およびその他のパッケージの依存関係が含まれます。

venv を実行環境に移行する場合は、(1) awx-manage コマンドを使用して、元のインスタンスから venv のリストを一覧表示してエクスポートし、(2) ansible-builder を使用して実行環境を作成する必要があります。詳細は、自動化実行環境へのアップグレードガイド および Ansible ビルダーガイド を参照してください。

3.1.9.1.2. Ansible Builder を使用した Ansible Engine 2.9 イメージへの移行

Ansible Automation Platform 2.1 で使用するために Ansible Engine 2.9 イメージを移行するには、ansible-builder ツールで、自動化実行環境で使用するためにイメージ (カスタムプラグインおよび依存関係を含む) を再構築するプロセスを自動化します。Ansible Builder を使用して実行環境を構築する方法の詳細は、Ansible Builder ガイド を参照してください。

3.1.9.1.3. Ansible Core 2.12 への移行

Ansible Core 2.12 にアップグレードする場合に、最新版の Ansible Core でサポートされるようにするには、Playbook、プラグイン、または Ansible インフラストラクチャーの他の部分を更新する必要があります。Ansible Core 2.12 との互換性を確保するために Ansible コンテンツを更新する手順については、Ansible-core2.12 Porting Guide を参照してください。

3.1.9.2. 自動化メッシュを使用した自動化スケールアップ

Red Hat Ansible Automation Platform の自動化メッシュコンポーネントは、マルチサイトのデプロイメント全体に自動化を分散するプロセスを簡素化します。IT 環境が複数に分離されている企業の場合、自動化メッシュは、ピアツーピアメッシュ通信ネットワークを使用して実行ノード全体に自動化をデプロイしてスケールアップするための一貫性があり、信頼性の高い方法を提供します。

バージョン 1.x から最新バージョンの Ansible Automation Platform にアップグレードする場合は、データをレガシーの分離ノードから自動化メッシュに必要な実行ノードに移行する必要があります。ハイブリッドノードとコントロールノードのネットワークを計画して、Ansible Automation Platform インストーラーにあるインベントリーファイルを編集して、メッシュ関連の値を各実行ノードに割り当てることで、自動化メッシュを実装できます。

分離ノードから実行ノードに移行する方法については、upgrade & migration guide

自動化メッシュと、ご使用の環境に合わせて自動化メッシュを設計するさまざまな方法については、Red Hat Ansible Automation Platform 化メッシュガイド を参照してください。

3.2. 外部の管理データベースを使用した Red Hat Ansible Automation Platform のインストール

以下の手順に従って、外部の管理データベースを使用して Red Hat Ansible Automation Platform (Automation Controller および Automation Hub の両方) をインストールできます。

3.2.1. 前提条件

3.2.2. Red Hat Ansible Automation Platform インストール設定

Automation Hub のインストール時に、以下の設定を使用できます。

  • automationhub_importer_settings: galaxy-importer に渡す設定および設定のディクショナリー。/etc/galaxy-importer/galaxy-importer.cfg で終了します。
  • automationhub_require_content_approval: コレクションが利用可能になる前に、自動化ハブが承認メカニズムを適用するかどうか。
  • automationhub_disable_https: TLS を有効にして自動化ハブをデプロイするかどうか。
  • automationhub_disable_hsts: 自動化ハブが HTTP Strict Transport Security (HSTS) の Web セキュリティーポリシーメカニズムを有効にしてデプロイする必要があるかどうか。
  • automationhub_ssl_validate_certs: デフォルトでは、プラットフォームは自己署名証明書を使用してデプロイするため、自動化ハブが自らを要求する際に証明書を検証するかどうか (デフォルト = False)。
  • automationhub_ssl_cert: web_server_ssl_cert と同じですが、自動化ハブの UI と API 用。
  • automationhub_ssl_key: 自動化ハブの UI と API 用の web_server_ssl_key と同じです。
  • automationhub_backup_collections: オートメーションハブは、/var/lib/pulp のアーティファクトを提供します。デフォルトでは、これは true に設定され、自動化コントローラーはデフォルトでアーティファクトを自動的にバックアップします。パーティション (LVM、NFS、CephFS など) がそこにマウントされている場合、企業組織は常にバックアップされるようになります。この場合は、automationhub_backup_collections = false を設定すると、バックアップまたは復元プロセスでは /var/lib/pulp をバックアップまたは復元する必要はありません。

3.2.3. Red Hat Ansible Automation Platform インストーラーのインベントリーファイルの編集

Red Hat Ansible Automation Platform インストーラーのインベントリーファイルを使用して、インストールシナリオを指定できます。

注記
  • の使用external databases: インベントリーファイルのデータベースセクションが正しく設定されていることを確認してください。
  • [automationhub] グループに自動化ハブの情報を追加します。
  • Automation Hub と自動化コントローラーは、同じノードにインストールできません。
  • 自動化コントローラーは、使用するデータベースのレプリケーションやフェイルオーバーを設定しません。自動化コントローラーは、所有するレプリケーションと連携する必要があります。
  • パフォーマンス上の理由から、データベースサーバーは、自動化コントローラーサーバーと同じネットワーク上または同じデータセンターに置く必要があります。
  • Ansible Automation Platform をインストールするにはコンテナーレジストリーサービスが必要です。コンテナーレジストリーにアクセスできると、自動化実行環境を Ansible Automation Platform に読み込み、Ansible Playbook およびロール実行する一貫性のあるコンテナー化された環境を提供できます。デフォルトでは、Ansible Automation Platform は Red Hat レジストリーサービスアカウントを必要とする registry.redhat.io を使用します。レジストリーサービスアカウントの作成については、レジストリーサービスアカウントの作成 を参照してください。
  • upgrading an existing cluster: クラスターをアップグレードするときに、既存のインスタンスまたはインスタンスグループを除外するようにクラスターを再設定する必要がある場合があります。インベントリーファイルからインスタンスまたはインスタンスグループを省略すると、クラスターからインスタンスを削除するだけでは不十分です。インベントリーファイルからインスタンスまたはインスタンスグループを除外する他に、アップグレードを開始する前に、インスタンスまたはインスタンスグループのプロビジョニングを解除する 必要もあります。解除しないと、省略されたインスタンスまたはインスタンスグループはクラスターと通信し続けます。これにより、アップグレード中に Tower サービスに関する問題が生じる可能性があります。
  • clustered installations: クラスター化されたセットアップを作成している場合は、localhost をすべてのインスタンスのホスト名または IP アドレスに置き換える必要があります。すべてのノードまたはインスタンスが、このホスト名やアドレスを使用して他のノードに到達できるようにする必要があります。つまり、いずれかのノードで localhost ansible_connection=local を使用することができません。また、すべてのノードがホスト名と同じ形式を使用する必要があります。
重要
  • リモートマシンへの root アクセスが必要です。Ansible では、これはさまざまな方法で実行できます。
  • ansible_user=root ansible_ssh_pass="your_password_here" インベントリーのホスト変数またはグループ変数
  • ansible_user=root ansible_ssh_private_key_file="path_to_your_keyfile.pem" インベントリーのホスト変数またはグループ変数
  • ANSIBLE_BECOME_METHOD='sudo' ANSIBLE_BECOME=True ./setup.sh

become プラグインの詳細は、特権昇格について を参照してください。

手順

  1. インストーラーに移動します。

    1. [バンドルのインストーラー]

      $ cd ansible-automation-platform-setup-bundle-<latest-version>
    2. [オンラインインストーラー]

      $ cd ansible-automation-platform-setup-<latest-version>
  2. テキストエディターで inventory ファイルを開きます。
  3. inventory ファイルのパラメーターを編集して、インストールシナリオを指定します。以下の例に従ってください。

3.2.4. 外部管理データベースを含む Red Hat Ansible Automation Platform インベントリーファイルの例

この例では、Red Hat Ansible Automation Platform をインストールするためにインベントリーファイルを設定する方法を説明します。このインストールインベントリーファイルには、外部の管理データベースを備えた Automation Controller と Automation Hub の両方が含まれます。

重要
  • Automation Controller と Automation Hub を同じノードにインストールすることはできません。
  • [automationhub] ホストの到達可能な IP アドレスを指定して、ユーザーが別のノードから Private Automation Hub のコンテンツを同期できるようにします。
  • registry_username および registry_password に Red Hat Registry Service Account の認証情報を入力し、Red Hat コンテナーレジストリーにリンクします。
[automationcontroller]
controller.acme.org

[automationhub]
automationhub.acme.org

[database]
database-01.acme.org

[all:vars]
admin_password='<password>'
pg_host='database-01.acme.org'
pg_port='5432'
pg_database='awx'
pg_username='awx'
pg_password='<password>'
pg_sslmode='prefer'  # set to 'verify-full' for client-side enforced SSL

registry_url='registry.redhat.io'
registry_username='<registry username>'
registry_password='<registry password>'

# Automation Hub Configuration
#
automationhub_admin_password='<password>'
automationhub_pg_host='database-01.acme.org'
automationhub_pg_port='5432'
automationhub_pg_database='automationhub'
automationhub_pg_username='automationhub'
automationhub_pg_password='<password>'
automationhub_pg_sslmode='prefer'

# The default install will deploy a TLS enabled Automation Hub.
# If for some reason this is not the behavior wanted one can
# disable TLS enabled deployment.
#
# automationhub_disable_https = False
# The default install will generate self-signed certificates for the Automation
# Hub service. If you are providing valid certificate via automationhub_ssl_cert
# and automationhub_ssl_key, one should toggle that value to True.
#
# automationhub_ssl_validate_certs = False
# SSL-related variables
# If set, this will install a custom CA certificate to the system trust store.
# custom_ca_cert=/path/to/ca.crt
# Certificate and key to install in nginx for the web UI and API
# web_server_ssl_cert=/path/to/tower.cert
# web_server_ssl_key=/path/to/tower.key
# Certificate and key to install in Automation Hub node
# automationhub_ssl_cert=/path/to/automationhub.cert
# automationhub_ssl_key=/path/to/automationhub.key
# Server-side SSL settings for PostgreSQL (when we are installing it).
# postgres_use_ssl=False
# postgres_ssl_cert=/path/to/pgsql.crt
# postgres_ssl_key=/path/to/pgsql.key

3.2.5. 設定スクリプトフラグおよび追加変数

設定スクリプトを実行して Automation Controller をインストールする場合に、フラグおよび追加変数を指定することもできます。

表3.5 フラグ

引数説明

-h

ヘルプメッセージを表示して終了します。

-i INVENTORY_FILE

Ansible インベントリーファイルへのパス (デフォルト: inventory)

-e EXTRA_VARS

追加の Ansible 変数を key=value または YAML/JSON として設定します。

-b

インストールの代わりにデータベースのバックアップを実行します。

-r

インストールの代わりにデータベースの復元を行います。

-k

生成 and SECRET_KEY の配布

-- の区切り文字を使用して、適用する Ansible 引数を追加します。たとえば、./setup.sh -i my_awesome_inventory.yml -e matburt_is_country_gold=True — -K となります。

注記
  • -r を渡してデータベース復元を実行する場合は、EXTRA_VARS でデフォルト以外のパスを指定しない限り、デフォルト復元パスが使用されます。復元パスを指定する EXTRA_VAR を渡す以下の例を参照してください。

    ./setup.sh -e 'restore_backup_file=/path/to/nondefault/location' -r
  • -e bundle_install=false を渡すと、オンラインインストールを強制的に実行できます。

    $ ./setup.sh -e bundle_install=false

表3.6 追加変数

変数説明デフォルト

upgrade_ansible_with_tower

Automation Controller のインストール時に、Ansible も最新の状態であることを確認します。

False

create_preload_data

Tower のインストール時に、デモ組織、プロジェクト、認証情報、ジョブテンプレートなども作成します。

True

bundle_install_folder

バンドルからインストールする場合に、バンドルされているリポジトリーを配置する場所

var/lib/tower-bundle

nginx_disable_https

nginx で HTTPS トラフィックを無効にします。HTTPS の負荷をロードバランサーに分散する場合に便利です。

False

nginx_disable_hsts

Web セキュリティーポリシーメカニズム HSTS を無効にします。

False

nginx_http_port

nginx が HTTP をリッスンするように設定するポート

80

nginx_https_port

nginx が HTTPS をリッスンするように設定するポート

443

backup_dir

バックアップ時に使用する一時的な場所

/var/backups/tower/

restore_backup_file

復元元として使用する別のバックアップファイルを指定します。

なし

required_ram

Tower のインストールに必要な最小メモリー (テストインストールの場合に限り変更してください)

3750

min_open_fds

表示ファイルの説明に使用できる最小リソース (テストインストールの場合に限り変更してください)

なし

ignore_preflight_errors

プリフライトチェックを無視します。これはテンプレートや他のシステム以外のイメージにインストールするときに便利です (required_ram および min_open_fds をオーバーライドします)。

False

  • コアをアップグレードするには、以下を実行します。
./setup.sh -e upgrade_ansible_with_tower=1
  • nginx で処理する https を無効化するには、以下を実行します。
./setup.sh -e nginx_disable_https=true
  • バックアップファイルから復元時にデフォルトではないパスを指定する場合は、以下を実行します。
./setup.sh -e 'restore_backup_file=/path/to/nondefault/location' -r

3.2.6. Red Hat Ansible Automation Platform インストーラー設定スクリプトの実行

Private Automation Hub のインストールに必要なパラメーターを使用して inventory ファイルを更新したら、setup スクリプトを実行ができます。

手順

  1. setup.sh スクリプトを実行します。

    $ ./setup.sh

インストールが開始します。

3.2.7. Automation Controller インストールの確認

インストールが完了したら、inventory ファイルに挿入した管理者認証情報でログインして、Automation Controller が正常にインストールしたことを確認できます。

手順

  1. inventory ファイルのAutomation Controller ノードに指定した IP アドレスに移動します。
  2. inventory ファイルに設定した管理者認証情報を使用してログインします。
注記

Automation Controller サーバーには、ポート 80 からアクセスできます。https://<TOWER_SERVER_NAME>/ ただし、ポート 443 にリダイレクトされるため、443 も使用できる必要があります。

重要

インストールに失敗し、Red Hat Ansible Automation Platform の有効なライセンスを購入済みのお客様は、Red Hat カスタマーポータル (https://access.redhat.com/) から Ansible までお問い合せください。

自動化コントローラーへのログインに成功すると、Red Hat Ansible Automation Platform 2.1 のインストールが完了します。

3.2.7.1. 追加の Automation Controller の設定とリソース

追加のAutomation Controller の設定については、以下の資料を参照してください。

表3.7 Automation Controller を設定するための資料

リンク説明

Automation Controller クイックセットアップガイド

Automation Controller を設定して最初の Playbook を実行します。

Automation Controller 管理ガイド

カスタマースクリプト、管理ジョブなどを使用して Automation Controller の管理を設定します。

Red Hat Ansible Automation Platform のプロキシーサポートの設定

プロキシーサーバーを使用して Automation Controller を設定します。

ユーザビリティーアナリティクスおよび Automation Controller からのデータ収集の管理

Red Hat と共有する Automation Controller の情報を管理します。

Automation Controller ユーザーガイド

Automation Controller の機能をより詳細に確認します。

3.2.8. Automation Hub のインストールの確認

インストールが完了したら、inventory ファイルに挿入した管理者認証情報でログインして、自動化ハブが正常にインストールしたことを確認できます。

手順

  1. inventory ファイルの自動化ハブノードに指定した IP アドレスに移動します。
  2. inventory ファイルに設定した管理者認証情報を使用してログインします。
重要

インストールに失敗し、Red Hat Ansible Automation Platform の有効なライセンスを購入済みのお客様は、Red Hat カスタマーポータル (https://access.redhat.com/) から Ansible までお問い合せください。

Automation Hub へのログインが成功すると、Red Hat Ansible Automation Platform 2.1 のインストールが完了します。

3.2.8.1. 追加の Automation Hub の設定とリソース

追加の Automation Hub 設定については、以下のリソースを参照してください。

表3.8 Automation Controller を設定するための資料

リンク説明

Private Automation Hub でのユーザーアクセスの管理

Automation Hub のユーザーアクセスを設定します。

Automation Hub での Red Hat 認定コレクションおよび Ansible Galaxy コレクションの管理

Automation Hub にコンテンツを追加します。

Automation Hub でのプロプライエタリーコンテンツコレクションの公開

Automation Hub で社内で開発したコレクションを公開します。

3.2.9. Ansible Automation Platform 2.1 の次のステップ

Ansible Automation Platform を初めて使用するユーザーの場合でも、以前の Ansible コンテンツを最新版をインストールした Red Hat Ansible Automation Platform に移行する予定の既存の管理者の場合でも、次の手順を確認して、Ansible Automation Platform 2.1 の新機能を活用し始めてみてください。

3.2.9.1. Ansible Automation Platform 2.1 へのデータの移行

Ansible Automation Platform 2.1 へのアップグレードを完了しようとしているプラットフォーム管理者の場合には、データを新しいインスタンスに移行するために追加の手順が必要になる場合があります。

3.2.9.1.1. 従来の仮想環境 (venvs) から自動化実行環境への移行

Ansible Automation Platform 2.1 は、カスタム Python 仮想環境 (venvs) よりも、自動化実行環境 (Ansible 自動化の実行とスケーリングに必要なコンポーネントをパッケージ化するコンテナー化されたイメージ) を優先するようになっています。これには、Ansible Core、Ansible Content Collections、Python の依存関係、Red Hat Enterprise Linux UBI 8、およびその他のパッケージの依存関係が含まれます。

venv を実行環境に移行する場合は、(1) awx-manage コマンドを使用して、元のインスタンスから venv のリストを一覧表示してエクスポートし、(2) ansible-builder を使用して実行環境を作成する必要があります。詳細は、自動化実行環境へのアップグレードガイド および Ansible ビルダーガイド を参照してください。

3.2.9.1.2. Ansible Builder を使用した Ansible Engine 2.9 イメージへの移行

Ansible Automation Platform 2.1 で使用するために Ansible Engine 2.9 イメージを移行するには、ansible-builder ツールで、自動化実行環境で使用するためにイメージ (カスタムプラグインおよび依存関係を含む) を再構築するプロセスを自動化します。Ansible Builder を使用して実行環境を構築する方法の詳細は、Ansible Builder ガイド を参照してください。

3.2.9.1.3. Ansible Core 2.12 への移行

Ansible Core 2.12 にアップグレードする場合に、最新版の Ansible Core でサポートされるようにするには、Playbook、プラグイン、または Ansible インフラストラクチャーの他の部分を更新する必要があります。Ansible Core 2.12 との互換性を確保するために Ansible コンテンツを更新する手順については、Ansible-core2.12 Porting Guide を参照してください。

3.2.9.2. 自動化メッシュを使用した自動化スケールアップ

Red Hat Ansible Automation Platform の自動化メッシュコンポーネントは、マルチサイトのデプロイメント全体に自動化を分散するプロセスを簡素化します。IT 環境が複数に分離されている企業の場合、自動化メッシュは、ピアツーピアメッシュ通信ネットワークを使用して実行ノード全体に自動化をデプロイしてスケールアップするための一貫性があり、信頼性の高い方法を提供します。

バージョン 1.x から最新バージョンの Ansible Automation Platform にアップグレードする場合は、データをレガシーの分離ノードから自動化メッシュに必要な実行ノードに移行する必要があります。ハイブリッドノードとコントロールノードのネットワークを計画して、Ansible Automation Platform インストーラーにあるインベントリーファイルを編集して、メッシュ関連の値を各実行ノードに割り当てることで、自動化メッシュを実装できます。

分離ノードから実行ノードに移行する方法については、upgrade & migration guide

自動化メッシュと、ご使用の環境に合わせて自動化メッシュを設計するさまざまな方法については、Red Hat Ansible Automation Platform 化メッシュガイド を参照してください。

第4章 マルチマシンクラスターのインストール

外部管理データベースを使用して、Automation Hub を使用して、クラスター化されたA utomation Controller として Ansible Automation Platform をインストールできます。このモードでは、複数の Automation Controller ノードがインストールされ、アクティブになります。任意のノードは HTTP 要求を受け取ることができ、すべてのノードがジョブを実行することができます。これにより、Ansible Automation Platform サーバーがクラスターにインストールされ、データベースとして PostgreSQL のリモートインスタンスと対話するように設定します。このリモート PostgreSQL は、管理するサーバーを使用することも、Amazon RDS などのクラウドサービスで提供することも可能です。

重要

Ansible Automation Platform インストーラーを使用すると、デプロイできます。only one インベントリーごとの Automation Hub。Automation Hub のスタンドアロンインスタンスには Ansible Automation Platform インストーラーを使用し、任意の数の異なるインベントリーでインストーラーを実行して、複数の Automation Hub をデプロイできます。

4.1. 外部管理データベースを使用した複数ノードの Red Hat Ansible Automation Platform のインストール

この手順に従い、外部管理データベースを使用して、Red Hat Ansible Automation Platform を複数の Automation Controller ノードおよび Automation Hub としてインストールできます。

4.1.1. 前提条件

4.1.2. Red Hat Ansible Automation Platform インストール設定

Automation Hub のインストール時に、以下の設定を使用できます。

  • automationhub_importer_settings: galaxy-importer に渡す設定および設定のディクショナリー。/etc/galaxy-importer/galaxy-importer.cfg で終了します。
  • automationhub_require_content_approval: コレクションが利用可能になる前に、自動化ハブが承認メカニズムを適用するかどうか。
  • automationhub_disable_https: TLS を有効にして自動化ハブをデプロイするかどうか。
  • automationhub_disable_hsts: 自動化ハブが HTTP Strict Transport Security (HSTS) の Web セキュリティーポリシーメカニズムを有効にしてデプロイする必要があるかどうか。
  • automationhub_ssl_validate_certs: デフォルトでは、プラットフォームは自己署名証明書を使用してデプロイするため、自動化ハブが自らを要求する際に証明書を検証するかどうか (デフォルト = False)。
  • automationhub_ssl_cert: web_server_ssl_cert と同じですが、自動化ハブの UI と API 用。
  • automationhub_ssl_key: 自動化ハブの UI と API 用の web_server_ssl_key と同じです。
  • automationhub_backup_collections: オートメーションハブは、/var/lib/pulp のアーティファクトを提供します。デフォルトでは、これは true に設定され、自動化コントローラーはデフォルトでアーティファクトを自動的にバックアップします。パーティション (LVM、NFS、CephFS など) がそこにマウントされている場合、企業組織は常にバックアップされるようになります。この場合は、automationhub_backup_collections = false を設定すると、バックアップまたは復元プロセスでは /var/lib/pulp をバックアップまたは復元する必要はありません。

4.1.3. Red Hat Ansible Automation Platform インストーラーのインベントリーファイルの編集

Red Hat Ansible Automation Platform インストーラーのインベントリーファイルを使用して、インストールシナリオを指定できます。

注記
  • の使用external databases: インベントリーファイルのデータベースセクションが正しく設定されていることを確認してください。
  • [automationhub] グループに自動化ハブの情報を追加します。
  • Automation Hub と自動化コントローラーは、同じノードにインストールできません。
  • 自動化コントローラーは、使用するデータベースのレプリケーションやフェイルオーバーを設定しません。自動化コントローラーは、所有するレプリケーションと連携する必要があります。
  • パフォーマンス上の理由から、データベースサーバーは、自動化コントローラーサーバーと同じネットワーク上または同じデータセンターに置く必要があります。
  • Ansible Automation Platform をインストールするにはコンテナーレジストリーサービスが必要です。コンテナーレジストリーにアクセスできると、自動化実行環境を Ansible Automation Platform に読み込み、Ansible Playbook およびロール実行する一貫性のあるコンテナー化された環境を提供できます。デフォルトでは、Ansible Automation Platform は Red Hat レジストリーサービスアカウントを必要とする registry.redhat.io を使用します。レジストリーサービスアカウントの作成については、レジストリーサービスアカウントの作成 を参照してください。
  • upgrading an existing cluster: クラスターをアップグレードするときに、既存のインスタンスまたはインスタンスグループを除外するようにクラスターを再設定する必要がある場合があります。インベントリーファイルからインスタンスまたはインスタンスグループを省略すると、クラスターからインスタンスを削除するだけでは不十分です。インベントリーファイルからインスタンスまたはインスタンスグループを除外する他に、アップグレードを開始する前に、インスタンスまたはインスタンスグループのプロビジョニングを解除する 必要もあります。解除しないと、省略されたインスタンスまたはインスタンスグループはクラスターと通信し続けます。これにより、アップグレード中に Tower サービスに関する問題が生じる可能性があります。
  • clustered installations: クラスター化されたセットアップを作成している場合は、localhost をすべてのインスタンスのホスト名または IP アドレスに置き換える必要があります。すべてのノードまたはインスタンスが、このホスト名やアドレスを使用して他のノードに到達できるようにする必要があります。つまり、いずれかのノードで localhost ansible_connection=local を使用することができません。また、すべてのノードがホスト名と同じ形式を使用する必要があります。
重要
  • リモートマシンへの root アクセスが必要です。Ansible では、これはさまざまな方法で実行できます。
  • ansible_user=root ansible_ssh_pass="your_password_here" インベントリーのホスト変数またはグループ変数
  • ansible_user=root ansible_ssh_private_key_file="path_to_your_keyfile.pem" インベントリーのホスト変数またはグループ変数
  • ANSIBLE_BECOME_METHOD='sudo' ANSIBLE_BECOME=True ./setup.sh

become プラグインの詳細は、特権昇格について を参照してください。

手順

  1. インストーラーに移動します。

    1. [バンドルのインストーラー]

      $ cd ansible-automation-platform-setup-bundle-<latest-version>
    2. [オンラインインストーラー]

      $ cd ansible-automation-platform-setup-<latest-version>
  2. テキストエディターで inventory ファイルを開きます。
  3. inventory ファイルのパラメーターを編集して、インストールシナリオを指定します。以下の例に従ってください。

4.1.4. Red Hat Ansible Automation Platform の複数ノードのインベントリーファイル例

以下の例では、Automation Controller のマルチノードクラスターインストールのインベントリーファイルを追加する方法を説明します。

重要
  • Automation Controller と Automation Hub を同じノードにインストールすることはできません。
  • [automationhub] ホストの到達可能な IP アドレスを指定して、ユーザーが別のノードから Private Automation Hub のコンテンツを同期できるようにします。
  • pg_password には特殊文字を使用しないでください。これにより、設定が失敗する場合があります。
  • registry_username および registry_password に Red Hat Registry Service Account の認証情報を入力し、Red Hat コンテナーレジストリーにリンクします。
[automationcontroller]
host1
host11
host12


[automationhub]
host2

[database]
1

[all:vars]
ansible_become=true

admin_password='<password>'

pg_host='dbnode.example.com'
pg_port='5432'

pg_database='tower'
pg_username='tower'
pg_password='<password>'

registry_url='registry.redhat.io'
registry_username='<registry username>'
registry_password='<registry password>'
1
フィールドは空でなければなりません。

4.1.5. 設定スクリプトフラグおよび追加変数

設定スクリプトを実行して Automation Controller をインストールする場合に、フラグおよび追加変数を指定することもできます。

表4.1 フラグ

引数説明

-h

ヘルプメッセージを表示して終了します。

-i INVENTORY_FILE

Ansible インベントリーファイルへのパス (デフォルト: inventory)

-e EXTRA_VARS

追加の Ansible 変数を key=value または YAML/JSON として設定します。

-b

インストールの代わりにデータベースのバックアップを実行します。

-r

インストールの代わりにデータベースの復元を行います。

-k

生成 and SECRET_KEY の配布

-- の区切り文字を使用して、適用する Ansible 引数を追加します。たとえば、./setup.sh -i my_awesome_inventory.yml -e matburt_is_country_gold=True — -K となります。

注記
  • -r を渡してデータベース復元を実行する場合は、EXTRA_VARS でデフォルト以外のパスを指定しない限り、デフォルト復元パスが使用されます。復元パスを指定する EXTRA_VAR を渡す以下の例を参照してください。

    ./setup.sh -e 'restore_backup_file=/path/to/nondefault/location' -r
  • -e bundle_install=false を渡すと、オンラインインストールを強制的に実行できます。

    $ ./setup.sh -e bundle_install=false

表4.2 追加変数

変数説明デフォルト

upgrade_ansible_with_tower

Automation Controller のインストール時に、Ansible も最新の状態であることを確認します。

False

create_preload_data

Tower のインストール時に、デモ組織、プロジェクト、認証情報、ジョブテンプレートなども作成します。

True

bundle_install_folder

バンドルからインストールする場合に、バンドルされているリポジトリーを配置する場所

var/lib/tower-bundle

nginx_disable_https

nginx で HTTPS トラフィックを無効にします。HTTPS の負荷をロードバランサーに分散する場合に便利です。

False

nginx_disable_hsts

Web セキュリティーポリシーメカニズム HSTS を無効にします。

False

nginx_http_port

nginx が HTTP をリッスンするように設定するポート

80

nginx_https_port

nginx が HTTPS をリッスンするように設定するポート

443

backup_dir

バックアップ時に使用する一時的な場所

/var/backups/tower/

restore_backup_file

復元元として使用する別のバックアップファイルを指定します。

なし

required_ram

Tower のインストールに必要な最小メモリー (テストインストールの場合に限り変更してください)

3750

min_open_fds

表示ファイルの説明に使用できる最小リソース (テストインストールの場合に限り変更してください)

なし

ignore_preflight_errors

プリフライトチェックを無視します。これはテンプレートや他のシステム以外のイメージにインストールするときに便利です (required_ram および min_open_fds をオーバーライドします)。

False

  • コアをアップグレードするには、以下を実行します。
./setup.sh -e upgrade_ansible_with_tower=1
  • nginx で処理する https を無効化するには、以下を実行します。
./setup.sh -e nginx_disable_https=true
  • バックアップファイルから復元時にデフォルトではないパスを指定する場合は、以下を実行します。
./setup.sh -e 'restore_backup_file=/path/to/nondefault/location' -r

4.1.6. Red Hat Ansible Automation Platform インストーラー設定スクリプトの実行

Private Automation Hub のインストールに必要なパラメーターを使用して inventory ファイルを更新したら、setup スクリプトを実行ができます。

手順

  1. setup.sh スクリプトを実行します。

    $ ./setup.sh

インストールが開始します。

4.1.7. Automation Controller インストールの確認

インストールが完了したら、inventory ファイルに挿入した管理者認証情報でログインして、Automation Controller が正常にインストールしたことを確認できます。

手順

  1. inventory ファイルのAutomation Controller ノードに指定した IP アドレスに移動します。
  2. inventory ファイルに設定した管理者認証情報を使用してログインします。
注記

Automation Controller サーバーには、ポート 80 からアクセスできます。https://<TOWER_SERVER_NAME>/ ただし、ポート 443 にリダイレクトされるため、443 も使用できる必要があります。

重要

インストールに失敗し、Red Hat Ansible Automation Platform の有効なライセンスを購入済みのお客様は、Red Hat カスタマーポータル (https://access.redhat.com/) から Ansible までお問い合せください。

自動化コントローラーへのログインに成功すると、Red Hat Ansible Automation Platform 2.1 のインストールが完了します。

4.1.7.1. 追加の Automation Controller の設定とリソース

追加のAutomation Controller の設定については、以下の資料を参照してください。

表4.3 Automation Controller を設定するための資料

リンク説明

Automation Controller クイックセットアップガイド

Automation Controller を設定して最初の Playbook を実行します。

Automation Controller 管理ガイド

カスタマースクリプト、管理ジョブなどを使用して Automation Controller の管理を設定します。

Red Hat Ansible Automation Platform のプロキシーサポートの設定

プロキシーサーバーを使用して Automation Controller を設定します。

ユーザビリティーアナリティクスおよび Automation Controller からのデータ収集の管理

Red Hat と共有する Automation Controller の情報を管理します。

Automation Controller ユーザーガイド

Automation Controller の機能をより詳細に確認します。

4.1.8. Automation Hub のインストールの確認

インストールが完了したら、inventory ファイルに挿入した管理者認証情報でログインして、自動化ハブが正常にインストールしたことを確認できます。

手順

  1. inventory ファイルの自動化ハブノードに指定した IP アドレスに移動します。
  2. inventory ファイルに設定した管理者認証情報を使用してログインします。
重要

インストールに失敗し、Red Hat Ansible Automation Platform の有効なライセンスを購入済みのお客様は、Red Hat カスタマーポータル (https://access.redhat.com/) から Ansible までお問い合せください。

Automation Hub へのログインが成功すると、Red Hat Ansible Automation Platform 2.1 のインストールが完了します。

4.1.8.1. 追加の Automation Hub の設定とリソース

追加の Automation Hub 設定については、以下のリソースを参照してください。

表4.4 Automation Controller を設定するための資料

リンク説明

Private Automation Hub でのユーザーアクセスの管理

Automation Hub のユーザーアクセスを設定します。

Automation Hub での Red Hat 認定コレクションおよび Ansible Galaxy コレクションの管理

Automation Hub にコンテンツを追加します。

Automation Hub でのプロプライエタリーコンテンツコレクションの公開

Automation Hub で社内で開発したコレクションを公開します。

4.1.9. Ansible Automation Platform 2.1 の次のステップ

Ansible Automation Platform を初めて使用するユーザーの場合でも、以前の Ansible コンテンツを最新版をインストールした Red Hat Ansible Automation Platform に移行する予定の既存の管理者の場合でも、次の手順を確認して、Ansible Automation Platform 2.1 の新機能を活用し始めてみてください。

4.1.9.1. Ansible Automation Platform 2.1 へのデータの移行

Ansible Automation Platform 2.1 へのアップグレードを完了しようとしているプラットフォーム管理者の場合には、データを新しいインスタンスに移行するために追加の手順が必要になる場合があります。

4.1.9.1.1. 従来の仮想環境 (venvs) から自動化実行環境への移行

Ansible Automation Platform 2.1 は、カスタム Python 仮想環境 (venvs) よりも、自動化実行環境 (Ansible 自動化の実行とスケーリングに必要なコンポーネントをパッケージ化するコンテナー化されたイメージ) を優先するようになっています。これには、Ansible Core、Ansible Content Collections、Python の依存関係、Red Hat Enterprise Linux UBI 8、およびその他のパッケージの依存関係が含まれます。

venv を実行環境に移行する場合は、(1) awx-manage コマンドを使用して、元のインスタンスから venv のリストを一覧表示してエクスポートし、(2) ansible-builder を使用して実行環境を作成する必要があります。詳細は、自動化実行環境へのアップグレードガイド および Ansible ビルダーガイド を参照してください。

4.1.9.1.2. Ansible Builder を使用した Ansible Engine 2.9 イメージへの移行

Ansible Automation Platform 2.1 で使用するために Ansible Engine 2.9 イメージを移行するには、ansible-builder ツールで、自動化実行環境で使用するためにイメージ (カスタムプラグインおよび依存関係を含む) を再構築するプロセスを自動化します。Ansible Builder を使用して実行環境を構築する方法の詳細は、Ansible Builder ガイド を参照してください。

4.1.9.1.3. Ansible Core 2.12 への移行

Ansible Core 2.12 にアップグレードする場合に、最新版の Ansible Core でサポートされるようにするには、Playbook、プラグイン、または Ansible インフラストラクチャーの他の部分を更新する必要があります。Ansible Core 2.12 との互換性を確保するために Ansible コンテンツを更新する手順については、Ansible-core2.12 Porting Guide を参照してください。

4.1.9.2. 自動化メッシュを使用した自動化スケールアップ

Red Hat Ansible Automation Platform の自動化メッシュコンポーネントは、マルチサイトのデプロイメント全体に自動化を分散するプロセスを簡素化します。IT 環境が複数に分離されている企業の場合、自動化メッシュは、ピアツーピアメッシュ通信ネットワークを使用して実行ノード全体に自動化をデプロイしてスケールアップするための一貫性があり、信頼性の高い方法を提供します。

バージョン 1.x から最新バージョンの Ansible Automation Platform にアップグレードする場合は、データをレガシーの分離ノードから自動化メッシュに必要な実行ノードに移行する必要があります。ハイブリッドノードとコントロールノードのネットワークを計画して、Ansible Automation Platform インストーラーにあるインベントリーファイルを編集して、メッシュ関連の値を各実行ノードに割り当てることで、自動化メッシュを実装できます。

分離ノードから実行ノードに移行する方法については、upgrade & migration guide

自動化メッシュと、ご使用の環境に合わせて自動化メッシュを設計するさまざまな方法については、Red Hat Ansible Automation Platform 化メッシュガイド を参照してください。

第5章 Red Hat Ansible Automation Platform のプロキシーサポートの設定

プロキシーを使用してトラフィックと通信できるように、Red Hat Ansible Automation Platform を設定できます。プロキシーサーバーは、リソースを別のサーバーから求めているクライアントが出した要求を仲介するロールを果たします。クライアントは、プロキシーサーバーに接続して、別のサーバーからサービスや利用可能なリソースを要求します。そして、このプロキシーサーバーは複雑な内容を簡素化して制御する方法の 1 つとして、その要求を評価します。次のセクションでは、サポート対象のプロキシー設定とその設定方法について説明します。

5.1. プロキシーサポートの有効化

プロキシーサーバーのサポートを提供するために、Automation Controller はプロキシーされたリクエスト (Automation Controller の前にある ALB、NLB、HAProxy、Squid、Nginx、tinyproxy など) を処理します。REMOTE_HOST_HEADERS Automation Controller 設定のリスト変数。デフォルトでは、REMOTE_HOST_HEADERS["REMOTE_ADDR", "REMOTE_HOST"] に設定されています。

プロキシーサーバーのサポートを有効にするには、REMOTE_HOST_HEADERS Automation Controller の設定ページのフィールド:

手順

  1. Automation Controller で、SettingsMiscellaneous System に移動します。
  2. REMOTE_HOST_HEADERS フィールドに次の値を入力します。

    [
      "HTTP_X_FORWARDED_FOR",
      "REMOTE_ADDR",
      "REMOTE_HOST"
    ]

Automation Controller は、ヘッダーのリストを検索して、リモートホストの IP アドレスを決定します。REMOTE_HOST_HEADERS 最初の IP アドレスが見つかるまで。

5.2. 既知のプロキシー

Automation Controller を REMOTE_HOST_HEADERS = ['HTTP_X_FORWARDED_FOR', 'REMOTE_ADDR', 'REMOTE_HOST'] で設定している場合は、X-Forwarded-For の値が、Automation Controller の前にあるプロキシーまたはロードバランサ―から送られていることを前提としています。プロキシー/ロードバランサーを使用せずにAutomation Controller に到達できる場合、またはプロキシーがヘッダーを検証しない場合は、X-Forwarded-For の値が偽造されて発信元の IP アドレスを偽装する可能性があります。HTTP_X_FORWARDED_FOR 設定で REMOTE_HOST_HEADERS を使用すると、脆弱性が発生します。

これを回避するには、許可される既知のプロキシのリストを設定することができます。PROXY_IP_ALLOWED_LIST Automation Controller の設定メニューのフィールド。既知のプロキシーリストに含まれていないロードバランサーおよびホストは、要求を拒否します。

5.2.1. 既知のプロキシーの設定

Automation Controller の既知のプロキシーのリストを設定するには、プロキシー IP アドレスを追加します。PROXY_IP_ALLOWED_LIST Automation Controller の設定ページのフィールド。

手順

  1. Automation Controller で、SettingsMiscellaneous System に移動します。
  2. PROXY_IP_ALLOWED_LIST フィールドに、以下の例の構文に従って、Automation Controller への接続を許可する IP アドレスを入力します。

    PROXY_IP_ALLOWED_LIST エントリー

    [
      "example1.proxy.com:8080",
      "example2.proxy.com:8080"
    ]

重要
  • PROXY_IP_ALLOWED_LIST は、この一覧のプロキシーが適切にヘッダー入力をサニタイズし、X-Forwarded-For の値がクライアントの実際のソース IP と同等になるように正しく設定します。Automation Controller は、PROXY_IP_ALLOWED_LIST の IP アドレスとホスト名に依存して、X-Forwarded-For フィールドに偽装されていない値を提供できます。
  • HTTP_X_FORWARDED_FOR を `REMOTE_HOST_HEADERS` の項目として設定しないでください。all 次の条件のいずれかが満たされています。

    • SSL Termination でプロキシー環境を使用している
    • プロキシーにより X-Forwarded-For ヘッダーのサニタイズまたは検証が行われクライアントの攻撃を防止することができる
    • /etc/tower/conf.d/remote_host_headers.py が信頼されたプロキシーまたはロードバランサーの送信元 IP のみを含む PROXY_IP_ALLOWED_LIST を定義している

5.3. リバースプロキシーの設定

HTTP_X_FORWARDED_FOR を追加することで、リバースプロキシサーバー設定に対応することができます。REMOTE_HOST_HEADERS Automation Controller 設定のフィールド。X-Forwarded-For (XFF) HTTP ヘッダーフィールドは、HTTP プロキシーまたはロードバランサー経由で Web サーバーに接続するクライアントの送信元 IP アドレスを識別します。

手順

  1. Automation Controller で、SettingsMiscellaneous System に移動します。
  2. REMOTE_HOST_HEADERS フィールドに次の値を入力します。

    [
      "HTTP_X_FORWARDED_FOR",
      "REMOTE_ADDR",
      "REMOTE_HOST"
    ]

第6章 Automation Controller の WebSocket 接続の設定

WebSocket の設定を nginx またはロードバランサー設定に合わせるために、Automation Controller を設定できます。

6.1. コントローラーの自動化用の WebSocket 設定

Automation Controller ノードは、WebSocket を介して他のすべての Automation Controller ノードに接続されます。この相互接続では、WebSocket が出力されたメッセージをすべて他の Automation Controller ノードに分散するために使用されます。これは、任意のブラウザークライアントの WebSocket が、どの Automation Controller ノードで実行している可能性のあるジョブにサブスクライブできるためです。WebSocket クライアントは特定の Automation Controller ノードにルーティングされません。すべての Automation Controller ノードは、任意の WebSocket 要求を処理でき、各 Automation Controller ノードは、すべてのクライアント宛てのすべての WebSocket メッセージを把握しておく必要があります。

Automation Controller は、データベースのインスタンスレコードを使用して、他の Automation Controller ノードの検出を自動的に処理します。

重要
  • (オープンインターネットではなく) ノードがプライベートで信頼されるサブネットに WebSocket トラフィックをブロードキャストしていることが意図されています。そのため、WebSocket ブロードキャストの HTTPS をオフにすると、Ansible Playbook の標準出力 (stdout) の大部分で構成される WebSocket トラフィックは、暗号化されない Automation Controller ノード間で送信されます。

6.1.1. 他の Automation Controller ノードの自動検出の設定

WebSocket 接続を設定して、Automation Controller がデータベースのインスタンスレコードを使用して他の Automation Controller ノードの検出を自動的に処理できるようにします。

  • ポート、プロトコル、および WebSocket 接続の確立時に証明書を検証するかどうかについて、Automation Controller の WebSocket 情報を編集します。

    BROADCAST_WEBSOCKET_PROTOCOL = 'http'
    BROADCAST_WEBSOCKET_PORT = 80
    BROADCAST_WEBSOCKET_VERIFY_CERT = False

第7章 ユーザビリティーアナリティクスおよび Automation Controller からのデータ収集の管理

Automation Controller のユーザーインターフェイスをオプトアウトまたは変更することで、Automation Controller からユーザビリティーアナリティクスおよびデータ収集への参加方法を変更できます。

7.1. ユーザビリティーアナリティクスおよびデータ収集

ユーザビリティーのデータ収集は、Automation Controller に含まれており、Automation Controller ユーザーが Automation Controller とどのように相互作用するかをよりよく理解するためのデータを収集し、今後のリリースの強化に役立て、ユーザーエクスペリエンスの合理化を継続していきます。

Automation Controller のトライアルまたは Automation Controller の新規インストールのみが、このデータ収集でオプトインされます。

関連情報

7.1.1. Automation Controller からのデータ収集の制御

で参加レベルを設定することにより、Automation Controller がデータを収集する方法を制御できます。User Interface 設定メニューのタブ。

手順

  1. Automation Controller にログインします。
  2. に移動SettingsUser Interface
  3. アナリティクストラッキングの状態ドロップダウンリストから希望のデータ収集レベルを選択します。

    1. Off: データ収集を防止します。
    2. Anonymous: 特定のユーザーデータなしでデータ収集を有効にします。
    3. Detailed: 特定のユーザーデータを含むデータ収集を有効にします。
  4. Save 設定を適用するか、Cancel 変更を破棄します。

第8章 サポート対象のインベントリープラグインテンプレート

アップグレード時に、既存の設定は、後方互換性のあるインベントリー出力を生成する新しい形式に変換されます。以下のテンプレートを使用して、インベントリーを新しいスタイルのインベントリープラグイン出力に移行するのに役に立ちます。

8.1. Amazon Web Services EC2

compose:
  ansible_host: public_ip_address
  ec2_account_id: owner_id
  ec2_ami_launch_index: ami_launch_index | string
  ec2_architecture: architecture
  ec2_block_devices: dict(block_device_mappings | map(attribute='device_name') | list | zip(block_device_mappings | map(attribute='ebs.volume_id') | list))
  ec2_client_token: client_token
  ec2_dns_name: public_dns_name
  ec2_ebs_optimized: ebs_optimized
  ec2_eventsSet: events | default("")
  ec2_group_name: placement.group_name
  ec2_hypervisor: hypervisor
  ec2_id: instance_id
  ec2_image_id: image_id
  ec2_instance_profile: iam_instance_profile | default("")
  ec2_instance_type: instance_type
  ec2_ip_address: public_ip_address
  ec2_kernel: kernel_id | default("")
  ec2_key_name: key_name
  ec2_launch_time: launch_time | regex_replace(" ", "T") | regex_replace("(\+)(\d\d):(\d)(\d)$", ".\g<2>\g<3>Z")
  ec2_monitored: monitoring.state in ['enabled', 'pending']
  ec2_monitoring_state: monitoring.state
  ec2_persistent: persistent | default(false)
  ec2_placement: placement.availability_zone
  ec2_platform: platform | default("")
  ec2_private_dns_name: private_dns_name
  ec2_private_ip_address: private_ip_address
  ec2_public_dns_name: public_dns_name
  ec2_ramdisk: ramdisk_id | default("")
  ec2_reason: state_transition_reason
  ec2_region: placement.region
  ec2_requester_id: requester_id | default("")
  ec2_root_device_name: root_device_name
  ec2_root_device_type: root_device_type
  ec2_security_group_ids: security_groups | map(attribute='group_id') | list |  join(',')
  ec2_security_group_names: security_groups | map(attribute='group_name') | list |  join(',')
  ec2_sourceDestCheck: source_dest_check | default(false) | lower | string
  ec2_spot_instance_request_id: spot_instance_request_id | default("")
  ec2_state: state.name
  ec2_state_code: state.code
  ec2_state_reason: state_reason.message if state_reason is defined else ""
  ec2_subnet_id: subnet_id | default("")
  ec2_tag_Name: tags.Name
  ec2_virtualization_type: virtualization_type
  ec2_vpc_id: vpc_id | default("")
filters:
  instance-state-name:
  - running
groups:
  ec2: true
hostnames:
  - network-interface.addresses.association.public-ip
  - dns-name
  - private-dns-name
keyed_groups:
  - key: image_id | regex_replace("[^A-Za-z0-9\_]", "_")
    parent_group: images
    prefix: ''
    separator: ''
  - key: placement.availability_zone
    parent_group: zones
    prefix: ''
    separator: ''
  - key: ec2_account_id | regex_replace("[^A-Za-z0-9\_]", "_")
    parent_group: accounts
    prefix: ''
    separator: ''
  - key: ec2_state | regex_replace("[^A-Za-z0-9\_]", "_")
    parent_group: instance_states
    prefix: instance_state
  - key: platform | default("undefined") | regex_replace("[^A-Za-z0-9\_]", "_")
    parent_group: platforms
    prefix: platform
  - key: instance_type | regex_replace("[^A-Za-z0-9\_]", "_")
    parent_group: types
    prefix: type
  - key: key_name | regex_replace("[^A-Za-z0-9\_]", "_")
    parent_group: keys
    prefix: key
  - key: placement.region
    parent_group: regions
    prefix: ''
    separator: ''
  - key: security_groups | map(attribute="group_name") | map("regex_replace", "[^A-Za-z0-9\_]", "_") | list
    parent_group: security_groups
    prefix: security_group
  - key: dict(tags.keys() | map("regex_replace", "[^A-Za-z0-9\_]", "_") | list | zip(tags.values()
      | map("regex_replace", "[^A-Za-z0-9\_]", "_") | list))
    parent_group: tags
    prefix: tag
  - key: tags.keys() | map("regex_replace", "[^A-Za-z0-9\_]", "_") | list
    parent_group: tags
    prefix: tag
  - key: vpc_id | regex_replace("[^A-Za-z0-9\_]", "_")
    parent_group: vpcs
    prefix: vpc_id
  - key: placement.availability_zone
    parent_group: '{{ placement.region }}'
    prefix: ''
    separator: ''
plugin: amazon.aws.aws_ec2
use_contrib_script_compatible_sanitization: true

8.2. Google Compute Engine

auth_kind: serviceaccount
compose:
  ansible_ssh_host: networkInterfaces[0].accessConfigs[0].natIP | default(networkInterfaces[0].networkIP)
  gce_description: description if description else None
  gce_id: id
  gce_image: image
  gce_machine_type: machineType
  gce_metadata: metadata.get("items", []) | items2dict(key_name="key", value_name="value")
  gce_name: name
  gce_network: networkInterfaces[0].network.name
  gce_private_ip: networkInterfaces[0].networkIP
  gce_public_ip: networkInterfaces[0].accessConfigs[0].natIP | default(None)
  gce_status: status
  gce_subnetwork: networkInterfaces[0].subnetwork.name
  gce_tags: tags.get("items", [])
  gce_zone: zone
hostnames:
- name
- public_ip
- private_ip
keyed_groups:
- key: gce_subnetwork
  prefix: network
- key: gce_private_ip
  prefix: ''
  separator: ''
- key: gce_public_ip
  prefix: ''
  separator: ''
- key: machineType
  prefix: ''
  separator: ''
- key: zone
  prefix: ''
  separator: ''
- key: gce_tags
  prefix: tag
- key: status | lower
  prefix: status
- key: image
  prefix: ''
  separator: ''
plugin: google.cloud.gcp_compute
retrieve_image_info: true
use_contrib_script_compatible_sanitization: true

8.3. Microsoft Azure Resource Manager

conditional_groups:
  azure: true
default_host_filters: []
fail_on_template_errors: false
hostvar_expressions:
  computer_name: name
  private_ip: private_ipv4_addresses[0] if private_ipv4_addresses else None
  provisioning_state: provisioning_state | title
  public_ip: public_ipv4_addresses[0] if public_ipv4_addresses else None
  public_ip_id: public_ip_id if public_ip_id is defined else None
  public_ip_name: public_ip_name if public_ip_name is defined else None
  tags: tags if tags else None
  type: resource_type
keyed_groups:
- key: location
  prefix: ''
  separator: ''
- key: tags.keys() | list if tags else []
  prefix: ''
  separator: ''
- key: security_group
  prefix: ''
  separator: ''
- key: resource_group
  prefix: ''
  separator: ''
- key: os_disk.operating_system_type
  prefix: ''
  separator: ''
- key: dict(tags.keys() | map("regex_replace", "^(.*)$", "\1_") | list | zip(tags.values() | list)) if tags else []
  prefix: ''
  separator: ''
plain_host_names: true
plugin: azure.azcollection.azure_rm
use_contrib_script_compatible_sanitization: true

8.4. VMware vCenter

compose:
  ansible_host: guest.ipAddress
  ansible_ssh_host: guest.ipAddress
  ansible_uuid: 99999999 | random | to_uuid
  availablefield: availableField
  configissue: configIssue
  configstatus: configStatus
  customvalue: customValue
  effectiverole: effectiveRole
  guestheartbeatstatus: guestHeartbeatStatus
  layoutex: layoutEx
  overallstatus: overallStatus
  parentvapp: parentVApp
  recenttask: recentTask
  resourcepool: resourcePool
  rootsnapshot: rootSnapshot
  triggeredalarmstate: triggeredAlarmState
filters:
- runtime.powerState == "poweredOn"
keyed_groups:
- key: config.guestId
  prefix: ''
  separator: ''
- key: '"templates" if config.template else "guests"'
  prefix: ''
  separator: ''
plugin: community.vmware.vmware_vm_inventory
properties:
- availableField
- configIssue
- configStatus
- customValue
- datastore
- effectiveRole
- guestHeartbeatStatus
- layout
- layoutEx
- name
- network
- overallStatus
- parentVApp
- permission
- recentTask
- resourcePool
- rootSnapshot
- snapshot
- triggeredAlarmState
- value
- capability
- config
- guest
- runtime
- storage
- summary
strict: false
with_nested_properties: true

8.5. Red Hat Satellite 6

group_prefix: foreman_
keyed_groups:
- key: foreman['environment_name'] | lower | regex_replace(' ', '') | regex_replace('[^A-Za-z0-9_]', '_') | regex_replace('none', '')
  prefix: foreman_environment_
  separator: ''
- key: foreman['location_name'] | lower | regex_replace(' ', '') | regex_replace('[^A-Za-z0-9_]', '_')
  prefix: foreman_location_
  separator: ''
- key: foreman['organization_name'] | lower | regex_replace(' ', '') | regex_replace('[^A-Za-z0-9_]', '_')
  prefix: foreman_organization_
  separator: ''
- key: foreman['content_facet_attributes']['lifecycle_environment_name'] | lower | regex_replace(' ', '') | regex_replace('[^A-Za-z0-9_]', '_')
  prefix: foreman_lifecycle_environment_
  separator: ''
- key: foreman['content_facet_attributes']['content_view_name'] | lower | regex_replace(' ', '') | regex_replace('[^A-Za-z0-9_]', '_')
  prefix: foreman_content_view_
  separator: ''
legacy_hostvars: true
plugin: theforeman.foreman.foreman
validate_certs: false
want_facts: true
want_hostcollections: false
want_params: true

8.6. OpenStack

expand_hostvars: true
fail_on_errors: true
inventory_hostname: uuid
plugin: openstack.cloud.openstack

8.7. Red Hat Virtualization

compose:
  ansible_host: (devices.values() | list)[0][0] if devices else None
keyed_groups:
- key: cluster
  prefix: cluster
  separator: _
- key: status
  prefix: status
  separator: _
- key: tags
  prefix: tag
  separator: _
ovirt_hostname_preference:
- name
- fqdn
ovirt_insecure: false
plugin: ovirt.ovirt.ovirt

8.8. Automation Controller

include_metadata: true
inventory_id: <inventory_id or url_quoted_named_url>
plugin: awx.awx.tower
validate_certs: <true or false>

第9章 カスタム通知でサポートされている属性

このセクションでは、サポート対象のジョブ属性リストと、通知用のメッセージテキスト作成に適した構文について説明します。サポートされるジョブ属性は以下のとおりです。

  • allow_simultaneous: (ブール値) 複数のジョブが、このジョブに関連付けられた JT から同時に実行できるかどうかを示す
  • controller_node: (文字列) 分離された実行環境を管理したインスタンス
  • created: (日時) ジョブ作成時のタイムスタンプ
  • custom_virtualenv: (文字列) ジョブの実行に使用されるカスタムの仮想環境
  • description: (文字列) ジョブの説明 (任意)
  • diff_mode: (ブール値) 有効になっている場合、ホストのテンプレート化されたファイルに追加されるテキストの変更を標準出力に表示
  • elapsed: (10 進数) ジョブ実行の経過時間 (秒単位)
  • execution_node: (文字列) ジョブが実行するノード
  • failed:: (ブール値) ジョブが失敗した場合は true
  • finished: (日時) ジョブが実行を完了した日時
  • force_handlers: (ブール値) ハンドラーが強制されている場合、ホストでタスクが失敗しても、通知されるとハンドラーが実行する (ホストに到達できない場合でも、状況によってはハンドラーの実行が回避されることに留意)
  • forks: (整数) ジョブに要求されたフォークの数
  • id: (整数) このジョブのデータベース ID
  • job_explanation: (文字列) stdout の実行およびキャプチャーを実行できない場合のジョブの状態を示すための状態フィールド
  • job_slice_count: (整数) スライスされたジョブの一部として実行された場合には、スライスの合計数 (1 の場合はスライスされたジョブの一部ではない)
  • job_slice_number: (整数) スライスされたジョブの一部として実行された場合には、スライス処理が行われたインベントリーの ID (スライスされたジョブの一部でなければ属性は使用されない)
  • job_tags: (文字列) 指定されたタグを持つタスクのみが実行される
  • job_type: (選択肢) run、check、または scan
  • launch_type: (選択肢) manual、relaunch、callback、scheduled、dependency、workflow、sync、または scm
  • limit: (文字列) 指定された場合は、このホストのセットに制限された Playbook を実行
  • modified: (日時) ジョブの最終更新時のタイムスタンプ
  • name: (文字列) このジョブの名前
  • Playbook: (文字列) 実行された Playbook
  • scm_revision: (文字列) このジョブに使用するプロジェクトからの SCM リビジョン (存在する場合)
  • skip_tags: (文字列) 指定した場合は、このタグセットをスキップして Playbook を実行
  • start_at_task: (文字列) 指定した場合は、この名前に一致するタスクで Playbook の実行を開始
  • started: (日時) ジョブが開始するためにキューに入れられた日時
  • status: (選択肢) new、pending、waiting、running、successful、failed、error、canceled
  • timeout: (整数) タスクが取り消されるまでの実行時間 (秒数)
  • type: (選択肢) このジョブのデータタイプ
  • url: (文字列) ジョブの URL
  • use_fact_cache: (ブール値) ジョブに対して有効化されている場合、Tower は Ansible ファクトキャッシュプラグインとして機能。データベースに対する Playbook 実行の終了時にファクトを保持し、Ansible で使用できるようにキャッシュ
  • verbosity: (選択肢) 0 - 5 (正常 - WinRM デバッグに対応)
  • host_status_counts: (各ステータスに一意に割り当てられたホスト数)

    • skipped: (整数)
    • ok: (整数)
    • failures: (整数)
    • failures: (整数)
    • dark: (整数)
    • processed: (整数)
    • rescued: (整数)
    • ignored (整数)
    • failed (ブール値)
  • summary_fields:

    • inventory

      • id: (整数) インベントリーのデータベース ID
      • name: (文字列) インベントリーの名前
      • description: (文字列) インベントリーの説明 (任意)
      • has_active_failures: (ブール値) (非推奨) このインベントリーのホストが失敗したかどうかを示すフラグ
      • total_hosts: (非推奨) (整数) このインベントリー内のホストの合計数
      • hosts_with_active_failures: (非推奨) (整数) このインベントリー内のアクティブなエラーのあるホストの数
      • total_groups: (非推奨) (整数) このインベントリー内のグループの合計数
      • groups_with_active_failures: (非推奨) (整数) このインベントリー内のアクティブなエラーのあるホストの数
      • has_inventory_sources: (非推奨) (ブール値) このインベントリーに外部のインベントリーソースがあるかどうかを示すフラグ
      • total_inventory_sources: インベントリー内で設定される外部インベントリーソースの合計数 (整数)
      • inventory_sources_with_failures: エラーのあるこのインベントリー内の外部インベントリーソースの数 (整数)
      • organization_id: このインベントリーが含まれる組織
      • kind: (選択肢) (空の文字列) (ホストにインベントリーとの直接リンクがあることを示す) または smart
    • project

      • id: (整数) プロジェクトのデータベース ID
      • name: (文字列) プロジェクトの名前
      • description: (文字列) プロジェクトの説明 (任意)
      • status: (選択肢) new、pending、waiting、running、successful、failed、error、canceled、never updated、ok、missing のいずれか
      • scm_type: (選択肢) (空の文字列)、git、hg、svn、insights のいずれか
    • job_template

      • id: (整数) ジョブテンプレートのデータベース ID
      • name: (文字列) ジョブテンプレートの名前
      • description: (文字列) ジョブテンプレートの説明 (任意)
    • unified_job_template

      • id: (整数) 統合ジョブテンプレートのデータベース ID
      • name: (文字列) 統合ジョブテンプレートの名前
      • description: (文字列) 統合ジョブテンプレートの説明 (任意)
      • unified_job_type: (選択肢) 統合ジョブタイプ (job、workflow_job、project_update など)
    • instance_group

      • id: (整数) インスタンスグループのデータベース ID
      • name: (文字列) インスタンスグループの名前
    • created_by

      • id: (int) 操作を開始したユーザーのデータベース ID
      • username: (文字列) 操作を開始したユーザー名
      • first_name - (文字列) 名
      • last_name - (文字列) 姓
    • labels

      • count: (整数) ラベルの数
      • results: ラベルを表すディクショナリーのリスト ( {"id": 5, "name": "database jobs"} など)

ジョブに関する情報は、グループ化された中括弧 {{}} を使用してカスタム通知メッセージで参照できます。特定のジョブ属性にはドット表記を使用してアクセスされます (例: {{ job.summary_fields.inventory.name }})。中括弧の前または前後に使用されている文字、または平文は、明確にするために追加できます。たとえば、ジョブ ID の「#」や記述子を示す一重引用符などです。カスタムメッセージには、メッセージ全体で多数の変数を含めることができます。

{{ job_friendly_name }} {{ job.id }} ran on {{ job.execution_node }} in {{ job.elapsed }} seconds.

ジョブ属性に加えてテンプレートに追加できる変数は、他にも複数あります。

approval_node_name: (文字列) 承認ノード名

approval_status: (選択肢) approved、denied、timed_out のいずれか

url: (文字列) 通知が送信されるジョブの URL (開始、成功、失敗、および承認の通知に適用)

workflow_url: (文字列) 関連する承認ノードへの URL。これにより、通知の受信者は関連するワークフロージョブページに移動し、何が起こっているかを確認できます (つまり、このノードは {{ workflow_url }}) で確認できます)。承認関連の通知の場合は、url と workflow_url の両方が同じです。

job_friendly_name: (文字列) ジョブの分かりやすい名前

job_metadata: (文字列) ジョブのメタデータを JSON 文字列として置き換えます。以下に例を示します。

{'url': 'https://towerhost/$/jobs/playbook/13',
 'traceback': '',
 'status': 'running',
 'started': '2019-08-07T21:46:38.362630+00:00',
 'project': 'Stub project',
 'playbook': 'ping.yml',
 'name': 'Stub Job Template',
 'limit': '',
 'inventory': 'Stub Inventory',
 'id': 42,
 'hosts': {},
 'friendly_name': 'Job',
 'finished': False,
 'credential': 'Stub credential',
 'created_by': 'admin'}

法律上の通知

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.