チュートリアル: サーバーレスアプリケーションをデプロイする

ナビゲーションペインの CodeCatalyst で [コード] を選択してから、[ソースリポジトリ] を選択します。

[リポジトリの追加] を選択し、[リポジトリの作成] を選択します。

[リポジトリ名] に次のように入力します。

codecatalyst-cfn-source-repository

[Create] (作成) を選択します。

ロールのポリシーを以下の手順で作成します。

1. AWS にサインインします。

2. IAM コンソール (https://console.aws.amazon.com/iam/) を開きます。

3. ナビゲーションペインで、ポリシー を選択します。

4. [ポリシーの作成] を選択します。

5. [JSON] タブを選択します。

6. 既存のコードを削除します。

7. 次のコードを貼り付けます。

   {
       "Version": "2012-10-17",
       "Statement": [{
       "Action": [
           "cloudformation:CreateStack",
           "cloudformation:DeleteStack",
           "cloudformation:Describe*",
           "cloudformation:UpdateStack",
           "cloudformation:CreateChangeSet",
           "cloudformation:DeleteChangeSet",
           "cloudformation:ExecuteChangeSet",
           "cloudformation:SetStackPolicy",
           "cloudformation:ValidateTemplate",
           "cloudformation:List*",
           "iam:PassRole"
       ],
       "Resource": "*",
       "Effect": "Allow"
   }]
   }

   注記

   ロールがワークフローアクションの実行に初めて使用されるときは、リソースポリシーステートメントでワイルドカードを使用し、利用可能になった後にリソース名でポリシーの範囲を絞り込みます。

   "Resource": "*"

8. [Next: Tags] (次へ: タグ) を選択します。

9. [次へ: レビュー] を選択します。

10. [名前] に次のように入力します。

    codecatalyst-deploy-policy

11. [ポリシーの作成] を選択します。

    これで、アクセス許可ポリシーが作成されました。

次のようにデプロイロールを作成します。

1. ナビゲーションペインで ロール を選択してから、ロールを作成する を選択します。

2. [カスタム信頼ポリシー] を選択します。

3. 既存のカスタム信頼ポリシーを削除します。

4. 次の信頼ポリシーを追加します。

   {
       "Version": "2012-10-17",
       "Statement": [
           {
               "Sid": "",
               "Effect": "Allow",
               "Principal": {
                   "Service":  [
                      "codecatalyst-runner.amazonaws.com",
                      "codecatalyst.amazonaws.com"
                    ]
               },
               "Action": "sts:AssumeRole"
           }
       ]
   }

5. [Next] を選択します。

6. [アクセス許可ポリシー] で codecatalyst-deploy-policy を検索し、チェックボックスをオンにします。

7. [Next] を選択します。

8. [ロール名] には、次のように入力します。

   codecatalyst-deploy-role

9. [ロールの説明] には、次のように入力します。

   CodeCatalyst deploy role

10. [ロールの作成] を選択します。

これで、信頼ポリシーとアクセス許可ポリシーを使用してデプロイロールが作成されました。

デプロイロール ARN を次のように取得します。

1. ナビゲーションペインで Roles (ロール) を選択します。

2. 検索ボックスに、作成したロールの名前 (codecatalyst-deploy-role) を入力します。

3. 使用するロールを一覧から選択します。

   ロールの [概要] ページが表示されます。

4. 上部で、[ARN] 値をコピーします。

これで、適切なアクセス許可を持つデプロイロールを作成し、ARN を取得しました。

ロールのポリシーを以下の手順で作成します。

1. AWS にサインインします。

2. IAM コンソール (https://console.aws.amazon.com/iam/) を開きます。

3. ナビゲーションペインで、ポリシー を選択します。

4. [ポリシーの作成] を選択します。

5. [JSON] タブを選択します。

6. 既存のコードを削除します。

7. 次のコードを貼り付けます。

   {
       "Version": "2012-10-17",
       "Statement": [{
       "Action": [
           "s3:PutObject",
           "iam:PassRole"
       ],
       "Resource": "*",
       "Effect": "Allow"
   }]
   }

   注記

   ロールがワークフローアクションの実行に初めて使用されるときは、リソースポリシーステートメントでワイルドカードを使用し、利用可能になった後にリソース名でポリシーの範囲を絞り込みます。

   "Resource": "*"

8. [Next: Tags] (次へ: タグ) を選択します。

9. [次へ: レビュー] を選択します。

10. [名前] に次のように入力します。

    codecatalyst-build-policy

11. [ポリシーの作成] を選択します。

    これで、アクセス許可ポリシーが作成されました。

次のようにビルドロールを作成します。

1. ナビゲーションペインで ロール を選択してから、ロールを作成する を選択します。

2. [カスタム信頼ポリシー] を選択します。

3. 既存のカスタム信頼ポリシーを削除します。

4. 次の信頼ポリシーを追加します。

   {
       "Version": "2012-10-17",
       "Statement": [
           {
               "Sid": "",
               "Effect": "Allow",
               "Principal": {
                   "Service":  [
                      "codecatalyst-runner.amazonaws.com",
                      "codecatalyst.amazonaws.com"
                    ]
               },
               "Action": "sts:AssumeRole"
           }
       ]
   }

5. [Next] を選択します。

6. [アクセス許可ポリシー] で codecatalyst-build-policy を検索し、チェックボックスをオンにします。

7. [Next] を選択します。

8. [ロール名] には、次のように入力します。

   codecatalyst-build-role

9. [ロールの説明] には、次のように入力します。

   CodeCatalyst build role

10. [ロールの作成] を選択します。

これで、信頼ポリシーとアクセス許可ポリシーを使用してビルドロールが作成されました。

次のようにビルドロール ARN を取得します。

1. ナビゲーションペインで Roles (ロール) を選択します。

2. 検索ボックスに、作成したロールの名前 (codecatalyst-build-role) を入力します。

3. 使用するロールを一覧から選択します。

   ロールの [概要] ページが表示されます。

4. 上部で、[ARN] 値をコピーします。

これで、適切なアクセス許可を持つビルドロールを作成し、その ARN を取得しました。

スタックをデプロイするアカウントを使用して AWS にサインインします。

IAM コンソール (https://console.aws.amazon.com/iam/) を開きます。

次のようにスタックロールを作成します。

1. ナビゲーションペインで Roles (ロール) を選択します。

2. [ロールの作成] を選択します。

3. [AWS サービス] を選択してください。

4. [ユースケース] セクションで、ドロップダウンリストから [CloudFormation] を選択します。

5. [CloudFormation] ラジオボタンを選択します。

6. 下部で、[次へ] を選択します。

7. 検索ボックスを使用して、次のアクセス許可ポリシーを検索し、それぞれのチェックボックスをオンにします。

   注記

   ポリシーを検索してもポリシーが表示されない場合は、[フィルターをクリア] を選択して再試行してください。

   • CloudWatchFullAccess

   • AWSCloudFormationFullAccess

   • IAMFullAccess

   • AWSLambda_FullAccess

   • AmazonAPIGatewayAdministrator

   • AmazonS3FullAccess

   • AmazonEC2ContainerRegistryFullAccess

   最初のポリシーでは、CloudWatch へのアクセスを許可し、アラームが発生したときにスタックのロールバックを有効にします。

   残りのポリシーでは、 このチュートリアルでデプロイされるスタック内のサービスとリソースに AWS SAM がアクセスできるようになります。詳細については、「AWS Serverless Application Model デベロッパーガイド」の「アクセス許可」を参照してください。

8. [Next] を選択します。

9. [ロール名] には、次のように入力します。

   codecatalyst-stack-role

10. [ロールの作成] を選択します。

次のように、スタックロールの ARN を取得します。

1. ナビゲーションペインで Roles (ロール) を選択します。

2. 検索ボックスに、作成したロールの名前 (codecatalyst-stack-role) を入力します。

3. 使用するロールを一覧から選択します。

4. [概要] セクションの [ARN] 値をコピーします。これは、後で必要になります。

これで、適切なアクセス許可を持つスタックロールを作成し、ARN を取得しました。

CodeCatalyst で、スペースに移動します。

[AWS アカウント] を選択します。アカウント接続が一覧表示されます。

ビルドロールとデプロイロールを作成したアカウントを表す AWS アカウント接続を選択します。

[AWS 管理コンソールからロールの管理] を選択します。

[Amazon CodeCatalyst スペースに IAM ロールの追加] ページが表示されます。ページにアクセスするには、サインインが必要な場合があります。

[IAM で作成した既存のロールを追加] を選択します。

ドロップダウンリストが表示されます。この一覧表示には、codecatalyst-runner.amazonaws.com および codecatalyst.amazonaws.com サービスプリンシパルを含む信頼ポリシーを持つすべての IAM ロールが表示されます。

ドロップダウンリストで [codecatalyst-build-role] を選択し、[ロールを追加] を選択します。

[IAM ロールを追加] を選択し、[IAM で作成した既存のロールを追加] を選択し、ドロップダウンリストから [codecatalyst-deploy-role] を選択します。[Add role] を選択します。

これで、ビルドロールとデプロイロールをスペースに追加しました。

[Amazon CodeCatalyst 表示名] の値をコピーします。この値は、ワークフローを作成するときに後で必要になります。

https://console.aws.amazon.com/s3/ で Amazon S3 コンソールを開きます。

メインペインで、[バケットを作成] を選択します。

[バケット名] に、次のように入力します。

codecatalyst-cfn-s3-bucket

[AWS リージョン] で、リージョンを選択します。このチュートリアルは、[米国西部 (オレゴン) us-west-2] を選択していることを前提としています。Amazon S3 がサポートしているリージョンについては、「AWS 全般のリファレンス」の「Amazon Simple Storage Service エンドポイントとクォータ」を参照してください。

ページ下部にある [バケットを作成] ボタンを選択します。

https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

プロジェクト「codecatalyst-cfn-project」を選択します。

ナビゲーションペインで [コード] を選択してから、[ソースリポジトリ] を選択します。

ソースリポジトリのリストから、リポジトリ「codecatalyst-cfn-source-repository」を選択します。

[ファイル] で、[ファイルを作成] を選択します。

[ファイル名] に次のように入力します。

.npmignore

テキストボックスに次のコードを入力します。

tests/*

[コミット] を選択し、再度 [コミット] を選択します。

これで、リポジトリのルートに .npmignore という名前のファイルが作成されました。

リポジトリの [ファイル] で、[ファイルを作成] を選択します。

[ファイル名] に次のように入力します。

package.json

テキストボックスに次のコードを入力します。

{
  "name": "hello_world",
  "version": "1.0.0",
  "description": "hello world sample for NodeJS",
  "main": "app.js",
  "repository": "https://github.com/awslabs/aws-sam-cli/tree/develop/samcli/local/init/templates/cookiecutter-aws-sam-hello-nodejs",
  "author": "SAM CLI",
  "license": "MIT",
  "dependencies": {
    "axios": "^0.21.1",
    "nyc": "^15.1.0"
  },
  "scripts": {
    "test": "nyc --reporter=clover mocha hello-world/tests/unit/ --reporter xunit --reporter-option output=junit.xml"
  },
  "devDependencies": {
    "aws-sdk": "^2.815.0",
    "chai": "^4.2.0",
    "mocha": "^8.2.1"
  }
}

[コミット] を選択し、再度 [コミット] を選択します。

これで、リポジトリのルートに「package.json」という名前のファイルが追加されました。

リポジトリの [ファイル] で、[ファイルを作成] を選択します。

[ファイル名] に次のように入力します。

sam-template.yml

テキストボックスに次のコードを入力します。

AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: >
  serverless-api

  Sample SAM Template for serverless-api
  
# More info about Globals: https://github.com/awslabs/serverless-application-model/blob/master/docs/globals.rst
Globals:
  Function:
    Timeout: 3

Resources:
  HelloWorldFunction:
    Type: AWS::Serverless::Function # For details on this resource type, see https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
    Properties:
      CodeUri: hello-world/
      Handler: app.lambdaHandler
      Runtime: nodejs12.x
      Events:
        HelloWorld:
          Type: Api # For details on this event source type, see https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api
          Properties:
            Path: /hello
            Method: get

Outputs:
  # ServerlessRestApi is an implicit API created out of the events key under Serverless::Function
  # Find out about other implicit resources you can reference within AWS SAM at
  # https://github.com/awslabs/serverless-application-model/blob/master/docs/internals/generated_resources.rst#api
  HelloWorldApi:
    Description: "API Gateway endpoint URL for the Hello World function"
    Value: !Sub "https://${ServerlessRestApi}.execute-api.${AWS::Region}.amazonaws.com/Prod/hello/"
  HelloWorldFunction:
    Description: "Hello World Lambda function ARN"
    Value: !GetAtt HelloWorldFunction.Arn
  HelloWorldFunctionIamRole:
    Description: "Implicit Lambda execution role created for the Hello World function"
    Value: !GetAtt HelloWorldFunctionRole.Arn

[コミット] を選択し、再度 [コミット] を選択します。

これで、リポジトリのルートフォルダに「sam-template.yml」という名前のファイルが追加されました。

リポジトリの [ファイル] で、[ファイルを作成] を選択します。

[ファイル名] に次のように入力します。

setup-sam.sh

テキストボックスに次のコードを入力します。

#!/usr/bin/env bash
echo "Setting up sam"

yum install unzip -y

curl -LO https://github.com/aws/aws-sam-cli/releases/latest/download/aws-sam-cli-linux-x86_64.zip
unzip -qq aws-sam-cli-linux-x86_64.zip -d sam-installation-directory

./sam-installation-directory/install; export AWS_DEFAULT_REGION=us-west-2

上記のコードでは、[us-west-2] を AWS リージョンに置き換えます。

[コミット] を選択し、再度 [コミット] を選択します。

これで、リポジトリのルートに「setup-sam.sh」という名前のファイルが追加されました。

リポジトリの [ファイル] で、[ファイルを作成] を選択します。

[ファイル名] に次のように入力します。

hello-world/app.js

テキストボックスに次のコードを入力します。

// const axios = require('axios')
// const url = 'http://checkip.amazonaws.com/';
let response;

/**
 *
 * Event doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format
 * @param {Object} event - API Gateway Lambda Proxy Input Format
 *
 * Context doc: https://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-context.html 
 * @param {Object} context
 *
 * Return doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html
 * @returns {Object} object - API Gateway Lambda Proxy Output Format
 * 
 */
exports.lambdaHandler = async (event, context) => {
    try {
        // const ret = await axios(url);
        response = {
            'statusCode': 200,
            'body': JSON.stringify({
                message: 'hello world',
                // location: ret.data.trim()
            })
        }
    } catch (err) {
        console.log(err);
        return err;
    }

    return response
};

[コミット] を選択し、再度 [コミット] を選択します。

これで、「hello-world」というフォルダと「app.js」というファイルが作成されました。

リポジトリの [ファイル] で、[ファイルを作成] を選択します。

[ファイル名] に次のように入力します。

hello-world/tests/unit/test-handler.js

テキストボックスに次のコードを入力します。

'use strict';

const app = require('../../app.js');
const chai = require('chai');
const expect = chai.expect;
var event, context;

describe('Tests index', function () {
    it('verifies successful response', async () => {
        const result = await app.lambdaHandler(event, context)

        expect(result).to.be.an('object');
        expect(result.statusCode).to.equal(200);
        expect(result.body).to.be.an('string');

        let response = JSON.parse(result.body);

        expect(response).to.be.an('object');
        expect(response.message).to.be.equal("hello world");
        // expect(response.location).to.be.an("string");
    });
});

[コミット] を選択し、再度 [コミット] を選択します。

これで、hello-world/tests/unit フォルダの下位に「test-handler.js」というファイルが追加されました。

ナビゲーションペインで [CI/CD]、[ワークフロー] の順に選択します。

[ワークフローを作成] を選択します。

[ソースリポジトリ] で、codecatalyst-cfn-source-repository を選択します。

[ブランチ] で、main を選択します。

[Create] (作成) を選択します。

YAML サンプルコードを削除します。

次の YAML コードを追加します。

Name: codecatalyst-cfn-workflow
SchemaVersion: 1.0

Triggers:
  - Type: PUSH
    Branches:
      - main   
Actions:
  Test:
    Identifier: aws/managed-test@v1
    Inputs:
      Sources:
        - WorkflowSource
    Outputs:
      Reports:
        CoverageReport:
          Format: CLOVERXML
          IncludePaths:
            - "coverage/*"
        TestReport:
          Format: JUNITXML
          IncludePaths:
            - junit.xml
    Configuration:
      Steps:
        - Run: npm install
        - Run: npm run test  
  BuildBackend:
    Identifier: aws/build@v1
    DependsOn:
      - Test
    Environment:
      Name: codecatalyst-cfn-environment
      Connections:
        - Name: codecatalyst-account-connection
          Role: codecatalyst-build-role
    Inputs:
      Sources:
        - WorkflowSource
    Configuration: 
      Steps:
        - Run: . ./setup-sam.sh
        - Run: sam package --template-file sam-template.yml --s3-bucket codecatalyst-cfn-s3-bucket --output-template-file sam-template-packaged.yml --region us-west-2
    Outputs:
      Artifacts:
        - Name: buildArtifact
          Files:
            - "**/*"
  DeployCloudFormationStack:
    Identifier: aws/cfn-deploy@v1
    DependsOn: 
      - BuildBackend
    Environment:
      Name: codecatalyst-cfn-environment
      Connections:
        - Name: codecatalyst-account-connection
          Role: codecatalyst-deploy-role
    Inputs:
      Artifacts:
        - buildArtifact
      Sources: []
    Configuration:
      name: codecatalyst-cfn-stack
      region: us-west-2
      role-arn: arn:aws:iam::111122223333:role/StackRole
      template: ./sam-template-packaged.yml
      capabilities: CAPABILITY_IAM,CAPABILITY_AUTO_EXPAND

上記のコードで置き換えます。

前述のコードのプロパティの詳細については、「「AWS CloudFormation スタックをデプロイ」アクション YAML」を参照してください。

(オプション) [検証] を選択して、コミットする前に YAML コードが有効であることを確認します。

[Commit] (コミット) を選択します。

[ワークフローをコミット] ダイアログボックスで、次のように入力します。

1. [ワークフローファイル名] の場合、デフォルトの「codecatalyst-cfn-workflow」のままにします。

2. [コミットメッセージ] には、次のように入力します。

   add initial workflow file

3. [リポジトリ] で、[codecatalyst-cfn-source-repository] を選択します。

4. [ブランチ名] で、[main] を選択します。

5. [Commit] (コミット) を選択します。

これでワークフローが作成されました。ワークフローの先頭で定義されているトリガーにより、ワークフローの実行が自動的に開始されます。具体的には、codecatalyst-cfn-workflow.yaml ファイルをソースリポジトリにコミット (およびプッシュ) すると、トリガーによってワークフローの実行が開始します。

ナビゲーションペインで [CI/CD]、[ワークフロー] の順に選択します。

先ほど作成したワークフロー「codecatalyst-cfn-workflow」を選択します。

[実行] タブを選択します。

[Run ID] 列で、実行 ID を選択します。

[Test] を選択して、テストの進行状況を確認します。

[BuildBackend] を選択すると、ビルドの進行状況が表示されます。

[DeployCloudFormationStack] を選択してデプロイの進行状況を確認します。

実行の詳細を表示する方法については、「ワークフロー実行のステータスと詳細の表示」を参照してください。

[DeployCloudFormationStack] アクションが完了したら、以下を実行します。

デプロイが成功したら、上部付近の水平メニューバーから [変数 (7)] を選択します。(右側のペインで [変数] を選択しないでください)。

[HelloWorldApi] の横にある https:// URL をブラウザに貼り付けます。

Lambda 関数からの [hello world] JSON メッセージが表示され、ワークフローが Lambda 関数と API Gateway を正常にデプロイおよび設定したことを示します。

ワークフロー図で、[Test] を選択し、[Reports] を選択します。

[TestReport] を選択してユニットテスト結果を表示するか、[CoverageReport] を選択してテスト対象のファイルのコードカバレッジの詳細を表示します。この場合、app.js と test-handler.js です。

AWS Management Console にサインインし、API Gateway コンソール https://console.aws.amazon.com/apigateway/ を開きます。

AWS SAM テンプレートが作成した [codecatalyst-cfn-stack] API を確認します。API 名は、ワークフロー定義ファイル (codecatalyst-cfn-workflow.yaml) の Configuration/name の値から取得します。

AWS Lambda コンソールを (https://console.aws.amazon.com/lambda/) 開きます。

ナビゲーションペインで、[Functions] (関数) を選択します。

Lambda 関数「codecatalyst-cfn-stack-HelloWorldFunction-string」を選択します。

API Gateway が 関数のトリガーであることを確認できます。この統合は、AWS SAM AWS::Serverless::Function リソースタイプによって自動的に設定されました。

CodeCatalyst で、プロジェクトに移動します。

ナビゲーションペインで [コード] を選択してから、[ソースリポジトリ] を選択します。

ソースリポジトリ「codecatalyst-cfn-source-repository」を選択します。

アプリケーションファイルを変更します。

1. hello-world フォルダを選択します。

2. app.js ファイルを選択します。

3. [編集] を選択します。

4. 行 23 において、hello world を Tutorial complete! に変更します。

5. [コミット] を選択し、再度 [コミット] を選択します。

   コミットにより、ワークフローの実行が開始します。名前の変更を反映するようにユニットテストを更新していないため、この実行は失敗します。

ユニットテストを更新します。

1. [hello-world\tests\unit\test-handler.js] を選択します。

2. [編集] を選択します。

3. 行 19 において、hello world を Tutorial complete! に変更します。

4. [コミット] を選択し、再度 [コミット] を選択します。

   コミットにより、もう 1 つのワークフローの実行が開始します。この実行は成功します。

ナビゲーションペインで [CI/CD]、[ワークフロー] の順に選択します。

[codecatalyst-cfn-workflow] を選択し、[実行] を選択します。

最新の実行の実行 ID を選択します。この時点では実行中です。

[Test]、[BuildBackend]、[DeployCloudFormationStack] を選択し、ワークフローの実行の進行状況を確認します。

ワークフローが完了したら、上部の近くの [変数 (7)] を選択します。

[HelloWorldApi] の横にある https:// URL をブラウザに貼り付けます。

Tutorial complete! メッセージがブラウザに表示されます。これは、アプリケーションが正常にデプロイされたことを示しています。

https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

codecatalyst-cfn-workflow を削除します。

codecatalyst-cfn-environment を削除します。

codecatalyst-cfn-source-repository を削除します。

codecatalyst-cfn-project を削除します。

CloudFormation で次のようにクリーンアップします。

1. https://console.aws.amazon.com/cloudformation で AWS CloudFormation コンソール を開きます。

2. codecatalyst-cfn-stack を削除します。

   スタックを削除すると、API Gateway および Lambda サービスからすべてのチュートリアルリソースが削除されます。

Amazon S3 で次のようにクリーンアップします。

1. https://console.aws.amazon.com/s3/ で Amazon S3 コンソールを開きます。

2. [codecatalyst-cfn-s3-bucket] を選択します。

3. バケットのコンテンツを削除します。

4. バケットを削除します。

IAM で次のようにクリーンアップします。

1. IAM コンソール (https://console.aws.amazon.com/iam/) を開きます。

2. codecatalyst-deploy-policy を削除します。

3. codecatalyst-build-policy を削除します。

4. codecatalyst-stack-policy を削除します。

5. codecatalyst-deploy-role を削除します。

6. codecatalyst-build-role を削除します。

7. codecatalyst-stack-role を削除します。