教程：部署无服务器应用程序

在 CodeCatalyst 的导航窗格中，选择代码，然后选择源存储库。

选择添加存储库，然后选择创建存储库。

在存储库名称中，输入：

codecatalyst-cfn-source-repository

选择创建。

按如下步骤操作，为角色创建策略：

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. 选择下一步：标签。

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. 打开 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. 选择下一步：标签。

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. 在导航窗格中，选择角色。

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. 选择下一步。

9. 对于角色名称，输入：

   codecatalyst-stack-role

10. 选择创建角色。

按如下步骤操作，获取堆栈角色的 ARN：

1. 在导航窗格中，选择角色。

2. 在搜索框中，输入刚创建的角色的名称（codecatalyst-stack-role）。

3. 从列表中选择该角色。

4. 在摘要部分中，复制 ARN 值。稍后您将需要用到它。

现在，您已创建具有相应权限的堆栈角色并已获取其 ARN。

在 CodeCatalyst 中，导航到您的空间。

选择 AWS accounts (账户)。此时将显示账户连接列表。

选择代表您在其中创建构建角色和部署角色的 AWS 账户的账户连接。

选择在 AWS 管理控制台中管理角色。

这将显示将 IAM 角色添加到 Amazon CodeCatalyst 空间页面。您可能需要登录才能访问该页面。

选择添加您在 IAM 中创建的现有角色。

这将显示一个下拉列表。该列表显示所有具有包含 codecatalyst-runner.amazonaws.com 和 codecatalyst.amazonaws.com 服务主体的信任策略的 IAM 角色。

在该下拉列表中，选择 codecatalyst-build-role，然后选择添加角色。

选择添加 IAM 角色，再选择添加您在 IAM 中创建的现有角色，然后在下拉列表中选择 codecatalyst-deploy-role。选择 Add role (添加角色)。

现在，您已将构建角色和部署角色添加到您的空间。

复制 Amazon CodeCatalyst 显示名称的值。您稍后在创建工作流时将需要此值。

通过以下网址打开 Simple Storage Service（Amazon S3）控制台：https://console.aws.amazon.com/s3/。

在主窗格中，选择创建存储桶。

对于存储桶名称，输入：

codecatalyst-cfn-s3-bucket

对于 AWS Region（亚马逊云科技区域），选择一个区域。本教程假设您选择了美国西部（俄勒冈州）us-west-2。有关 Amazon S3 支持的区域的信息，请参阅《AWS 一般参考》中的 Amazon Simple Storage Service endpoints and quotas。

在页面底部选择创建存储桶。

通过访问 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");
    });
});

选择提交，然后再次选择提交。

现在，您已将名为 test-handler.js 的文件添加到 hello-world/tests/unit 文件夹下。

在导航窗格中，选择 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 代码在提交之前有效。

选择提交。

在提交工作流对话框中，输入以下内容：

1. 对于工作流文件名，保留默认值 codecatalyst-cfn-workflow。

2. 对于提交消息，输入：

   add initial workflow file

3. 对于存储库，选择 codecatalyst-cfn-source-repository。

4. 对于分支名称，选择主。

5. 选择提交。

现在，您已创建工作流。由于在工作流顶部定义了触发器，因此工作流运行会自动启动。具体而言，当您将 codecatalyst-cfn-workflow.yaml 文件提交（并推送）到源存储库时，触发器启动了工作流运行。

在导航窗格中，选择 CI/CD，然后选择工作流。

选择您刚刚创建的工作流：codecatalyst-cfn-workflow。

选择运行选项卡。

在运行 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 Gateway 控制台：https://console.aws.amazon.com/apigateway/。

观察 AWS SAM 模板创建的 codecatalyst-cfn-stack API。API 名称来自工作流定义文件（codecatalyst-cfn-workflow.yaml）中的 Configuration/name 值。

通过 https://console.aws.amazon.com/lambda/ 打开 AWS 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. 打开 AWS CloudFormation 控制台，地址：https://console.aws.amazon.com/cloudformation。

2. 删除codecatalyst-cfn-stack。

   删除堆栈将从 API Gateway 和 Lambda 服务中移除所有教程资源。

在 Amazon S3 中进行清理，如下所示：

1. 通过以下网址打开 Simple Storage Service（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。