Automation Controller 管理ガイド

手順

1. サブスクリプションの pool_id を確認するために、次のコマンドを入力します。

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

   Copy to Clipboard Toggle word wrap

   このコマンドは以下を返します。

   Subscription Name: Red Hat Ansible Automation Platform, Premium (5000 Managed Nodes)
   Provides: Red Hat Ansible Engine
   Red Hat Single Sign-On
   Red Hat Ansible Automation Platform
   SKU: MCT3695
   Contract: ********
   Pool ID: ********************
   Provides Management: No
   Available: 4999
   Suggested: 1

   Copy to Clipboard Toggle word wrap

2. このサブスクリプションを割り当てるには、次のコマンドを入力します。

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

   Copy to Clipboard Toggle word wrap

   すべてのノードに割り当てられている場合は、リポジトリーが検出されます。

3. サブスクリプションが正常に割り当てられたかどうかを確認するには、次のコマンドを入力します。

   # subscription-manager list --consumed

   Copy to Clipboard Toggle word wrap

4. このサブスクリプションを削除するには、次のコマンドを入力します。

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

   Copy to Clipboard Toggle word wrap

手順

1. Automation Controller で Vault パスワードごとに Vault 認証情報を作成します。
2. 認証情報のフィールドとして Vault ID を指定し、パスワードを入力します (暗号化されて保存されます)。
3. 新しい認証情報のエンドポイントを使用して、ジョブテンプレートに複数の Vault 認証情報を割り当てます。

手順

1. コマンド automation-controller-service stop を使用して、インスタンスをシャットダウンするか、サービスを停止します。

2. 別のインスタンスから次のプロビジョニング解除コマンドを実行して、Automation Controller クラスターからインスタンスを削除します。

   $ awx-manage deprovision_instance --hostname=<name used in inventory file>

   Copy to Clipboard Toggle word wrap

1. Red Hat Enterprise Linux オペレーティングシステムが必要です。メッシュ内の各ノードには、Automation Controller がアクセスできる静的 IP アドレス、または解決可能な DNS ホスト名が必要です。
2. 続行する前に、RHEL 仮想マシンの最小要件を満たしていることを確認している。詳細は、Red Hat Ansible Automation Platform のシステム要件 を参照してください。

3. 通信が必要なリモートネットワーク内に RHEL インスタンスをデプロイします。仮想マシンの作成は、Red Hat Enterprise Linux ドキュメントの 仮想マシンの作成 を参照してください。提案されたタスクを仮想マシン上で実行できるように、必ず仮想マシンの容量を十分にスケーリングしてください。

   • RHEL ISO は、access.redhat.com から入手できます。
   • RHEL クラウドイメージは、console.redhat.com の Image Builder を使用してビルドできます。

手順

1. シークレットを作成します。

   oc create secret generic ee-pull-secret \
        --from-literal=username=<username> \
        --from-literal=password=<password> \
        --from-literal=url=registry.redhat.io
   
   
   oc edit automationcontrollers <instance name>

   Copy to Clipboard Toggle word wrap

2. ee_pull_credentials_secret ee-pull-secret を仕様に追加します。

   spec.ee_pull_credentials_secret=ee-pull-secret

   Copy to Clipboard Toggle word wrap

   Automation Controller UI からインスタンスを管理するには、システム管理者またはシステム監査者の権限が必要です。

手順

1. 各 RHEL インスタンスに SSH で接続し、次の手順を実行します。ネットワークアクセスと制御によっては、SSH プロキシーまたは他のアクセスモデルが必要になる場合があります。

   以下のコマンドを使用します。

   ssh [username]@[host_ip_address]

   Copy to Clipboard Toggle word wrap

   たとえば、Amazon Web Services で実行されている Ansible Automation Platform インスタンスの場合は、以下のようになります。

   ssh ec2-user@10.0.0.6

   Copy to Clipboard Toggle word wrap
2. 後のステップで、ホップノードから実行ノードに接続するために使用できる SSH キーを作成またはコピーします。これは、自動化メッシュ設定のためだけに使用される一時キー、または長期間有効なキーの場合があります。SSH ユーザーとキーは、後の手順で使用されます。

3. baseos および appstream リポジトリーを使用して、RHEL サブスクリプションを有効にします。Ansible Automation Platform RPM リポジトリーは、Red Hat Update Infrastructure (RHUI) はなく、subscription-manager を通じてのみ利用できます。RHEL と RHUI を含む他の Linux フットプリントを使用しようとすると、エラーが発生します。

   sudo subscription-manager register --auto-attach

   Copy to Clipboard Toggle word wrap

   アカウントで Simple Content Access が有効になっている場合は、次を使用します。

   sudo subscription-manager register

   Copy to Clipboard Toggle word wrap

   Simple Content Access の詳細は、Simple Content Access のスタートガイド を参照してください。

4. Ansible Automation Platform サブスクリプションと適切な Red Hat Ansible Automation Platform チャネルを有効にします。

   # subscription-manager repos --enable ansible-automation-platform-2.4-for-rhel-8-x86_64-rpms for RHEL 8
   
   # subscription-manager repos --enable ansible-automation-platform-2.4-for-rhel-9-x86_64-rpms for RHEL 9

   Copy to Clipboard Toggle word wrap

5. パッケージが最新であることを確認します。

   sudo dnf upgrade -y

   Copy to Clipboard Toggle word wrap

6. ansible-core パッケージをインストールします。

   sudo dnf install -y ansible-core

   Copy to Clipboard Toggle word wrap

手順

1. ナビゲーションパネルから、Administration → Instances を選択します。

2. Instances リストページで、Add をクリックします。Create new Instance ウィンドウが開きます。

   

   インスタンスには次の属性が必要です。

   • Host Name: (必須) インスタンスの完全修飾ドメイン名 (パブリック DNS) ) または IP アドレスを入力します。このフィールドは、インストーラーベースのデプロイメントの hostname に相当します。

     注記

     インスタンスがコントロールクラスターから解決できないプライベート DNS を使用している場合、DNS ルックアップルーティングは失敗し、生成された SSL 証明書は無効になります。代わりに IP アドレスを使用してください。

   • オプション: Description: インスタンスの説明を入力します。
   • Instance State: このフィールドは自動入力され、インストール中であることを示します。変更はできません。
   • リスナーポート: このポートは、受信接続をリッスンするために receptor に使用されます。ポートを設定に適したポートに設定できます。このフィールドは、API の listen_port に相当します。デフォルト値は 27199 ですが、独自のポート値を設定できます。

   • インスタンスタイプ: execution ノードおよび hop ノードのみを作成できます。Operator ベースのデプロイメントは、コントロールノードまたはハイブリッドノードをサポートしません。

     オプション:

     • インスタンスの有効化: 実行ノード上でジョブを実行できるようにするには、このボックスをオンにします。
     • Managed by Policy ボックスをオンにして、ポリシーがインスタンスの割り当て方法を決定できるようにします。

     • Peers from control nodes ボックスをオンにして、コントロールノードがこのインスタンスに自動的にピアリングできるようにします。Automation Controller に接続されているノードの場合は、Peers from Control nodes ボックスをチェックして、そのノードと Automation Controller の間に直接通信リンクを作成します。その他のすべてのノードの場合は、以下のとおりとなります。

       • ホップノードを追加しない場合は、Peers from Control がオンになっていることを確認してください。
       • ホップノードを追加する場合は、Peers from Control がチェックされていないことを確認してください。
       • ホップノードと通信する実行ノードの場合は、このボックスをオンにしないでください。

     • 実行ノードをホップノードとピアリングするには、 icon next to the Peers フィールドをクリックします。

       Select Peers ウィンドウが表示されます。

       実行ノードをホップノードにピアリングします。

3. Save をクリックします。

   

4. 更新したトポロジーをグラフィック表示するには、トポロジービューアー を参照してください。

   注記

   新しく作成したインスタンスに SSH アクセスできる任意のコンピューターから、次の手順を実行します。

5. Install Bundle の横にある アイコンをクリックして、この新しいインスタンスと、作成されたノードを自動化メッシュにインストールするために必要なファイルを含む tar ファイルをダウンロードします。

   

   インストールバンドルには、TLS 証明書とキー、認証局、および適切な Receptor 設定ファイルが含まれています。

   receptor-ca.crt
   work-public-key.pem
   receptor.key
   install_receptor.yml
   inventory.yml
   group_vars/all.yml
   requirements.yml

   Copy to Clipboard Toggle word wrap

6. ダウンロードした tar.gz インストールバンドルを、ダウンロードした場所から展開します。これらのファイルがリモートマシン上の正しい場所にあることを確認するために、インストールバンドルには install_receptor.yml Playbook が含まれています。Playbook には Receptor コレクションが必要です。次のコマンドを実行して、コレクションをダウンロードします。

   ansible-galaxy collection install -r requirements.yml

   Copy to Clipboard Toggle word wrap

7. ansible-playbook コマンドを実行する前に、inventory.yml ファイル内の次のフィールドを編集します。

   all:
     hosts:
       remote-execution:
         ansible_host: 10.0.0.6
         ansible_user: <username> # user provided
     ansible_ssh_private_key_file: ~/.ssh/<id_rsa>

   Copy to Clipboard Toggle word wrap
   • ansible_host が、ノードの IP アドレスまたは DNS に設定されていることを確認します。
   • ansible_user を、インストールを実行しているユーザー名に設定します。
   • ansible_ssh_private_key_file を設定して、インスタンスへの接続に使用される秘密鍵のファイル名を含めます。
   • inventory.yml ファイルの内容はテンプレートとして機能し、メッシュトポロジーでの receptor ノードのインストールおよび設定中に適用されるロールの変数が含まれています。他のフィールドの一部を変更したり、高度なシナリオではファイル全体を置き換えたりすることができます。詳細は、Role Variables を参照してください。

8. プライベート DNS を使用するノードの場合は、次の行を inventory.yml に追加します。

    ansible_ssh_common_args: <your ssh ProxyCommand setting>

   Copy to Clipboard Toggle word wrap

   これは、install-ceptor.yml Playbook に、proxy コマンドを使用してローカル DNS ノード経由でプライベートノードに接続するように指示します。

9. 属性を設定したら、Save をクリックします。作成したインスタンスの Details ページが開きます。
10. ファイルを保存して続行します。

11. インストールバンドルを実行してリモートノードをセットアップし、ansible-playbook を実行するシステムには、ansible.receptor コレクションがインストールされている必要があります。

    ansible-galaxy collection install ansible.receptor

    Copy to Clipboard Toggle word wrap

    あるいは、以下のような場合もあります。

    ansible-galaxy install -r requirements.yml

    Copy to Clipboard Toggle word wrap
    • requirements.yml ファイルから receptor コレクションの依存関係をインストールすると、そこで指定された receptor のバージョンが一貫して取得されます。さらに、今後必要になる可能性のある他のコレクションの依存関係も取得されます。
    • Playbook が実行されるすべてのノードに receptor コレクションをインストールします。インストールしない場合は、エラーが発生します。

12. receptor_listener_port が定義されている場合、マシンには、受信 TCP 接続を確立するために使用可能なオープンポート (27199 など) も必要です。次のコマンドを実行して、receptor 通信用にポート 27199 を開きます。

    sudo firewall-cmd --permanent --zone=public --add-port=27199/tcp

    Copy to Clipboard Toggle word wrap
    注記

    場合によっては、サーバーが Receptor ポート (デフォルトは 27199) をリッスンしないことがあります。

    ノード A、B、C、D を持つコントロールプレーンがあるとします。

    RPM インストーラーは、最小権限アプローチを使用してコントロールプレーンノード間に強力に接続されたピアリングを作成し、必要なノード上でのみ TCP リスナーを開きます。Receptor の接続はすべて双方向接続であるため、接続が確立されると、Receptor は双方向に通信できるようになります。

    以下に、3 つのコントローラーノードのピアリング設定を例として示します。

    コントローラーノード A -→ コントローラーノード B

    コントローラーノード A -→ コントローラーノード C

    コントローラーノード B -→ コントローラーノード C

    以下を設定すると、リスナーを強制できます。

    receptor_listener=True

    ただし、コントローラー B -→ A への接続は、すでに存在するため、拒否される可能性があります。

    その場合、コントローラー A は他のノードへの接続を作成しているため、コントローラー A には何も接続されません。コントローラー A で次のコマンドを実行しても、何も返されません。

    [root@controller1 ~]# ss -ntlp | grep 27199 [root@controller1 ~]#

13. 自動化メッシュを更新するマシン上で、次の Playbook を実行します。

    ansible-playbook -i inventory.yml install_receptor.yml

    Copy to Clipboard Toggle word wrap

    この Playbook を実行すると、自動化メッシュが設定されます。

    

手順

1. ナビゲーションパネルから、Administration → Topology View を選択します。Topology View が開き、各 receptor ノード間のリンクがグラフィック表示されます。

   

2. ズームレベルを調整したり、グラフィックビューを操作したりするには、ツールバーにあるズームイン ( )、ズームアウト ( )、拡大 ( )、リセット ( ) のコントロールアイコンを使用します。

   クリックおよびドラッグして移動したり、マウスやトラックパッドでスクロールすることでズームしたりすることもできます。画面に合わせる機能は、画面に合わせて自動的にグラフィックを拡大縮小し、中央に再配置します。これは、大きなメッシュ全体を表示する場合に特に便利です。

   

   デフォルトのビューにリセットするには、ズームリセット ( ) アイコンをクリックします。

3. 表示されているノードのタイプを特定するには、Legend を参照します。

   仮想マシンベースのインストールについては、コントロールプレーンおよび実行プレーン を参照してください。

   Operator ベースのインストールについては、コントロールプレーンおよび実行プレーン を参照してください。

   上記のリンクから各ノードタイプの詳細を参照してください。

   注記

   Legend が表示されていない場合は、上部のバーのトグルを使用して有効にします。

   Legend には、node status <node_statuses> が色別に表示され、ノードの健全性を示します。Legend の Error ステータスには、Unavailable 状態 (Instances リストビューに表示されるもの) に加えて、Automation Controller の新しいバージョンで生じる今後のエラー状態が含まれます。

   Legend には、次のリンクステータスも表示されます。

   • Established: このリンク状態は、準備完了、使用不可、または無効であるノード間のピア接続を示します。
   • Adding: このリンク状態は、メッシュトポロジーに追加するように選択されたノード間のピア接続を示します。
   • Removing: このリンク状態は、トポロジーから削除するように選択されたノード間のピア接続を示します。

4. ノードにカーソルを合わせると、コネクターが強調表示されて直接接続されたノード (ピア) を示します。または、ノードをクリックして、ホスト名、ノードタイプ、ステータスなどホストの詳細を取得します。

   

5. 表示された詳細からインスタンスのホスト名のリンクをクリックすると、Details ページにリダイレクトされ、そのノードに関する詳細情報、特に Error ステータスに関する情報が表示されます。次の例を参照してください。

   

   

   Details ページを使用して、インスタンスを削除したり、必要に応じてインスタンスのヘルスチェックを実行したり、インスタンスからジョブの割り当てを解除したりできます。デフォルトでは、ジョブを各ノードに割り当てることができます。ただし、これを無効にして、ノードでジョブが実行されないようにすることもできます。

手順

1. ナビゲーションパネルから Settings を選択します。
2. System オプションのリストから Logging settings を選択します。
3. Logging settings 画面で、Edit をクリックします。

4. 次の設定可能なオプションを設定します。

   • Enable External Logging: ログを外部ログアグリゲーターに送信する場合は、トグルボタンをクリックして ON にします。
   • Logging Aggregator: ログを送信するホスト名または IP アドレスを入力します。

   • Logging Aggregator Port: アグリゲーターのポートが必要な場合は、ポートを指定します。

     注記

     接続タイプが HTTPS の場合、ホスト名をポート番号付きの URL として入力できます。その後はポートを再度入力する必要はありません。ただし、TCP 接続と UDP 接続は、URL ではなく、ホスト名とポート番号の組み合わせによって特定されます。したがって、TCP 接続または UDP 接続の場合は、指定されたフィールドでポートを指定します。代わりに URL が Logging Aggregator フィールドに入力された場合、そのホスト名部分がホスト名として抽出されます。

   • Logging Aggregator Type: クリックして、リストからアグリゲータサービスを選択します。

     

   • Logging Aggregator Username: 必要に応じて、ロギングアグリゲーターのユーザー名を入力します。
   • Logging Aggregator Password/Token: 必要に応じて、ロギングアグリゲーターのパスワードを入力します。
   • Log System Tracking Facts Individually: ツールチップアイコン をクリックすると、オンに切り替えるか、デフォルトのままオフにしておくかなど、追加情報が表示されます。
   • Logging Aggregator Protocol: クリックして、ログアグリゲーターと通信するための接続タイプ (プロトコル) を選択します。その後に表示されるオプションは、選択したプロトコルによって異なります。
   • Logging Aggregator Level Threshold: ログハンドラーで報告する重大度のレベルを選択します。
   • TCP Connection Timeout: 接続タイムアウトを秒単位で指定します。このオプションは、HTTPS および TCP ログアグリゲータープロトコルにのみ適用されます。
   • Enable/disable HTTPS certificate verification: HTTPS ログプロトコルの証明書検証はデフォルトで有効になっています。接続を確立する前に、外部ログアグリゲーターによって送信された HTTPS 証明書をログハンドラーで検証しない場合は、トグルを OFF に設定します。
   • Loggers to Send Data to the Log Aggregator Form: デフォルトでは、4 種類のデータすべてが事前に入力されています。各データ型の追加情報を表示するには、フィールドの横にあるツールチップアイコン をクリックします。不要なデータ型を削除します。
   • Log Format For API 4XX Errors: 特定のエラーメッセージを設定します。詳細は、API 4XX エラー設定 を参照してください。

5. 選択したロギングアグリゲーションのエントリーを確認します。次の例は Splunk 用にセットアップされています。

   

6. Save をクリックするか、変更を破棄する場合は Cancel をクリックします。

手順

1. ナビゲーションパネルから Settings を選択し、Logging settings を選択します。
2. Logging settings ページで、Edit をクリックします。
3. Log Format For API 4XX Errors フィールドを変更します。

手順

1. Prometheus 設定ファイル (通常は prometheus.yml) で、<token_value>、作成した Automation Controller ユーザーの有効なユーザー名とパスワード、および <controller_host> を指定します。

   注記

   あるいは、OAuth2 トークン (/api/v2/users/N/personal_tokens/ で生成可能) を指定することもできます。デフォルトでは、この設定はユーザー名 = admin、パスワード = password であるユーザーを想定しています。

   次の例は、Automation Controller で Prometheus を認証するために /api/v2/tokens エンドポイントで作成した OAuth2 トークンを使用し、Automation Controller のメトリクスエンドポイントの URL が https://controller_host:443/metrics である場合の有効な収集設定です。

   scrape_configs
   
     - job_name: 'controller'
       tls_config:
           insecure_skip_verify: True
       metrics_path: /api/v2/metrics
       scrape_interval: 5s
       scheme: https
       bearer_token: <token_value>
       # basic_auth:
       #   username: admin
       #   password: password
       static_configs:
           - targets:
               - <controller_host>

   Copy to Clipboard Toggle word wrap

   アラートやサービスディスカバリー設定など、Prometheus の他の要素を設定する方法については、Prometheus configuration ドキュメントを参照してください。

   Prometheus がすでに実行中の場合には、再読み込みしたエンドポイントに POST 要求を送信するか、Prometheus プロセスまたはサービスを強制終了し、Prometheus を再起動して設定の変更を適用する必要があります。

2. ブラウザーを使用して http://<your_prometheus>:9090/graph にある Prometheus UI のグラフに移動し、いくつかのクエリーをテストします。たとえば、awx_sessions_total{type="user"} を実行すると、現在のアクティブな Automation Controller ユーザーセッションの数をクエリーできます。

   

1. ワークロードの特徴付け
2. さまざまなノードタイプの機能の確認
3. ワークロードの要件に基づくデプロイメントのプランニング

手順

1. ナビゲーションパネルから Settings を選択します。

2. 次の Authentication オプションから選択します。

   • Azure AD の設定
   • Github の設定
   • Google OAuth2 の設定
   • LDAP 認証
   • RADIUS 設定

   • SAML 設定

     • 透過的な SAML ログイン
     • SAML のロギングを有効にする
   • TACACS+ 設定

   • Generic OIDC 設定

     必要な情報がすべて含まれていることを確認してください。

3. Save をクリックして設定を適用するか、Cancel をクリックして変更を破棄します。

手順

1. ナビゲーションパネルから Settings を選択します。

2. Jobs オプションで Jobs settings を選択します。表示されたフィールドで設定可能なオプションを設定します。追加情報が必要な場合、対象のフィールドの横にあるツールチップアイコン をクリックします。

   Galaxy 設定の詳細は、Automation Controller ユーザーガイド の Ansible Galaxy サポート セクションを参照してください。

   注記

   すべてのタイムアウト値は秒単位です。

3. 設定を適用するには Save を、変更を破棄するには Cancel をクリックします。

手順

1. ナビゲーションパネルから Settings を選択します。

2. 次の System オプションから選択します。

   • Miscellaneous System settings: アクティビティーストリームの有効化、デフォルトの実行環境の指定、Automation Controller ホストのベース URL の定義、Automation Controller 管理アラートの有効化、ユーザーの可視性の設定、アナリティクスの定義、ユーザー名とパスワードの指定、およびプロキシーの設定を行います。
   • Miscellaneous Authentication settings: 認証方法 (ビルトインまたは SSO)、セッション (タイムアウト、ログインしたセッション数、トークン)、およびソーシャル認証マッピングに関連するオプションを設定します。

   • Logging settings: 選択したタイプをもとにロギングオプションを設定します。

     

     各ロギングアグリゲーションタイプの詳細は、ロギングおよびアグリゲーション セクションを参照してください。

3. 表示されたフィールドで設定可能なオプションを設定します。追加情報が必要な場合、対象のフィールドの横にあるツールチップアイコン をクリックします。

   以下は Miscellaneous System の設定例です。

   
   注記

   Allow External Users to Create Oauth2 Tokens 設定は、デフォルトでは無効になっています。これにより、外部ユーザーは独自のトークンを作成できなくなります。有効にしてから無効にすると、その間に外部ユーザーが作成したトークンは残り、自動的には取り消されません。

4. 設定を適用するには Save を、変更を破棄するには Cancel をクリックします。

手順

1. ナビゲーションパネルから Settings を選択します。
2. User Interface オプションから User Interface settings を選択します。
3. Edit をクリックして個人設定を設定します。