実行環境の作成と使用

手順

1. カスタム実行環境のビルドアーティファクトを保存するディレクトリーを作成します。以下の手順で作成する新しいファイルは、このディレクトリーの下に作成されます。

   $ mkdir $HOME/custom-ee $HOME/custom-ee/files
   $ cd $HOME/custom-ee/

2. カスタム実行環境の要件を定義する execution-environment.yml ファイルを作成します。

   注記

   実行環境定義形式のバージョン 3 が必要です。そのため、続行する前に、execution-environment.yml ファイルに version: 3 が明示的に含まれていることを確認してください。

   1. Private Automation Hub で利用可能な最小実行環境を指すように、ベースイメージをオーバーライドします。
   2. ビルドプロセスで使用する非接続のコンテンツソースを指すために必要な、追加のビルドファイルを定義します。カスタムの execution-environment.yml ファイルは次の例のようになります。

   version: 3
   
   images:
     base_image:
       name: private-hub.example.com/ee-minimal-rhel8:latest
   
   dependencies:
     python: requirements.txt
     galaxy: requirements.yml
   
   additional_build_files:
     - src: files/ansible.cfg
       dest: configs
     - src: files/pip.conf
       dest: configs
     - src: files/hub-ca.crt
       dest: configs
     # uncomment if custom RPM repositories are required
     #- src: files/custom.repo
     #  dest: configs
   
   additional_build_steps:
     prepend_base:
       # copy a custom pip.conf to override the location of the PyPI content
       - ADD _build/configs/pip.conf /etc/pip.conf
       # remove the default UBI repository definition
       - RUN rm -f /etc/yum.repos.d/ubi.repo
       # copy the hub CA certificate and update the trust store
       - ADD _build/configs/hub-ca.crt /etc/pki/ca-trust/source/anchors
       - RUN update-ca-trust
       # if needed, uncomment to add a custom RPM repository configuration
       #- ADD _build/configs/custom.repo /etc/yum.repos.d/custom.repo
   
     prepend_galaxy:
       - ADD _build/configs/ansible.cfg ~/.ansible.cfg
   
   ...

3. Private Automation Hub を指す ansible.cfg ファイルを files/ サブディレクトリーに作成します。

   $ cat files/ansible.cfg
   [galaxy]
   server_list = private_hub
   
   [galaxy_server.private_hub]
   url = /https://private-hub.example.com/api/galaxy/

4. 内部 PyPI ミラー (Web サーバーまたは Nexus など) を指す pip.conf ファイルを files/ サブディレクトリーに作成します。

   $ cat files/pip.conf
   [global]
   index-url = https://<pypi_mirror_fqdn>/
   trusted-host = <pypi_mirror_fqdn>

5. オプション: カスタム実行環境に RPM を追加するために bindep.txt ファイルを使用する場合は、非接続の Satellite、または RPM リポジトリーをホストする他の場所を指す files/ サブディレクトリーに、custom.repo ファイルを作成します。この手順が必要な場合は、custom.repo ファイルに対応するサンプルの execution-environment.yml ファイル内の手順をコメント解除します。

   次の例は UBI リポジトリーの場合です。他のローカルリポジトリーもこのファイルに追加できます。ミラーコンテンツが Web サーバーのどこにあるかに応じて、URL パスの変更が必要な場合があります。

   $ cat files/custom.repo
   [ubi-8-baseos]
   name = Red Hat Universal Base Image 8 (RPMs) - BaseOS
   baseurl = http://<ubi_mirror_fqdn>/repos/ubi-8-baseos
   enabled = 1
   gpgkey = file:///etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release
   gpgcheck = 1
   
   [ubi-8-appstream]
   name = Red Hat Universal Base Image 8 (RPMs) - AppStream
   baseurl = http://<ubi_mirror_fqdn>/repos/ubi-8-appstream
   enabled = 1
   gpgkey = file:///etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release
   gpgcheck = 1

6. Private Automation Hub Web サーバー証明書の署名に使用される CA 証明書を追加します。Private Automation Hub が、インストーラーによって提供される自己署名証明書を使用する場合は、以下の手順を行います。

   1. Private Automation Hub からファイル /etc/pulp/certs/pulp_webserver.crt をコピーし、hub-ca.crt という名前を付けます。
   2. hub-ca.crt ファイルを files/ サブディレクトリーに追加します。

7. Private Automation Hub が、認証局によって署名されたユーザー提供の証明書を使用する場合は、以下の手順を行います。

   1. その CA 証明書のコピーを作成し、hub-ca.crt という名前を付けます。
   2. hub-ca.crt ファイルを files/` サブディレクトリーに追加します。

8. 上記の手順を完了したら、カスタム実行環境イメージに必要なコンテンツを含む Python の requirements.txt ファイルと Ansible コレクションの requirements.yml ファイルを作成します。

   注記

   必要なコレクションはすべて、Private Automation Hub に事前にアップロードする必要があります。

   次のファイルは、custom-ee/ ディレクトリーに存在する必要があります。bindep.txt と files/custom.repo は任意です。

手順

1. setup.sh が保存されているディレクトリーに移動します。

2. 次のコマンドを実行して、./group_vars/automationcontroller を作成します。

   touch ./group_vars/automationcontroller

3. 次の内容を ./group_vars/automationcontroller に貼り付けます。環境に合わせて設定を調整します。

   # Automation Hub Registry
   registry_username: 'your-automation-hub-user'
   registry_password: 'your-automation-hub-password'
   registry_url: 'automationhub.example.org'
   registry_verify_ssl: False
   
   ## Execution Environments
   control_plane_execution_environment: 'automationhub.example.org/ee-supported-rhel8:latest'
   
   global_job_execution_environments:
     - name: "Default execution environment"
       image: "automationhub.example.org/ee-supported-rhel8:latest"
     - name: "Minimal execution environment"
       image: "automationhub.example.org/ee-minimal-rhel8:latest"

   注記

   registry_username と registry_password の取得方法については、registry_username と registry_password の設定 を参照してください。

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

   $ ./setup.sh

検証

1. システム管理者アクセス権を持つユーザーとして Ansible Automation Platform にログインします。
2. Automation Execution → Infrastructure → Execution Environments に移動します。
3. Image 列で、実行環境イメージの場所がデフォルト値の <registry url>/ansible-automation-platform-<version>/<image name>:<tag> から <automation hub url>/<image name>:<tag> に変更されていることを確認します。

1. base ビルドステージでは、指定されたベースイメージが、Python、pip、ansible-core、ansible-runner など、他のビルドステージで必要なコンポーネントを使用して (オプションで) カスタマイズされます。次に、生成されたイメージが検証され、必要なコンポーネントが利用可能であることが確認されます (コンポーネントはベースイメージにすでに存在している可能性があるため)。結果として得られるカスタマイズされた base イメージの一時的なコピーは、他のすべてのビルドステージのベースとして使用されます。
2. galaxy ビルドステージでは、定義ファイルで指定されたコレクションがダウンロードされ、final ビルドステージでのインストールのために保存されます。コレクションによって宣言された Python とシステムの依存関係も (存在する場合)、今後の分析のために収集されます。
3. builder ビルドステージでは、コレクションによって宣言された Python の依存関係が、定義ファイルにリストされている依存関係とマージされます。この最後の Python 依存関係セットは、Python ホイールとしてダウンロードおよびビルドされ、final ビルドステージでのインストールのために保存されます。
4. final ビルドステージでは、以前にダウンロードしたコレクションが、システムパッケージおよびコレクションによって依存関係として宣言された、または定義ファイルにリストされていた、以前にビルドされた Python パッケージとともにインストールされます。

手順

1. Podman を使用して registry.redhat.io にログインします。

   $ podman login -u="[username]" -p="[token/hash]" registry.redhat.io

2. 必要な自動化実行環境のベースイメージをプルできることを確認します。

   podman pull registry.redhat.io/ansible-automation-platform-24/ee-minimal-rhel8:latest

3. 必要なベースイメージと新しい実行環境イメージに追加する追加のコンテンツを指定するように Ansible Builder ファイルを設定します。

   1. たとえば、Galaxy の Kubernetes Core Collection をイメージに追加するには、Galaxy エントリーを使用します。

      collections:
        - kubernetes.core

   2. 定義ファイルとその内容の詳細は、定義ファイルの内容の内訳 セクションを参照してください。

4. 実行環境の定義ファイルの EE_BASE_IMAGE フィールドに、元の ee-minimal コンテナーの URL とタグを指定します。編集後の最終的な execution-environment.yml ファイルは次のようになります。

   例5.1 カスタマイズされた execution-environment.yml ファイル

   version: 3
   
   images:
     base_image: 'registry.redhat.io/ansible-automation-platform-25/ee-minimal-rhel9:latest'
   
   dependencies:
     galaxy:
       collections:
         - kubernetes.core

   注記

   この例では、自動化ハブの認定コレクションではなく、コミュニティーバージョンの kubernetes.core を使用するため、ansible.cfg ファイルを作成したり、定義ファイルで参照したりする必要はありません。

5. 以下のコマンドを使用して、新しい実行環境イメージをビルドします。

   $ ansible-builder build -t [username]/new-ee

   ここで、[username] はユーザー名を指定し、new-ee は新しいコンテナーイメージの名前を指定します。

   注記

   build で -t を使用しない場合は、ansible-execution-env というイメージが作成され、ローカルのコンテナーレジストリーに読み込まれます。

   • podman images コマンドを使用して、新しいコンテナーイメージが一覧に表示されていることを確認します。

     以下は、イメージ new-ee を使用した 'podman images' コマンドの出力を示しています。

     REPOSITORY          TAG     IMAGE ID      CREATED        SIZE
     localhost/new-ee    latest  f5509587efbb  3 minutes ago  769 MB

6. コレクションがインストールされていることを確認します。

   $ podman run [username]/new-ee ansible-doc -l kubernetes.core

7. Automation Hub で使用するイメージにタグを付けます。

   $ podman tag [username]/new-ee [automation-hub-IP-address]/[username]/new-ee

8. Podman を使用して Automation Hub にログインします。

   注記

   コンテナーをプッシュするには、Automation Hub の admin または適切なコンテナーリポジトリーのアクセス許可が必要です。詳細は、Private Automation Hub でのコンテナーの管理 を参照してください。

   $ podman login -u="[username]" -p="[token/hash]" [automation-hub-IP-address]

9. イメージを自動化ハブのコンテナーレジストリーにプッシュします。

   $ podman push [automation-hub-IP-address]/[username]/new-ee

10. 新しいイメージを自動化コントローラーインスタンスにプルします。

    1. Automation Controller に移動します。
    2. ナビゲーションパネルから、Automation Execution → Infrastructure → Execution Environments を選択します。
    3. Add をクリックします。

    4. 適切な情報を入力して Save をクリックし、新規イメージにプルします。

       注記

       自動化ハブのインスタンスがパスワードまたはトークンで保護されている場合は、適切なコンテナーレジストリーの認証情報が設定されていることを確認してください。

1. Automation Hub で使用する実行環境の取得
2. Automation Hub で使用する実行環境のタグ付け
3. Private Automation Hub への実行環境のプッシュ
4. コンテナーリポジトリーの設定
5. コンテナーリポジトリーへの README の追加
6. 自動化実行環境へのアクセスの提供
7. コンテナーイメージへのタグ付け
8. 認証情報の作成
9. コンテナーリポジトリーからのイメージのプル
10. イメージのプル
11. コンテナーリポジトリーからのイメージの同期