Zenn
⛑️

Serverless Frameworkの基本的な使い方

2023/04/19に公開
AWS
Serverless Framework
tech

Serverless Framework

概念

Serverless Frameworkは、LambdaをメインとするインフラリソースをデプロイするためのCLI。
functionsセクションを利用し、Lambda本体とLambdaがトリガーをするイベントを定義。
resourceセクションでは、CloudFormationの構文を利用してインフラを定義。
デプロイはCloudFormationを使用して行われるため、デプロイイベントをCloudFormationのコンソール画面で確認可能。
プラグインを使用して機能を追加、上書きが可能。
AWS以外にも、AzureやGoogleなどのクラウドプロバイダーをサポート。
デプロイは、serverless.ymlをCloudFormationのテンプレートへ変換、ソースコードや依存関係ファイルをZipファイルにして実行。
S3にスタックの状態を保存するためのファイルを格納。

インストール

npmパッケージがインストールされている環境で、以下のコマンドを実行。

npm install -g serverless

installコマンドの-gオプションは--globalと同じ。
パスが通った状態になり、どのディレクトリからも実行可能。

which serverless

#結果
/usr/local/bin/serverless

実行環境となるサービスを作成。
サービスはフレームワークの単位であり、複数のサービスをオーケストレーションすることも可能。

serverless コマンドはslsと省略可能。

コマンド 役割
serverless create
(sls create)		 サービスの作成。
--template (-t) テンプレートの指定。ランタイムごとにテンプレートが用意されており、aws-python3はPython3.9。
自動でserverless.ymlとhandlerファイルが生成されるが、後からランタイムの修正可能。
--name (-n) サービス名。
--path (-p) サービスを作成するパス。 
serverless create --template aws-python3 --name abetest-service --path abetest

サービスを作成すると、ディレクトリに必要なファイルを自動で生成。

ファイル名 役割
handler テンプレートで指定したランライムで作成。Lambdaのソースコードを定義。
.gitignore. コミットの際に対象から外すファイルを指定。

serverless.yml

役割

  • サービスの宣言。
  • サービスを展開するクラウドサービスの定義。
  • 1つ以上の関数を定義。
  • 各機能のトリガーとなるイベント(HTTPリクエストなど)の定義。
  • 使用するプラグインの定義。
  • 作成するAWSリソースのセットを定義。
  • イベントセクションにリストされたイベントが、デプロイ時にそのイベントに必要なリソースを自動的に作成。
  • 変数による柔軟な設定。

構成

セクション 役割
service サービスの宣言。
frameworkVersion バージョンの指定。
provider アカウントのセットアップ。
name ：使用するクラウドサービス。.awsディレクトリの認証情報を参照。
runtime ：使用するプログラミング言語を指定。
stage ： デプロイする環境。デフォルトはdev
region ： デプロイするリージョン。デフォルトはus-east-1。
profile ： 認証情報を参照するユーザーの切り替え。
memorySize ：Lambdaで使用するメモリの指定。デフォルトは1024MB。
package ソースコードに含めるデータをpatternsパラメータで定義。
含めるデータは、ファイル名をそのまま入力。含めないデータは、ファイル名の前に!をつける。
ディレクトリ配下のデータ全ての場合は/**を使用。
function 作成するLambdaとAPI Gatewayのパラメータ。
resouce 作成するリソースのパラメータ。 CloudFormationと同じ構文を使用。

serverless.ymlの例

service: users
frameworkVersion: '3'
provider:
  name: aws
  runtime: python3.9
  stage: prod               #デフォルトはdev。
  region: us-east-2     #デフォルトはus-east-1。
  profile: shintaro      #認証情報にあるデフォルト以外のユーザーでデプロイする場合に指定。
  memorySize: 512    #MB単位で指定。デフォルトは1024MB。Lambdaに合わせて、必要なサイズを指定可能。

package:                     #ディレクトリにあるファイルはデフォルトで含まれるため、ソースコードは指定不要。
  patterns:
    - '!node_modules/**'
    - '!buildspec.yml'
    - '!package.json'
    - '!package-lock.json'

構築

デフォルトのLambda関数をデプロイ。

serverless.yml

service: abetest

frameworkVersion: '3'

provider:
  name: aws
  runtime: python3.9
  region: ap-northeast-1

functions:
  hello:
    handler: handler.hello

handler.py

import json


def hello(event, context):
    body = {
        "message": "Go Serverless v1.0! Your function executed successfully!",
        "input": event
    }

    response = {
        "statusCode": 200,
        "body": json.dumps(body)
    }

    return response

    # Use this code if you don't use the http event with the LAMBDA-PROXY
    # integration
    """
    return {
        "message": "Go Serverless v1.0! Your function executed successfully!",
        "event": event
    }
    """

デプロイは以下のコマンドを使用。

serverless deploy

.severlessディレクトリを生成。

ファイル 役割
cloudformation-template-create-stack.json アーティファクトを格納するS3をCloudFormationで作成するテンプレート。
cloudformation-template-update-stack.json Cloudformationを使用してデプロイするスタックのテンプレート。
serverless-state.json CloudFormationのテンプレートへ変換するためのデータ。
abetest.zip ソースコードの圧縮ファイル。

Lambda関数を作成。
関数名は、サービス-ステージ-Lambdaの論理IDを付与。

CloudFormationを使用しているため、コンソールでスタックを表示。

スタックの状態を保存するためのServerlessDeploymentBucketを生成。
serverless removeコマンドでサービスを削除する場合、このバケットも削除の対象。
テンプレートのproviderセクションにdeploymentBucketパラメータを設け、nameでバケットを指定可能。
バケットを自動で生成する必要がないため、cloudformation-template-create-stack.jsonが.serverlessディレクトリから消える。
データはデフォルトで5回のデプロイまで保存され、それより古いものは自動で削除。maxPreviousDeploymentArtifactsで変更可能。

provider:
  deploymentBucket:
    name: abetest-deploymentbucket
    maxPreviousDeploymentArtifacts: 10

サービスの削除は以下のコマンドを使用。

serverless remove

StepFunctionsによるAWS請求額通知

毎日12時にEventbridgeでAWSの請求額を取得するLambda関数を起動させ、SNSから通知メールを送信するシステム。
Serverless Frameworkを使用するので、あえてStepFunctionsを使用して構築。

対応するコードはGitHubに公開しています！

https://github.com/Shintaro-Abe/serverless-practice.git

serverless stepfunctionsプラグインをインストール。
尚、resourceセクションにCloudFormation構文で記述する方法でも作成可能。

sudo npm install --save-dev serverless-step-functions

serverless.yml 【part.1】

  • providerセクションにLambdaの実行ロールを定義。
    CloudWatch Logsのポリシーは自動的に付与。他にアタッチするポリシーを記述。
    ロググループを自動で生成。
  • stepFunctionsセクションでEventBridgeを定義。
    stepFunctionsセクションで作成すると、実行に必要なポリシーをアタッチしたロールを自動で作成。
    EventBridgeが使用するロールはresourceセクションで定義が必要。
    ロググループはresourceセクションで定義が必要。stepFunctionsセクションで関連付けを行うと、必要なポリシーを自動でアタッチ。

Serverless Frameworkの機能を活用した方が、テンプレートに記述する量が少ない。

自動で付与されるポリシー

サービス ポリシー
Lambda logs:CreateLogStream
logs:CreateLogGroup
logs:TagResource
logs:PutLogEvents
StepFunctions 実行に必要なポリシー。

https://github.com/Shintaro-Abe/serverless-practice/blob/37871ad2b5a40a1a8a2db5ce4bc9848082da338b/sources/serverless-part1.yml

serverless.yml 【part.2】

LambdaとStepFunctions以外のリソースをresourceセクションで作成。

https://github.com/Shintaro-Abe/serverless-practice/blob/37871ad2b5a40a1a8a2db5ce4bc9848082da338b/sources/serverless-part2.yml

cost.py

Developers IO 藤井元貴さん作成のapp.pyを参考にさせていただきました。

https://github.com/Shintaro-Abe/serverless-practice/blob/37871ad2b5a40a1a8a2db5ce4bc9848082da338b/sources/cost.py

まとめ

LambdaやStepFunctionsはServerless Frameworkで定義すると、ロールやトリガーなどの管理がしやすい。
様々なプラグインを試してみて、開発の引き出しを増やしていきたい。

GitHubで編集を提案

Discussion