Automation Controller のスタートガイド
Automation Controller のスタートガイド
概要
はじめに リンクのコピーリンクがクリップボードにコピーされました!
まず、Ansible Automation Platform をインストールし、(Automation Controller によって提供される) 初期 Playbook をデプロイできるターゲットシステムを選択します。最初の Playbook では、コントローラーの使用方法と適切な設定方法を説明しながら、単純な Ansible タスクを実行します。Ansible ドキュメントの マネージドノード セクションで説明されているように、Ansible で管理できるあらゆる種類のシステムを使用できます。詳細な手順は、Red Hat Ansible Automation Platform インストールガイド を参照してください。
Ansible Automation Platform はサブスクリプションベースで提供されます。サブスクリプションの種類によって、価格とサポートレベルが異なります。サブスクリプションと機能の詳細は、Subscription Types を参照してください。
Red Hat ドキュメントへのフィードバック (英語のみ) リンクのコピーリンクがクリップボードにコピーされました!
このドキュメントの改善に関するご意見がある場合や、エラーを発見した場合は、https://access.redhat.com から Technical Support チームに連絡してください。
第1章 インストール後の Automation Controller ダッシュボードへのログイン リンクのコピーリンクがクリップボードにコピーされました!
Automation Controller をインストールした後、ダッシュボードにログインする必要があります。
手順
- インストールの完了後に指定したログイン情報を使用して、Web ブラウザーを開き、サーバー URL (https://<CONTROLLER_SERVER_NAME>/) に移動して Automation Controller にログインします。
インストールプロセス中に指定した認証情報を使用してログインします。
- デフォルトのユーザー名は admin です。
- admin のパスワードは指定した値です。
- 目的のユーザーの横にある アイコン ⋮ をクリックします。
- をクリックします。
- 必要な詳細を編集し、 をクリックします。
第2章 Ansible Automation Controller のサブスクリプションの管理 リンクのコピーリンクがクリップボードにコピーされました!
Automation Controller を使用するには、その使用を許可する有効なサブスクリプションが必要です。
2.1. 正式な Ansible Automation Controller のサブスクリプションの取得 リンクのコピーリンクがクリップボードにコピーされました!
すでに Red Hat 製品のサブスクリプションをお持ちの場合は、そのサブスクリプションを通じて Automation Controller サブスクリプションを取得できます。Red Hat Ansible Automation Platform および Red Hat Satellite のサブスクリプションをお持ちでない場合は、試用版サブスクリプションをリクエストできます。
手順
- Red Hat Ansible Automation Platform サブスクリプションをお持ちの場合は、Automation Controller を起動するときに Red Hat の顧客認証情報を使用して、サブスクリプション情報にアクセスします。サブスクリプションのインポート を参照してください。
Ansible 以外の Red Hat サブスクリプションまたは Satellite サブスクリプションをお持ちの場合は、次のいずれかの方法で Automation Controller にアクセスします。
- ライセンスページでユーザー名とパスワードを入力します。
- Red Hat カスタマーポータルの Subscription Allocations ページからサブスクリプションマニフェストを取得します。詳細は、Automation Controller ユーザーガイド の サブスクリプションマニフェストの取得 を参照してください。
- Red Hat Ansible Automation Platform のサブスクリプションをお持ちでない場合は、Try Red Hat Ansible Automation Platform に移動し、試用版サブスクリプションをリクエストしてください。
関連情報
サブスクリプションでサポートされる内容を確認するには、Automation Controller のライセンス、更新、およびサポート を参照してください。* サブスクリプションに問題がある場合は、セールスアカウントマネージャーまたは Red Hat カスタマーサービス (https://access.redhat.com/support/contact/customerService/) にお問い合わせください。
2.2. サブスクリプションのインポート リンクのコピーリンクがクリップボードにコピーされました!
正式な Ansible Automation Platform サブスクリプションを取得したら、Automation Controller を使用する前に、サブスクリプションを Automation Controller システムにインポートする必要があります。前提条件
初めてログインしたときに、Automation Analytics はデフォルトでオプトインされます。これは、Red Hat がユーザーエクスペリエンスを大きく改善し、製品を改良する上で役立ちます。以下を実行してオプトアウトできます。
- ナビゲーションパネルから を選択し、Miscellaneous System settings オプションを選択します。
- をクリックします。
- Automation Analytics の収集データを オフの位置に切り替えます。
- をクリックします。
Automation Analytics のオプトインを有効にするには、Automation Controller のインスタンスが Red Hat Enterprise Linux 上で実行されている必要があります。
詳細は、Automation Analytics セクションを参照してください。
前提条件
- サブスクリプションマニフェストを取得している。詳細は、サブスクリプションマニフェストの取得 を参照してください。
手順
Automation Controller を初回起動します。Subscription Management 画面が表示されます。
次のいずれかの手順を実行して、サブスクリプションを取得してインポートします。
サブスクリプションマニフェストを取得した場合は、ファイルが保存されている場所に移動してアップロードします。アップロードするサブスクリプションマニフェストは、その一部だけでなく、
.zipファイル全体です。注記Subscription manifest オプションの Browse オプションが無効になっている場合は、username フィールドと password フィールドをクリアして有効にしてください。
次に、サブスクリプションメタデータが RHSM/Satellite API または指定したマニフェストから取得されます。1 つのインストールに多数のサブスクリプション数が適用された場合、Automation Controller はその数を結合しますが、最も早い有効期限日を有効期限 (サブスクリプションの更新が必要となる日) として使用します。
Red Hat の顧客認証情報を使用している場合は、ライセンスページでユーザー名とパスワードを入力します。Automation Controller クラスターノードがサブスクリプションマネージャーを通じて Satellite に登録されている場合は、Satellite のユーザー名またはパスワードを使用します。認証情報を入力したら、 をクリックします。
Automation Controller は、ユーザーが設定したサブスクリプションサービスを取得します。続いて、実行するサブスクリプションを選択するためのプロンプトをユーザーに表示し、そのメタデータを Automation Controller に適用します。ユーザーは長期間にわたってログインし、サブスクリプションを更新した場合は、新しいサブスクリプションを取得できます。
- をクリックします。
使用許諾契約書を確認し、I agree to the End User License Agreement チェックボックスを選択して、 をクリックします。
サブスクリプションが承認されると、Automation Controller にサブスクリプションの詳細が表示され、ダッシュボードが開きます。ダッシュボードからサブスクリプション設定画面に戻るには、ナビゲーションパネルの オプションから → を選択します。
オプション: ダッシュボードからサブスクリプション設定画面に戻るには、ナビゲーションパネルで → オプションを選択します。
サブスクリプションのトラブルシューティング
サブスクリプションの有効期限が切れたら (サブスクリプション設定ウィンドウのサブスクリプションの詳細で確認できます)、Automation Controller で更新する必要があります。これは、新しいサブスクリプションをインポートするか、新しいサブスクリプションを設定することで実行できます。
"Error fetching licenses" というメッセージが表示された場合は、Satellite ユーザーに必要な適切なアクセス権があることを確認してください。サブスクリプションを適用するには、Automation Controller 管理者にこのアクセス権が必要です。
Satellite のユーザー名とパスワードは、既存のサブスクリプションについて Satellite API をクエリーするために使用されます。Automation Controller は、Satellite API からそれらのサブスクリプションに関するメタデータを受信し、フィルタリングして、適用できる有効なサブスクリプションを検出します。このサブスクリプションは、有効なサブスクリプションオプションとして UI に表示されます。
以下の Satellite ロールが、適切なアクセス権を付与します。
-
view_subscriptionsおよびview_organizationsフィルターを使用したカスタムロール - Viewer
- 管理者
- Organization Administrator
- Manager
Automation Controller との統合には、最も制限が厳しい Custom ロールを使用します。詳細は、ユーザーとロールの管理に関する Satellite ドキュメント を参照してください。
System Administrator ロールは Administrator user チェックボックスと同等ではないため、サブスクリプション API ページにアクセスするのに十分なパーミッションがありません。
2.3. トラブルシューティング: サブスクリプションのコンプライアンスの維持 リンクのコピーリンクがクリップボードにコピーされました!
サブスクリプションには、次の 2 つのステータスがあります。
- Compliant: サブスクリプションが、サブスクリプション数以内の自動化したホストの数に対して適切であることを示します。
- Out of compliance: サブスクリプション内のホスト数を超えていることを示します。
詳細は、Automation Controller ユーザーガイド の トラブルシューティング: サブスクリプションのコンプライアンスの維持 を参照してください。
2.4. ホストメトリクスユーティリティー リンクのコピーリンクがクリップボードにコピーされました!
Automation Controller は、コマンドラインインターフェイス (CLI) を通じて、ホストメトリクスデータとホストメトリクス概要の CSV 出力を生成する方法を提供します。API を介してホストを一括して論理削除することもできます。
詳細は、Automation Controller ユーザーガイド の ホストメトリクスユーティリティー セクションを参照してください。
第3章 Automation Controller ダッシュボードを使用した IT オーケストレーション リンクのコピーリンクがクリップボードにコピーされました!
ダッシュボードは、IT オーケストレーションのニーズに対応するグラフィカルなフレームワークを備えています。ナビゲーションメニューを使用して、次のタスクを実行します。
- さまざまなビューを表示する
- リソースに移動する
- ユーザーにアクセス権を付与する
- UI で Automation Controller の機能を管理する
3.1. ダッシュボードの表示 リンクのコピーリンクがクリップボードにコピーされました!
手順
Menu アイコンをクリックして、ナビゲーションパネルを表示または非表示にします。
- メインダッシュボードには概要が表示され、現在の Job status がリストされます。
- ジョブのステータスは、期間またはジョブの種類でフィルタリングできます。
- Recent Jobs と Recent Templates の概要を、それぞれのタブで表示できます。
ナビゲーションパネルの最後の項目は です。ここから Automation Controller の設定にアクセスできます。
Settings ページでは、管理者は次の設定を設定できます。
- Authentication
- ジョブ
- システムレベルの属性
- UI および製品ライセンス情報のカスタマイズ
詳細は、Automation Controller 管理ガイド の Automation Controller 設定 を参照してください。
単純な Playbook を起動するには、いくつかの設定オプションを設定する必要があります。初期設定作業を完了すると、Automation Controller が適切に設定され、後でより複雑な Playbook を簡単に実行できるようになります。
第4章 Automation Controller での組織の管理 リンクのコピーリンクがクリップボードにコピーされました!
組織は、ユーザー、チーム、プロジェクト、およびインベントリーを論理的にまとめたものです。これは、コントローラーオブジェクト階層の最上位のオブジェクトです。組織を作成すると、Automation Controller に組織の詳細が表示されます。これにより、組織のアクセス環境と実行環境を管理できるようになります。
4.1. 組織の確認 リンクのコピーリンクがクリップボードにコピーされました!
Organizations ページには、インストールの既存の組織が表示されます。
手順
ナビゲーションパネルから、 → を選択します。
注記Automation Controller はデフォルトの組織を自動的に作成します。Self-Support レベルのライセンスをお使いの場合は、デフォルトの組織しか使用できないため、デフォルトの組織を削除しないでください。
デフォルトの組織は初期設定のまま使用できます。後で編集することもできます。
注記新しい組織を追加できるのは、Enterprise または Premium ライセンスのみです。
Enterprise または Premium ライセンスをご利用で、新しい組織を追加するには、Automation Controller ユーザーガイド の 組織 のセクションを参照してください。
4.2. 組織の編集 リンクのコピーリンクがクリップボードにコピーされました!
初期設定時にデフォルトの組織をそのままにしておくことができますが、後で編集することもできます。
手順
次のいずれかの方法を使用して組織を編集します。
- 組織の Details ページで、変更する組織の横にある をクリックします。
- ナビゲーションパネルから、 → を選択します。変更する組織を選択し、適切な詳細を編集します。
- 変更を保存します。
第5章 Automation Controller のユーザーロール リンクのコピーリンクがクリップボードにコピーされました!
組織に関連付けられているユーザーは、組織の Access タブに表示されます。
System Administrator ロールを持つデフォルトの管理者ユーザーが自動的に作成されます。このユーザーは、Automation Controller のすべてのユーザーが使用できます。そのまま使用することも、後で編集することもできます。Normal User、System Auditor、System Administrator など、その他のユーザーを組織に追加することもできますが、先にそれらのユーザーを作成する必要があります。
詳細は、「Automation Controller User Guide」の Users セクションを参照してください。
このスタートガイドでは、デフォルトのユーザーをそのままにしておきます。
第6章 インベントリー リンクのコピーリンクがクリップボードにコピーされました!
インベントリーは、Automation Controller によって管理されるホストのコレクションです。組織はインベントリーに割り当てられます。一方、インベントリーに対して Playbook を起動する権限は、ユーザーまたはチームレベルで制御されます。
詳細は、以下のドキュメントを参照してください。
6.1. 新しいインベントリーの作成 リンクのコピーリンクがクリップボードにコピーされました!
Inventories ウィンドウには、現在使用可能なインベントリーのリストが表示されます。インベントリーのリストは、名前、検索タイプ、組織、説明、インベントリーの所有者と変更者、または追加の基準で並べ替えることができます。
手順
既存のインベントリーを表示するには、ナビゲーションパネルから → を選択します。
- Automation Controller には、コントローラーの仕組みを理解するのに役立つデモ用インベントリーがあります。そのまま使用することも、後で編集することもできます。必要に応じて、別のインベントリーを作成できます。
- 別のインベントリーを追加する方法の詳細は、Automation Controller ユーザーガイド の 新規インベントリーの追加 を参照してください。
- をクリックして、その詳細を表示します。
組織と同様に、インベントリーにもユーザーとチームが関連付けられています。これらは Access タブで確認できます。詳細は、Automation Controller ユーザーガイド の インベントリー を参照してください。
このインベントリーには、System Administrator ロールを持つユーザーが自動的に設定されています。
6.2. グループとホストの管理 リンクのコピーリンクがクリップボードにコピーされました!
インベントリーはグループとホストに分かれています。グループは、特定の環境 (「データセンター 1」や「ステージテスト」など)、サーバータイプ (「アプリケーションサーバー」や「DB サーバー」など)、またはその他の環境を表すことができます。デモ用インベントリーに属するグループとホストは、Groups タブと Hosts タブに表示されます。
6.2.1. 新しいグループとホストの追加 リンクのコピーリンクがクリップボードにコピーされました!
グループは標準インベントリーにのみ適用できます。スマートインベントリーを使用して直接設定することはできません。標準インベントリーで使用されるホストを介して既存のグループを関連付けることができます。詳細は、Automation Controller ユーザーガイド の インベントリーへのグループの追加 を参照してください。
手順
- ナビゲーションパネルから、 → を選択します。
- 新しいグループを追加するには、Groups タブを選択し、 をクリックします。
- グループに新しいホストを追加するには、Hosts タブを選択し、 をクリックします。
初期設定の一環として、また Automation Controller が適切にセットアップされていることをテストするために、使用できるローカルホストを追加します。
例
作成した組織に、特定のアプリケーションをサポートする Web サーバーホストのグループがある場合は、次の手順を実行します。
- グループを作成し、Web サーバーホストを追加して、これらのホストをインベントリーに追加します。
- をクリックするか (変更がない場合)、Automation Controller ブラウザーの上部にあるパンくずリストのナビゲーションリンクを使用して、Inventories リストビューに戻ります。 をクリックしても Details ダイアログは終了しません。
第7章 認証情報の管理 リンクのコピーリンクがクリップボードにコピーされました!
認証情報は、Ansible Playbook を起動するコントローラーユーザーを認証するものです。パスワードと SSH キーは、インベントリーのホストに対する認証に使用します。Automation Controller の認証情報機能を使用すると、Playbook の起動時に Automation Controller ユーザーにパスワードまたはキーフレーズの入力を要求できます。
7.1. 新しい認証情報の作成 リンクのコピーリンクがクリップボードにコピーされました!
初期設定の一環として、デモ用の認証情報と Galaxy 認証情報が作成されます。Galaxy 認証情報をテンプレートとして使用します。この情報は、コピーはできますが、編集はできません。必要に応じて認証情報をさらに追加できます。
手順
- ナビゲーションパネルから → を選択します。
新しい認証情報を追加するには、Automation Controller ユーザーガイド の 認証情報の作成 を参照してください。
注記追加の認証情報を設定する場合、割り当てるユーザーが root アクセス権を持っているか、SSH を使用してホストマシンに接続できる必要があります。
- をクリックして詳細を表示します。
7.2. 認証情報の編集 リンクのコピーリンクがクリップボードにコピーされました!
初期設定時には、デフォルトの Demo Credential をそのままにしておくことができます。後で編集することもできます。
手順
以下のいずれかの方法を使用して、認証情報を編集します。
- 認証情報の Details ページに移動し、 をクリックします。
- ナビゲーションパネルから → を選択します。認証情報名の横にある をクリックし、適切な詳細を編集します。
- 変更を保存します。
第8章 プロジェクトの管理 リンクのコピーリンクがクリップボードにコピーされました!
プロジェクトとは、Automation Controller にある Ansible Playbook の論理的コレクションのことです。Playbook と Playbook ディレクトリーはさまざまな方法で管理できます。
- Automation Controller サーバー上にあるプロジェクトのベースパスの下にこれらを手動で配置します。
- Playbook を Automation Controller でサポートされているソースコード管理 (SCM) システムに配置します。Git、Subversion、Mercurial などの SCM を使用できます。
このスタートガイドでは、簡単に実行できるように軽量のサンプルを使用しています。ただし、実稼働環境では、ソースコントロールを使用して Playbook を管理する必要があります。DevOps の理念に従い、インフラストラクチャーをコードとして扱うことが推奨されます。
8.1. プロジェクトの設定 リンクのコピーリンクがクリップボードにコピーされました!
Automation Controller には、スタートプロセスを簡素化するために、Demo Project が最初の作業用に用意されています。
手順
- 既存のプロジェクトを確認するには、ナビゲーションパネルから → を選択します。
- をクリックして、その詳細を表示します。
8.2. プロジェクトの編集 リンクのコピーリンクがクリップボードにコピーされました!
初期設定時には、デフォルトの Demo Project をそのままにしておくことができます。後で編集することもできます。
手順
次のいずれかの方法を使用して、プロジェクトを開いて編集します。
- プロジェクトの Details ページに移動し、 をクリックします。
- ナビゲーションパネルから、 → を選択します。プロジェクト名の横にある をクリックし、適切な詳細を編集します。
- 変更を保存します。
8.3. プロジェクトの同期 リンクのコピーリンクがクリップボードにコピーされました!
プロジェクトの最新の変更を取得する場合は、そのプロジェクトの SCM 同期を手動で開始します。
手順
次のいずれかの方法を使用して、プロジェクトを開いて SCM ベースのデモ用プロジェクトを更新します。
- プロジェクトの Details ページに移動し、 をクリックします。
- ナビゲーションパネルから、 → を選択し、 をクリックします。
ソースコントロールを使用するように設定されたプロジェクトを追加すると、「同期」が開始します。これにより、設定されたソースコントロールからプロジェクトの詳細が取得されます。
第9章 ジョブテンプレートの使用 リンクのコピーリンクがクリップボードにコピーされました!
ジョブテンプレートは、プロジェクトの Ansible Playbook と、それを起動するために必要な設定を組み合わせたものです。ジョブテンプレートは、同じジョブを何度も実行する場合に役立ちます。また、ジョブテンプレートは、Ansible Playbook コンテンツの再利用とチーム間のコラボレーションを促進します。詳細は、Automation Controller ユーザーガイド の ジョブテンプレート を参照してください。
9.1. ジョブテンプレートの使い始める リンクのコピーリンクがクリップボードにコピーされました!
初期設定の一環として、Demo Job Template が作成されます。
手順
- 既存のテンプレートを確認するには、ナビゲーションパネルから → を選択します。
- をクリックして、その詳細を表示します。
9.2. ジョブテンプレートの編集 リンクのコピーリンクがクリップボードにコピーされました!
初期設定時には、デフォルトの Demo Job Template をそのままにしておくことができます。後で編集することもできます。
手順
次のいずれかの方法を使用して、テンプレートを開いて編集します。
- ジョブテンプレートの Details ページで をクリックします。
- ナビゲーションパネルから、 → を選択します。テンプレート名の横にある をクリックし、適切な詳細を編集します。
変更を保存します。
- 保存後に終了して Templates リストビューに戻るには、パンくずリストのナビゲーションリンクを使用するか、 をクリックします。 をクリックしても Details ダイアログは終了しません。
9.3. ジョブテンプレートの実行 リンクのコピーリンクがクリップボードにコピーされました!
Automation Controller の利点は、ボタンを押すだけで Ansible Playbook をデプロイできることです。コマンドラインで常に Ansible Playbook に渡すすべてのパラメーターを保存するようにテンプレートを設定できます。テンプレートは、Playbook に加えて、インベントリー、認証情報、追加の変数、およびコマンドラインで指定できるすべてのオプションと設定を渡します。
手順
- ナビゲーションパネルから → を選択し、ジョブテンプレートの横にある をクリックします。
初めてジョブを起動すると、ステータスページが生成されます。このページは、ジョブが完了するまで、Automation Controller のライブイベント機能によって自動的に更新されます。
ジョブ結果の詳細は、Automation Controller ユーザーガイド の Automation Controller のジョブ を参照してください。
関連情報
前述の Automation Controller 機能の詳細や、管理タスクとコントローラー API の詳細は、以下のドキュメントを参照してください。