Serverless Frameworkで複数のLambdaの管理を楽にする

執筆者

浅岡慎也

更新日：2022.12.23

公開日：2021.04.23

目次

Serverless Frameworkを検討したきっかけ
Serverless Frameworkって何？
AWSのLambda FunctionとS３を使って実践
まとめ

Serverless Frameworkを検討したきっかけ

業務で使うサーバーが、いつの間にかAWSになってから、毎日AWSを業務で利用しています。 AWSには、沢山のサービスがありますが、私のお気に入りはAWS Lambdaです。

理由は、とりあえずシンプルに作れるから！
プロジェクトが始まると、切り出せそうな処理はどんどんLambda Functionとして作ってはデプロイを繰り返します。

結果、案件も終わりが見えた頃には、「Lambda Functionいっぱい問題」発生。このパターンが日常的にあり、修正や管理のコストが大きくなることが多いです。

Lamda大量問題

Lambda Function自体は便利ですが、以下の悩みがあります。

デプロイされているソース状態がわからない (パッケージサイズによるけど)
数が多くなるとデプロイが大変。以下の手順を手動で何度も行うのは大変
1. 最新ソースをgitからclone
2. npm install
3. zip圧縮
4. AWSにアップロード
5. 動作確認

お手製ツールを用意したりなどで、なんとかごまかし運用をしていた所、弊社のアーキテクトから「Serverless Framework使えば?」とのアドバイスを受け「何やそれ？」ってなったのが、導入のきっかけになります。 (キャッチアップせーよ、頭使って仕事しろよって話ですね。。。)

Serverless Frameworkって何？

Serverless Frameworkとは、お手軽に「サーバレスアーキテクチャ」を構築することができるフレームワークです。もちろん、AWSのLambda Functionにも対応しています。

そもそもサーバーレスアーキテクチャって何？

簡潔にいうと、「常時起動しているサーバーを使わずにアーキテクチャ（仕組み）が実現できている状態」というニュアンスが近いです。メリットとしては、常時起動サーバーがなくなり、以下のサーバーあるあるの問題がなくなることです。

サーバーを常時起動している場合、使用していない時間も料金がかかる問題
起動しているサーバーは、誰がメンテナンスするの問題
サーバー設定担当者によって構成が微妙に違うので、デプロイしたらコードが動かない問題

重複しますが、そんなサーバー関連の問題を減らすことができる「サーバレスアーキテクチャ」をお手軽に構築できるのが、「Serverless Framework」となります。

Serverless Frameworkのメリット

Serverless Frameworkによるメリットは、以下です。

サーバーレスアーキテクチャを簡単に構築できる
サーバーレスアーキテクチャの管理が簡単になる
フレームワークにより、サーバーレスアーキテクチャ構築手法が一本化できる

私がLambda Functionで導入した時に嬉しかった点は以下です。

デプロイの負担が減った！
環境変数の追加漏れがなくなった！
関連する複数のLambda Functionを一括で更新できるようになった！(これがとにかく便利でした)

Serverless Frameworkのデメリット

メリットだけではなく、デメリットもあるにはあります。

理解するまでの学習コストがかかる
慣れるまでは、初回の準備が面倒
ローカルでのテスト実行時の起動速度が遅くなる

AWSのLambda FunctionとS３を使って実践

成果物の要件を以下と定義します。

Lambda Function 1の挙動
1. 実行したらHelloWorldを出力
2. S3にhello.jsonをアップロード
Lambda Function 2の挙動
1. S3からhello.jsonを読み込み
2. hello.jsonの中身を出力
Server Frameworkで動く状態になっていること

Lambda Function 1の作成

以下のコードを作成して、AWSにデプロイします。

const aws = require('aws-sdk');

exports.handler = function (event, context) {
  (async () => {
    try {
      // Hello Worldを出力
      console.log('Hello World!');

      // s3にファイル出力
      const s3 = new aws.S3({
        endpoint: process.env.S3_BUCKET_ENDPOINT,
        s3ForcePathStyle: true,
        signatureVersion: 'v4',
        region: process.env.S3_BUCKET_REGION,
       });

      // とりあえずの同期実行
      await (async () => new Promise((resolve, reject) => {
        s3.putObject({
          Bucket: process.env.S3_BUCKET_NAME,
          Key: 'hello.json',
          Body: JSON.stringify({
            'date': new Date().toISOString(),
          }),
        }, (err) => {
          if (!err) {
            resolve();
          } else {
            reject(err);
          }
        });
      }).catch((e) => {
        throw new Error(e);
      }))();
      
      context.succeed('succeed');

    } catch (e) {
      console.error(e);
      context.fail('fail');
    }
  })();
};

const aws = require('aws-sdk');

exports.handler = function (event, context) {

(async () => {

try {

// Hello Worldを出力

console.log('Hello World!');

// s3にファイル出力

const s3 = new aws.S3({

endpoint: process.env.S3_BUCKET_ENDPOINT,

s3ForcePathStyle: true,

signatureVersion: 'v4',

region: process.env.S3_BUCKET_REGION,

});

// とりあえずの同期実行

await (async () => new Promise((resolve, reject) => {

s3.putObject({

Bucket: process.env.S3_BUCKET_NAME,

Key: 'hello.json',

Body: JSON.stringify({

'date': new Date().toISOString(),

}),

}, (err) => {

if (!err) {

resolve();

} else {

reject(err);

}

});

}).catch((e) => {

throw new Error(e);

}))();

context.succeed('succeed');

} catch (e) {

console.error(e);

context.fail('fail');

}

})();

};

Lambda1をデプロイ

S3の操作を行うためのロール設定

S3でロール設定

テストなので、とりあえずS3のフルアクセス権限を設定しています。
※プロダクションコードの場合は、適切な権限設定を行ってください。

ロールを設定

以下のように環境変数も設定。

環境変数を設定

Lambda Function 1の実行

無事「Hello World」がコンソール上に出力されました。

Lambda1の実行結果

無事、S3に「hello.json」がアップロードされました。

S3にアップロード

Lambda Function 2の作成

以下のコードを作成して、AWSにデプロイします。

const aws = require('aws-sdk');

exports.handler = function (event, context) {
  (async () => {
    try {
      // s3のファイル読み込み
      const s3 = new aws.S3({
        endpoint: process.env.S3_BUCKET_ENDPOINT,
        s3ForcePathStyle: true,
        signatureVersion: 'v4',
        region: process.env.S3_BUCKET_REGION,
      });
      
      const data = await (async () => new Promise((resolve, reject) => {
        s3.getObject({
          Bucket: process.env.S3_BUCKET_NAME,
          Key: 'hello.json',
        }, (err, res) => {
          if (!err) {
            resolve(JSON.parse(res.Body.toString()));
          } else {
            reject(err);
          }
        });
      }).catch((e) => {
        throw new Error(e);
      }))();

      // 読み込んだファイルの内容を出力
      console.log(data);

      context.succeed('succeed');

    } catch (e) {
      console.error(e);
      context.fail('fail');
    }
  })();
};

const aws = require('aws-sdk');

exports.handler = function (event, context) {

(async () => {

try {

// s3のファイル読み込み

const s3 = new aws.S3({

endpoint: process.env.S3_BUCKET_ENDPOINT,

s3ForcePathStyle: true,

signatureVersion: 'v4',

region: process.env.S3_BUCKET_REGION,

});

const data = await (async () => new Promise((resolve, reject) => {

s3.getObject({

Bucket: process.env.S3_BUCKET_NAME,

Key: 'hello.json',

}, (err, res) => {

if (!err) {

resolve(JSON.parse(res.Body.toString()));

} else {

reject(err);

}

});

}).catch((e) => {

throw new Error(e);

}))();

// 読み込んだファイルの内容を出力

console.log(data);

context.succeed('succeed');

} catch (e) {

console.error(e);

context.fail('fail');

}

})();

};

Lambda2をデプロイ

ロールは、さきほど作成したものを使いまわして設定
環境変数は、さきほどのLambda Function 1と同じ内容を設定

無事、S3からファイルを読み込み、中身を出力できました。

Lambda2の実行結果

Lambda FunctionをServerless Frameworkとして設定

envファイルを作成し、Lambda Functionに設定する環境変数情報を設定します。 envファイルは、以下のようにYAML形式でシンプルに記述できます。(リージョンやバケットは適宜書き換えてください)

S3_BUCKET_ENDPOINT: s3.ap-northeast-1.amazonaws.com
S3_BUCKET_REGION: ap-northeast-1
S3_BUCKET_NAME: test-xxxxxxxxxx

S3_BUCKET_ENDPOINT: s3.ap-northeast-1.amazonaws.com

S3_BUCKET_REGION: ap-northeast-1

S3_BUCKET_NAME: test-xxxxxxxxxx

Serverless Framework本体用にYAML形式の設定ファイルを作成します。今回は、以下のような設定ファイルを用意しました。

# ServerlessFrameworkでデプロイしたLambdaFunctionの関数名に自動で追加される接頭辞
service: sfw-test

provider:
  name: aws
  stage: ${opt:stage, 'dev'}
  region: ap-northeast-1
  lambdaHashingVersion: 20201221
  # LambdaFunctionで必要なポリシーを設定
  iam:
    role:
      statements:
        - Effect: "Allow"
          Action:
            - s3:*
          Resource: "*"
  timeout: 60
  memorySize: 128
custom:
  # 環境別にenvファイルを別々で用意する場合は、以下のリストに追加
  environment:
    # ローカルでテスト実行するための環境変数ファイル
    local: ${file(./env/local.yml)}
    # devlop環境でテスト実行するための環境変数ファイル
    dev: ${file(./env/dev.yml)}

# デプロイするLambdaFunctionの設定リスト
functions:
  # helloworldを出力して、S3にファイルをアップロードするスクリプト
  helloworld:
    # 使用するランタイムのバージョン設定
    runtime: nodejs14.x
    # 実行するハンドラーのパス
    handler: src/helloworld/index.handler
    # タイムアウト設定
    timeout: 15
    # 使用メモリー設定
    memorySize: 128
    # 環境変数の設定（* process.envで取得できる
    environment:
      S3_BUCKET_ENDPOINT: ${self:custom.environment.${self:provider.stage}.S3_BUCKET_ENDPOINT}
      S3_BUCKET_REGION: ${self:custom.environment.${self:provider.stage}.S3_BUCKET_REGION}
      S3_BUCKET_NAME: ${self:custom.environment.${self:provider.stage}.S3_BUCKET_NAME}
  # S3からファイルを読み込んで出力するスクリプト
  reader:
    # 使用するランタイムのバージョン設定
    runtime: nodejs14.x
    # 実行するハンドラーのパス
    handler: src/reader/index.handler
    # タイムアウト設定
    timeout: 15
    # 使用メモリー設定
    memorySize: 128
    # 環境変数の設定（* process.envで取得できる
    environment:
      S3_BUCKET_ENDPOINT: ${self:custom.environment.${self:provider.stage}.S3_BUCKET_ENDPOINT}
      S3_BUCKET_REGION: ${self:custom.environment.${self:provider.stage}.S3_BUCKET_REGION}
      S3_BUCKET_NAME: ${self:custom.environment.${self:provider.stage}.S3_BUCKET_NAME}
    # イベントトリガー設定
    events:
      # S3の指定バケットにファイルがアップされたら自動実行するように設定
      - s3:
          bucket: ${self:custom.environment.${self:provider.stage}.S3_BUCKET_NAME}
          event: s3:ObjectCreated:*
          # 
          # 手動で作成したバケットを使用する場合は設定が必要
          # 
          existing: true

# ServerlessFrameworkでデプロイしたLambdaFunctionの関数名に自動で追加される接頭辞

service: sfw-test

provider:

name: aws

stage: ${opt:stage, 'dev'}

region: ap-northeast-1

lambdaHashingVersion: 20201221

# LambdaFunctionで必要なポリシーを設定

iam:

role:

statements:

- Effect: "Allow"

Action:

- s3:*

Resource: "*"

timeout: 60

memorySize: 128

custom:

# 環境別にenvファイルを別々で用意する場合は、以下のリストに追加

environment:

# ローカルでテスト実行するための環境変数ファイル

local: ${file(./env/local.yml)}

# devlop環境でテスト実行するための環境変数ファイル

dev: ${file(./env/dev.yml)}

# デプロイするLambdaFunctionの設定リスト

functions:

# helloworldを出力して、S3にファイルをアップロードするスクリプト

helloworld:

# 使用するランタイムのバージョン設定

runtime: nodejs14.x

# 実行するハンドラーのパス

handler: src/helloworld/index.handler

# タイムアウト設定

timeout: 15

# 使用メモリー設定

memorySize: 128

# 環境変数の設定（* process.envで取得できる

environment:

S3_BUCKET_ENDPOINT: ${self:custom.environment.${self:provider.stage}.S3_BUCKET_ENDPOINT}

S3_BUCKET_REGION: ${self:custom.environment.${self:provider.stage}.S3_BUCKET_REGION}

S3_BUCKET_NAME: ${self:custom.environment.${self:provider.stage}.S3_BUCKET_NAME}

# S3からファイルを読み込んで出力するスクリプト

reader:

# 使用するランタイムのバージョン設定

runtime: nodejs14.x

# 実行するハンドラーのパス

handler: src/reader/index.handler

# タイムアウト設定

timeout: 15

# 使用メモリー設定

memorySize: 128

# 環境変数の設定（* process.envで取得できる

environment:

S3_BUCKET_ENDPOINT: ${self:custom.environment.${self:provider.stage}.S3_BUCKET_ENDPOINT}

S3_BUCKET_REGION: ${self:custom.environment.${self:provider.stage}.S3_BUCKET_REGION}

S3_BUCKET_NAME: ${self:custom.environment.${self:provider.stage}.S3_BUCKET_NAME}

# イベントトリガー設定

events:

# S3の指定バケットにファイルがアップされたら自動実行するように設定

- s3:

bucket: ${self:custom.environment.${self:provider.stage}.S3_BUCKET_NAME}

event: s3:ObjectCreated:*

# 手動で作成したバケットを使用する場合は設定が必要

existing: true

Serverless Frameworkでインフラリソースの管理

Serverless Frameworkでは、Lambda Functionで使用する周辺リソース（S3,SQSなど）も同時にデプロイ管理することができます。手動で作成した既存のリソースも使用しても問題ありません。

Lambda FunctionをServerless Frameworkでデプロイ

Serverless Frameworkでデプロイを行います。

serverless deploy --aws-profile ${profile指定が必要な時のみ} --verbose --stage dev

関係するLambda Functionが一括でデプロイされました。

Lambdaの一括デプロイ

環境変数が設定されていることを確認

環境変数を確認

今回は一括でデプロイしましたが、以下のようなコマンドで個別にデプロイすることもできます。

serverless deploy --aws-profile ${profile指定が必要な時のみ} --verbose --stage dev -f helloworld

Serverless Frameworkの動作確認

ちゃんと動くかテストします。

Serverless Frameworkの動作確認

無事、Serverless FrameworkでアップロードしたLambda Function 1が動作しました。

Serverless Frameworkの設定に問題がなければ、Lambda Function 1を実行した時に保存されるS3ファイルをトリガーにして、Lambda Function 2が動いているはずなので、Cloud Watchのログを確認します。

ログを確認

無事、Serverless FrameworkでアップロードしたLambda Function 2が動作しました。

念のため、手動での実行テストも行います。

手動テスト結果

無事、Serverless Frameworkでアップロードした、Lambda Function 2が動作しました。

まとめ

実際に、Serverless Frameworkを使って便利だなぁと思った点は以下となります。

とにかくデプロイが楽になった
関係するLambda Functionを一括でデプロイできる
こういうパターンで組む時にデプロイミスが減った Cloud Design Pattern: Queuing Chainパターン
環境変数の管理が楽になった
ウェブコンソール上で設定していた時にあったようなミスがなくなった

新しいことを取り入れるのは、いつも億劫になりがちですが、実際にやってみると「何でもっと早くこれにせんかったんや」と思うことが多いです。Serverless Frameworkについても、その一つです。

まだ使ってみたことがない方は、お試しいただければと思います。

執筆者

浅岡慎也

システム開発部 Cast Me!グループリーダー

2013年にPLAN-Bへ中途入社。様々な自社プロダクトの開発に参画し、新規の立ち上げから運用まで広く携わる。プロダクト開発・運用でたまにある火事場や土壇場をねじ伏せていく力と速さは社内ナンバー1。後進を育てながらも、常に最前線に立ち開発を行う。SEARCH WRITEの立ち上げからサービス拡大まで関わった後、新規プロダクトに取り組み中。

DOWNLOAD

無料資料ダウンロードはこちら

CONTACT

お問い合わせはこちら

Serverless Frameworkで複数のLambdaの管理を楽にする

Serverless Frameworkを検討したきっかけ

Serverless Frameworkって何？

そもそもサーバーレスアーキテクチャって何？

Serverless Frameworkのメリット

Serverless Frameworkのデメリット

AWSのLambda FunctionとS３を使って実践

Lambda Function 1の作成

Lambda Function 1の実行

Lambda Function 2の作成

Lambda FunctionをServerless Frameworkとして設定

Serverless Frameworkでインフラリソースの管理

Lambda FunctionをServerless Frameworkでデプロイ

Serverless Frameworkの動作確認

まとめ

浅岡慎也

IAM Identity Center(AWS SSO)に移行して1年たったので使い方などまとめる

AWSマネージドデータベースとは？利点と気をつけたいことまとめ

Aurora Serverlessを実際に使ってみたメリットとデメリット

高級キーボードってどうなの

Serverless Frameworkで複数のLambdaの管理を楽にする

Serverless Frameworkを検討したきっかけ

Serverless Frameworkって何？

そもそもサーバーレスアーキテクチャって何？

Serverless Frameworkのメリット

Serverless Frameworkのデメリット

AWSのLambda FunctionとS３を使って実践

Lambda Function 1の作成

Lambda Function 1の実行

Lambda Function 2の作成

Lambda FunctionをServerless Frameworkとして設定

Serverless Frameworkでインフラリソースの管理

Lambda FunctionをServerless Frameworkでデプロイ

Serverless Frameworkの動作確認

まとめ

浅岡 慎也

RELATED POSTS

IAM Identity Center(AWS SSO)に移行して1年たったので使い方などまとめる

AWSマネージドデータベースとは？利点と気をつけたいことまとめ

Aurora Serverlessを実際に使ってみたメリットとデメリット

高級キーボードってどうなの

浅岡慎也