self-service automation portal の使用
self-service automation portal を使用する
概要
はじめに リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Ansible Automation Platform に興味をお持ちいただきありがとうございます。Ansible Automation Platform は、Ansible を装備した環境に、制御、ナレッジ、委譲の機能を追加して、チームが複雑かつ複数層のデプロイメントを管理できるように支援する商用サービスです。
このガイドでは、self-service automation portal インスタンスにテンプレートを追加する方法と、それを起動して自動化ジョブを実行する方法を説明します。また、ジョブを実行できるチームとユーザーを制限できるように、ロールベースのアクセス制御 (RBAC) を設定する方法も説明します。
このガイドの更新により、Ansible Automation Platform の最新リリースの情報が追加されました。
Red Hat ドキュメントへのフィードバック (英語のみ) リンクのコピーリンクがクリップボードにコピーされました!
このドキュメントの改善に関するご意見がある場合や、エラーを発見した場合は、https://access.redhat.com からテクニカルサポートに連絡してリクエストを送信してください。
第1章 概要 リンクのコピーリンクがクリップボードにコピーされました!
self-service automation portal からテンプレートを起動して、既存の Ansible Automation Platform セットアップからジョブテンプレートを実行できます。
- 自動生成されたセルフサービステンプレートは、Ansible Automation Platform のジョブテンプレートから self-service automation portal に自動的に同期されます。自動生成されたテンプレートのフォームは、ジョブテンプレートのフォームと同じです。
- Git リポジトリーからカスタムセルフサービステンプレートをインポートできます。設定ファイルは、各カスタムテンプレートを Ansible Automation Platform 内の特定のジョブテンプレートにリンクし、ユーザーが入力する必要があるフォームを含みます。
複数のカスタムセルフサービステンプレートを 1 つの Ansible Automation Platform ジョブテンプレートに関連付けることができます。ロールベースのアクセス制御 (RBAC) を使用すると、自動化の経験レベルが異なるユーザーに、異なるカスタムセルフサービステンプレートを割り当てることができます。たとえば、新しいユーザーには設定の範囲を狭め、簡略化したテンプレートを設計し、自動化の専門家向けにはより詳細なテンプレートを設計できます。
第2章 self-service automation portal へのログイン リンクのコピーリンクがクリップボードにコピーされました!
2.1. self-service automation portal へのサインイン リンクのコピーリンクがクリップボードにコピーされました!
前提条件
- self-service automation portal 用に、Ansible Automation Platform で OAuth アプリケーションを設定した。
- Ansible Automation Platform でユーザーアカウントを設定した。
手順
ブラウザーで self-service automation portal の URL に移動し、サインインページを開きます。
- をクリックします。
Ansible Automation Platform のサインインページが表示されます。
- Ansible Automation Platform の認証情報を入力し、Log in をクリックします。
- self-service automation portal の Web コンソールが開きます。
2.2. テンプレートの表示 リンクのコピーリンクがクリップボードにコピーされました!
前提条件
- self-service automation portal にサインインした。
手順
- ブラウザーで self-service automation portal にサインインします。
ナビゲーションウィンドウで Templates を選択すると、アクセスできるテンプレートを表すタイルが表示されるランディングページが開きます。
2.3. 自動生成されたテンプレートの同期 リンクのコピーリンクがクリップボードにコピーされました!
自動生成されたセルフサービステンプレートは、Ansible Automation Platform のジョブテンプレートから self-service automation portal に同期されます。Templates ページから手動で同期をトリガーできます。
この同期では、自動生成されたセルフサービステンプレートの更新のみが取得されます。
手順
- ブラウザーで self-service automation portal にサインインします。
ナビゲーションペインで Templates を選択すると、アクセスできるテンプレートが表示されます。
- 同期を開始するには、Sync now を選択します。
2.4. タスク実行履歴の表示 リンクのコピーリンクがクリップボードにコピーされました!
self-service automation portal から実行されたすべてのタスクのリストを表示できます。Templates ページから手動で同期をトリガーできます。
手順
- ブラウザーで self-service automation portal にサインインします。
ナビゲーションペインで、History を選択します。
Task list ページには、実行されたタスクが表示されます。
トラブルシューティング
実行されたタスクが Task List ページに表示されない場合は、管理者に連絡して、アカウントの RBAC で scaffolder.task.read permission が選択されていることを確認してください。
第3章 テンプレートの使用 リンクのコピーリンクがクリップボードにコピーされました!
3.1. カスタマイズされたセルフサービステンプレート リンクのコピーリンクがクリップボードにコピーされました!
カスタムセルフサービステンプレートは、GitHub または Gitlab のリポジトリーに YAML ファイルとして保存されます。ユーザーが self-service automation portal からソフトウェアテンプレートを起動する場合、Ansible Automation Platform で関連するジョブテンプレートの実行に必要な値をフォームに入力する必要があります。
カスタムセルフサービステンプレート YAML ファイルには、Ansible Automation Platform の認証トークンの ui:field: キーを含む token: セクションが必要です。これにより、ユーザーが self-service automation portal でテンプレートを起動したときに表示されるフォームにトークンのフィールドが生成されます。ユーザーはトークンを入力します。これは、Ansible Automation Platform でのジョブテンプレートの実行を認証するために使用されます。
次の例は ansible-rhdh-templates Ansible コレクションの extensions/patterns/service ディレクトリーにある configure_service.yml バックステージソフトウェアテンプレートの token: セクションを示しています。セキュリティー上の理由から、token.ui:backstage.review.show の値を false に設定して、トークンがユーザーに表示されないようにします。
3.2. self-service automation portal にテンプレートを追加する リンクのコピーリンクがクリップボードにコピーされました!
self-service automation portal インスタンスの Templates ビューに、カスタムセルフサービステンプレートのタイルを追加できます。カスタムセルフサービステンプレートは、git リポジトリーで定義されます。
カスタムセルフサービステンプレートの名前は一意である必要があります。カスタムセルフサービステンプレートの名前には、自動生成されたジョブテンプレートや他のカスタムセルフサービステンプレートとは異なる名前を指定する必要があります。
前提条件
- 使用するテンプレート用のリポジトリーを Git SCM に作成した。
-
カスタムテンプレートの Git リポジトリーで、
metadata.nameフィールドが一意であり、既存の自動生成されたテンプレートまたは別のカスタムセルフサービステンプレートと一致しないことを確認します。たとえば、metadata.nameキーの値に*-customを追加します。
metadata: name: provision-database-custom
metadata:
name: provision-database-custom
- Ansible Automation Platform プラットフォーム管理者として self-service automation portal にログインする必要があります。
手順
- ブラウザーで、self-service automation portal インスタンスに移動し、Ansible Automation Platform の認証情報を使用してサインインします。
- Templates ページに移動します。
- をクリックします。
- 追加するテンプレートの有効な Git SCM URL を入力します。
- をクリックしてテンプレートを取得します。
- テンプレートを取得した後、何がインポートされてカタログに追加されるかをリストで確認します。
- をクリックします。
検証
インポートの完了後、Templates ページに戻り、新しく作成されたテンプレートを表示します。これでテンプレートを起動できます。
3.3. テンプレートの起動 リンクのコピーリンクがクリップボードにコピーされました!
この手順では、self-service automation portal インスタンスの Templates ビューのタイルからテンプレートを起動する方法を説明します。
前提条件
Ansible Automation Platform ジョブテンプレートに関連付けられているテンプレートに対して、Ansible Automation Platform で RBAC を設定した。
手順
- ブラウザーで、self-service automation portal インスタンスに移動し、Ansible Automation Platform の認証情報を使用してサインインします。
- Templates ページに移動します。設定したテンプレートはページ上にタイルとして表示されます。
起動するテンプレートの Start をクリックします。
テンプレートの説明が表示されます。
- Launch をクリックして、テンプレートを実行するためのパラメーターの設定を開始します。
- 必須フィールドに入力します。
- Next をクリックします。
- 入力した情報を確認します。
- Create をクリックしてテンプレートを起動します。
- テンプレート実行の進行状況が表示されます。
第4章 カスタムセルフサービステンプレートの権限の操作 リンクのコピーリンクがクリップボードにコピーされました!
self-service automation portal で設定したカスタムセルフサービステンプレートでは、Ansible Automation Platform から同期される自動生成されたセルフサービステンプレートの RBAC ルールとは異なる RBAC ルールセットが使用されます。
- 自動生成されたセルフサービステンプレート: これらのテンプレートの RBAC 設定は、Ansible Automation Platform から同期されます。
- カスタムセルフサービステンプレート: self-service automation portal でこれらのテンプレートの RBAC を設定する必要があります。
4.1. カスタムセルフサービステンプレートの RBAC の設定 リンクのコピーリンクがクリップボードにコピーされました!
RBAC は Helm チャートで設定されます。admin ユーザーが RBAC 管理者 (rbac_admin) として設定されています。
この手順では、self-service automation portal で、選択したチームのみが特定のカスタムセルフサービステンプレートを表示および実行できるロールを作成する方法を説明します。
self-service automation portal のカスタムセルフサービステンプレートは、Ansible Automation Platform のジョブテンプレートに関連付けられています。この関連付けは、カスタムセルフサービステンプレートの YAML ファイルの steps.actions セクションで設定されます。
self-service automation portal からカスタムセルフサービステンプレートを起動する権限を特定のチームに割り当てる場合は、そのチームが Ansible Automation Platform で関連するジョブテンプレートを実行する権限を持っていることを確認する必要があります。
前提条件
Ansible Automation Platform インスタンスの管理者ユーザーとして、
example-userなどのユーザーを作成した。アクセス管理と認証 ガイドの ユーザーの作成 を参照してください。
このユーザーをチームのメンバーとして追加した (例:
example-team)。アクセス管理と認証 ガイドの チームへのユーザーの追加 を参照してください。
手順
-
ブラウザーで、
admin特権を持つ Ansible Automation Platform ユーザーとして self-service automation portal インスタンスにログインします。 - ナビゲーションパネルで、 → を選択します。
RBAC ビューで、Create をクリックします。
Create Role ビューが表示されます。
- ロールの名前を入力します。
- ロールの使用を許可するユーザーまたはグループを選択します。
- Add Permission policies セクションで、ロールに対して有効にするプラグインを選択します。
- プラグインのリストで Permission を選択し、ロールの詳細な権限ポリシーを設定します。
- Next をクリックします。
- ロールに対して選択した設定を確認します。
- Create をクリックしてルートを作成します。
4.2. RBAC の検証 リンクのコピーリンクがクリップボードにコピーされました!
この手順では、設定したロールが正しく機能していることを確認する方法を説明します。
権限を持つユーザーがテンプレートを使用できることを確認します。
- ロールの使用が有効になっているチームのメンバーであるユーザーとして、self-service automation portal にログインします。
- RBAC が適用されていること、およびロールに対して有効にしたテンプレートをユーザーが使用できることを確認します。
- self-service automation portal からログアウトします。
権限を持たないユーザーがテンプレートを表示または使用できないことを確認します。
- ロールの使用が有効になっている新しいチームのメンバーではないユーザーとして、self-service automation portal にログインします。
- RBAC が適用されていること、およびロールに対して有効にしたテンプレートをユーザーが使用できないことを確認します。
- self-service automation portal からログアウトします。
4.3. カスタムセルフサービステンプレートの登録解除 リンクのコピーリンクがクリップボードにコピーされました!
カスタムセルフサービステンプレートを登録解除できます。テンプレートを登録解除すると、self-service automation portal コンソールの Templates ビューからテンプレートが削除されます。
手順
- ブラウザーで、管理者特権を持つユーザーとして self-service automation portal にログインします。
- セルフサービステンプレートを表示するには、Templates を選択します。
削除するカスタムセルフサービステンプレートごとに、次の手順を実行します。
- カスタムセルフサービステンプレートをクリックすると、Template detail ビューが開きます。ナビゲーションバーには Unregister Template オプションがあります。
Unregister Template をクリックします。
- ダイアログで、テンプレートの登録を解除することを確認します。
- Delete Entity をクリックしてテンプレートの登録を解除します。
検証
ブラウザーで、self-service automation portal インスタンスの Templates ビューに移動します。登録解除したカスタムセルフサービステンプレートが削除されていることを確認します。
第5章 self-service automation portal でフィードバックを提供する リンクのコピーリンクがクリップボードにコピーされました!
self-service automation portal では、新しい機能やコンテンツを提案したり、一般的なフィードバックを提供したりできるフィードバックフォームが提供されます。
self-service automation portal コンソールで Feedback をクリックすると、フィードバックフォームが表示されます。
- フィードバックを入力してください。
- I understand that feedback is shared with Red Hat のチェックボックスを選択します。
- Submit をクリックします。
Red Hat がフィードバックを確実に受け取れるようにするには、ブラウザーの広告ブロッカーやプライバシーツールで self-service automation portal の URL を除外してください。