Automation Services Catalog の使用開始

Red Hat Ansible Automation Platform 2.2

初期設定とワークフロー

Red Hat Customer Content Services

概要

本書では、Automation Services Catalog を使い始める方法を説明します。これには、Ansible Tower プロバイダーに接続するための前提条件と手順のほか、ユーザーと権限の設定などが含まれます。また、プラットフォーム、ポートフォリオ、および製品の使用手順についても説明します。

はじめに

重要

自動化サービスカタログのサポートは、2.4 以降の Ansible Automation Platform では利用できなくなりました。

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

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

第1章 Automation Services Catalog について

Automation Services Catalog は、Red Hat Ansible Automation Platform 内のサービスです。Automation Services Catalog を使用すると、お客様はさまざまな環境にわたって Ansible Tower で製品カタログソースを編成し、管理することができます。

Automation Services Catalog を使用すると、以下が可能になります。

  • 個別のプラットフォームインベントリーにマルチレベルの承認を適用する
  • プラットフォームから製品形式でコンテンツをポートフォリオに編成する
  • ユーザーの特定のグループと共有するためにポートフォリオを選択する
  • ユーザー要求の実行を促進する値に境界を設定する

第2章 Automation Services Catalog の使用開始

本書では、Automation Services Catalog を使い始める方法を説明します。これには、Ansible Tower プロバイダーに接続するための前提条件と手順のほか、ユーザーと権限の設定などが含まれます。また、プラットフォーム、ポートフォリオ、および製品の使用手順についても説明します。

本書で説明されているセットアップを完了して手順に従うと、ユーザーがアクセスでき、承認プロセスで管理された製品ポートフォリオが提供されます。

注記

エンタイトルメント

Automation Service Catalog の使用を開始するには、以下が必要です。

Organization Administrator のエンタイトルメントを持つ 1 人以上の Red Hat アカウントユーザー。Red Hat の企業アカウントのアカウント番号。

第3章 Automation Services Catalog へのユーザーアクセス

組織に Automation Services Catalog を設定する場合は、ユーザー環境の範囲、それらのユーザーのグループ化の方法、および割り当てるロールについて検討してください。User Access を使用して、このワークフローを管理できます。

Automation Services Catalog 機能とワークフローは、特定の ロール が割り当てられている グループ で管理されます。Organization Administrator ロールは、グループの最初の作成を実行し、ロールを割り当て、ユーザーを追加します。

グループ

グループはユーザーで定義され、多くのユーザーを含む柔軟性があり、複数のロールを持ちます。Automation Services Catalog の使用に関する組織の要件に基づいて、新しいグループを作成します。

ロール

ロールは、各グループが実行する定義されたアクションセットを提供します。Automation Services Catalog が使用する以下のロールに基づいて、ユーザーに必要なアクセスレベルを決定します。

表3.1 ロール参照テーブル

 ロール説明

管理

Organization Administrator

  • Catalog および Approval のユーザーアクセスの管理
  • プラットフォームソースのカタログへの追加

承認

Approval Administrator

  • 承認グループへのユーザーの作成および割り当て
  • 承認プロセスの作成および設定
  • リクエストの承認または拒否
  • 既存のリクエストの監視

Approval Approver

  • リクエストの承認または拒否
  • 既存のリクエストの監視

Approval User

  • 製品のリクエスト
  • 既存のリクエストの監視

カタログ

Catalog Administrator

  • オーダープロセスの作成 / 編集
  • オーダープロセスの製品またはポートフォリオへの設定
  • オーダープロセスの削除

Catalog User

  • 製品のリクエスト
  • 既存のリクエストの監視
注記

デフォルトでは、すべてのユーザーには Catalog User および Approval User ロールが割り当てられます。

重要

セキュリティーに影響を与える可能性があるため、cloud.redhat.com のユーザー数を Organization Administrator 権限で制限してください。

3.1. 管理者グループの作成

Organization Administrator は、Automation Services Catalog で管理者およびユーザーの新しいグループを作成できます。Catalog および Approval 管理者は、Automation Services Catalog の設定で初期ワークフローを実行する必要があります。このセクションでは、Catalog および Approval 管理者の両方にグループを作成します。

3.1.1. Catalog Administrator グループの作成

Catalog Administrator は、作成、読み取り、更新、およびオーダーのパーミッションを付与するロールです。このロールは、ポートフォリオや製品に関連するプロセスの作成および管理に使用されます。

Catalog Administrator グループを作成するには、以下を実行します。

  1. SettingsUser Access に移動します。
  2. Create Group をクリックします。
  3. グループの 名前 を入力し、説明 を設定します。
  4. Next をクリックします。
  5. Add members モーダルで、グループに追加する各ユーザーを確認します。終了したら Next をクリックします。
  6. Assign roles モーダルで Catalog Administrator を確認します。
  7. 新規グループの詳細を確認し、Confirm をクリックします。

Catalog Administrator のグループが作成され、続いて Approval 管理者のグループを作成します。

3.1.2. Approval Administrator グループの作成

Approval Administrator は、作成、読み取り、更新、およびオーダーのパーミッションを付与するロールです。このロールは、ポートフォリオや製品に関連するプロセスの作成および管理に使用されます。

Approval Administrator グループを作成するには、以下を実行します。

  1. SettingsUser Access に移動します。
  2. Create Group をクリックします。
  3. グループの 名前 を入力し、説明 を設定します。
  4. Next をクリックします。
  5. Add members モーダルで、グループに追加する各ユーザーを確認します。終了したら Next をクリックします。
  6. Assign roles モーダルで Approval Administrator を確認します。
  7. 新規グループの詳細を確認し、Confirm をクリックします。

Approval Administrators の新しいグループが作成されました。Approval Administrators は、プラットフォーム、ポートフォリオ、および製品に設定する新たな承認プロセスを作成できます。

3.1.3. Approval Approver グループの作成

Approval Approver は、Automation Services Catalog ユーザーが製品をオーダーする時に生成されるリクエストを承認または拒否するユーザーに、作成および読み取りのパーミッションを付与するロールです。

Approval Approver グループを作成するには、以下を実行します。

  1. SettingsUser Access に移動します。
  2. Create Group をクリックします。
  3. グループの 名前 を入力し、説明 を設定します。
  4. Next をクリックします。
  5. Add members モーダルで、グループに追加する各ユーザーを確認します。終了したら Next をクリックします。
  6. Assign roles モーダルで Approval Approvers を確認します。
  7. 新規グループの詳細を確認し、Confirm をクリックします。

Approval Approvers の新しいグループが作成されました。

3.1.4. 既存グループへの新規ユーザーの追加

Catalog Administrator は、新規ユーザーを既存のグループに追加できます。追加が完了すると、ユーザーにはそのグループに関連付けられたパーミッションのレベルが設定されます。

User AccessGroups ビューのグループにユーザーを追加できます。

  1. SettingsUser Access に移動します。
  2. Groups をクリックします。
  3. 一覧からグループを選択します。
  4. Members をクリックしてから、Add Member をクリックします。
  5. グループに追加するモーダルに表示されるユーザーを確認します。
  6. Add to group をクリックします。

メンバーが正常に追加されたかどうかを知らせるメッセージが表示されます。

第4章 Approval の設定

Automation Services Catalog は、ポートフォリオ、製品、およびプラットフォームインベントリーに適用されるグループベースの承認プロセスをサポートし、Approval サービスを使用するリクエストの承認に選択された組織グループを追加する柔軟生を提供します。

承認管理者は、承認グループおよびプロセスの作成、リクエストの詳細の表示、リクエストの承認または拒否、および既存のリクエストのステータスの監視を実行できます。

4.1. 承認リクエスト

承認リクエストは、承認ポリシーがアタッチされた製品をユーザーがオーダーすると作成されます。オーダーにより、製品に割り当てられた承認プロセスが開始し、各承認プロセスで承認者として指定されたユーザーが、リクエストの準備ができたことを通知する電子メールを受け取ります。

Catalog にログインするユーザーは、以下のタブから承認リクエストにアクセスできます。

  • My requests: ユーザーのグループパーミッションに基づいてユーザーが承認できるリクエスト。
  • All requests: すべての承認者グループにまたがるすべてのリクエスト。
  • Approval processes: Approval Administrator が設定できる承認プロセスの一覧。Approval Administrator のみがアクセスできます。

4.2. 承認プロセス

承認プロセスは、リクエストを承認するために必要な 1 つまたは複数のグループで設定されます。各グループには、承認が必要なリクエストの作成時に、そのユーザーに関連付けられたメールアドレス経由で通知されます。

承認管理者は、ポートフォリオに設定された場合に、順次または並行して実行する製品の承認プロセスを設計できます。以下で、シンプルな順次および並列承認プロセスについて説明します。

プラットフォーム、ポートフォリオ、または製品レベルで承認プロセスを設定します。プラットフォームに設定された承認プロセスは、そのプラットフォームからのすべての製品に適用されます。

  • Serial process: 製品には、階層的なシーケンスで実行する必要がある複数の承認プロセスがあります。2 つの承認プロセスが製品に順次割り当てられている場合は、2 つ目の承認グループに通知が送信される前に、1 つ目の承認プロセスの承認グループがリクエストを承認する必要があります。承認プロセス実行の優先度は、承認プロセス一覧のビューの位置に基づいています。一覧のトップにある承認プロセスは、その下にあるプロセスの前に実行されます。
  • Parallel process: 製品には複数のグループが含まれる 1 つの承認プロセスがあります。リクエストが作成されると、すべてのグループに同時に通知され、すべてのグループが承認するまでオーダーは許可されません。リクエストを拒否するグループはプロセスを終了し、オーダーが拒否されたことがユーザーに通知されます。
注記

Approval プロセスの作成時にグループを作成して一覧表示するには、Approval Administrator にも Organization Administrator 権限を付与する必要があります。

4.2.1. 承認プロセスの作成

承認プロセスを作成すると、Automation Services Catalog ユーザーによる製品オーダーを承認するために必要な特定のグループを指定します。

Approval processes 一覧のビューから承認プロセスを作成できます。

  1. メインナビゲーションから Approval を選択します。
  2. Approval processes タブを選択します。
  3. 作成 をクリックします。
  4. 承認プロセス名と説明を指定します。
  5. Set groups ドロップダウンメニューからグループを選択します。承認には複数のグループを設定できます。
  6. 終了したら Submit をクリックします。

プラットフォーム、ポートフォリオ、または製品に対して承認プロセスを実装します。

4.3. 承認プロセスシーケンス

各承認プロセスには、ポートフォリオに設定された順次承認プロセスに含まれる場合に実行される優先順位を決定するシーケンス ID が割り当てられます。シーケンス ID が 1 の承認プロセスは、シーケンス ID が 1 を超えるプロセスの前に、新しいリクエストの承認プロセスでグループを実行および通知します。

4.3.1. 承認プロセスシーケンスの編集

承認プロセス一覧のビューから、承認プロセスのシーケンス番号を編集できます。

  1. メインナビゲーションから Approval を選択します。
  2. Approval processes タブをクリックします。
  3. 承認プロセスに移動し、 More actions をクリックします。
  4. Edit をクリックします。
  5. Enter sequence の下に、任意のシーケンス番号を入力します。
  6. Save をクリックします。

承認プロセス一覧のビューが更新され、新規シーケンスが反映されます。

4.4. 自動承認

以下のレベルで承認プロセスを設定しないことで、自動的に承認する製品を指定できます。

  • 製品をホストするインベントリー
  • 製品を含むポートフォリオ
  • 製品自体

これらのレベルで承認プロセスのない製品は、オーダーの作成時に承認されます。

第5章 プラットフォーム、ポートフォリオ、製品の使用

本セクションでは、Automation Services Catalog を使い始めるためのプラットフォーム、ポートフォリオ、および製品の基本ワークフローについて説明します。

以下について説明します。

  • ポートフォリオの作成方法
  • ソースプラットフォームからポートフォリオへの製品の追加方法
  • ポートフォリオの承認プロセスの設定方法
  • ユーザーとのポートフォリオの共有方法

5.1. ポートフォリオの作成およびポートフォリオへの製品の追加

ポートフォリオを作成するには、以下の手順に従います。

  1. Create portfolio をクリックします。
  2. New Portfolio Name および Description を指定します。
  3. ドロップダウンリストから Approval workflow を選択します。
  4. Save をクリックします。

最初のポートフォリオは空になっているため、この空の状態から製品を追加し始めることができます。

プラットフォームから製品を追加するには、以下を行います。

  1. Filter by Platform フィールドをクリックし、接続されたプラットフォームを表示します。
  2. プラットフォームを選択します。画面には、そのプラットフォームの製品が設定されます。
  3. 各製品を確認して、ポートフォリオに追加します。
  4. Add をクリックします。

5.2. ポートフォリオの承認プロセスの設定

ポートフォリオが作成され、いくつかの製品が追加されました。次のステップでは、ポートフォリオの承認プロセスを設定します。ポートフォリオの承認プロセスを設定することにより、特定のグループがユーザーのオーダーを承認するように指定されます。

ポートフォリオの承認プロセスを設定するには、以下を行います。

  1. Portfolios に移動します。
  2. ポートフォリオタイルで More actions をクリックし、Set approval を選択します。
  3. Set approval process のドロップダウンメニューから、ポートフォリオに設定する承認プロセスを選択します。
  4. Save をクリックします。

5.3. ユーザーとのポートフォリオの共有

これで、ポートフォリオをユーザーのグループと共有する準備が整いました。これらの指定されたユーザーグループはポートフォリオで収集された製品をオーダーでき、それらのオーダーはポートフォリオに設定された承認プロセスを使用して承認または拒否されます。

ポートフォリオを共有するには、以下の手順を実施します。

  1. Portfolios をクリックします。
  2. ポートフォリオで More actions をクリックし、Share をクリックします。アイコン [Y] は共有ポートフォリオを示します。
  3. グループを追加します。

    1. Invite group の下で、ポートフォリオを共有するグループを検索します。
    2. ドロップダウンリストを使用してパーミッションのレベルを選択します。
  4. 既存グループの共有設定を編集します。

    1. Groups with access の下で、各グループのドロップダウンを使用してパーミッションを調整します。
    2. グループとのポートフォリオの共有を停止するには、アイコン [X] をクリックします。
  5. 終了したら Send をクリックします。

ポートフォリオは、収集した製品をオーダーできるユーザーのグループにアクセスできるようになりました。別のユーザーグループと共有するために、このポートフォリオの複製、名前の変更、および新規製品の追加ができるようになりました。

5.4. 既存のポートフォリオをコピーして編集し、新規グループと共有する

ポートフォリオのコピーにより、すでに編成されたポートフォリオをすばやく複製して、異なるユーザーのグループに提供することができます。コピーが作成されると、製品の追加または削除、新規グループとの共有、組織の要件を満たすための新たな承認プロセスの適用を実行できます。

ポートフォリオのコピーにより、すでに編成されたポートフォリオをすばやく複製して、異なるユーザーのグループに提供することができます。コピーが作成されると、製品の追加または削除、新規グループとの共有、組織の要件を満たすための新たな承認プロセスの適用を実行できます。

さまざまなポートフォリオから追加のポートフォリオに製品をコピーすることもできます。

5.5. 異なるポートフォリオへの製品のコピー

グループのニーズを満たすための新しいポートフォリオの開発の一環として、あるポートフォリオから別のポートフォリオに製品をコピーすることができます。製品がコピーされると、基本フィールドの編集、サーベイの更新、さまざまな承認プロセスの適用を実行することができます。

5.6. ワークフローの概要

本ガイドの本セクションのワークフローでは、Automation Services Catalog を使い始めるのに必要なプラットフォーム、ポートフォリオ、および製品に対する基本的なアクションの実行方法を説明します。

  • Automation Service Catalog にアクセスするためのエンタイトルメントを追加します。
  • 必要なグループおよびユーザーを作成します。
  • ソースプラットフォームに接続します。
  • ポートフォリオを作成します。
  • ソースプラットフォームからポートフォリオに製品を追加します。
  • ポートフォリオの承認プロセスを設定します。
  • ポートフォリオをユーザーと共有します。
  • 既存のポートフォリオのコピーを作成し、異なるユーザーと共有します。
  • あるポートフォリオから別のポートフォリオに製品をコピーします。

次のセクションでは、サーベイエディターの使用について説明し、リクエストとオーダーの使用に関する概要を説明します。

第6章 サーベイエディターの使用

ユーザーは、Automation Services Catalog で製品をオーダーする際に、リクエストを完了するための追加情報を提供しなければならない場合があります。このプロンプトは、製品に関連付けられたサーベイにより作成されます。Ansible Tower で最初に作成および編集された Catalog Administrator および更新権限を持つポートフォリオユーザーは、Automation Services Catalog でサーベイを編集できます。送信および検証されると、サーベイは、ユーザーが送信した追加の変数を、オーダーの実行時に Ansible Tower で実行されるジョブまたはワークフローテンプレートに渡します。

ジョブテンプレートのサーベイの作成および編集の詳細は、Ansible Tower ユーザーガイドSurveys を参照してください。

サーベイプロパティーエディターを使用すると、以下が可能になります。

  • 情報を提供するユーザーのユーザーエクスペリエンスを強化するために、ラベル、ヘルパーテキスト、またはプレースホルダーを設定します。
  • 既存の検証パラメーターをさらに制限します。
  • 検証メッセージを変更します。
  • サーベイの選択したフィールドを非表示にするか、無効にするか、読み取り専用に設定します。

6.1. サーベイプロパティーエディター

サーベイの値は Ansible Tower で定義され、Automation Services Catalog プロパティーエディターにより、Catalog Administrator は、デフォルト値の調整やドロップダウンメニューからのアイテムの削除など、サーベイオプションを制限できます。

また、プロパティーエディターを使用して、フィールドを非表示にするか、無効にするか、読み取り専用に設定します。

注記

Hidden または Disabled に設定された必須フィールドの初期値を指定します。これには、read only フィールドが含まれます。

6.2. サーベイの編集

製品の詳細ビューで、サーベイのフィールドを編集できます。プロパティーエディターを使用して各フィールドを個別に編集します。

前提条件

製品には、Ansible Tower で作成される関連のサーベイがあります。

手順

  1. Products をクリックします。
  2. 製品を探し、タイトルをクリックします。
  3. More actions をクリックして、Edit survey を選択します。
  4. サーベイでフィールドを選択します。Properties エディターが表示されます。
  5. Properties をクリックして、そのフィールド用に編集する要素を表示します。
  6. Validation を選択して、ユーザー入力の検証に使用するバリデータータイプを設定します。
  7. 終了したら Save をクリックします。

第7章 オーダーの管理

ユーザーがリクエストを正常に送信したら、オーダーが作成され、必要な検証が提供されます。その後、承認プロセスがユーザーのオーダーステータスを管理します。

7.1. リクエストの承認または拒否

ユーザーがオーダーを出すと、オーダーが作成され、オーダーページで確認することができます。Approval Approver ロールが割り当てられているグループは、オーダーの承認または拒否を行うことができます。それぞれのリクエストの詳細情報と、オーダーした製品とそれに関連するリクエスターおよびプロジェクトに関する情報が提供されます。ステージトランクスクリプトも提供されます。リクエストの拒否には正当な理由が必要で、承認者は理由を入力する必要があります。

リクエストを承認または拒否するには、以下を実行します。

  1. Approval に移動します。
  2. Requests タブをクリックしてから、リクエストをクリックして詳細ビューを展開します。
  3. Approve または Deny をクリックします。リクエストを拒否する場合は Reason を指定します。
  4. Submit をクリックします。

7.2. リクエストへのコメント

管理者または承認者としてリクエストについてコメントします。コメントはシステムによってキャプチャーされ、承認の各段階で表示されます。

リクエストについてコメントするには、以下を実行します。

  1. Approval に移動します。
  2. Requests タブをクリックしてから、リクエストをクリックします。
  3. Comment をクリックします。
  4. コメントを追加して Submit をクリックします。

第8章 まとめ

本書のこれまでのセクションで、Automation Services Catalog を使い始めるために必要な主要なワークフローについて説明してきました。

これらのワークフローに従って、以下が実行されました。

  • ユーザーアクセスを通じて Catalog と Approval の両方を使用する必要なグループとユーザーを作成しました。
  • ソースプラットフォームに接続しました。
  • ポートフォリオを作成しました。
  • ソースプラットフォームからポートフォリオに製品を追加しました。
  • ポートフォリオの承認プロセスを作成および設定しました。
  • ユーザーとポートフォリオを共有しました。
  • ユーザーが作成したオーダーを承認または拒否しました。
  • 必要に応じてオーダーにコメントしました。

法律上の通知

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.