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

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

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

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

codecatalyst-cfn-source-repository

[作成] を選択します。

次のように、ロールのポリシーを作成します。

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

2. https://console.aws.amazon.com/iam/ で 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. [次へ: タグ] を選択します。

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. [次へ] をクリックします。

6. アクセス許可ポリシー で、そのチェックボックスを検索codecatalyst-deploy-policyして選択します。

7. [次へ] をクリックします。

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

   codecatalyst-deploy-role

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

   CodeCatalyst deploy role

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

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

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

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

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

3. リストからロールを選択します。

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

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

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

次のように、ロールのポリシーを作成します。

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

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

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

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

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

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

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

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

   注記

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

   "Resource": "*"

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

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. [次へ] をクリックします。

6. アクセス許可ポリシー で、そのチェックボックスを検索codecatalyst-build-policyして選択します。

7. [次へ] をクリックします。

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

   codecatalyst-build-role

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

   CodeCatalyst build role

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

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

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

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

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

3. リストからロールを選択します。

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

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

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

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

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

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

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

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

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

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

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

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

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

   注記

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

   • CloudWatchFullAccess

   • AWS CloudFormationFullAccess

   • IAMFullAccess

   • AWS Lambda_FullAccess

   • mazonAPIGateway管理者

   • AmazonS3FullAccess

   • AmazonEC2ContainerRegistryFullAccess

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

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

8. [次へ] をクリックします。

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

   codecatalyst-stack-role

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

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

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

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 表示名 の値をコピーします。この値は、後でワークフローを作成するときに必要になります。

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

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

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

codecatalyst-cfn-s3-bucket

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

ページの下部で、バケットの作成 を選択します。

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。

[作成] を選択します。

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. ブランチ名 で、メイン を選択します。

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

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

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

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

実行 タブを選択します。

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

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

ビルドの進行状況BuildBackendを表示するには、 を選択します。

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

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

DeployCloudFormationStack アクションが終了したら、次の操作を行います。

デプロイが成功したら、上部の横のメニューバーから可変 (7) を選択します。（右側のペインでは変数を選択しないでください）。

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

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

ワークフロー図で、テスト を選択し、レポート を選択します。

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

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

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

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

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

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. コミット を選択し、もう一度コミット を選択します。

   コミットにより、別のワークフロー実行が開始されます。この実行は成功します。

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

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

最新の実行の実行 ID を選択します。まだ進行中である必要があります。

テスト 、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ゲートウェイサービスと Lambda サービスからすべてのチュートリアルリソースが削除されます。

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

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

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

3. バケットの内容を削除します。

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

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

1. https://console.aws.amazon.com/iam/ で 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 を削除します。