本記事はPart2までで作成したAWSスタックに対して、CICDパイプラインを作成していきます。Part2までのスタックを作成してない場合は参考記事として参照いただければ幸いです。
環境情報
- 作業環境はAWS Cloud9を利用
- cdk versionは2.63.2
はじめに
AWS CDKを用いた場合でも、直接デプロイするのではなくCodeCommitやCodePipelineを使ってCICDサイクルを管理したいケースは多々あると思います。これまでのPartsでは作成したスタックを直接cdk deployで環境に反映していましたが、今回はしっかりとPipelineを通してデプロイされるように構築していきたいと思います。
CDK Pipelineの作成
Pipeline用のスタックを作成する
まずはパイプラインのスタックを作成していきます。このスタックは実際のアプリケーションとは異なるため、アプリケーションとは関係なく独立したスタックとして作成していきます。
libフォルダ配下に新たにlib/pipeline-stack.tsファイルを作成し、以下のコードを記述していきます。
import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
export class WorkshopPipelineStack extends cdk.Stack {
constructor(scope: Construct, id: string, props?: cdk.StackProps) {
super(scope, id, props);
// Pipeline code goes here
}
}
CDKデプロイエントリーポイントの更新
これまではアプリケーション用のスタックが直接デプロイされていましたが、今後はPipeline用のスタックを介してデプロイするため直接アプリ用のスタックがデプロイされないようにします。代わりに、Pipeline用のスタックがデプロイ時のエントリーポイントとなるように修正します。
bin/cdk-workshop.tsファイルを以下のように更新します。
import * as cdk from 'aws-cdk-lib';
import { WorkshopPipelineStack } from '../lib/pipeline-stack';
const app = new cdk.App();
new WorkshopPipelineStack(app, 'CdkWorkshopPipelineStack');
下準備ができたので、パイプラインをつくっていきましょう！
リポジトリの作成
まずはソースコントロール用のリポジトリを作成していきます。CodeCommitリポジトリを作成していきましょう。
lib/pipeline-stack.tsを以下のように編集します。
import * as cdk from 'aws-cdk-lib';
import * as codecommit from 'aws-cdk-lib/aws-codecommit';
import { Construct } from 'constructs';
export class WorkshopPipelineStack extends cdk.Stack {
constructor(scope: Construct, id: string, props?: cdk.StackProps) {
super(scope, id, props);
// Create a CodeCommit repository
new codecommit.Repository(this, 'WorkshopRepo', {
repositoryName: "WorkshopRepo"
});
}
}
ここまでで一旦デプロイしてみます。
cdk deploy
レポジトリができていますね！
リポジトリのクレデンシャルを取得し、コミットする
まずはリポジトリ接続用のクレデンシャルを取得します。この手順は本記事の内容をVisualStudioCodeなどで実施している方向けです。筆者の場合はCloud9にawsのcredentialファイルを配置しているため、CodeCommitリポジトリ専用のGitクレデンシャルを取得する必要はありません。
クレデンシャルはIAMコンソール >> Users（任意ユーザー） >> Security credentials >> HTTP Git credentials for AWS CodeCommitの順番に遷移し、"Generate credentials"より作成して取得してください。
次にCodeCommitコンソールから今回作成したリポジトリのURLを取得します。
.gitignoreファイルを開き、!lambda/*jsを追記します。これを追記しないとgit commitにlambda用のファイルが含まれません。
*.js
!jest.config.js
*.d.ts
node_modules
# CDK asset staging directory
.cdk.staging
cdk.out
!lambda/*.js
ちなみにCloud9利用の場合は設定から"Show Hidden Files"をONにすることで確認できます。
ファイルをローカルにコミットしていきます。
git add -A && git commit -m "Workshop Stack Initial Commit"
次にリモートリポジトリの情報を取得し（XXXXの部分は先ほどコピーしたURL）、
git remote add origin XXXXX
実際にリモートリポジトリに反映します。(--set-upstreamを指定することで、masterブランチの内容を上書きしています)
git push --set-upstream origin master
CodeCommitのコンソールを確認すると、しっかりlambdaフォルダも含まれてプッシュされていますね！
パイプラインの定義と作成
それではパイプラインを定義していきます。lib/pipeline-stack.tsを以下のように編集していきます。
import * as cdk from 'aws-cdk-lib';
import * as codecommit from 'aws-cdk-lib/aws-codecommit';
import { Construct } from 'constructs';
import { CodeBuildStep, CodePipeline, CodePipelineSource } from 'aws-cdk-lib/pipelines';
export class WorkshopPipelineStack extends cdk.Stack {
constructor(scope: Construct, id: string, props?: cdk.StackProps) {
super(scope, id, props);
// Create a CodeCommit repository
const repo = new codecommit.Repository(this, 'WorkshopRepo', {
repositoryName: "WorkshopRepo"
});
// Declare CodePipeline
const pipeline = new CodePipeline(this, 'Pipeline', {
pipelineName: 'WorkshopPipeline',
synth: new CodeBuildStep('SynthStep', {
input: CodePipelineSource.codeCommit(repo, 'master'),
installCommands: [
'npm install -g aws-cdk'
],
commands: [
'npm ci',
'npm run build',
'npx cdk synth'
]
})
});
}
}
-
new CodePipeline(...):Pipelineを初期化しています。 -
synth(...):dependenciesのインストールやビルド、synthを実行するコマンドを記述していきます。決まりとしてsynthするコマンドは一番最後に記述します。NPMベースのプロジェクトの場合はnpx cdk synthとなります。 -
input: CDKのソースコードがストアされているリポジトリを指定します。
一旦ここまでの内容をリポジトリにコミットしていきます。
$ git commit -am "Added Pipeline" && git push
デプロイしていきます。
$ cdk deploy
パイプラインが作成されました！
パイプラインにアプリケーションを紐づける
この時点でのパイプラインは、コミットされるごとに自動でトリガーされますが、アプリケーションを”デプロイ”するためのステージが必要です。ステージの中で実際のアプリケーションを紐付けます。その後デプロイ用のステージをパイプラインに組み込んでいきましょう。
まずはlib配下に新規ファイルpipeline-stage.tsファイルを以下のように作成します。
import { CdkWorkshopStack } from './cdk-workshop-stack';
import { Stage, StageProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
export class WorkshopPipelineStage extends Stage {
constructor(scope: Construct, id: string, props?: StageProps) {
super(scope, id, props);
new CdkWorkshopStack(this, 'WebService');
}
}
上記のコードではパイプライン上に組み込む新規のStageを定義して、アプリケーションを紐付け（インスタンス化）ました。
ただこの状態だとエディター上でエラーが表示されているかと思います。これはアプリケーションスタックがパイプラインを通してデプロイされる状態にまだ調整されていないからです。
では調整していきます。lib/cdk-workshop-stack.tsを以下のように編集します。
import * as cdk from 'aws-cdk-lib';
import * as lambda from 'aws-cdk-lib/aws-lambda';
import * as apigw from 'aws-cdk-lib/aws-apigateway';
import { Construct } from 'constructs';
import { HitCounter } from './hitcounter';
export class CdkWorkshopStack extends cdk.Stack {
constructor(scope: Construct, id: string, props?: cdk.StackProps) {
super(scope, id, props);
// defines an AWS Lambda resource
...
上記コードについて、変更前のscopeパラメータはcdk.Appとなっていました。これはコンストラクトツリーの中ではappの子要素であることを意味します。今回の変更でこのスタックはパイプラインを通してデプロイされるように変更したので、appの子要素である必要はなくなったためConstructをセットしています。
では作成したステージをパイプラインに紐づけていきます。
lib/pipeline-stack.tsを以下のように編集していきます。
import * as cdk from 'aws-cdk-lib';
import * as codecommit from 'aws-cdk-lib/aws-codecommit';
import { Construct } from 'constructs';
import { WorkshopPipelineStage } from './pipeline-stage';
import { CodeBuildStep, CodePipeline, CodePipelineSource } from 'aws-cdk-lib/pipelines';
export class WorkshopPipelineStack extends cdk.Stack {
constructor(scope: Construct, id: string, props?: cdk.StackProps) {
super(scope, id, props);
// Create a CodeCommit repository
const repo = new codecommit.Repository(this, 'WorkshopRepo', {
repositoryName: "WorkshopRepo"
});
// Declare CodePipeline
const pipeline = new CodePipeline(this, 'Pipeline', {
pipelineName: 'WorkshopPipeline',
synth: new CodeBuildStep('SynthStep', {
input: CodePipelineSource.codeCommit(repo, 'master'),
installCommands: [
'npm install -g aws-cdk'
],
commands: [
'npm ci',
'npm run build',
'npx cdk synth'
]
})
});
const deploy = new WorkshopPipelineStage(this, 'Deploy');
const deployStage = pipeline.addStage(deploy);
}
}
ここではWorkshopPipelineStageをインスタンス化し、このインスタンス化したステージをパイプラインに追加しています（pipeline.addStage(deploy)）。
git add .して、コミットします！（もうcdk deployは不要ですね）
$ git add .
$ git commit -am "Add deploye stage to pipeline" && git push
ちょっと時間はかかりますが、、、完了しました！
デプロイステージも追加されています。
これでひとまずやりたかったことは実現できました！
アプリケーションコードを更新してテスト
では実際にアプリケーションコードを更新してデプロイし、テストしてみましょう！Lambda関数を編集します。
exports.handler = async function(event) {
console.log("request:", JSON.stringify(event, undefined, 2));
return {
statusCode: 200,
headers: { "Content-Type": "text/plain" },
/*bodyをGreatJobに編集*/
body: `GreatJob, CDK! You've hit ${event.path}\n`
};
};
保存してコミットします。
$ git commit -am "Update hello.js lambda" && git push
パイプラインが動き始めました！ドキドキ
無事に成功したようです！（スクショ割愛）
URLに対してテストをしたいのですが、cdk deployコマンドを使ってないのでターミナル上では確認できないですね。
CloudFormationコンソールから"Deploy-WebService"スタックを選択し、Outputsタブを参照してください。こちらにURLが出力されています。
このURLをHitすると、先ほど更新した内容が反映されていますね！
$ curl https://XXXXXXXXXX.execute-api.ap-northeast-1.amazonaws.com/prod/
GreatJob, CDK! You've hit /
さらに実施したい方向け
ここからはアディショナルな内容となりますが、こちらのサイトで以下の2点の実装方法を解説しています。興味のある方は是非実施してみてください！
- URLエンドポイントをよりわかりやすくCloudFormationのOutPutsタブに表示する方法
- デプロイ時にURLエンドポイントに対してテストを実施するステップをパイプラインに組み込む方法
まとめ
今回はCDKを用いたCICDパイプラインの構築を実践してみました！Part1から続くこの内容で、かなりCDKに対する理解が深まったと思います。
CDKを利用することで、アプリケーション作成の際に必要な細かいAWSリソース（IAMロールなど）も自動で作成できますし、同じ内容をCloudFormationテンプレートで記述するよりも記述量はかなり少なかった印象です。また、デプロイの中にテストを組み込めるのも利点かとおもいました。
シーンに応じでAWS CDKを今後も利用していきたいと思います。
以上です。
参考サイト