https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/function/automation/index.html Recent content in 3.10 自動化 on JP1 Cloud Service 運用統合 利用ガイド Hugo -- gohugo.io ja https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/function/automation/auth_reg/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/function/automation/auth_reg/index.html 自動化で登録した認証情報は、ジョブを実行する対象ホストのシークレット情報を管理します。 ここでは、以下の認証情報の登録方法について説明します。 GitLab、Ops Iのクレデンシャル情報にアクセスするための認証情報 PATを使用した認証情報 （1）GitLab、Ops Iのクレデンシャル情報にアクセスするための認証情報 PlaybookはGitLabに格納されているため、AWXからGitLabにアクセスする必要があります。AWXからGitLab、Ops Iのクレデンシャル情報にアクセスするための認証情報の登録方法について説明します。 GitLabにアクセスするにあたって、事前にGitLabアクセストークンをシークレットに格納する必要があります。また、PlaybookからAPIを実行する場合、AWXからOps Iのクレデンシャル情報にアクセスする必要があります。Ops Iのクレデンシャル情報も同様にシークレットに格納する必要があります。 情報をシークレットに格納した後に、以下のシークレットの情報を取得してください。下表に必要な取得項目と参照先を示します。 （表）認証情報登録のため事前に取得する情報一覧 項目 参照先 secrets Engine名 Secrets Engines作成 シークレットへのパス（「Path for this secret」に入力した任意のパス） キー名（「Secret data」に入力した任意のkey） Secretの作成 AppRoleのロールID AppRoleのシークレットID 自動化からシークレットにアクセスするための認証情報の取得 【シークレットにアクセスするための認証情報の登録手順】 AWSからシークレットに格納したGitLabアクセストークン、Ops Iのクレデンシャル情報を参照するために、まずAWSからシークレットにアクセスするための設定をします。 1. 自動化アプリケーションを選択し、コンテンツエリアに表示されたAWXの画面で「リソース」カテゴリーの「認証情報」を選択します。 2. 認証情報画面が表示されるので追加ボタンをクリックすると、新規認証情報の作成画面が表示されるので必要な情報を入力します。 （図）新規認証情報の作成画面（認証情報タイプ「HashiCorp Vault Secret Lookup」） （表）シークレットにアクセスするための新規認証情報の作成画面入力情報一覧 項目 説明 名前 シークレットにアクセスするための認証情報の名前 「Outpost」は予約語のため使用不可 認証情報タイプ シークレットにアクセスする場合は「HashiCorp Vault Secret Lookup」を選択 サーバーURL http://vault.テナント名-service:8200 テナント名はPlaybookをもっているテナント名に置き換える。 AppRole role_id 事前にシークレットで取得したAppRoleのロールID AppRole secret_id 事前にシークレットで取得したAppRoleのシークレットID 認証へのパス approle（デフォルト） API バージョン v2を選択 3. 保存ボタンをクリックします。 【GitLabへアクセスするための認証情報の登録手順】 GitLabへアクセスするための認証情報は、認証情報タイプ「ソースコントロール」で登録します。「ソースコントロール」の認証情報から、「HashiCorp Vault Secret Lookup」の認証情報を参照することにより、シークレットからキーをとってくることができGitLabへアクセスできるようになります。 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/function/automation/project/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/function/automation/project/index.html プロジェクトは、Playbookを格納するディレクトリです。 プロジェクトでは、作成したプロジェクトを使用する組織や、「Playbookβ.yaml」が登録されているGitLabのリポジトリへアクセスするための認証情報などを設定します。ここで設定された組織に所属するユーザーのみが、このプロジェクトやこのプロジェクトを設定したジョブテンプレートにアクセスできます。 【プロジェクトの設定手順】 1. 自動化アプリケーションを選択し、コンテンツエリアに表示されたAWXの画面で「リソース」カテゴリーの「プロジェクト」を選択します。 2. プロジェクト画面が表示されるので追加ボタンをクリックすると、新規プロジェクトの作成画面が表示されるので必要な情報を入力します。 （図）新規プロジェクトの作成画面 （表）ジョブ作成のためのプロジェクトの作成画面入力情報一覧 項目 説明 名前 プロジェクト名 組織 アイコンをクリックすると、登録されている組織の一覧が表示されるので、任意の組織のラジオボタンをチェックして選択ボタンをクリックする。選択した組織に所属するユーザーがこのプロジェクトを表示や編集、または実行することができる。 ソースコントロールのタイプ GitLabに登録されているPlaybookにアクセスするため「Git」を選択する。 ソースコントロールのURL https://git.テナント名.ops-integration.com/グループ名/プロジェクト名.git 「Playbookβ.yaml」が登録されているGitLabのリポジトリのURL ソースコントロールブランチ/タグ/コミット 「Playbookβ.yaml」が登録されているGitLabのリポジトリのブランチ ソースコントロール認証情報 アイコンをクリックすると、ソースコントロールの認証情報一覧が表示されるので、「認証情報の登録」で作成したソースコントロール認証情報名を選択する。 3. 必要な情報の入力が完了したら保存ボタンをクリックします。詳細画面が表示され、自動的にGitLabへの同期が始まり、最終ジョブステータスが実行中になります。同期が完了したらステータスが成功になります。同期を中断する場合は、同期の取り消しボタンをクリックします。同期の取り消し確認ダイアログが表示されるので、取り消しの確認ボタンをクリックします。詳細画面に戻るので、編集ボタンをクリックして詳細の編集画面で保存ボタンをクリックします。 【設定したプロジェクトの再同期手順】 プロジェクトの設定手順で、ソースコントロールに指定したGitLabにplaybookを追加した場合は、以下の手順で再同期する必要があります。 1. コンテンツエリアの「リソース」カテゴリーの「プロジェクト」を選択します。 2. プロジェクト画面から該当するプロジェクト名をクリックして、詳細画面を開きます。 3. 同期ボタンをクリックします。 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/function/automation/inventory/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/function/automation/inventory/index.html インベントリーはジョブを実行できるホストを管理します。 ここで設定された組織に所属するユーザーのみが、このインベントリーやインベントリーを用いたジョブの実行を行うことができます。 【インベントリーの登録手順】 1. 自動化アプリケーションを選択し、コンテンツエリアに表示されたAWXの画面で「リソース」カテゴリーの「インベントリー」を選択します。 2. インベントリー画面が表示されるので追加ボタンをクリックし、「インベントリーの追加」を選択すると、新規インベントリーの作成画面が表示されるので必要な情報を入力します。 （図）新規インベントリーの作成画面 （表）インベントリーの作成画面入力情報一覧 項目 説明 名前 インベントリー名 組織 アイコンをクリックすると、登録されている組織の一覧が表示されるので、任意の組織のラジオボタンをチェックして選択ボタンをクリックする。選択した組織に所属するユーザーがこのインベントリーを表示、編集、および実行することができる。 3. 必要な情報の入力が完了したら保存ボタンをクリックします。 4. 詳細画面が表示されるので、詳細画面のタブにある「ホスト」を選択し、[追加]ボタンをクリックすると、新規ホストの作成画面が表示されます。任意の情報を入力し、ジョブを実行するホストを登録します。 （図）新規ホストの作成画面 （表）ホストの作成画面入力情報一覧 項目 説明 名前 ホスト名、またはIPアドレスを指定します。 変数 ジョブを実行する際にAWXに渡す変数とその値を指定します。 詳細はAWXのマニュアルを参照してください。AWXのマニュアルおよびバージョン、エディションについては付録 「OSSのバージョンおよびエディション、参照先のマニュアル」を参照してください。 ホストにlocalhostを登録する例※を以下に記載します。 （表）ホストにlocalhostを登録する例 項目 説明 名前 localhost 変数 ansible_connection: local ansible_python_interpreter: '{{ ansible_playbook_python }}' ※ジョブを中継サーバーで実行する場合は中継サーバー、それ以外の場合はOps Iサーバーで実行されます。 5. 必要な情報の入力が完了したら保存ボタンをクリックします。 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/function/automation/job_template/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/function/automation/job_template/index.html ジョブテンプレートはジョブを実行するための認証情報、プロジェクト、インベントリーなどを組み合わせた定義のセットになります。 プロジェクトを通して、プロジェクトに設定されているリポジトリから「Playbookβ.yaml」を指定することによってPlaybookと連携できます。また、WorkflowのYAMLファイルで、Task modelのactionにOps I提供部品の「awx.run_job_template」を定義することによって、ワークフローからジョブテンプレートを自動実行することができます。Ops I提供部品の「awx.run_job_template」については「awx.run_job_template」を参照してください。 【ジョブテンプレートの設定手順】 1. 自動化アプリケーションを選択し、コンテンツエリアに表示されたAWXの画面で「リソース」カテゴリーの「テンプレート」を選択します。 2. テンプレート画面が表示されるので追加ボタンをクリックして新規ジョブテンプレートの追加をクリックすると、新規ジョブテンプレートの作成画面が表示されるので必要な情報を入力します。 （表）「Playbookβ.yaml」を自動実行させるためのプロジェクトの作成画面入力情報一覧 項目 説明 名前 ジョブテンプレートの名前 ジョブタイプ 実行を選択する インベントリー アイコンをクリックすると、インベントリーの一覧が表示されるので、ジョブの実行対象とするインベントリーを指定する。 プロジェクト アイコンをクリックすると、プロジェクトの一覧が表示されるので「プロジェクトの設定」で作成したプロジェクトを選択する。 Playbook 上の「プロジェクト」の項目で選択した、プロジェクトにひもづけられたリポジトリに登録されているYAMLファイルの一覧が表示されるので、「Playbookβ.yaml」を選択する。 認証情報 アイコンをクリックすると、認証情報の一覧が表示されるので、必要に応じて「認証情報の登録」で作成した認証情報を選択する。 中継サーバーを経由してジョブ実行対象のサーバーにジョブを実行させる場合、「中継サーバー使用手順」を参照してください。 カスタムした実行環境を使用する場合、実行環境の指定が必要になります。詳細は「自動化実行環境の拡張」を参照してください。 3. 必要な情報の入力が完了したら保存ボタンをクリックします。 詳細画面が表示されるので起動ボタンをクリックすると、「Playbookβ.yaml」に定義された内容が実行されます。テンプレート画面に作成したジョブテンプレート一覧が表示されるので、実行したジョブテンプレートのロケットアイコンをクリックすることでもジョブを実行することができます。 実行したジョブテンプレートの実行結果については、「ジョブの実行結果の確認」を参照してください。 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/function/automation/job_confirm/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/function/automation/job_confirm/index.html 1. 自動化アプリケーションを選択し、コンテンツエリアに表示されたAWXの画面で「ビュー」カテゴリーの「ジョブ」を選択します。 2. 表示されたジョブの一覧から、結果を確認したいジョブ名を選択します。 3. ジョブの詳細画面が表示されるので、詳細タブや出力タブから実行結果を確認します。 （図）自動化詳細画面