Appearance
用語集
リソース
Qmonus Value Streamにおいて、登録・設定するリソースを以下に説明します。
Deployment Parameters
Deployment Parameters (CI/CDパイプラインで利用されるパラメータや機密情報)を構成するリソースを以下に示します。アプリケーションと環境に関するリソースを用意し、そのアプリケーションをそれぞれの環境にデプロイするためのパラメータを管理するためのDeploymentを作成します。このDeploymentに具体的なパラメータを登録し、CI/CDパイプラインと関連付けることで、登録したパラメータをCI/CDパイプラインで読み出すことができます。
なお、Projectはこれらのリソースをグルーピングする最上位概念であり、ユーザはProjectにアクセス権を付与されることで、そのProject内のリソースを操作できるようになります。
CI/CD Pipelines
API/CLIを中心に作成するCI/CDパイプラインを以下に示します。CI/CD処理の最小単位であるTaskと、それを束ねるPipeline、さらに各Pipeline (ステージ) 間の処理を接続するAssemblyLineから構成されます。AssemblyLineは、上述したDeployment Parametersを読み出し、PipelineとTaskの実行パラメータを解決する役割も担います。PipelineとTaskについては、Tektonの仕様に準拠していますので、詳しくはTekton Pipeline仕様を参照してください。
用語一覧
| 用語 | 説明 |
|---|---|
| Application | 1つのDocker Imageで構成されるアプリケーション。モノレポ構成の場合は、Docker Imageの数だけApplicationを作ることを推奨。 |
| AssemblyLine | Pipelineを直列・並列に組み合わせて、ビルド・デプロイ・リリースまでのCI/CDタスクを一気通貫で行うワークフローの定義。マイクロサービス単位でのリリースをまとめる役割を持つ。 |
| AssemblyLine Results | 実行されたAssemblyLineから明示的に出力されたKey-Value形式の実行結果。出力するパラメータはAssemblyLine manifestのresultsフィールドにて定義できる。出力された値はPromotion時の入力パラメータとして利用可能である。 |
| AssemblyLine Stage | AssemblyLineの設定の一つで、1つのDeploymentと1つのPipelineを指定して構成する。StageではWhat (=Application), Where(=Environment), How(=Pipeline)を定義することになる。 |
| AssemblyLineFactory | AssemblyLine実行時に生成され、AssemblyLineRunの生成と実行を管理するインスタンス。AssemblyLine実行時に与えた入力パラメータやAssemblyLineRunの実行履歴などを保持している。 |
| AssemblyLineRun | AssemblyLineに記述されたAssemblyLine Stageの定義に従い、順番にPipelineを実行するためのインスタンス。PipelineRunやTaskRunと同種のリソース。 |
| Asset | Qmonus Value Streamがユーザに提供するバイナリ形式のツールやCloud Native Adapter Catalogなどのダウンロード可能な資材を指す。 |
| Artifact | AssemblyLine/Pipeline/Taskの実行結果やTaskにおける中間生成物(Cloud Native Adapterをコンパイルした後のKubernetes Manifest等)を指す。 |
| Cancel | 実行しているAssemblyLineRunを中断する機能を指す。ただし、Cancel時点で実行中のPipelineRunは最後まで実行される。 |
| CI/CD Adapter | Cloud Native Adapterのカテゴリの1つ。アプリケーションのデリバリプロセスを定義するAdapter。 |
| Cloud Native Adapter | 開発したアプリケーションをクラウド基盤上で動作させる過程を仲介する独自の仕組み。商用で実績のあるシステム構成やCI/CDパイプラインを再利用可能な形でまとめることができ、アプリケーションと Cloud Native Adapter を組み合わせることで、ベストプラクティスに沿ったシステム構成やCI/CDを実現できる。また、Cloud Native Adapter 自体も複数組み合わせることで新しいAdapterを構成することもできる。旧称 Design Pattern |
| Confirmation | AssemblyLineRun/PipelineRunの処理を一時中断して、承認要求を行う機能を指す。 |
| Deployment | 指定したApplicationを指定したEnvironmentにデリバリするための定義。1つのApplicationと1つのEnvironmentを選んで作成する。 |
| Deployment Config | Deploymentに対して定義可能なKey-Value形式のパラメータ。各環境ごとに利用したいアプリケーションパラメータを設定するために利用する。 |
| Deployment Parameters | CI/CDパイプラインで利用されるDeploymentに対して定義可能なパラメータや機密情報の総称。Deployment ConfigとDeployment Secretを合わせたものになる。 |
| Deployment Secret | Deploymentに対して定義可能な機密情報に関するパラメータ。アプリケーションで利用したい機密情報を設定するために利用する。 |
| Environment | Applicationのデリバリ先を定義したもの。1つ以上のProvisioning Targetを指定して構成する。 |
| GitRepository | Applicationのソースコードが格納されているGitリポジトリの設定。ソースコード以外に、DockerfileやQVS Configなどが含まれる |
| Infrastructure Adapter | Cloud Native Adapterのカテゴリの1つ。アプリケーションを動作させるためのシステム構成を定義するAdapter。 |
| Manifest | Kubernetes互換のあるリソース定義のこと |
| Pipeline | Tekton Pipelineを指す。 |
| PipelineRun | Tekton PipelineRunを指す。 |
| Project | 各種リソースの認可の単位。AssemblyLine Stageには同一Project内のDeploymentのみ指定できるため、AssemblyLineでまとめて処理したいApplicationは一つのProjectにまとめる必要がある。 |
| Project Credentials | AssemblyLine/Pipeline/Taskが実行されるQmonus Value Streamの実行エンジンであるTektonクラスタに対して登録される機密情報を指す。Taskでマウントして利用できるが、デリバリ先の環境では利用できない。 |
| Promotion | AssemblyLine(A)の処理が完了した後、(A)のAssemblyLine Resultsを使用して後段のAssemblyLine(B)を実行することを指す。AssemblyLineに対し、事前にPromotion先を設定することで利用可能となる。 |
| Provisioning Target | Environmentで指定するアプリケーションのデプロイ先環境を指す。Environmentに複数のProvisioning Targetを設定可能。 |
| QVS Config | Cloud Native Adapterとそのパラメータを指定するQmonus Value Streamの設定ファイル。Application毎に作成し、各ApplicationのGit Repositoryに配置する。旧称 Application Config |
| Retry | AssemblyLineRunが失敗した際に、失敗したTaskの先頭からやり直す機能を指す。 |
| Task | Tekton Taskを指す。 |
| TaskRun | Tekton TaskRunを指す。 |
| Webhook Trigger | Git RepositoryからのpushイベントをトリガーとしてAssemblyLineを駆動できるようにするための設定。 |
| マイクロサービス | リリースサイクルが同じで、まとめてリリースしたいApplication群のことを指す。 |
Pipeline パラメータ
仕様 > Pipeline パラメータに移動しました。