23. ワークフロージョブテンプレート¶
workflow job template (ワークフロージョブテンプレート) は、一連の各種ジョブテンプレートをリンクして、リリースプロセスに含まれていたジョブ全体を追跡するタスクを 1 つのユニットとして実行します。このようなリソースには以下が含まれます。
ジョブテンプレート
ワークフローテンプレート
プロジェクト同期
インベントリーソース同期
The Templates menu opens a list of the workflow and job templates that are currently available. The default view is collapsed (Compact), showing the template name, template type, and the statuses of the jobs that ran using that template, but you can click Expanded to view more information. This list is sorted alphabetically by name, but you can sort by other criteria, or search by various fields and attributes of a template. From this screen, you can launch (
), edit (
), and copy (
) a workflow job template.
ワークフローテンプレートにのみ、ワークフローエディターにアクセスするためのショートカットとしてワークフロービジュアライザーアイコン (
) があります。
注釈
ワークフローテンプレートは、ワークフローテンプレートのビルディングブロックとして使用できます。ワークフローテンプレートに含まれるパラメーターの多くで、Prompt on Launch (起動プロンプト) を有効にして、ワークフロージョブテンプレートレベルで変更でき、個別のワークフローテンプレートレベルで割り当てられた値に影響を与えることはありません。詳しくは、「ワークフロービジュアライザー」のセクションを参照してください。
23.1. ワークフローテンプレートの作成¶
新規ワークフロージョブテンプレートを作成するには、以下を実行します。
ボタンをクリックしてから、メニュー一覧より ワークフロージョブテンプレート を選択します。
以下のフィールドに該当する詳細を入力します。
注釈
If a field has the Prompt on launch checkbox selected, launching the workflow template, or when the workflow template is used within another workflow template, it will prompt for the value for that field upon launch. Most prompted values will override any values set in the workflow job template; exceptions are noted below.
Field |
Options |
Prompt on Launch |
|---|---|---|
Name |
Enter a name for the job. |
N/A |
Description |
Enter an arbitrary description as appropriate (optional). |
N/A |
Organization |
Choose the organization to be used with this template from the organizations available to the currently logged in user. |
N/A |
Inventory |
Optionally choose the inventory to be used with this template from the inventories available to the currently logged in user. |
Yes |
Limit |
A host pattern to further constrain the list of hosts managed or affected by the playbook. Multiple patterns can be separated by colons ( |
Yes |
Source control branch |
Select a branch for the workflow. This branch is applied to all workflow job template nodes that prompt for a branch. |
Yes |
Labels |
|
|
Variables |
|
|
Job Tags |
Begin typing and selecting the Create x drop-down to specify which parts of the playbook should be executed. For more information and examples refer to Tags in the Ansible documentation. |
Yes |
Skip Tags |
Begin typing and selecting the Create x drop-down to specify certain tasks or parts of the playbook to skip. For more information and examples refer to Tags in the Ansible documentation. |
Yes |
) beside a label to remove it. When a label is removed, it is no longer associated with that particular workflow template, but it will remain associated with any other jobs or job templates that reference it.
) only removes the newly added labels, not existing default labels.Options: Specify options for launching this workflow job template, if necessary.
Check Enable Webhooks to turn on the ability to interface with a predefined SCM system web service that is used to launch a workflow job template. Currently supported SCM systems are GitHub and GitLab.
Webhook を有効にすると、他のフィールドが表示され、以下の追加情報の入力を求められます。
Webhook サービス: Webhook からリッスンするサービスを選択します
Webhook の認証情報: オプションで、ステータス更新を Webhook サービスに送り返すために使用する認証情報として GitHub または GitLab のパーソナルアクセストークン (PAT) を指定します。選択するには認証情報が存在する必要があります。作成するには、「認証情報タイプ」を参照してください。
保存 したら、追加のフィールドにデータが投入され、ワークフロービジュアライザーが自動的に表示されます。
Webhook URL: POST 要求を送信する Webhook サービスの URL が自動的に入力されます。
Webhook Key: automation controller に送信されたペイロードへの署名に Webhook サービスが使用するために生成された共有シークレット。automation controller がこのサービスから Webhook を受け入れるには、Webhook サービスでこの設定が行われている必要があります。
Webhook の設定に関する追加情報は、Webhook の使用 を参照してください。
同時実行ジョブの有効化 にチェックを入れて、このワークフローの同時実行を許可します。追加情報は、「automation controller の容量判断およびジョブの影響」を参照してください。
ワークフローテンプレートの設定が完了したら、保存 をクリックします。
Saving the template exits the workflow template page and the Workflow Visualizer opens to allow you to build a workflow. See the ワークフロービジュアライザー section for further instructions. Otherwise, you may close the Workflow Visualizer to return to the Details tab of the newly saved template in order to review, edit, add permissions, notifications, schedules, and surveys, or view completed jobs and build a workflow template at a later time. Alternatively, you can click Launch to launch the workflow, but you must first save the template prior to launching, otherwise, the Launch button remains grayed-out. Also, note the Notifications tab is present only after the template has been saved.
23.2. パーミッションの使用¶
アクセス をクリックすると、ユーザーおよびチームメンバーに関連付けられたパーミッションの確認、付与、編集、および削除を実行できます。
追加 ボタンをクリックすると、このワークフローテンプレート用の新しい権限が作成され、画面の指示に従って割り当てられます。
23.3. 通知の使用¶
通知 をクリックすると、設定した全通知の統合を確認できます。テンプレートを保存してはじめて、通知 タブが表示されます。
トグルを使用して、特定のテンプレートで使用する通知を有効または無効にします。詳細については、通知の有効化と無効化 を参照してください。
通知が設定されていない場合は、詳細について 通知テンプレートの作成 を参照してください。
さまざまな通知タイプの設定に関する追加の情報は、通知タイプ を参照してください。
23.4. 完了したジョブの表示¶
完了したジョブ タブでは、実行したワークフローテンプレートの一覧が表示されます。展開 をクリックして、各ジョブのさまざまな情報を表示します。
このビューから、ジョブ ID、ワークフロージョブの名前をクリックすると、その内容が図で表示されます。以下の例では、ワークフロージョブのジョブ詳細が表示されます。
ノードには、一目で識別できるラベルが付いています。詳細については、ワークフロービジュアライザー セクションの legend_を参照してください。
23.5. スケジュールの使用¶
スケジュール をクリックすると、このテンプレートに設定されているスケジュールを確認できます。
23.5.1. ワークフローテンプレートのスケジュール¶
To schedule a wokflow job template run, click the Schedules tab.
スケジュールがすでに設定されている場合には、スケジュールの設定をレビュー、編集、または有効化/無効化します。
スケジュールが設定されていない場合には、詳細情報を「スケジュール」で参照してください。
ネスとかされたワークフローで使用するワークフローテンプレートに、インベントリーオプションとして survey や、Prompt on Launch が選択されている場合には、PROMPT ボタンが、スケジュールフォームの SAVE および CANCEL ボタンの横に表示されます。PROMPT ボタンをクリックすると、オプションで INVENTORY のステップが表示され、インベントリーを指定または削除するか、変更せずにこのステップをスキップすることができます。
23.6. Survey¶
「実行」または「チェック」のジョブタイプを含むワークフローにより、ワークフローテンプレートの作成または編集画面で Survey 設定できます。Survey は、「Prompt for Extra Variables (追加変数のプロンプト)」の場合と同様に Playbook の追加変数を設定しますが、ユーザーにとって使いやすい質問と回答を使って実行します。また Survey はユーザー入力の確認を可能にします。Survey ボタンをクリックして Survey を作成します。
Survey のユースケースは多岐に及びます。一例として、開発者に「push to stage」ボタンを付与する操作が必要な場合、これは Ansible の高度な知識がなくても実行できます。起動時に、このタスクは「What tag should we release?」などといった質問への回答を求めるプロンプトを出す可能性があります。
多項選択式の質問など、多種の質問を尋ねることができます。
23.6.1. Survey の作成¶
Survey を作成するには、以下を実行します。
Survey ボタンをクリックして、Survey の追加 ウィンドウを起動します。
画面上部にある ON/OFF の切り替えボタンを使用すると、この survey プロンプトをすぐに有効化または無効化できます。
Survey には複数の質問を含めることができます。それぞれの質問について、以下の情報を入力します。
名前: ユーザーに尋ねる質問
説明: (オプション) ユーザーに尋ねられる内容の説明。
Answer Variable Name (回答の変数名): ユーザーの応答の保存に使用する Ansible 変数名。これは Playbook で使用される変数です。変数名にはスペースを含めることができません。
回答タイプ: 以下の質問のタイプから選択します。
テキスト: 単一行のテキスト。この回答の最小および最大の長さ (文字数) を設定できます。
Textarea (テキスト領域): 複数行のテキストフィールド。この回答の最小および最大の長さ (文字数) を設定できます。
パスワード: 応答は、実際のパスワードが処理される場合と同様に機密情報として処理されます。この回答の最小および最大の長さ (文字数) を設定できます。
Multiple Choice (single select) (複数の選択 (単一選択)): 1 度に 1 つのみを選択できるオプションの一覧。複数の選択オプション ボックスに 1 行に 1 つのオプションを入力します。
Multiple Choice (multiple select)(複数の選択 (複数選択)): 1 度に任意の数のオプションを選択できるオプションの一覧。複数の選択オプション ボックスに 1 行に 1 つのオプションを入力します。
Integer (整数): 整数。この回答の最小および最大の長さ (文字数) を設定できます。
Float (浮動): 10 進数。この回答の最小および最大の長さ (文字数) を設定できます。
Default Answer (デフォルトの回答): 選択したタイプにより、質問に対するデフォルトの回答を指定できます。この値はインターフェースに事前投入されており、ユーザーにより回答が指定されない場合に使用します。
必須: この質問に対する回答がユーザーから求められているかどうかを示します。
質問の情報を入力したら、追加 ボタンをクリックして質問を追加します。
定型化されたバージョンの Survey が「プレビュー」ペインに表示されます。いずれの質問についても、編集 ボタンをクリックして質問を編集できます。削除 ボタンをクリックすると質問を削除でき、グリッドアイコンをクリックおよびドラッグして質問の順序を変更できます。
左ペインに戻り、質問を追加します。
完了したら、保存 をクリックして Survey を保存します。
23.6.2. オプションの Survey の質問¶
Survey の質問に対する 必須 の設定は、対話するユーザーにとって回答がオプションかどうかを決定します。
背後では、オプションの Survey 変数が入力されていない場合でも extra_vars の Playbook に渡すことができます。
テキスト以外の変数 (入力タイプ) がオプションとマークされ、入力されていない場合には、Survey の
extra_varは Playbook に渡されません。テキスト入力またはテキスト領域の入力がオプションとしてマークされていて、この内容が入力されておらず、最小の
length > 0が設定されている場合に、Survey のextra_varは Playbook に渡されません。テキスト入力またはテキスト領域の入力がオプションとしてマークされていて、この内容が入力されておらず、最小の
length === 0が設定されている場合に、Survey のextra_varは、値が空のストリング ( “” ) に設定された状態で Playbook に渡されます。
23.7. ワークフロービジュアライザー¶
ワークフロービジュアライザーが導入され、グラフィカルな形式で、ジョブテンプレート、ワークフローテンプレート、プロジェクト同期、インベントリー同期を統合し、ワークフローテンプレートをビルドできるようになります。ワークフローテンプレートをビルドする前に、親、子、兄弟のノードに関するさまざまなシナリオでの留意事項について「ワークフロー」のセクションを確認してください。
23.7.1. ワークフローの構築¶
テンプレート (ジョブテンプレートまたはワークフロージョブテンプレート)、プロジェクトの同期、インベントリーの同期、または承認のうち、複数のノードタイプの組み合わせを設定して、ワークフローを構築できます。各ノードは長方形で表され、リレーションシップと関連するエッジタイプはノード間を接続する線 (リンク) で表されます。
ワークフローテンプレートの詳細/編集ビューで ビジュアライザー タブをクリックするか、テンプレートリストビューから (
) アイコンをクリックして、ワークフロービジュアライザーを起動します。
ボタンをクリックし、ワークフローに追加するノードの一覧を表示します。
右側のペインで、ドロップダウンメニューから追加するノードのタイプを選択します。
承認 ノードを選択する場合は、承認ノード を参照してください。
ノードを選択すると、そのノードに関連する有効なオプションが表示されます。
注釈
ワークフローのグラフへの入力時にデフォルトのインベントリーがないジョブテンプレートを選択すると、親ワークフローのインベントリーが使用されます。ジョブテンプレートには認証情報は必要ありませんが、パスワードを必要とする認証情報がある場合には、この認証情報がプロンプトを使用する認証情報に置き換えられない限り、使用中のワークフローに対してジョブテンプレートを選択することはできません。
ノードを選択すると、ワークフローはビルドを開始するので、選択したノードで行うアクションタイプを指定する必要があります。このアクションは、エッジタイプ とも呼ばれます。
ノードが root ノードの場合には、エッジタイプはデフォルトで Always になり、編集できません。
後続のノードでは、次のシナリオ (エッジタイプ) のいずれかを選択して、それぞれに適用できます。
Always (常時): 成功または失敗にかかわらず、実行を継続します。
On Success (成功時): 正常に完了すると、次のテンプレートを実行します。
On Failure (失敗時): 失敗時に、別のテンプレートを実行します。
Convergence (収束) フィールドから、ノードが収束ノードである場合のノードの動作を選択します。
Any はデフォルトの動作で、次の収束するノードをトリガーする前に、指定されたとおりに「すべて」のノードを完了できます。 1 つの親のステータスがこれらの実行条件の 1 つを満たしている限り、任意の子ノードが実行されます。つまり、ANY ノードは **すべて**の ノードを完了する必要がありますが、1つ のノードのみが期待される結果で完了する必要があります。
次のノードを収束およびトリガーする前に、すべての*ノードが指定どおりに完了することを確認する場合は **All* を選択します。ALL ノードの目的は、子ノードを実行するために、すべての親がその期待される結果を満たしていることを確認することです。ワークフローは、子ノードを実行するために、すべての親が期待どおりに動作したことを確認します。それ以外の場合、子ノードは実行されません。
これが選択されていると、グラフィカルビューによりノードに ALL というラベルが付けられます。
注釈
ノードがルートノードであるか、またはノードが収束していないノードである場合、Convergence ルールの設定は適用されません。その動作は、それをトリガーするアクションによって決定されるためです。
ワークフローで使用するジョブテンプレートのパラメーターに Prompt on Launch (起動プロンプト) が選択されている場合には、Prompt ボタンが表示され、ノードレベルでこれらの値を変更できるようになります。ウィザードを使用して、各タブ値を変更し、プレビュータブで 確定 をクリックします。
同様に、ワークフローで使用するワークフローテンプレートで、インベントリーオプションとして Prompt on Launch (起動プロンプト) が選択されている場合には、ウィザードを使用して、プロンプト時にインベントリーを指定します。親のワークフローに独自のインベントリーがある場合には、ここで指定するインベントリーは上書きされます。
注釈
For workflow job templates with promptable fields that are required, but do not have a default, you must provide those values when creating a node before the Select button becomes enabled. The two cases that disable the Select button until a value is provided via the Prompt button: 1) when you select the Prompt on Launch checkbox in a workflow job template, but do not provide a default, or 2) when you create a survey question that is required but do not provide a default answer. However, this is NOT the case with credentials. Credentials that require a password on launch are not permitted when creating a workflow node, since everything needed to launch the node must be provided when the node is created. So, if a workflow job template prompts for credentials, automation controller prevents you from being able to select a credential that requires a password.
また、対象のノードで変更を適用するには、プロンプトのウィザードの終了時に、選択 をクリックする必要があります。選択しないと、変更内容が、実際にジョブテンプレートで設定した値に戻ってしまいます。
ノードが作成されると、ノードにはそのジョブタイプのラベルが付けられます。各ワークフローノードに関連付けられるテンプレートは、プロセスの進行時に選択した実行シナリオに基づいて実行されます。コンパス (
) アイコンをクリックして、各実行シナリオとそのジョブタイプの凡例を表示します。
ノードの上にカーソルを合わせると、別のノードの追加
、ノードの情報 
の表示、ノードの詳細の編集 、既存のリンクの編集 
、または選択したノードの削除 
が可能になります。
ノードの追加/編集が完了したら、選択 をクリックしてすべての変更を保存し、グラフィカルビューにレンダリングします。ワークフローの構築に利用できる方法については、ノードの構築シナリオ を参照してください。
When done with building your workflow template, click Save to save your entire workflow template and return to the new workflow template details page.
重要
このペインで 閉じる をクリックしても、作業は保存されません。代わりにワークフロービジュアライザー全体を閉じて最初からやり直す必要があります。
23.7.1.1. 承認ノード¶
承認 ノードを選択するには、ワークフローを次に進めるためにユーザーの介入が必要です。この機能は、Playbook 間のワークフローを一時停止する手段として使用し、ユーザーはワークフローで次の Playbok に進むことを承認できるため、ユーザーが仲介するのに十分な時間を指定することも、他のトリガーを待たずにできるだけ早く次に進めることもできます。
タイムアウトのデフォルトは「なし」ですが、リクエストの有効期限が切れて自動的に拒否されるまでの時間を指定できます。承認ノードの情報を選択して指定すると、グラフィカルビューで、承認ノードの横に一時停止 (
) アイコンが表示されます。
承認者は、承認ノードを含むワークフロージョブテンプレートを実行できる任意のユーザーで、組織管理者以上の権限 (そのワークフロージョブテンプレートに関連付けられた組織のもの)、またはその特定のワークフロージョブテンプレート内で明示的に割り当てられた Approve パーミッションを持つ任意のユーザーです。
保留中の承認ノードが指定された制限時間内に承認されなかった場合 (有効期限が割り当てられている場合)、または拒否された場合には、承認ノードはそれぞれ「タイムアウト」または「失敗」としてマークされ、次の「失敗したノード」または「常時ノード」に進みます。承認された場合は、「成功時」のパスが使用されます。API で、すでに承認、拒否、またはタイムアウトになったノードに POST を実行しようとすると、このアクションは冗長であり、それ以上の手順は実行されないことを通知するメッセージが表示されます。
以下は、承認ワークフローで許可されるさまざまなレベルの権限を示しています。
23.7.1.2. ノードの構築シナリオ¶
親ノードの をクリックして兄弟ノードを追加できます。
ノード間に別のノードを挿入するには、 が表示されるまで 2 つのノード間をつなぐ線の上にマウスをかざします。 をクリックすると自動的に 2 つのノード間にノードが挿入されます。
root ノードを追加して分割のシナリオを表現するには、 ボタンをもう一度クリックします。
分割シナリオを作成するノード上にマウスをかざし、そこから分割シナリオを開始して、 をクリックします。これで実際に、同じ親ノードから複数のノードが追加されて、兄弟ノードが作成されます。
注釈
新規ノードの追加時には、PROMPT ボタンでワークフローテンプレートも適用します。ワークフローテンプレートにより、インベントリーおよび survey のプロンプトが表示されます。
最後に挿入したノードを取り消すには、右のペーンから何も選択せずに別のノードをクリックするか、右のペーンから キャンセル をクリックします。
以下は、ジョブテンプレートで開始される 3 つのタイプのジョブがすべて含まれるワークフローの例です。これが実行に失敗する場合は、プロジェクト同期ジョブに進み、成否にかかわらず、インベントリーの同期ジョブに進みます。
ウィンドウの先頭にあるキーを参照して、グラフィックな説明と関連付けられる記号および色の意味を特定するのを忘れないでください。
注釈
ワークフローで、兄弟ノードにさまざまなエッジタイプが指定されていて、後続のノードがアタッチされたノードを削除した場合には、アタッチされたノードが自動的に兄弟ノードセットと結合されて、そのエッジタイプを保持します。
以下の方法で、ノードを変更できます。
ノードを編集する必要がある場合に、編集するノードをクリックすると右側のペインには現在の選択内容が表示されます。変更を加えたら 選択 をクリックして変更をグラフィカルビューに適用します。
既存のリンクのエッジタイプを編集するには (success (成功)/failure (失敗)/always (常時))、リンクをクリックします。右側のペインに、現在の選択内容が表示されます。変更を加えたら 保存 をクリックして変更をグラフィカルビューに適用します。
別のノードに新規リンクを追加するには、各ノード上に表示される、リンク
アイコンをクリックします。クリックすると、リンクを追加可能なノードがハイライトされます。実行可能なオプションは、点線で表示されます。無効なオプションは、ボックス (ノード) がグレーアウトされます。このようなボックスを選択できたとしても、無効なリンクが生成されます。以下の例では、矢印で示されているように、e2e-ec20de52-project のリンク先に対する選択可能なオプションとして Demo Project が表示されます。
リンクを削除するには対象のリンクをクリックして、リンク解除 をクリックします。
ターゲットまたは子ノードに複数の親がある場合に、このボタンは、右側のパネルにのみ表示されます。すべてのノードが常に、少なくとも 1 つ以上の他のノードにリンクされている必要があるため、必要のなくなったリンクを削除する前に、新規リンクを作成する必要があります。
設定アイコン (
) をクリックしてビューのズーム、パン、または再配置を行います。または、ワークフローの図をドラッグして画面上で再配置するか、マウスをスクロールしてズームします。
23.8. ワークフローテンプレートの起動¶
以下のいずれかの方法でワークフローテンプレートを起動します。
Access the workflow templates list from the Templates menu on the left navigation bar or while in the workflow template Details view, scroll to the bottom to access the
button from the list of templates.
While in the Workflow Job Template Details view of the job you want to launch, click Launch.
Along with any extra variables set in the workflow job template and survey, automation controller automatically adds the same variables as those added for a workflow job template upon launch. Additionally, automation controller automatically redirects the web browser to the Jobs Details page for this job, displaying the progress and the results.
ワークフローの承認に関連するイベントは、承認リクエストがある場合は、その詳細情報とともにアクティビティーストリーム (
) に表示されます。
23.9. ワークフローテンプレートのコピー¶
automation controller では、ワークフローテンプレートのコピー機能を使用できます。ワークフローテンプレートをコピーすることを選択した場合には、関連付けられたスケジュール、通知、またはパーミッションは コピーされません。スケジュールおよび通知は、ワークフローテンプレートのコピーを作成するユーザーまたは管理者により作成しなおす必要があります。ジョブテンプレートをコピーするユーザーには管理者権限が付与されますが、パーミッションはワークフローテンプレートには割り当てられません (コピーされません)。
左のナビゲーションバーの テンプレート メニューまたはワークフロージョブテンプレートの詳細ビューからコピーするワークフロージョブテンプレートにアクセスし、下方にスクロールしてテンプレートの一覧からこれにアクセスします。
- ボタンをクリックします。
新規テンプレートが、コピーしたテンプレートの名前とタイムスタンプが設定された状態で開きます。
コピーされたテンプレートを選択して 名前 フィールドの内容を新規の名前に置き換え、他のフィールドのエントリーを指定または変更してこのページを完了します。
完了したら 保存 をクリックします。
注釈
プロジェクトが使用する認証情報で現在のユーザーに 読み取り アクセスしか割り当てられていない場合など、リソースに、適切なレベルのパーミッションが割り当てられていない関連リソースが含まれる場合に、このリソースはコピーできません。ただし、ワークフローテンプレートでは、このノードのいずれかで、権限のないジョブテンプレートを使用する場合に、ワークフローテンプレートのコピーは可能ですが、コピーしたワークフローテンプレートでは、ワークフローテンプレートノード内の適切なフィールドがなくなります。
23.10. 追加変数¶
注釈
ジョブ起動 API に渡される extra_vars は、以下のいずれかが該当する場合のみ有効です。
それらは有効な survey の変数に対応する。
ask_variables_on_launchが True に設定されている。
Survey 変数を渡す際に、この変数は追加変数 (extra_vars) として渡されます。これは、(Survey で実行するように) 追加変数をワークフローテンプレートに渡すと、インベントリーおよびプロジェクトから渡される他の変数が上書きされる可能性があるために注意が必要です。
たとえば、インベントリーの定義された変数が debug = true であるとします。この変数 debug = true がワークフローテンプレート Survey で上書きされる可能性はあります。
渡す必要のある変数が上書きされないようにするには、この変数を Survey で再定義して組み込むことができます。追加変数はインベントリー、グループおよびホストのレベルで定義できることに注意してください。
以下の表では、Ansible の変数の順序との比較で、automation controller の変数の順序の動作 (階層) を示しています。
変数の順序の階層 (最後に一覧表示された win)
