16. プロジェクト¶

16.1. 新規プロジェクトの追加¶

新規プロジェクトを作成するには、以下を実行します。

1. 追加 ボタンをクリックします。これにより、プロジェクトの作成 ウィンドウが起動します。

2. 以下の必須フィールドに適切な情報を入力します。

• 名前

• 説明 (オプション)

• 組織: プロジェクトには 1 つ以上の組織がなければなりません。ここで 1 つの組織を選択してプロジェクトを作成し、プロジェクトの作成後にさらに組織を追加できます。

• デフォルトの実行環境 (オプション): 実行環境の名前を入力するか、既存の実行環境の一覧から検索して、このプロジェクトを実行します。詳細は Ansible Automation Platform Upgrade and Migration Guide の Execution Environments へのアップグレード を参照してください。

• ソースコントロール認証情報タイプ: ドロップダウンメニューリストから、このプロジェクトに関連付けられている SCM タイプを選択します。後に続くセクションでは、選択したタイプにより、利用可能なオプションが異なります。詳細は、後続のセクションの 「Playbook の手動による管理」または「ソースコントロールの使用による Playbook の管理」を参照してください。

3. 完了したら 保存 をクリックします。

16.2. ソースコントロールからのプロジェクトの更新¶

1. プロジェクトを選択し、 ボタンをクリックして、既存の SCM ベースのプロジェクトを更新します。

注釈

ソースコントロールを使用するためにプロジェクト設定を追加した直後に「同期」が開始され、設定されたソースコントロールからプロジェクト詳細の取り込みが実行されることに注意してください。

2. ステータス 列のプロジェクトのステータスをクリックすると、更新プロセスの詳細が表示されます。

16.3. パーミッションの使用¶

このプロジェクトに割り当てられており、プロジェクト、インベントリー、ジョブテンプレート、およびその他の automation controller 要素の読み取り、変更、および管理を行う機能を提供するパーミッションのセット (ロールベースのアクセス制御) は、権限とも呼ばれています。

詳細 タブの隣の アクセス タブを使用して、プロジェクトのパーミッションにアクセスします。この画面では、現在このプロジェクトに対してパーミッションがあるユーザー一覧を表示します。この一覧は、ユーザー名、名 または 姓 別で並び替え、検索が可能です。

16.3.1. パーミッションの追加¶

1. アクセス タブで 追加 ボタンをクリックします。

2. 追加するユーザーまたはチームを選択し、**次へ**をクリックします。

3. リストから 1 つまたは複数のユーザーを選択します。これには、メンバーとして追加するユーザーの隣にあるチェックボックスをクリックして、次へ をクリックします。

この例では、追加するユーザーが 2 つ選択されています。

4. 選択したユーザーやチームに割り当てるロールを選択します。役割の一覧は、下にスクロールして確認してください。リソースによって利用できるオプションが異なります。

5. 保存 ボタンをクリックすると、選択したユーザーまたはチームにロールが適用され、メンバーとして追加されます。

ユーザー/チームの追加ウィンドウが閉じ、各ユーザーやチームに割り当てられた更新済みのロールが表示されます。

特定ユーザーのロールを削除するには、そのリソースの横にある「関連付けの解除」(x) ボタンをクリックします。

これにより確認ダイアログが起動し、関連付けの解除を確定するように求められます。

16.4. 通知の使用¶

通知 タブをクリックすると、設定した通知の統合を確認できます。

トグルを使用して、特定のプロジェクトで使用する通知を有効または無効にします。詳細については、「通知の有効化と無効化」を参照してください。

通知が設定されていない場合は、左ナビゲーションバーの 通知 リンクから設定し、新しい通知を作成することができます。

さまざまな通知タイプの設定に関する追加の情報は、「通知タイプ」を参照してください。

16.5. ジョブテンプレートの使用¶

ジョブテンプレート をクリックし、ジョブテンプレートや、このプロジェクトに関連付けられているワークフローテンプレートを追加および確認できます。

そのテンプレートを使用して実行したジョブのステータスをクリックすると、その詳細やその他の有用な情報を見ることができます。このリストは、さまざまな条件で並べ替えたり、検索を実行して目的のテンプレートを絞り込むことができます。

このビューから、テンプレートの設定を起動 () または編集 () できます。

16.6. スケジュールの使用¶

スケジュール をクリックすると、このプロジェクトに設定されているスケジュールを確認できます。

16.7. Ansible Galaxy サポート¶

プロジェクト更新の終了時に、automation controller は、<project-top-level-directory>/roles/requirements.yml の roles ディレクトリーで requirements.yml という名のファイルを検索します。このファイルが見つかると、以下のコマンドが自動的に実行されます。

ansible-galaxy role install -r roles/requirements.yml -p <project-specific cache location>/requirements_roles -vvv

このファイルを使用すると、Galaxy ロールや、他のリポジトリー内のロールを参照できます。このロールは、独自のプロジェクトと組み合わせてチェックアウトできます。この Ansible Galaxy サポートを追加することで、この結果を達成するために git サブモジュールを作成する必要がなくなります。SCM プロジェクト (およびロール/コレクション) がプライベートジョブ環境からプルされ、そこから実行される場合は、/tmp 内のプロジェクトに固有の <private job directory> がデフォルトで作成されます。ただし、設定ウィンドウのジョブの設定タブで、お使いの環境に基づいて別の ジョブの実行パス を指定することができます。

キャッシュディレクトリーはグローバルプロジェクトディレクトリー内のサブディレクトリーで、コンテンツはキャッシュの場所から <job private directory>/requirements_roles の場所にコピーできます。

デフォルトでは、automation controller にシステム全体の設定があり、この設定で SCM プロジェクト用に roles/requirements.yml ファイルからロールを動的にダウンロードできます。ロールのダウンロードを有効にする の切り替えボタンを オフ にすることで、設定メニューの **ジョブ設定**画面にあるこの設定をオフにできます。

プロジェクトの同期が実行するたびに、automation controller は、プロジェクトのソースと、Galaxy や Collections のロールがプロジェクトで古くなっているかどうかを判断します。プロジェクトの更新により、更新内のロールがダウンロードされます。

ジョブがアップストリームロールに加えられた変更を取得する必要がある場合は、プロジェクトを更新すると、これが確実に行われます。ロールの変更は、新しいコミットが provision-role ソースコントロールにプッシュされたことを意味します。この変更をジョブで有効にするために、playbooks リポジトリーに新しいコミットをプッシュする必要はありませんが、ロールをローカルキャッシュにダウンロードするプロジェクトを更新する 必要があります。たとえば、ソースコントロールに 2 つの git リポジトリーがあるとします。1 つ目は playbooks で、automation controller のプロジェクトはこの URL を指しています。2 つ目は provision-role であり、playbooks git リポジトリー内の roles/requirements.yml ファイルにより参照されます。

つまり、ジョブは、すべてのジョブの実行前に最新のロールをダウンロードします。ロールとコレクションは、パフォーマンス上の理由でローカルでキャッシュされます。また、プロジェクトの SCM 更新オプション で 起動時のリビジョン更新 を選択し、各ジョブの実行前にアップストリームロールを再ダウンロードするようにする必要があります。

更新は同期よりもはるかに前のプロセスで行われるため、これによりエラーと詳細がより速く、より論理的な場所で詳細が表示されます。

requirements.yml の構文に関する詳細情報と例については、Ansible ドキュメントの「role requirements section」セクションを参照してください。

とくに公開する必要のあるディレクトリーがある場合は、設定画面のジョブで 分離されたジョブの公開するパス に指定するか、設定ファイルで以下のエントリーを更新して指定することができます。

AWX_ISOLATION_SHOW_PATHS = ['/list/of/', '/paths']

注釈

Playbook が /var/lib/awx/.ssh で定義した鍵や設定を使用する必要がある場合には、このファイルを主要ファイルとして、AWX_ISOLATION_SHOW_PATHS に追加してください。

設定ファイルに変更を加えた場合には、変更の保存後に automation-controller-service restart コマンドを使用してサービスを再起動するようにしてください。

ユーザーインターフェースでは、ジョブ設定ウィンドウで、これらの設定を行うことができます。

16.8. コレクションのサポート¶

Automation controller は、ジョブの実行時におけるプロジェクト固有の Ansible コレクションをサポートします。SCM に collections/requirements.yml という名前のコレクション要件ファイルを指定すると、automation controller は、ジョブ実行前に暗黙的なプロジェクトを同期する際に、そのファイルで指定したコレクションをインストールします。コレクションの要件は次のように指定します。

ansible-galaxy collection install -r requirements.yml -p <job tmp location>

デフォルトでは、automation controller にシステム全体の設定があり、この設定で SCM プロジェクト用に collections/requirements.yml ファイルからコレクションを動的にダウンロードできます。コレクションのダウンロードを有効にする の切り替えボタンを オフ にすることで、設定メニューの ジョブ設定 タブにあるこの設定をオフにできます。

ロールとコレクションはパフォーマンス上の理由からローカルにキャッシュされるため、以下を確実に行うためには、プロジェクトの SCM 更新オプションで 起動時のリビジョン更新 を選択する必要があります。

16.8.1. Hub でのコレクションの使用¶

automation controller がコレクションコンテンツのデフォルトのソースとして Automation Hub を使用できるようにするには、Automation Hub UI で API トークンを作成する必要があります。これにより、automation controller 内で指定することができるようになります。非公開の Automation Hub コレクションまたは公開 Automation Hub コレクションに接続できますが、指定する URL のみが異なります。

1. https://cloud.redhat.com/ansible/automation-hub/token に移動し、Load token をクリックします。

2. コピーアイコンをクリックして、API トークンをクリップボードにコピーします。

3. 公開 Automation Hub を使用するには、コピーしたトークンを使用して Automation Hub 認証情報を作成し、トークンページの Server URL フィールドおよび SSO URL フィールドにある URL を指定します。

• Galaxy Server URL = https://cloud.redhat.com/api/automation-hub/

• 認証サーバー URL = https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token

4. 非公開の Automation Hub を使用するには、ローカルの Automation Hub のリポジトリー管理ダッシュボードから取得したトークンを使用して Automation Hub 認証情報を作成し、以下のように公開されたリポジトリーの URL を指定します。

異なる名前空間/コレクションで異なるリポジトリーを作成できます。Automation Hub のリポジトリーごとに、別の Automation Hub 認証情報を作成する必要があります。https://$<hub_url>/api/galaxy/content/<repo you want to pull from> 形式の Automation Hub UI から、Ansible CLI URL を 認証情報の作成 フォームの Galaxy Server URL フィールドにコピーします。

Automation Hub UI 固有の手順については、「Managing Red Hat Certified and Ansible Galaxy Collections in Ansible Hub」を参照してください。

5. Automation Hub からコンテンツの同期が可能な組織に移動し、新しい Automation Hub 認証情報を組織に追加します。このステップでは、各組織を。コンテンツを使用できる Automation Hub 認証情報 (つまりリポジトリー) に関連付けることができます。

注釈

リポジトリーが 2 つあるとします。

• Prod: Namespace 1 および Namespace 2 (それぞれコレクション A および B が含まれます (namespace1.collectionA:v2.0.0 および namespace2.collectionB:v2.0.0)

• Stage: コレクション A のみがある Namespace 1 (Automation Hub の namespace1.collectionA:v1.5.0 )。Prod および Stage のリポジトリー URL があります。

それぞれに Automation Hub 認証情報を作成できます。次に、さまざまな組織にさまざまなレベルのアクセスを割り当てることができます。たとえば、開発者組織が両方のリポジトリーにアクセスできるのに対し、運用組織は |ah|の Prod リポジトリーにのみアクセスできるようにすることができます。

Automation Hub UI 固有の手順については、「Managing User Access in Ansible Hub」を参照してください。

6. Automation Hub に自己署名証明書がある場合は、トグルをクリックして設定 Ansible Galaxy SSL 証明書の検証を無視する を有効にします。署名した証明書を使用する 公開 Automation ハブ では、代わりにトグルをクリックして無効にします。これは、グローバル設定になります。

7. ソースリポジトリーが collections/requirements.yml ファイルにある要件ファイルに必要なコレクションを指定するプロジェクトを作成します。Ansible のドキュメント https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#install-multiple-collections-with-a-requirements-file で説明されている構文を参照してください。

8. プロジェクトリストのビューで をクリックして、このプロジェクトに対して更新を実行します。Automation controller は collections/requirements.yml ファイルから Galaxy コレクションを取得し、それを変更されたものとして報告します。このプロジェクトを使用するジョブテンプレートに対してコレクションがインストールされます。

注釈

Galaxy またはコレクションから更新が必要な場合は、必要なロールをダウンロードし、/tmp ファイルでより多くの領域を消費する同期が実行されます。大規模なプロジェクト (約 10 GB) があると、/tmp のディスク容量が問題になる可能性があります。

コレクションの詳細は、「Using Collections」を参照してください。Red Hat がこれらの公式コレクションのいずれかを公開する方法 (automation controller のインストールを直接自動化するために使用できます) は、AWX Ansible Collection のドキュメントを参照してください。このページは、Red Hat Ansible Automation Platform サブスクリプションでご利用になれるため、Red Hat のカスタマー認証情報を使用してアクセスしてください。