Appearance
Config および Credential の登録
ここでは、AssemblyLineを実行するために必要なパラメータとして、 Config および Credential を登録します。
Deployment Config の登録
Qmonus Value Streamでは、Repository や Provisioning Targetなど、Deploymentに関連する各種リソースにおいて設定した値を 全て Deployment Params として参照でき、AssemblyLineからパイプラインステージを実行する際の引数として 利用できます。 加えて、 Deployment Config に設定することで、任意のパラメータを追加して拡張できます。
また、AssemblyLine manifestの各パイプラインステージに記述したパラメータバインディング定義(spec.params
)を評価して実際にPipelineに渡される値、および定義が漏れている値を、AssemblyLineの詳細画面から確認できます。 これらの機能を用いて、Pipelineの実行パラメータを検証しながらConfigを設定できます。
Deployment Config を編集する主な流れは以下のとおりです。
- AssemblyLine 詳細画面にて、各パイプラインステージにおけるPipeline実行時引数が正しいことを確認します。
- Pipeline実行時引数の解決方法に誤りがある場合、 AssemblyLine manifestのパラメータバインディング定義(
spec.params
)を修正します。 - Pipeline実行時引数に不足もしくは誤りがある場合、 Deployment Config を修正します。
- 再度AssemblyLine 詳細画面を確認し、 Deployment Config およびAssemblyLine manifest の修正により、実行時引数が正しく設定されていることを確認します。 まだ不備がある場合は、再度 Deployment Config および AssemblyLine manifest を修正します。
Pipeline実行時引数の確認
AssemblyLineの詳細画面にて、実際にPipelineを実行する際の引数として渡される値を確認します。
- 実行したいAssemblyLineの詳細画面を開きます。
- パイプラインステージを選択します。
- パイプラインステージで実行されるPipelineの引数一覧と、各引数に対して注入される Deployment Params の値が表示されます。 表示される項目は以下のとおりです。
項目 | 詳細 |
---|---|
Name | Pipelineの実行時引数のkey |
Preset | Pipelineの引数定義にて設定されているdefault値です。 Deployment Params が未設定の場合に使用されます。 |
Set at | Deployment Params にて設定されている値です。 AssemblyLine manifestのパラメータバインディングが未定義の場合、この値が使用されます。 |
Override at AssemblyLine | AssemblyLine manifestにおけるパラメータバインディング定義です。最終的にPipeline実行時引数として渡されるパラメータは、この定義に基づいて決定されます。 |
Evaluated | Pipeline実行時に、実際に渡される引数が表示されます。値が未設定の場合は、背景が赤色で表示されます。 $(inputs.<AssemblyLine params key>) および $(params.<Deployment params key>) をバインディングしている場合、これらは実行時まで値が確定しないので、その定義のまま表示されます。 |
- Evaluatedの欄が赤色になっており、Pipeline実行時引数に値が渡らない状態となっている場合、および誤った値が入っている場合は、修正が必要です。
利用可能なDeployment Paramsの確認
パイプラインステージに指定しているDeploymentにおいて利用可能な Deployment Params を確認します。 Pipelineの実行時パラメータを修正する際に、挿入すべき値が Deployment Params にすでに存在する場合は、AssemblyLineのパラメータバインディングを修正することで、その値を挿入できます。
Info
用途が異なるKeyValueだがたまたま同じ値が入っている、という場合は、Valueが同値の新しいKeyValueを作成することを推奨します。当該KeyValueに変更が入った際に、予期せぬ値に変更されてしまうリスクがあるためです。
- 左メニューからApplicationを選択します。
- Application一覧の中から、対象のパイプラインステージで指定しているApplicationを選択します。
- 画面下部の Global Parameter View において、対象のパイプラインステージで指定しているDeploymentの列を確認します。これが、当該Deploymentで利用可能な Deployment Params です。
- Pipelineの実行時パラメータとして利用できるパラメータが Deployment Params に存在し、パイプラインステージのパラメータバインディングを書き換えることが妥当な場合、AssemblyLine manifestを修正します。 AssemblyLine manifest パラメータバインディング定義の修正は、こちら を参考に実施してください。
Deployment Configの設定
Deployment Params に使用したい値がない場合、 Deployment Config にKeyValueを追加して、 Deployment Params を拡張します。
- 実行したいAssemblyLineの詳細画面を開きます。
- パイプラインステージを選択します。
- 画面中ほどの
EDIT DEPLOYMENT CONFIG
を押下します。 - Editorが表示されますので、任意のKeyValueを記述します。KeyとValueは、ともにStringで記述してください。Editorは、JSON/YAML/KeyValueの形式から選択できます。
- 設定内容が正しいことを確認し、保存します。
- Deployment Params の値が表示されたテーブルが更新され、設定した内容が反映されていることを確認します。
Credentialの登録
WARNING
本機能は、フリートライアル環境ではご利用いただけません。フリートライアル環境では、特定の機能が制限されており、全ての機能をご利用いただけない場合がございます。
AssemblyLineで使用するTaskにおいて、k8s secretをmountしている場合、事前に Credential
の登録が必要になります。 Credential
は、デリバリパイプライン実行環境のnamespace内に k8s secretとして保存されます。 Taskでmountする用途でのみ使用され、それ以外の用途で使用できません。 また、置換や削除をできますが、登録したsecretの値は画面上で閲覧できません。
以下手順に従い、secretを設定します。
- 左メニューからCredentialを選択します。
- 画面右上の
NEW CREDENTIAL
ボタンを押下します。 - 下記に従い、各フォームに入力します。
- Name を入力します。 Nameは、k8s secretのnameとして登録され、Taskでmountする際に使用されます。
- 必要に応じて、Descriptionを入力します。
- Secret Dataに、secretの値をkey-value形式で入力します。valueは改行可能です。
- 設定内容が正しいことを確認し、Credentialを作成します。