Amazon CodeCatalyst 不再向新客戶開放。現有客戶可以繼續正常使用該服務。如需詳細資訊，請參閱[如何從 CodeCatalyst 遷移](migration.md)。 本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # 教學課程：部署無伺服器應用程式 在本教學課程中，您將了解如何使用工作流程建置、測試和部署無伺服器應用程式做為 CloudFormation 堆疊。 本教學課程中的應用程式是一個簡單的 Web 應用程式，會輸出 'Hello World' 訊息。它包含 AWS Lambda 函數和 Amazon API Gateway，您可以使用 [AWS Serverless Application Model (AWS SAM)](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html) 建置它，這是 的延伸[CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html)。 **Topics** + [先決條件](#deploy-tut-lambda-cfn-prereqs) + [步驟 1：建立來源儲存庫](#deploy-tut-lambda-cfn-source) + [步驟 2：建立 AWS 角色](#deploy-tut-lambda-cfn-roles) + [步驟 3：將 AWS 角色新增至 CodeCatalyst](#deploy-tut-lambda-cfn-roles-add) + [步驟 4：建立 Amazon S3 儲存貯體](#deploy-tut-lambda-cfn-s3) + [步驟 5：新增來源檔案](#deploy-tut-lambda-cfn-files) + [步驟 6：建立和執行工作流程](#deploy-tut-lambda-cfn-workflow) + [步驟 7：進行變更](#deploy-tut-lambda-cfn-change) + [清除](#deploy-tut-lambda-cfn-clean-up) ## 先決條件 開始之前： + 您需要具有連線 AWS 帳戶的 CodeCatalyst **空間**。如需詳細資訊，請參閱[建立空間](spaces-create.md)。 + 在您的空間中，您需要一個名為 的空專案： ``` codecatalyst-cfn-project ``` 使用**從頭開始**選項來建立此專案。 如需詳細資訊，請參閱[在 Amazon CodeCatalyst 中建立空專案](projects-create.md#projects-create-empty)。 + 在專案中，您需要名為 的 CodeCatalyst **環境**： ``` codecatalyst-cfn-environment ``` 設定此環境，如下所示： + 選擇任何類型的，例如**非生產**。 + 將您的帳戶連接到該 AWS 帳戶。 + 針對**預設 IAM 角色**，選擇任何角色。稍後您將指定不同的角色。 如需詳細資訊，請參閱[部署至 AWS 帳戶 和 VPCs](deploy-environments.md)。 ## 步驟 1：建立來源儲存庫 在此步驟中，您會在 CodeCatalyst 中建立來源儲存庫。此儲存庫用於存放教學課程的來源檔案，例如 Lambda 函數檔案。 如需來源儲存庫的詳細資訊，請參閱 [建立來源儲存庫](source-repositories-create.md)。 **建立來源儲存庫** 1. 在 CodeCatalyst 的導覽窗格中，選擇**程式碼**，然後選擇**來源儲存庫**。 1. 選擇**新增儲存庫**，然後選擇**建立儲存庫**。 1. 在**儲存庫名稱**中，輸入： ``` codecatalyst-cfn-source-repository ``` 1. 選擇**建立**。 您現在已建立名為 的儲存庫`codecatalyst-cfn-source-repository`。 ## 步驟 2：建立 AWS 角色 在此步驟中，您會建立下列 AWS IAM 角色： + **部署角色** – 授予 CodeCatalyst **部署 CloudFormation 堆疊**動作許可，以存取您將部署無伺服器應用程式的 AWS 帳戶和 CloudFormation 服務。**部署 CloudFormation 堆疊**動作是工作流程的一部分。 + **組建角色** – 授予 CodeCatalyst 組建動作許可，以存取 AWS 您的帳戶並寫入 Amazon S3，其中將存放無伺服器應用程式套件。建置動作是工作流程的一部分。 + **堆疊角色** – 授予 CloudFormation 許可，以讀取和修改稍後將提供之 AWS SAM 範本中指定的資源。同時授予 CloudWatch 許可。 如需 IAM 角色的詳細資訊，請參閱*AWS Identity and Access Management 《 使用者指南*》中的 [IAM 角色](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)。 **注意** 若要節省時間，您可以建立稱為角色的單一`CodeCatalystWorkflowDevelopmentRole-spaceName`角色，而不是先前列出的三個角色。如需詳細資訊，請參閱[為您的帳戶和空間建立 **CodeCatalystWorkflowDevelopmentRole-*spaceName***角色](ipa-iam-roles.md#ipa-iam-roles-service-create)。了解該`CodeCatalystWorkflowDevelopmentRole-spaceName`角色具有非常廣泛的許可，可能會帶來安全風險。我們建議您只在安全性較少的教學課程和案例中使用此角色。本教學假設您正在建立先前列出的三個角色。 **注意** [Lambda 執行角色](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html)也是必要的，但您不需要立即建立，因為`sam-template.yml`檔案會在步驟 5 中執行工作流程時為您建立。 **建立部署角色** 1. 建立角色的政策，如下所示： 1. 登入 AWS。 1. 前往 [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/) 開啟 IAM 主控台。 1. 在導覽窗格中，選擇**政策**。 1. 選擇 **Create policy** (建立政策)。 1. 請選擇 **JSON** 標籤。 1. 刪除現有的程式碼。 1. 貼上以下程式碼： **注意** 第一次使用該角色執行工作流程動作時，請在資源政策陳述式中使用萬用字元，然後在資源名稱可用後縮小政策的範圍。 ``` "Resource": "*" ``` 1. 選擇下**一步：標籤**。 1. 選擇下**一步：檢閱**。 1. 在**名稱**中，輸入： ``` codecatalyst-deploy-policy ``` 1. 選擇**建立政策**。 您現在已建立許可政策。 1. 建立部署角色，如下所示： 1. 在導覽窗格中，選擇**角色**，然後選擇**建立角色**。 1. 選擇**自訂信任政策**。 1. 刪除現有的自訂信任政策。 1. 新增下列自訂信任政策： 1. 選擇**下一步**。 1. 在**許可政策**中，搜尋`codecatalyst-deploy-policy`並選取其核取方塊。 1. 選擇**下一步**。 1. 針對**角色名稱**，輸入： ``` codecatalyst-deploy-role ``` 1. 針對**角色描述**，輸入： ``` CodeCatalyst deploy role ``` 1. 選擇建**立角色**。 您現在已建立具有信任政策和許可政策的部署角色。 1. 取得部署角色 ARN，如下所示： 1. 在導覽窗格中，選擇**角色**。 1. 在搜尋方塊中，輸入您剛建立的角色名稱 (`codecatalyst-deploy-role`)。 1. 從清單中選擇角色。 角色的**摘要**頁面隨即出現。 1. 在頂端複製 **ARN** 值。 您現在已建立具有適當許可的部署角色，並取得其 ARN。 **建立建置角色** 1. 建立角色的政策，如下所示： 1. 登入 AWS。 1. 前往 [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/) 開啟 IAM 主控台。 1. 在導覽窗格中，選擇**政策**。 1. 選擇 **Create policy** (建立政策)。 1. 請選擇 **JSON** 標籤。 1. 刪除現有的程式碼。 1. 貼上以下程式碼： **注意** 第一次使用該角色執行工作流程動作時，請在資源政策陳述式中使用萬用字元，然後在資源名稱可用後縮小政策的範圍。 ``` "Resource": "*" ``` 1. 選擇下**一步：標籤**。 1. 選擇下**一步：檢閱**。 1. 在**名稱**中，輸入： ``` codecatalyst-build-policy ``` 1. 選擇**建立政策**。 您現在已建立許可政策。 1. 建立建置角色，如下所示： 1. 在導覽窗格中，選擇**角色**，然後選擇**建立角色**。 1. 選擇**自訂信任政策**。 1. 刪除現有的自訂信任政策。 1. 新增下列自訂信任政策： 1. 選擇**下一步**。 1. 在**許可政策**中，搜尋`codecatalyst-build-policy`並選取其核取方塊。 1. 選擇**下一步**。 1. 針對**角色名稱**，輸入： ``` codecatalyst-build-role ``` 1. 針對**角色描述**，輸入： ``` CodeCatalyst build role ``` 1. 選擇建**立角色**。 您現在已建立具有信任政策和許可政策的建置角色。 1. 取得建置角色 ARN，如下所示： 1. 在導覽窗格中，選擇**角色**。 1. 在搜尋方塊中，輸入您剛建立的角色名稱 (`codecatalyst-build-role`)。 1. 從清單中選擇角色。 角色的**摘要**頁面隨即出現。 1. 在頂端複製 **ARN** 值。 您現在已建立具有適當許可的建置角色，並取得其 ARN。 **建立堆疊角色** 1. AWS 使用您要部署堆疊的帳戶登入 。 1. 前往 [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/) 開啟 IAM 主控台。 1. 建立堆疊角色，如下所示： 1. 在導覽窗格中，選擇 **Roles** (角色)。 1. 選擇 **Create Role** (建立角色)。 1. 選擇 **AWS 服務**。 1. 在**使用案例**區段中，從下拉式清單中選擇 **CloudFormation**。 1. 選取 **CloudFormation** 選項按鈕。 1. 在底部，選擇**下一步**。 1. 使用搜尋方塊，尋找下列許可政策，然後選取其各自的核取方塊。 **注意** 如果您搜尋政策但未顯示，請務必選擇**清除篩選條件**，然後再試一次。 + **CloudWatchFullAccess** + **AWS CloudFormationFullAccess** + **IAMFullAccess** + **AWS Lambda\$1FullAccess** + **AmazonAPIGatewayAdministrator** + **AmazonS3FullAccess** + **AmazonEC2ContainerRegistryFullAccess** 第一個政策允許存取 CloudWatch，以便在警示發生時啟用堆疊轉返。 其餘政策允許 AWS SAM 存取本教學課程中將部署的堆疊中的服務和資源。如需詳細資訊，請參閱《 *AWS Serverless Application Model 開發人員指南*》中的[許可](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-permissions.html)。 1. 選擇**下一步**。 1. 針對**角色名稱**，輸入： ``` codecatalyst-stack-role ``` 1. 選擇建**立角色**。 1. 取得堆疊角色的 ARN，如下所示： 1. 在導覽窗格中，選擇**角色**。 1. 在搜尋方塊中，輸入您剛建立的角色名稱 (`codecatalyst-stack-role`)。 1. 從清單中選擇角色。 1. 在**摘要**區段中，複製 **ARN** 值。供稍後使用。 您現在已建立具有適當許可的堆疊角色，並且已取得其 ARN。 ## 步驟 3：將 AWS 角色新增至 CodeCatalyst 在此步驟中，您將建置角色 (`codecatalyst-build-role`) 和部署角色 (`codecatalyst-deploy-role`) 新增至您空間中的 CodeCatalyst 帳戶連線。 **注意** 您不需要將堆疊角色 (`codecatalyst-stack-role`) 新增至連線。這是因為 *CloudFormation* （非 CodeCatalyst) 使用堆疊角色，在 CodeCatalyst 與 AWS 使用部署角色之間建立連線*之後*。由於 CodeCatalyst 不會使用堆疊角色來存取 AWS，因此不需要與帳戶連線建立關聯。 **將建置和部署角色新增至您的帳戶連線** 1. 在 CodeCatalyst 中，導覽至您的空間。 1. 選擇**AWS 帳戶**。帳戶連線清單隨即顯示。 1. 選擇代表您建立建置和部署角色 AWS 的帳戶的帳戶連線。 1. **從管理主控台選擇 AWS 管理角色**。 將 **IAM 角色新增至 Amazon CodeCatalyst 空間**頁面隨即出現。您可能需要登入才能存取頁面。 1. 選取**新增您在 IAM 中建立的現有角色**。 下拉式清單隨即出現。清單會顯示具有信任政策的所有 IAM 角色，其中包含 `codecatalyst-runner.amazonaws.com``codecatalyst.amazonaws.com`和服務主體。 1. 在下拉式清單中，選擇 `codecatalyst-build-role`，然後選擇**新增角色**。 1. 選擇**新增 IAM 角色**，選擇**新增您在 IAM 中建立的現有角色**，然後在下拉式清單中選擇 `codecatalyst-deploy-role`。選擇 **Add role (新增角色)**。 您現在已將建置和部署角色新增至您的空間。 1. 複製 **Amazon CodeCatalyst 顯示名稱**的值。稍後建立工作流程時，您將需要此值。 ## 步驟 4：建立 Amazon S3 儲存貯體 在此步驟中，您會建立 Amazon S3 儲存貯體，存放無伺服器應用程式的部署套件 .zip 檔案。 **建立 Amazon S3 儲存貯體** 1. 開啟位於 [https://console.aws.amazon.com/s3/](https://console.aws.amazon.com/s3/) 的 Amazon S3 主控台。 1. 在主窗格中，選擇**建立儲存貯**體。 1. 針對**儲存貯體名稱**，輸入： ``` codecatalyst-cfn-s3-bucket ``` 1. 對於 **AWS 區域**，選擇一個區域。本教學假設您選擇了**美國西部 （奧勒岡） us-west-2**。如需 Amazon S3 支援之區域的相關資訊，請參閱《》中的 [Amazon Simple Storage Service 端點和配額](https://docs.aws.amazon.com/general/latest/gr/s3.html)*AWS 一般參考*。 1. 在頁面底部，選擇**建立儲存貯**體。 您現在在美國西部 （奧勒岡） us-west-2 區域中建立名為 **codecatalyst-cfn-s3-bucket**的儲存貯體。 ## 步驟 5：新增來源檔案 在此步驟中，您會將數個應用程式來源檔案新增至 CodeCatalyst 來源儲存庫。`hello-world` 資料夾包含您將部署的應用程式檔案。`tests` 資料夾包含單元測試。資料夾結構如下所示： ``` . |— hello-world | |— tests | |— unit | |— test-handler.js | |— app.js |— .npmignore |— package.json |— sam-template.yml |— setup-sam.sh ``` ### .npmignore 檔案 `.npmignore` 檔案指出哪些檔案和資料夾 npm 應該從應用程式套件中排除。在本教學課程中，npm 會排除 `tests` 資料夾，因為它不是應用程式的一部分。 **新增 .npmignore 檔案** 1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。 1. 選擇您的專案， `codecatalyst-cfn-project` 1. 在導覽窗格中，選擇**程式碼**，然後選擇**來源儲存庫**。 1. 從來源儲存庫清單中，選擇您的儲存庫 `codecatalyst-cfn-source-repository`。 1. 在**檔案中**，選擇**建立檔案**。 1. 針對**檔案名稱**，輸入： ``` .npmignore ``` 1. 在文字方塊中，輸入下列程式碼： ``` tests/* ``` 1. 選擇**遞交**，然後再次選擇**遞交**。 您現在已在儲存庫的根`.npmignore`目錄中建立名為 的檔案。 ### package.json 檔案 `package.json` 檔案包含有關節點專案的重要中繼資料，例如專案名稱、版本編號、描述、相依性，以及描述如何與應用程式互動和執行的其他詳細資訊。 本教學`package.json`課程中的 包含相依性和`test`指令碼的清單。測試指令碼會執行下列動作： + 使用 [mocha](https://mochajs.org/)，測試指令碼會執行 中指定的單元測試，`hello-world/tests/unit/`並使用 [xunit]() 報告程式將結果寫入`junit.xml`檔案。 + 使用[伊斯坦堡 (nyc)](https://istanbul.js.org/)，測試指令碼會使用 [clover](https://openclover.org/doc/manual/4.2.0/general--about-openclover.html) 報告程式產生程式碼涵蓋範圍報告 (`clover.xml`)。如需詳細資訊，請參閱伊斯坦堡文件中[的使用替代報告程式](https://istanbul.js.org/docs/advanced/alternative-reporters/#clover)。 **新增 package.json 檔案** 1. 在儲存庫的**檔案中**，選擇**建立檔案**。 1. 針對**檔案名稱**，輸入： ``` package.json ``` 1. 在文字方塊中，輸入下列程式碼： ``` { "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" } } ``` 1. 選擇**遞交**，然後再次選擇**遞交**。 您現在已將名為 的檔案新增至儲存庫的`package.json`根目錄。 ### sam-template.yml 檔案 `sam-template.yml` 檔案包含部署 Lambda 函數和 API Gateway 並將其一起設定的指示。它遵循[AWS Serverless Application Model 範本規格](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-specification.html)，擴展 CloudFormation 範本規格。 您在本教學課程中使用 AWS SAM 範本，而不是一般 CloudFormation 範本，因為 AWS SAM 提供實用的 [AWS：：Serverless：：Function](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-function.html) 資源類型。此類型會執行許多behind-the-scenes組態，您通常必須將其寫入才能使用基本 CloudFormation 語法。例如， `AWS::Serverless::Function`會建立 Lambda 函數、Lambda 執行角色，以及啟動函數的事件來源映射。如果您想要使用基本 CloudFormation 進行寫入，則必須將所有程式碼編寫。 雖然本教學課程使用預先編寫的範本，但您可以使用建置動作在工作流程中產生範本。如需詳細資訊，請參閱[部署 CloudFormation 堆疊](deploy-action-cfn.md)。 **新增 sam-template.yml 檔案** 1. 在儲存庫的**檔案中**，選擇**建立檔案**。 1. 針對**檔案名稱**，輸入： ``` sam-template.yml ``` 1. 在文字方塊中，輸入下列程式碼： ``` 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 ``` 1. 選擇**遞交**，然後再次選擇**遞交**。 您現在已在儲存庫的根資料夾`sam-template.yml`下新增名為 的檔案。 ### setup-sam.sh 檔案 `setup-sam.sh` 檔案包含下載和安裝 CLI AWS SAM 公用程式的指示。工作流程會使用此公用程式來封裝`hello-world`來源。 **新增 setup-sam.sh 檔案** 1. 在儲存庫的**檔案中**，選擇**建立檔案**。 1. 針對**檔案名稱**，輸入： ``` setup-sam.sh ``` 1. 在文字方塊中，輸入下列程式碼： ``` #!/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 ``` 在上述程式碼中，將 AWS *us-west-2* 取代為您的 區域。 1. 選擇**遞交**，然後再次選擇**遞交**。 您現在已將名為 的檔案新增至儲存庫的`setup-sam.sh`根目錄。 ### app.js 檔案 `app.js` 包含 Lambda 函數程式碼。在本教學課程中，程式碼會傳回文字 `hello world`。 **新增 app.js 檔案** 1. 在儲存庫的**檔案中**，選擇**建立檔案**。 1. 針對**檔案名稱**，輸入： ``` hello-world/app.js ``` 1. 在文字方塊中，輸入下列程式碼： ``` // 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 }; ``` 1. 選擇**遞交**，然後再次選擇**遞交**。 您現在已建立名為 的資料夾`hello-world`和名為 的檔案`app.js`。 ### test-handler.js 檔案 `test-handler.js` 檔案包含 Lambda 函數的單位測試。 **新增 test-handler.js 檔案** 1. 在儲存庫的**檔案中**，選擇**建立檔案**。 1. 針對**檔案名稱**，輸入： ``` hello-world/tests/unit/test-handler.js ``` 1. 在文字方塊中，輸入下列程式碼： ``` '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"); }); }); ``` 1. 選擇**遞交**，然後再次選擇**遞交**。 您現在已在 `hello-world/tests/unit` 資料夾`test-handler.js`下新增名為 的檔案。 您現在已新增所有來源檔案。 花一點時間仔細檢查您的工作，並確保將所有檔案放在正確的資料夾中。資料夾結構如下所示： ``` . |— hello-world | |— tests | |— unit | |— test-handler.js | |— app.js |— .npmignore |— README.md |— package.json |— sam-template.yml |— setup-sam.sh ``` ## 步驟 6：建立和執行工作流程 在此步驟中，您建立的工作流程會封裝您的 Lambda 原始程式碼並進行部署。工作流程包含下列依順序執行的建置區塊： + 觸發條件 – 當您將變更推送至來源儲存庫時，此觸發條件會自動啟動工作流程執行。關於觸發條件的詳細資訊，請參閱 [使用觸發程序自動啟動工作流程執行](workflows-add-trigger.md)。 + 測試動作 (`Test`) – 在觸發時，此動作會安裝 [Node 套件管理員 (npm)](https://www.npmjs.com/)，然後執行 `npm run test`命令。此命令會告知 npm 執行 `package.json` 檔案中定義的`test`指令碼。`test` 指令碼接著會執行單元測試，並產生兩個報告：測試報告 (`junit.xml`) 和程式碼涵蓋報告 (`clover.xml`)。如需詳細資訊，請參閱[package.json 檔案](#deploy-tut-lambda-cfn-files-package-json)。 接下來，測試動作會將 XML 報告轉換為 CodeCatalyst 報告，並在測試動作**的報告**索引標籤下顯示在 CodeCatalyst 主控台中。 如需測試動作的詳細資訊，請參閱 [使用工作流程進行測試使用工作流程進行測試](test-workflow-actions.md)。 + 建置動作 (`BuildBackend`) – 測試動作完成後，建置動作會下載並安裝 AWS SAM CLI、封裝`hello-world`來源，並將套件複製到 Amazon S3 儲存貯體，Lambda 服務預期會是該儲存貯體。動作也會輸出名為 的新 AWS SAM 範本檔案，`sam-template-packaged.yml`並將其置於名為 的輸出成品中`buildArtifact`。 如需建置動作的詳細資訊，請參閱 [使用工作流程建置](build-workflow-actions.md)。 + 部署動作 (`DeployCloudFormationStack`) – 完成建置動作後，部署動作會尋找建置動作 (`buildArtifact`) 產生的輸出成品，在其中尋找 AWS SAM 範本，然後執行範本。 AWS SAM 範本會建立可部署無伺服器應用程式的堆疊。 **建立工作流程** 1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。 1. 選擇**建立工作流程**。 1. 針對**來源儲存庫**，選擇 `codecatalyst-cfn-source-repository`。 1. 針對**分支**，選擇 `main`。 1. 選擇**建立**。 1. 刪除 YAML 範例程式碼。 1. 新增下列 YAML 程式碼： **注意** 在下列 YAML 程式碼中，您可以視需要省略這些`Connections:`區段。如果您省略這些區段，您必須確保環境中**預設 IAM 角色**欄位中指定的角色包含 中所述兩個角色的許可和信任政策[步驟 2：建立 AWS 角色](#deploy-tut-lambda-cfn-roles)。如需使用預設 IAM 角色設定環境的詳細資訊，請參閱 [建立環境](deploy-environments-creating-environment.md)。 ``` 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 ``` 在上述程式碼中，取代： + 兩個具有您環境名稱的 *codecatalyst-cfn-environment* 執行個體。 + 這兩個 *codecatalyst-account-connection* 執行個體都具有您帳戶連線的顯示名稱。顯示名稱可能是數字。如需詳細資訊，請參閱[步驟 3：將 AWS 角色新增至 CodeCatalyst](#deploy-tut-lambda-cfn-roles-add)。 + *codecatalyst-build-role* 使用您在 中建立的建置角色名稱[步驟 2：建立 AWS 角色](#deploy-tut-lambda-cfn-roles)。 + *codecatalyst-cfn-s3-bucket*，內含您在 中建立的 Amazon S3 儲存貯體名稱[步驟 4：建立 Amazon S3 儲存貯體](#deploy-tut-lambda-cfn-s3)。 + Amazon S3 儲存貯體所在的區域 （第一個執行個體） 和堆疊將部署的區域 （第二個執行個體） 為 *us-west-2* 的兩個執行個體。這些區域可能不同。本教學假設兩個區域都設為 `us-west-2`。如需 Amazon S3 和 支援區域的詳細資訊 CloudFormation，請參閱《》中的[服務端點和配額](https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html)*AWS 一般參考*。 + *codecatalyst-deploy-role* 使用您在 中建立的部署角色名稱[步驟 2：建立 AWS 角色](#deploy-tut-lambda-cfn-roles)。 + *codecatalyst-cfn-environment*，其中包含您在 中建立的環境名稱[先決條件](#deploy-tut-lambda-cfn-prereqs)。 + *arn：aws：iam：：111122223333：role/StackRole*，其中包含您在 中建立之堆疊角色的 Amazon Resource Name (ARN)[步驟 2：建立 AWS 角色](#deploy-tut-lambda-cfn-roles)。 **注意** 如果您決定不建立建置、部署和堆疊角色，請將 *codecatalyst-build-role*、 *codecatalyst-deploy-role*和 *arn：aws：iam：：111122223333：role/StackRole* 取代為`CodeCatalystWorkflowDevelopmentRole-spaceName`角色的名稱或 ARN。如需有關此角色的詳細資訊，請參閱 [步驟 2：建立 AWS 角色](#deploy-tut-lambda-cfn-roles)。 如需先前所示程式碼中屬性的相關資訊，請參閱 [「部署 CloudFormation 堆疊」動作 YAML](deploy-action-ref-cfn.md)。 1. （選用） 選擇**驗證**，以確保 YAML 程式碼在遞交之前有效。 1. 選擇 **Commit** (遞交)。 1. 在**遞交工作流程**對話方塊中，輸入下列內容： 1. 對於**工作流程檔案名稱**，請保留預設值 `codecatalyst-cfn-workflow`。 1. 針對**遞交訊息**，輸入： ``` add initial workflow file ``` 1. 針對**儲存庫**，選擇 **codecatalyst-cfn-source-repository**。 1. 針對**分支名稱**，選擇**主要**。 1. 選擇 **Commit** (遞交)。 您現在已建立工作流程。由於工作流程頂端定義的觸發條件，工作流程執行會自動啟動。具體而言，當您將`codecatalyst-cfn-workflow.yaml`檔案遞交 （並推送） 到您的來源儲存庫時，觸發會啟動工作流程執行。 **檢視進行中工作流程執行** 1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。 1. 選擇您剛建立的工作流程：`codecatalyst-cfn-workflow`。 1. 選擇**執行**索引標籤。 1. 在**執行 ID** 欄中，選擇執行 ID。 1. 選擇**測試**以查看測試進度。 1. 選擇 **BuildBackend** 以查看建置進度。 1. 選擇 **DeployCloudFormationStack** 以查看部署進度。 如需檢視執行詳細資訊的詳細資訊，請參閱 [檢視工作流程執行狀態和詳細資訊](workflows-view-run.md)。 1. 當 **DeployCloudFormationStack** 動作完成時，請執行下列動作： + 如果工作流程執行成功，請前往下一個程序。 + 如果工作流程在**測試**或 **BuildBackend** 動作上執行失敗，請選擇**日誌**來疑難排解問題。 + 如果在 **DeployCloudFormationStack** 動作上執行工作流程失敗，請選擇部署動作，然後選擇**摘要**索引標籤。捲動至 **CloudFormation 事件**區段以檢視詳細的錯誤訊息。如果發生轉返，請在重新執行工作流程之前，透過 中的 AWS CloudFormation 主控台刪除`codecatalyst-cfn-stack`堆疊。 **驗證部署** 1. 成功部署後，從頂端附近的水平選單列中選擇**變數 (7)**。（請勿在右側窗格中選擇**變數**。) 1. 在 **HelloWorldApi** 旁邊，將 `https://` URL 貼到瀏覽器。 隨即顯示來自 Lambda 函數的 **hello world** JSON 訊息，指出工作流程已成功部署和設定 Lambda 函數和 API Gateway。 **提示** 您可以使用幾個小型組態，讓 CodeCatalyst 在工作流程圖表中顯示此 URL。如需詳細資訊，請參閱[在工作流程圖表中顯示應用程式 URL](deploy-app-url.md)。 **驗證單位測試結果和程式碼涵蓋範圍** 1. 在工作流程圖表中，選擇**測試**，然後選擇**報告**。 1. 選擇 **TestReport** 以檢視單位測試結果，或選擇 **CoverageReport** 以檢視測試中檔案的程式碼涵蓋範圍詳細資訊，在此情況下為 `app.js`和 `test-handler.js`。 **驗證已部署的資源** 1. 登入 AWS 管理主控台 並開啟 API Gateway 主控台，網址為 https：//[https://console.aws.amazon.com/apigateway/](https://console.aws.amazon.com/apigateway/)。 1. 觀察 AWS SAM 範本建立的 **codecatalyst-cfn-stack** API。API 名稱來自工作流程定義檔案 () 中的 `Configuration/name`值`codecatalyst-cfn-workflow.yaml`。 1. 在 https：//[https://console.aws.amazon.com/lambda/](https://console.aws.amazon.com/lambda/) 開啟 AWS Lambda 主控台。 1. 在導覽視窗中，選擇**函數**。 1. 選擇您的 Lambda 函數 `codecatalyst-cfn-stack-HelloWorldFunction-string`。 1. 您可以查看 API Gateway 如何觸發函數。此整合是由 資源類型自動設定 AWS SAM `AWS::Serverless::Function`。 ## 步驟 7：進行變更 在此步驟中，您會變更並遞交 Lambda 原始程式碼。此遞交會啟動新的工作流程執行。此執行會使用 Lambda 主控台中指定的預設流量轉移組態，在藍綠配置中部署新的 Lambda 函數。 **變更您的 Lambda 來源** 1. 在 CodeCatalyst 中，導覽至您的專案。 1. 在導覽窗格中，選擇**程式碼**，然後選擇**來源儲存庫**。 1. 選擇您的來源儲存庫 `codecatalyst-cfn-source-repository`。 1. 變更應用程式檔案： 1. 選擇 `hello-world` 資料夾。 1. 選擇 `app.js` 檔案。 1. 選擇**編輯**。 1. 在第 23 行，`hello world`變更為 **Tutorial complete\$1**。 1. 選擇**遞交**，然後再次選擇**遞交**。 遞交會導致工作流程執行開始。此執行將會失敗，因為您尚未更新單元測試以反映名稱變更。 1. 更新單元測試： 1. 選擇 `hello-world\tests\unit\test-handler.js`。 1. 選擇**編輯**。 1. 在第 19 行，`hello world`變更為 **Tutorial complete\$1**。 1. 選擇**遞交**，然後再次選擇**遞交**。 遞交會導致另一個工作流程執行開始。此執行將會成功。 1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。 1. 選擇 `codecatalyst-cfn-workflow`，然後選擇**執行**。 1. 選擇最新執行的執行 ID。它應該仍在進行中。 1. 選擇**測試**、 **BuildBackend** 和 **DeployCloudFormationStack** 以查看工作流程執行進度。 1. 當工作流程完成時，請選擇頂端附近的**變數 (7)**。 1. 在 **HelloWorldApi** 旁邊，將 `https://` URL 貼到瀏覽器中。 瀏覽器中會出現一`Tutorial complete!`則訊息，指出您的新應用程式已成功部署。 ## 清除 清除本教學課程中使用的檔案和服務，以避免收取這些檔案和服務的費用。 **在 CodeCatalyst 主控台中清除** 1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。 1. 刪除 `codecatalyst-cfn-workflow`。 1. 刪除 `codecatalyst-cfn-environment`。 1. 刪除 `codecatalyst-cfn-source-repository`。 1. 刪除 `codecatalyst-cfn-project`。 **在 中清除 AWS 管理主控台** 1. 在 CloudFormation 中清除，如下所示： 1. 在 https：//[https://console.aws.amazon.com/cloudformation](https://console.aws.amazon.com/cloudformation/) 開啟 CloudFormation 主控台。 1. 刪除`codecatalyst-cfn-stack`。 刪除堆疊會從 API Gateway 和 Lambda 服務中移除所有教學課程資源。 1. 在 Amazon S3 中清除，如下所示： 1. 開啟位於 [https://console.aws.amazon.com/s3/](https://console.aws.amazon.com/s3/) 的 Amazon S3 主控台。 1. 選擇 `codecatalyst-cfn-s3-bucket`。 1. 刪除儲存貯體內容。 1. 刪除儲存貯體。 1. 在 IAM 中清除，如下所示： 1. 前往 [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/) 開啟 IAM 主控台。 1. 刪除`codecatalyst-deploy-policy`。 1. 刪除`codecatalyst-build-policy`。 1. 刪除`codecatalyst-stack-policy`。 1. 刪除`codecatalyst-deploy-role`。 1. 刪除`codecatalyst-build-role`。 1. 刪除`codecatalyst-stack-role`。 在本教學課程中，您已了解如何使用 CodeCatalyst 工作流程和部署堆疊動作，將無伺服器應用程式部署為 CloudFormation ** CloudFormation 堆疊**。