教學課程：建立使用 AWS CloudFormation 部署動作變數的管道 - AWS CodePipeline
先決條件：建立 AWS CloudFormation 服務角色和 CodeCommit 儲存庫步驟 1：下載、編輯和上傳範例 AWS CloudFormation 範本步驟 2：建立管道步驟 3：新增 AWS CloudFormation 部署動作以建立變更集步驟 4：新增手動核准動作步驟 5：新增 CloudFormation部署動作以執行變更集步驟 6：新增 CloudFormation部署動作以刪除堆疊

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

教學課程：建立使用 AWS CloudFormation 部署動作變數的管道

在本教學課程中，您可以使用 AWS CodePipeline 主控台建立具有部署動作的管道。管道執行時，此範本會建立堆疊，並建立 outputs 檔案。堆疊範本產生的輸出是 中 AWS CloudFormation 動作產生的變數 CodePipeline。

在從範本建立堆疊的動作中，您可以指定變數命名空間。然後，該 outputs 檔案產生的變數可以被後續動作使用。在此範例中，您可以根據 AWS CloudFormation 動作產生的StackName變數建立變更集。手動核准之後，您執行變更集，然後建立根據 StackName 變數刪除堆疊的刪除堆疊動作。

重要

作為建立管道的一部分，客戶提供的 S3 成品儲存貯體將由 CodePipeline 用於成品。（這與用於 S3 來源動作的儲存貯體不同。） 如果 S3 成品儲存貯體位於與管道帳戶不同的帳戶中，請確保 S3 成品儲存貯體由 AWS 帳戶 安全且可靠的 擁有。

先決條件：建立 AWS CloudFormation 服務角色和 CodeCommit 儲存庫

您必須已擁有下列各項目：

  • CodeCommit 儲存庫。您可以使用您在 中建立的 AWS CodeCommit 儲存庫教學課程：建立簡單的管道 （CodeCommit 儲存庫）。

  • 此範例會從範本建立 Amazon DocumentDB 堆疊。您必須使用 AWS Identity and Access Management （IAM） 來建立具有下列 Amazon DocumentDB 許可 AWS CloudFormation 的服務角色。

    "rds:DescribeDBClusters",
"rds:CreateDBCluster",
"rds:DeleteDBCluster",
"rds:CreateDBInstance"

步驟 1：下載、編輯和上傳範例 AWS CloudFormation 範本

下載範例 AWS CloudFormation 範本檔案，並將其上傳至您的 CodeCommit 儲存庫。

  1. 導覽至您區域的範例範本頁面。例如，us-west-2 的頁面位於 https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sample-templates-services-us-west-2.html。在 Amazon DocumentDB下，下載 Amazon DocumentDB 叢集的範本。檔案名稱為 documentdb_full_stack.yaml。

  2. 將 documentdb_full_stack.yaml 檔案解壓縮，然後在文字編輯器中開啟檔案。進行下列變更：

    1. 在此範例中，將下列 Purpose: 參數新增至範本中的 Parameters 區段。

        Purpose:
    Type: String
    Default: testing
    AllowedValues:
      - testing
      - production
    Description: The purpose of this instance.

    2. 在此範例中，將下列 StackName 輸出新增至範本中的 Outputs: 區段。

        StackName:
    Value: !Ref AWS::StackName

  3. 將範本檔案上傳至您的 AWS CodeCommit 儲存庫。您必須將解壓縮和編輯過的範本檔案上傳至儲存庫的根目錄。

    若要使用 CodeCommit 主控台上傳檔案：

    1. 開啟 CodeCommit 主控台，然後從儲存庫清單中選擇您的儲存庫。

    2. 選擇 Add file (新增檔案)，然後選擇 Upload file (上傳檔案)。

    3. 選取 Choose file (選擇檔案)，然後瀏覽您的檔案。輸入您的使用者名稱和電子郵件地址來確定變更。選擇 Commit changes (遞交變更)。

    您的檔案在儲存庫的根層級看起來應該像這樣：

    documentdb_full_stack.yaml

步驟 2：建立管道

在本節中，您可以採取下列動作建立管道：

  • 具有 CodeCommit 動作的來源階段，其中來源成品是您的範本檔案。

  • 具有部署動作的 AWS CloudFormation 部署階段。

系統會為精靈所建立的來源和部署階段中每個動作指派變數命名空間，分別是 SourceVariables 和 DeployVariables。由於動作已指派命名空間，因此在此範例中設定的變數可供下游動作使用。如需詳細資訊，請參閱變數參考。

使用精靈建立管道

  1. 登入 AWS Management Console 並在 https：//http://console.aws.amazon.com/codesuite/codepipeline/home 開啟 CodePipeline 主控台。

  2. 在 Welcome (歡迎) 頁面、Getting started (入門) 頁面、或者 Pipelines (管道) 頁面上，選擇 Create pipeline (建立管道)。

  3. 在 Step 1: Choose pipeline settings (步驟 1：選擇管道設定) 的 Pipeline name (管道名稱) 中，輸入 MyCFNDeployPipeline。

  4. 在管道類型 中，選擇 V1 作為本教學課程的目的。您也可以選擇 V2；但請注意，管道類型在特徵和價格方面有所不同。如需詳細資訊，請參閱管道類型。

  5. 在 Service role (服務角色) 中，執行下列其中一項作業：

    • 選擇新服務角色， CodePipeline 以允許 在 中建立服務角色IAM。

    • 選擇 Existing service role (現有服務角色)。在 Role name (角色名稱) 中，從清單選擇您的服務角色。

  6. 在 Artifact store (成品存放區) 中：

    1. 選擇預設位置以使用預設成品存放區，例如指定為預設值的 Amazon S3 成品儲存貯體，用於您為管道選取的區域中的管道。

    2. 如果您已在管道所在的相同區域中擁有成品存放區，例如 Amazon S3 成品儲存貯體，請選擇自訂位置。

    注意

    這不是原始碼的來源儲存貯體。這是管道的成品存放區。每個管道都需要有個別成品存放區，例如 S3 儲存貯體。當您建立或編輯管道時，管道區域中必須有一個成品儲存貯體，且每個執行動作 AWS 的區域必須有一個成品儲存貯體。

    如需詳細資訊，請參閱 輸入和輸出成品 和 CodePipeline 管道結構參考。

    選擇 Next (下一步)。

  7. 在 Step 2: Add source stage (步驟 2：新增來源階段)：

    1. 在 Source provider (來源提供者) 中選擇 AWS CodeCommit。

    2. 在儲存庫名稱 中，選擇您在 中建立的 CodeCommit 儲存庫名稱步驟 1：建立 CodeCommit 儲存庫。

    3. 在 Branch name (分支名稱) 中，選擇包含最新程式碼更新的分支名稱。

    選取儲存庫名稱和分支後，會顯示要為此管道建立的 Amazon CloudWatch Events 規則。

    選擇 Next (下一步)。

  8. 在 Step 3: Add build stage (步驟 3：新增建置階段) 中，選擇 Skip build stage (跳過建置階段)，然後再次選擇 Skip (跳過) 來接受警告訊息​。

    選擇 Next (下一步)。

  9. 在 Step 4: Add deploy stage (步驟 4：新增部署階段) 中：

    1. 在 Action name (動作名稱) 中，選擇 Deploy (部署)。在部署提供者 中，選擇 CloudFormation。

    2. 在 Action mode (動作模式) 中，選擇 Create or update a stack (建立或更新堆疊)。

    3. 在 Stack name (堆疊名稱) 中，輸入堆疊的名稱。這是範本將建立的堆疊名稱。

    4. 在 Output file name (輸出檔案名稱) 中，輸入輸出檔案的名稱，例如 outputs。這是在建立堆疊後由此動作建立的檔案名稱。

    5. 展開 Advanced (進階)。在 Parameter overrides (參數覆寫) 下，輸入範本覆寫作為索引鍵/值組。例如，此範本需要下列覆寫。

      {
"DBClusterName": "MyDBCluster",
"DBInstanceName": "MyDBInstance",
"MasterUser": "UserName",
"MasterPassword": "Password",
"DBInstanceClass": "db.r4.large",
"Purpose": "testing"}

      如果您未輸入覆寫，範本會建立具有預設值的堆疊。

    6. 選擇 Next (下一步)。

    7. 選擇 Create pipeline (建立管道)。允許您的管道執行。您的兩階段管道已完成，並準備好新增其他階段。

步驟 3：新增 AWS CloudFormation 部署動作以建立變更集

在管道中建立下一個動作， AWS CloudFormation 允許在手動核准動作之前建立變更集。

  1. 在 開啟 CodePipeline 主控台https://console.aws.amazon.com/codepipeline/。

    在 Pipelines (管道) 下，選擇您的管道，然後選擇 View (檢視)。本圖顯示您的管道來源和部署階段。

  2. 選擇編輯管道，或繼續在 Edit (編輯) 模式中顯示管道。

  3. 選擇編輯部署階段。

  4. 新增部署動作，為在上一個動作中建立的堆疊建立變更集。您可以在階段中的現有動作之後新增此動作。

    1. 在 ​Action name (動作名稱) 中，輸入 Change_Set。在動作提供者 中，選擇 AWS CloudFormation 。

    2. 在輸入成品 中，選擇 SourceArtifact。

    3. 在 Action mode (動作模式) 中，選擇 Create or replace a change set (建立或取代變更集)。

    4. 在 Stack name (堆疊名稱) 中，輸入變數語法，如下所示。這是堆疊名稱，變更集是為此堆疊而建立，其中預設命名空間 DeployVariables 已指派給該動作。

      #{DeployVariables.StackName}

    5. 在 Change set name (變更集名稱) 中，輸入變更集的名稱。

      my-changeset

    6. 在 Parameter Overrides (參數覆寫) 中，將 Purpose 參數從 testing 變更為 production。

      {
"DBClusterName": "MyDBCluster",
"DBInstanceName": "MyDBInstance",
"MasterUser": "UserName",
"MasterPassword": "Password",
"DBInstanceClass": "db.r4.large",
"Purpose": "production"}

    7. 選擇 Done (完成) 以儲存動作。

步驟 4：新增手動核准動作

在管道中建立手動核准動作。

  1. 選擇編輯管道，或繼續在 Edit (編輯) 模式中顯示管道。

  2. 選擇編輯部署階段。

  3. 在建立變更集的部署動作之後新增手動核准動作。此動作可讓您在管道執行變更集 AWS CloudFormation 之前，先驗證 中建立的資源變更。

步驟 5：新增 CloudFormation部署動作以執行變更集

在管道中建立下一個動作， AWS CloudFormation 允許在手動核准動作之後執行變更集。

  1. 在 開啟 CodePipeline 主控台https://console.aws.amazon.com/codepipeline/。

    在 Pipelines (管道) 下，選擇您的管道，然後選擇 View (檢視)。本圖顯示您的管道來源和部署階段。

  2. 選擇編輯管道，或繼續在 Edit (編輯) 模式中顯示管道。

  3. 選擇編輯部署階段。

  4. 新增部署動作，以執行先前手動動作中核准的變更集：

    1. 在 Action name (動作名稱) 中，輸入 Execute_Change_Set。在動作提供者 中，選擇 AWS CloudFormation。

    2. 在輸入成品 中，選擇 SourceArtifact。

    3. 在 Action mode (動作模式) 中，選擇 Execute a change set (執行變更組合)。

    4. 在 Stack name (堆疊名稱) 中，輸入變數語法，如下所示。這是堆疊名稱，變更集是為此堆疊而建立。

      #{DeployVariables.StackName}

    5. 在 Change set name (變更集名稱) 中，輸入您在上一個動作中建立的變更集名稱。

      my-changeset

    6. 選擇 Done (完成) 以儲存動作。

    7. 繼續管道執行。

步驟 6：新增 CloudFormation部署動作以刪除堆疊

在管道中建立最終動作， AWS CloudFormation 允許從輸出檔案中的變數取得堆疊名稱，並刪除堆疊。

  1. 在 開啟 CodePipeline 主控台https://console.aws.amazon.com/codepipeline/。

    在 Pipelines (管道) 下，選擇您的管道，然後選擇 View (檢視)。本圖顯示您的管道來源和部署階段。

  2. 選擇編輯管道。

  3. 選擇編輯部署階段。

  4. 新增將刪除堆疊的部署動作：

    1. 在動作名稱 中，選擇 DeleteStack。在部署提供者 中，選擇 CloudFormation。

    2. 在 Action mode (動作模式) 中，選擇 Delete a stack (刪除堆疊)。

    3. 在 Stack name (堆疊名稱) 中，輸入變數語法，如下所示。這是動作將刪除的堆疊名稱。

    4. 選擇 Done (完成) 以儲存動作。

    5. 選擇 Save (儲存) 以儲存管道。

    管道會在儲存時執行。