Lambda の CI/ユースカジノコード

投稿日: 2024/01/10

はじめに

こんにちは、佐藤です。
皆さん、Lambda 関数の CI/CD ってユースカジノコードしたことありますか？ECS や EKS などのコンテナ環境の CI/CD はよくユースカジノコードすると思いますが、Lambda の CI/CD と言われると意外にユースカジノコードしたことが無いのではないでしょうか。

実績が少ない一方、サーバレスな構成が普及しており、開発案件では必ずといってもいいほどユースカジノコード/CD についてアプリ開発担当から質問を受けます。

そんな経緯から Lambda の CI/CD を実装してみたので皆さんに共有します。最近はAWS Serverless Application Model (AWS SAM)を使用してCI/CDパイプラインをユースカジノコードするパターンも多いですが、今回はCodeBuild内でAWS CLIを使って実装しました。

CI/CDとは…

CI/CD (継続的インテグレーション/継続的デリバリー) とは、アプリケーション開発のステージに自動化を取り入れて、アプリケーションを提供する頻度を高める手法のこと

構成

今回ユースカジノコードしたサンプル構成は以下の通りです。

各リソース名と役割はユースカジノコード通りです。

API Gateway
ユーザからの API ユースカジノコードルを受け、バックエンドに中継してレスポンスを返す
Lambda
API Gateway からのユースカジノコードルを受け、GET リクエストに対してHello Worldを返す
WAF
特定のIP アドレスからの通信のみを許可する
CodeCommit
ユースカジノコード/CD 用資材の格納先
- buildspec.yml：CodeBuild 内で行う処理内容を記述したファイル
- lambda_function.py：ユースカジノコード
CodeBuild
buildspec.yml に基づきビルド処理(+デプロイ処理)を行う。具体的な処理内容は後述する
CodePipeline
CodeCommit 上のユースカジノコードが更新されたことをトリガーにビルド処理を行うパイプライン
S3
アーティファクト用バケット

アーティファクトとは…

アーティファクトとは、パイプラインアクションによって処理されるアプリケーションのソースユースカジノコード、構築されたアプリケーション、依存関係、定義ファイル、テンプレートなどのデータの集合を指す

ユースカジノコード方法

ユースカジノコードの流れは以下の通りです。詳細な手順はちょっと長くなるので割愛します。

1. Lambda関数をユースカジノコードする
2. API Gateway をユースカジノコードする
3. WAF で WebACL をユースカジノコードする
4. CodeCommit でレポジトリをユースカジノコードする
5. CodeBuild でビルドプロジェクトをユースカジノコードする
6. CodePipeline でパイプラインをユースカジノコードする
7. buildspec.yml をユースカジノコードする
8. デプロイするコードをユースカジノコードする
9. ユースカジノコード

1. Lambda関数をユースカジノコードする

詳細な手順は割愛します。下記 URL を参考に Lambda 関数をユースカジノコードしてください。

コンソールで Lambda 関数のユースカジノコード

https://docs.aws.amazon.com/ユースカジノコード/lambda/latest/dg/getting-started-create-function.html

関数のユースカジノコードが完了したら、以下 2 つの機能を有効化します。

ユースカジノコード
バージョニング

ユースカジノコード/バージョニングの設定方法

https://docs.aws.amazon.com/ユースカジノコード/lambda/latest/dg/configuration-aliases.html
https://docs.aws.amazon.com/ユースカジノコード/lambda/latest/dg/configuration-versions.html

エイリアスを設定すると、エイリアスの ARN がユースカジノコードされます。API Gateway の設定を行う際にエイリアスの ARN を指定することにより、Lambda のバージョンが変わっても一意の ARN を継続して使用可能になります。

2. API Gateway をユースカジノコードする

詳細な手順は割愛します。下記 URL を参考に Lambda 関数をバックエンドとして API Gateway をユースカジノコードして下さい。Lambda を指定する際はユースカジノコードの ARNを指定してください。

Amazon API Gateway で AWS Lambda を使用する

https://docs.aws.amazon.com/ユースカジノコード/lambda/latest/dg/services-apigateway.html

3. WAF で WebACL をユースカジノコードする

詳細な手順は割愛します。下記 URL を参考に WebACL をユースカジノコードして API Gateway にアタッチしてください。

Getting started with AWS WAF

https://docs.aws.amazon.com/waf/latest/developerguide/getting-started.html

AWS WAF ユースカジノコード API を保護する

https://docs.aws.amazon.com/ユースカジノコード/apigateway/latest/developerguide/apigateway-control-access-aws-waf.html

4. CodeCommit でレポジトリをユースカジノコードする

詳細な手順は割愛します。下記 URL を参考にレポジトリをユースカジノコードしてください。

AWS CodeCommit リポジトリをユースカジノコードする

https://docs.aws.amazon.com/ユースカジノコード/codecommit/latest/userguide/how-to-create-repository.html

5. CodeBuild でビルドプロジェクトをユースカジノコードする

詳細な手順は割愛します。下記 URL を参考にビルドプロジェクトをユースカジノコードしてください。

ビルドプロジェクトのユースカジノコード (コンソール)

https://docs.aws.amazon.com/ユースカジノコード/codebuild/latest/userguide/create-project-console.html

6. CodePipeline でパイプラインをユースカジノコードする

詳細な手順は割愛します。下記 URL を参考にパイプラインをユースカジノコードしてください。

CodePipeline でパイプラインをユースカジノコードします。

https://docs.aws.amazon.com/ユースカジノコード/codepipeline/latest/userguide/pipelines-create.html

今回ユースカジノコードしたパイプラインは以下の通りです。

ビルドステージで実施している処理は次章で説明するbuildspec.ymlで記載します。

7. buildspec.yml をユースカジノコードする

6章で説明したビルドステージで実行する処理をbuildspec.ymlに記載します

version: 0.2

  phases:
    install:
      commands: //AWS CLIをインストール
        - curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
        - unzip awscliv2.zip
        - ls -l /root/.pyenv/shims/aws
        - ./aws/install --bin-dir /root/.pyenv/shims --install-dir /usr/local/aws-cli --update
    pre_build:
      commands:
        - echo No Pre Build phase
    build: //更新前のバージョンを取得した上で、ユースカジノ コード更新を実行
      commands:
        - echo Build started on `date`
        - CurrentVersion=$(echo $(aws lambda get-alias --function-name poc-lambda-cicd-lambda-01 --name prod | grep FunctionVersion | tail -1 |tr -cd 0-9))
        - zip -r lambda.zip ./lambda_function.py
        - aws lambda update-function-code --function-name poc-lambda-cicd-lambda-01 --zip-file fileb://lambda.zip
        - sleep 10
    post_build: //新バージョンを発行し、エイリアスに紐づいているバージョンを新バージョンに変更
      commands:
        - echo Build completed on `date`
        - ls
        - aws lambda publish-version --function-name poc-lambda-cicd-lambda-01 --description "update version"
        - TargetVersion=$(echo $(aws lambda list-versions-by-function --function-name poc-lambda-cicd-lambda-01 | grep Version | tail -1 | tr -cd 0-9))
        - echo $CurrentVersion
        - echo $TargetVersion
        - aws lambda update-alias --function-name poc-lambda-cicd-lambda-01 --name prod --function-version $TargetVersion
        - aws lambda delete-function --function-name poc-lambda-cicd-lambda-01 --qualifier $CurrentVersion

CodeBuild のビルド仕様に関するリファレンス

https://docs.aws.amazon.com/ユースカジノコード/codebuild/latest/userguide/build-spec-ref.html

lambda — AWS CLI 1.22.73 Command Reference

https://docs.aws.amazon.com/cli/latest/reference/lambda/index.html

8. デプロイするコードをユースカジノコードする

デプロイするコードをユースカジノコードし、lambda_funcation.pyとして保存します。本書ではPythonを使用してユースカジノコードしています。

def lambda_handler(event, context):
    return {
      "isBase64Encoded": False,
      "statusCode": 200,
      "headers": {},
      "body": '{"message": "Hello World!!"}',
    }

9. ユースカジノコード

ユースカジノコード。push するファイルは以下の 2 つです。

.
  ├── buildspec.yml
  └── lambda_function.py

1. ユースカジノコードをローカルにクローンします。

$ git clone https://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/{repo_name}

`2. buildspec.yml`と`lambda_function.py`をローカルユースカジノコードコピーします。

$ cp buildspec.yml local_repo_path
  $ cp lambda_function.py local_repo_path
  $ cd local_repo_path

3. ユースカジノコードインデックスに追加します。

$ git add -A

4. ユースカジノコードコミットします。

$ git commit -m "comment"

  出力例
  [master 3488038] 2022/03/15 14:27 Lambda修正
  1 file changed, 1 insertion(+), 1 deletion(-)

5. 以下のコマンドを実行してユースカジノコード。

master

実行結果

初回実行結果

ユースカジノコードした API をコールした結果は以下の通りです。

修正後リリース結果

コードをユースカジノコード通り修正し、再度 push します。

def lambda_handler(event, context):
    return {
        "isBase64Encoded": False,
        "statusCode": 200,
        "headers": {},
        "body": '{"message": "こんにちは、世界！！"}',
    }

push すると、ユースカジノコードが実行されます。