Zenn
📘

serverless framework入門(Lambda,VPC,環境変数,IAM Role,S3)

2021/12/13に公開
tech

はじめに

serverless frameworkを使おうと思った時に、日本語の記事があまり見つからなかったので残します。

serverless framework https://www.serverless.com/

serverless offline https://github.com/dherault/serverless-offline

今回使用したソースコード https://github.com/goda-kazuki/try-serverless-framework

前提

AWS CLIが使えること

使ってみる

  1. serverless frameworkのインストール
npm install serverless
  1. 実行環境の作成
npx serverless create --template aws-nodejs
  1. serverless.ymlのリージョン変更
us-east-1
→ap-northeast-1
  1. デプロイしてみる
npx sls deploy

AWS側のCloudFormationが実行されます。

裏ではcloudFormationが実行される

serverless framework Lambdaデプロイ

  1. デプロイしたLambdaを実行してみる
npx serverless invoke --function hello

無事にリクエストが完了しました。

[try-serverless-framework]$ npx serverless invoke --function hello                                                                              +[main]
{
    "statusCode": 200,
    "body": "{\n  \"message\": \"Go Serverless v1.0! Your function executed successfully!\",\n  \"input\": {}\n}"
}

その他設定

環境変数の設定

各functionの下にenvironmentという記述をすれば、環境変数が設定されます。

functions:
  hello:
    handler: handler.hello
    environment:
      CONFIG: "CONFIGの内容"

ステージによって環境変数や名前を分けたい時

開発環境と本番環境で環境変数を分けたい時ってあると思いますが、そういった設定も可能です。

  1. configの中にdevとprdの環境設定ファイルを用意しておきます。 https://github.com/goda-kazuki/try-serverless-framework/tree/main/config

  2. stageの設定を行います。

stage: ${opt:stage, self:custom.defaultStage}
  1. 環境変数のファイルの場所を設定します。
custom:
  defaultStage: dev
  otherfile:
    environment:
      dev: ${file(./config/dev.yml)}
      prd: ${file(./config/prd.yml)}
  1. 環境変数指定している部分を書き換える
CONFIG: ${self:custom.otherfile.environment.${self:provider.stage}.CONFIG}
  1. デプロイします
npx sls deploy --stage prd

VPCに関連付けたい場合

サブネットとセキュリティグループを指定することで、VPCに関連付けることが出来ます。

  vpc:
    securityGroupIds:
      - ${self:custom.otherfile.environment.${self:provider.stage}.LAMBDA_VPC_SECURITY_GROUP}
    subnetIds:
      - ${self:custom.otherfile.environment.${self:provider.stage}.LAMBDA_VPC_SUBNET_ID}

IAM Roleの作成と紐付け

  1. resourceにIAM Roleを作成するように設定
resources:
  Resources:
    tryServerlessFrameworkLambdaRole:
      Type: AWS::IAM::Role
      Properties:
        RoleName: try-serverless-framework-${opt:stage, self:provider.stage}-lambdaRole
        AssumeRolePolicyDocument:
          Version: '2012-10-17'
          Statement:
            - Effect: Allow
              Principal:
                Service:
                  - lambda.amazonaws.com
              Action: sts:AssumeRole
        ManagedPolicyArns:
          - "arn:aws:iam::aws:policy/AmazonS3FullAccess"
          - "arn:aws:iam::aws:policy/AWSLambda_FullAccess"
          - "arn:aws:iam::aws:policy/AmazonRDSFullAccess"
          - "arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole"
          - "arn:aws:iam::aws:policy/service-role/AWSLambdaVPCAccessExecutionRole"
  1. 作成したRoleを使うように設定
provider:
  iam:
    role: tryServerlessFrameworkLambdaRole

S3バケットの作成

resources:
  Resources:
    Bucket:
      Type: AWS::S3::Bucket
      Properties:
        BucketName: try-serverless-framework-${opt:stage, self:provider.stage}-image-buckets

ローカルで開発したい場合(serverless-offline)

  1. serverless-offlineのインストール
npm install serverless-offline --save-dev
  1. serverless-offlineを使用するように記述
plugins:
  - serverless-offline
  1. serverless offline起動
npx serverless offline
  1. lambdaの実行
aws lambda invoke /dev/null --endpoint-url http://localhost:3002 --function-name try-serverless-framework-dev-hello

終わりに

今までは、コンソールでポチポチ設定していたものがコードで管理できるようになったので良かったです。 CloudFormationやterraformにもいつか挑戦してみたいです。

GitHubで編集を提案

Discussion