Applicationの追加

新しいApplicationの追加方法

Applicationはリソースの集合や設定が一緒に管理されているもので、デプロイ予定のサービスを表しています。 PipeCDの場合、全てのApplicationマニフェストとDeploymentの設定ファイル(.pipe.yaml)はGitリポジトリのディレクトリ(Applicationディレクトリ)にコミットされる必要があります。

Applicationはデプロイされる前に、PipeCDのWebコンソールでの登録に加えて、Deploymentの設定ファイル(.pipe.yaml)がApplicationディレクトリにコミットされている必要があります。 pipedはApplicationを管理することができ、それぞれのApplicationは一つのEnvironmentに所属しなければなりません。現在、PipeCDは以下のApplicationをサポートしています。

  • Kubernetes application
  • Terraform application
  • Cloud Run application
  • Lambda application
  • ECS application

Webコンソールから新しいApplicationを登録

Applicationを登録することでPipeCDはApplicationに関する基本情報を知ることができます。 具体的には、Application設定がされている場所、pipedがどのように処理するべきか、どのクラウドにデプロイされるべきなのかなどといった情報です。

Applicationリストページにある+ADDボタンをクリックすることで、以下のようにポップアップウインドウが表示されます。

ポップアップウインドウの表示例

全ての入力必須項目を入力後、SaveボタンをクリックすればApplication登録は完了です。

以下のリストが登録フォームの入力項目です。

フィールド 説明 項目
Name Applicationの名前 必須
Kind KubernetesTerraformCloudRunLambdaECSの中から選ぶ。 必須
Env Applicationが所属するEnvironment。Settings/Environmentページで登録したものの中から選ぶ。 必須
Piped Settings/Pipedページで登録したものの中から選ぶ。 必須
Repository Application設定とDeployment設定が格納されたGitリポジトリ。pipedの設定で登録したものの中から選ぶ。 必須
Path Repositoryを基準とした相対パス。 ./はリポジトリルートを意味する。 必須
Config Filename Deploymentの設定ファイルの名前。デフォルトは.pipe.yaml 任意
Cloud Provider Applicationがデプロイされる場所。pipedの設定で登録したものの中から選ぶ。 必須

Deploymentの設定ファイルの追加

Applicationの登録後はDeploymentの設定ファイル(.pipe.yaml)をGitリポジトリのApplicationディレクトリに追加していきます。 pipedはこのファイルによってApplicationのデプロイ方法(canary/blue-greenストラテジーや手動による承認など)について知ることができます。 Deploymentの設定ファイルは以下のようにYAMLフォーマットで書くことができます。

apiVersion: pipecd.dev/v1beta1
kind: ApplicationKind
spec:
  ...
  • kindにはApplication Kindを設定します。先述したように、KubernetesTerraformCloudRunLambdaECSがサポート対象のKindとなっています。
  • specではそれぞれのApplication Kind特有の設定をします。

サポートされているDeploymentについてはpipecd/examplesをご覧ください。