Automation Pipelines を VMware Aria Automation Orchestrator (Orchestrator) と統合すると、Orchestrator ワークフローを実行してその機能を拡張できます。VMware Aria Automation Orchestrator には、サードパーティ製ツールと統合できる事前定義済みのワークフローが多数含まれています。これらのワークフローは、DevOps プロセスの自動化と管理、一括操作の自動化などに役立ちます。
たとえば、パイプラインで Orchestrator タスクのワークフローを使用すると、ユーザーを有効にし、ユーザーを削除し、仮想マシンを移動できます。さらに、テスト フレームワークと統合してパイプラインの実行時にコードをテストするなど、さまざまなことができます。code.vmware.com では、VMware Aria Automation Orchestrator ワークフローのコード例を参照できます。
パイプラインで VMware Aria Automation Orchestrator ワークフローを使用すると、アプリケーションをビルド、テスト、および展開するときにアクションを実行できます。定義済みのワークフローをパイプラインに含めることも、カスタム ワークフローを作成して使用することもできます。ワークフローごとに入力、タスク、出力があります。
パイプラインで Orchestrator ワークフローを実行するには、パイプラインに含めた Orchestrator タスクで使用できるワークフローのリストに、そのワークフローが表示されている必要があります。
そのワークフローがパイプラインの Orchestrator タスクに表示されるようにするには、管理者が VMware Aria Automation Orchestrator で次の手順を実行する必要があります。
- PIPELINES タグを Orchestrator ワークフローに適用します。
- Orchestrator ワークフローをグローバルとしてマークします。
前提条件
- VMware Aria Automation Orchestrator のオンプレミス インスタンスに管理者としてアクセスできることを確認します。詳細については、管理者に問い合わせるか、vRealize Orchestrator ドキュメントを参照してください。
- Automation Pipelines で、プロジェクトのメンバーであることを確認します。メンバーでない場合は、プロジェクトにメンバーとして追加するように Automation Pipelines 管理者に依頼します。Automation Pipelinesでプロジェクトを追加する方法を参照してください。
- Automation Pipelines で、パイプラインを作成し、ステージを追加します。
手順
- 管理者として、パイプラインで実行する VMware Aria Automation Orchestrator ワークフローを準備します。
- VMware Aria Automation Orchestrator で、ユーザーを有効にするためのワークフローなど、パイプラインで使用する必要があるワークフローを検索します。
必要なワークフローがどこにもない場合には作成できます。
- 検索バーに「タグ ワークフロー」と入力し、タグ ワークフロー という名前のワークフローを検索します。
- タグ ワークフロー という名前のカード上で [実行] をクリックすると、設定領域が表示されます。
- タグ付けされたワークフロー テキスト領域で、Automation Pipelines パイプラインで使用するワークフローの名前を入力し、そのワークフローをリストから選択します。
- タグ および 値 のテキスト領域に、PIPELINES と大文字で入力します。
- [グローバル タグ] という名前のチェック ボックスをクリックします。
- [実行] をクリックします。これにより、Automation Pipelines パイプラインで選択する必要があるワークフローに PIPELINES という名前のタグが付けられます。
- ナビゲーション ペインで [ワークフロー] をクリックし、パイプラインで実行されるワークフロー カードに PIPELINES という名前のタグが表示されることを確認します。
Automation Pipelines にログインして、パイプラインに Orchestrator タスクを追加すると、タグ付けされたワークフローがワークフロー リストに表示されます。
- VMware Aria Automation Orchestrator で、ユーザーを有効にするためのワークフローなど、パイプラインで使用する必要があるワークフローを検索します。
- Automation Pipelines で、VMware Aria Automation Orchestrator インスタンスのエンドポイントを作成します。
- の順にクリックします。
- プロジェクトを選択します。
- 適切な名前を入力します。
- VMware Aria Automation Orchestrator エンドポイントの URL を入力します。
次の形式を使用します。 https://orchestrator-appliance.yourdomain.local:8281次の形式は使用しないでください。https://orchestrator-appliance.yourdomain.local:8281/vco/apiVMware Aria Automation アプライアンスに組み込まれている VMware Aria Automation Orchestrator インスタンスの URL は、アプライアンスの FQDN であり、ポートを含みません。例： https://automation-appliance.yourdomain.local/vcoVMware Aria Automation 8.x 以降の外部 VMware Aria Automation Orchestrator アプライアンスの場合、アプライアンスの FQDN は次のとおりです。 https://orchestrator-appliance.yourdomain.localVMware Aria Automation 7.x の外部 VMware Aria Automation Orchestrator アプライアンスの場合、アプライアンスの FQDN は次のとおりです。 https://orchestrator-appliance.yourdomain.local:8281/vcoエンドポイントの追加時に問題が発生した場合は、必要に応じて、SHA-256 証明書フィンガープリントからコロンを削除して YAML 構成をインポートします。たとえば、 B0:01:A2:72... は B001A272... になります。サンプル YAML コードは次のようになります。
``` --- project: Demo kind: ENDPOINT name: external-orchestrator description: '' type: orchestrator properties: url: https://yourVROhost.yourdomain.local username: yourusername password: yourpassword fingerprint: <your_fingerprint> ```
- 入力した URL に証明書が必要な場合は、[証明書を承諾] をクリックします。
- VMware Aria Automation Orchestrator エンドポイントがバージョン 8.0 ～ 8.7 の場合は、認証タイプに [基本認証] または [トークン] を選択できます。VMware Aria Automation Orchestrator エンドポイントのバージョンが 8.8 以降の場合は、認証タイプに [トークン] を選択する必要があります。
注： VMware Aria Automation Orchestrator エンドポイントがバージョン 8.8 以降の場合は、 [基本認証] を選択しないでください。基本認証はサポートされていないため、エンドポイントの作成は失敗します。
- [基本認証] を選択した場合は、VMware Aria Automation Orchestrator サーバのユーザー名とパスワードを入力します。
認証に非ローカル ユーザーを使用している場合は、ユーザー名のドメイン部分を省略する必要があります。たとえば、[email protected] を認証するには、[ユーザー名] テキスト領域に svc_vro と入力する必要があります。
- 認証タイプに [トークン] を選択した場合は、プライベート トークンを生成します。
VMware Cloud Services API トークンは、 Automation Pipelines との外部 API 接続の際にユーザーを認証します。API トークンを取得するには、次の手順を実行します。
- [トークンの生成] をクリックします。
- ユーザー名とパスワードに関連付けられているメール アドレスを入力し、[生成] をクリックします。
生成するトークンは 6 か月有効です。これは更新トークンとも呼ばれます。
- 後で使用するためにトークンを変数として保持するには、[変数の作成] をクリックし、変数の名前を入力して [保存] をクリックします。
- 後で使用するためにトークンをテキスト値で保持するには、[コピー] をクリックし、トークンをテキスト ファイルに貼り付けてローカルに保存します。
- [閉じる] をクリックします。
- [基本認証] を選択した場合は、VMware Aria Automation Orchestrator サーバのユーザー名とパスワードを入力します。
- パイプラインで Orchestrator タスクを実行する準備をします。
- Orchestrator タスクをパイプライン ステージに追加します。
- 適切な名前を入力します。
- [ワークフロー プロパティ] 領域で、VMware Aria Automation Orchestrator エンドポイントを選択します。
- VMware Aria Automation Orchestrator で PIPELINES としてタグ付けしたワークフローを選択します。
作成したカスタム ワークフローを選択した場合は、入力パラメータ値の入力が必要になることがあります。
- [タスクの実行] の [条件に基づく] をクリックします。
- パイプラインの実行時に適用する条件を入力します。
パイプラインを実行するタイミング 条件の選択 条件に基づく 定義した条件が true に評価される場合にのみ、パイプライン タスクを実行します。条件が false の場合、タスクはスキップされます。
Orchestrator タスクには、ブール式を含めることができます。次のオペランドと演算子を使用できます。
- ${pipeline.variableName} などのパイプライン変数。変数を入力するときは、中括弧のみを使用します。
- ${Stage1.task1.machines[0].value.hostIp[0]} などのタスク出力変数。
- ${releasePipelineName} などのデフォルトのパイプライン バインド変数。
- true、false、'true'、'false' などの大文字と小文字を区別しないブール値。
- 引用符を含めない整数値または 10 進数値。
- "test" や 'test' など一重引用符または二重引用符で囲んだ文字列値。
- == Equals や != Not Equals など文字列タイプおよび数値タイプの値。
- >、>=、<、<= などの関係演算子。
- && や || などのブール論理。
- +、-、*、/ などの算術演算子。
- 丸括弧でネストされた式。
- リテラル値 ABCD を含む文字列は false に評価され、タスクはスキップされます。
- 単項演算子はサポートされていません。
たとえば、${Stage1.task1.output} == “Passed” || ${pipeline.variableName} == 39 のような条件があります。
常時 [常時] を選択した場合、パイプラインは条件なしでタスクを実行します。 - あいさつのメッセージを入力します。
- [タスクの検証] をクリックし、発生したエラーを修正します。
- パイプラインを保存し、有効にして実行します。
- パイプラインの実行後、結果を確認します。
- [実行] をクリックします。
- パイプラインをクリックします。
- タスクをクリックします。
- 結果、入力値、およびプロパティを確認します。
ワークフロー実行 ID、誰がいつタスクに応答したか、また、応答にコメントを含めたかを把握できます。
結果
完了です。Automation Pipelines で使用する VMware Aria Automation Orchestrator ワークフローにタグを付け、Automation Pipelines パイプラインに Orchestrator タスクを追加しました。DevOps 環境でのアクションを自動化するワークフローがパイプラインで実行されるようになります。
例: Orchestrator タスクの出力形式
Orchestrator タスクの出力形式は、この例のようになります。
[{
"name": "result",
"type": "STRING",
"description": "Result of workflow run.",
"value": ""
},
{
"name": "message",
"type": "STRING",
"description": "Message",
"value": ""
}]
次のタスク
引き続きパイプラインに Orchestrator ワークフロー タスクを含めて、開発環境、テスト環境、および本番環境でタスクを自動化できるようにします。
