创建管道、阶段和操作

步骤 1：创建管道并为其命名

1. 登录 AWS Management Console 并打开 CodePipeline 控制台，网址为 http://console.aws.amazon.com/codesuite/codepipeline/home。

2. 在 Welcome 页面上，选择 Create pipeline。

   如果这是您第一次使用 CodePipeline，请选择 “入门”。

3. 在步骤 1：选择管道设置页面上，在管道名称中，输入管道的名称。

   在单个 AWS 账户中，您在一个 AWS 区域中创建的每个管道都必须具有唯一的名称。名称可重用于不同区域的管道。

   注意

   创建管道后，便无法再更改其名称。有关其他限制的信息，请参阅中的配额 AWS CodePipeline。

4. 对于管道类型，选择以下选项之一：管道类型有不同的特点和价格。有关更多信息，请参阅 管道类型。

   • V1 类型的管道的JSON结构包含标准管道、阶段和操作级参数。

   • V2 类型的管道与 V1 类型结构相同，并支持其他参数，例如 Git 标签上的触发器和管道级变量。

5. 在服务角色中，执行下列操作之一：

   • 选择 “新建服务角色” CodePipeline 以允许在中创建新的服务角色IAM。

   • 选择 “现有服务角色” 以使用已在中创建的服务角色IAM。在角色中ARN，ARN从列表中选择您的服务角色。

   注意

   根据您的服务角色的创建时间，您可能需要更新其权限以支持其他权限 AWS 服务。有关信息，请参阅向 CodePipeline 服务角色添加权限。

   有关服务角色及其策略语句的更多信息，请参阅管理 CodePipeline 服务角色。

6. （可选）在变量下，选择添加变量，以添加管道级变量。

   有关管道级变量的更多信息，请参阅变量参考。有关在管道执行时传递的管道级变量的教程，请参阅教程：使用管道级变量。

   注意

   虽然添加管道级变量是可选的，但如果使用管道级变量指定了管道而没有提供变量值，管道执行将失败。

7. （可选）展开高级设置。

8. 在构件存储中，执行下列操作之一：

   1. 选择默认位置，在为管道选择的管道中使用默认项目存储，例如指定为默认的 S3 工件存储桶。 AWS 区域

   2. 如果您在管道所在的区域中已有构件存储（例如，S3 构件存储桶），请选择自定义位置。在存储桶中，选择存储桶名称。

   注意

   这不是源代码的源存储桶。这是管道的项目存储。每个管道都需要一个单独的构件存储，例如 S3 存储桶。创建或编辑管道时，管道区域中必须有一个工件存储桶，并且每个运行操作的 AWS 区域都必须有一个工件存储桶。

   有关更多信息，请参阅输入和输出构件 和CodePipeline 管道结构参考。

9. 在加密密钥中，执行下列操作之一：

   1. 要使用 CodePipeline 默认值 AWS KMS key 加密管道项目存储（S3 存储桶）中的数据，请选择默认 AWS 托管密钥。

   2. 要使用客户托管密钥对管道构件存储（S3 桶）中的数据进行加密，请选择客户托管密钥。选择密钥 ID ARN、密钥或别名ARN。

10. 选择下一步。

步骤 2：创建源阶段

• 在步骤 2：添加源阶段页面上的源提供程序中，选择您的源代码存储到的存储库的类型，并指定其必需选项，然后选择下一步。

  • 对于 Bitbucket Cloud GitHub（版本 2）、 GitHub 企业服务器、 GitLab .com 或 GitLab自行管理：

    1. 在连接下，选择一个现有连接或创建一个新连接。要创建或管理 GitHub 源操作的连接，请参阅GitHub 连接。

    2. 选择要用作管道的源位置的存储库。

       选择添加触发器或筛选触发器类型以启动您的管道。有关使用触发器的更多信息，请参阅筛选代码推送或拉取请求的触发器。有关使用 glob 模式筛选的更多信息，请参阅使用语法中的 glob 模式。

    3. 在输出构件格式中，为构件选择格式。

       • 要使用默认方法存储 GitHub 操作的输出对象，请选择CodePipeline默认。该操作访问 GitHub 存储库中的文件，并将工件存储在管道构件存储中的ZIP文件中。

       • 要存储包含仓库URL引用的JSON文件，以便下游操作可以直接执行 Git 命令，请选择 “完全克隆”。此选项只能由 CodeBuild 下游操作使用。

         如果选择此选项，则需要更新 CodeBuild 项目服务角色的权限，如所示故障排除 CodePipeline。如需查看教程以了解如何使用完整克隆选项，请参阅教程：使用带有 GitHub 管道源的完整克隆。

  • 对于 Amazon S3：

    1. 在Amazon S3 位置中，提供 S3 存储桶名称和已启用版本控制的存储桶中对象的路径。存储桶名称和路径的格式与以下内容类似：

        s3://bucketName/folderName/objectName

       注意

       当 Amazon S3 是您的管道的源提供程序时，您可以将一个或多个源文件压缩到单个 .zip 文件中，然后将 .zip 文件上传到源桶。您也可以上传单个解压缩的文件；但是，需要 .zip 文件的下游操作将失败。

    2. 选择 S3 源存储桶后， CodePipeline 创建 Amazon E CloudWatch vents 规则和要为此管道创建的 AWS CloudTrail 跟踪。接受更改检测选项下面的默认值。这 CodePipeline 允许使用 Amazon Ev CloudWatch en AWS CloudTrail ts 并检测新管道的更改。选择下一步。

  • 对于 AWS CodeCommit：

    • 在存储库名称中，选择要用作管道源位置的 CodeCommit 存储库的名称。在分支名称中，从下拉列表中选择要使用的分支。

    • 在输出构件格式中，为构件选择格式。

      • 要使用默认方法存储 CodeCommit 操作的输出对象，请选择CodePipeline默认。该操作访问 CodeCommit 存储库中的文件，并将工件存储在管道构件存储中的ZIP文件中。

      • 要存储包含仓库URL引用的JSON文件，以便下游操作可以直接执行 Git 命令，请选择 “完全克隆”。此选项只能由 CodeBuild 下游操作使用。

        如果选择此选项，则需要向您的 CodeBuild 服务角色添加codecommit:GitPull权限，如所示为 CodeCommit源操作添加 CodeBuild GitClone 权限。您还需要为 CodePipeline 服务角色添加codecommit:GetRepository权限，如所示向 CodePipeline 服务角色添加权限。如需查看教程以了解如何使用完整克隆选项，请参阅教程：使用带有 GitHub 管道源的完整克隆。

    • 选择 CodeCommit 存储库名称和分支后，更改检测选项中会显示一条消息，显示要为此管道创建的 Amazon Ev CloudWatch ents 规则。接受更改检测选项下面的默认值。这 CodePipeline 允许使用 Amazon E CloudWatch vents 来检测您的新管道的更改。

  • 对于亚马逊 ECR：

    • 在存储库名称中，选择您的 Amazon ECR 存储库的名称。

    • 在图像标签中，指定映像名称和版本（如果不同于）LATEST。

    • 在输出构件中，选择包含下一阶段要使用的图像名称和存储库URI信息的输出对象默认值，例如。 MyApp

      有关ECS使用 CodeDeploy蓝绿色部署（包括亚马逊ECR源阶段）为亚马逊创建管道的教程，请参阅教程：使用 Amazon ECR 源代码和 ECS-to-部署创建管道 CodeDeploy 。

    当您在管道中包含 Amazon ECR 源阶段时，当您提交更改时，源操作会生成一个imageDetail.json文件作为输出项目。有关 imageDetail.json 文件的信息，请参阅imageDetail用于亚马逊ECS蓝/绿部署操作的.json 文件。

  注意

  对象和文件类型必须与您计划使用的部署系统兼容（例如，Elastic Beanstalk 或）。 CodeDeploy受支持文件类型可能包括 .zip、.tar 和 .tgz 文件。有关 Elastic Beanstalk 的受支持容器类型的更多信息，请参阅自定义和配置 Elastic Beanstalk 环境和支持的平台。有关使用部署修订版的更多信息 CodeDeploy，请参阅上传您的应用程序修订版和准备修订版。

步骤 3：创建生成阶段

如果您计划在创建部署阶段，则此步骤是可选的。

• 在步骤 3：添加生成阶段页面上，执行下列操作之一，然后选择下一步：

  • 如果您计划创建部署阶段，请选择跳过构建阶段。

  • 从构建提供程序中，选择构建服务的自定义操作提供程序，并提供该提供程序的配置详细信息。有关如何添加 Jenkins 作为构建提供程序的示例，请参阅教程：创建一个四阶段管道。

  • 从构建提供程序中，选择 AWS CodeBuild。

    在区域中，选择资源所在的 AWS 区域。Re g ion 字段指定为此操作类型和提供者类型创建 AWS 资源的位置。仅为操作提供方是 AWS 服务的操作显示此字段。“区域” 字段默认为与您的管道相同的 AWS 区域。

    在项目名称中选择您的构建项目。如果您已经在中创建了构建项目 CodeBuild，请选择它。或者，您可以在中创建构建项目， CodeBuild 然后返回此任务。按照《CodeBuild用户指南》中的 “创建要使用的管道” CodeBuild 中的说明进行操作。

    在环境变量中，要将 CodeBuild环境变量添加到生成操作中，请选择添加环境变量。每个变量由三个条目组成：

    • 在名称中，输入环境变量的名称或键。

    • 在值中，输入环境变量的值。如果您为变量类型选择参数，请确保此值是您已经存储在 Sy AWS stems Manager 参数存储中的参数的名称。

      注意

      我们强烈不鼓励使用环境变量来存储敏感值，尤其是 AWS 证书。使用 CodeBuild 控制台或时 AWS CLI，环境变量将以纯文本形式显示。对于敏感值，我们建议您改用 参数 类型。

    • （可选）在类型中，输入环境变量的类型。有效值为明文或参数。默认值为明文。

    （可选）在构建类型中，选择下列选项之一：

    • 要在单个构建操作执行中运行每次构建，请选择单次构建。

    • 要在同一个构建操作执行中运行多次构建，请选择批处理构建。

    （可选）如果您选择运行批处理构建，则可以选择将批处理中的所有构件合并到一个位置，将所有构建构件放入单个输出构件中。

步骤 4：创建部署阶段

如果已创建了构建阶段，则此步骤为可选步骤。

• 在步骤 4：添加部署阶段页面上，执行下列操作之一，然后选择下一步：

  • 如果您在上一步中创建了构建阶段，则选择跳过部署阶段。

    注意

    如果您已跳过构建阶段，则不会显示此选项。

  • 在部署提供程序中，选择您为部署提供程序创建的自定义操作。

    在区域中，仅对于跨区域操作，请选择创建资源的 AWS 区域。区域字段指定为此操作类型和提供方类型创建 AWS 资源的位置。此字段仅在操作提供方是 AWS 服务的情况下对操作显示。“区域” 字段默认为与您的管道相同的 AWS 区域。

  • 在部署提供程序中，适用于默认提供商的字段如下所示：

    • CodeDeploy

      在应用程序名称中，输入或选择现有 CodeDeploy 应用程序的名称。在部署组中，输入应用程序的部署组的名称。选择下一步。您也可以在 CodeDeploy控制台中创建应用程序、部署组或两者兼而有之。

    • AWS Elastic Beanstalk

      在应用程序名称中，输入或选择现有 Elastic Beanstalk 应用程序的名称。在环境名称中，输入应用程序的环境。选择下一步。您还可以在 Elastic Beanstalk 控制台中创建应用程序和/或环境。

    • AWS OpsWorks Stacks

      在堆栈中，输入或选择要使用的堆栈的名称。在层中，选择目标实例所属的层。在 App 中，选择您要更新和部署的应用程序。如果您需要创建一个应用程序，请选择在 AWS OpsWorks中创建一个新的。

      有关将应用程序添加到堆栈和层中的信息 AWS OpsWorks，请参阅AWS OpsWorks 用户指南中的添加应用程序。

      有关如何使用中的简单管道 CodePipeline 作为在 AWS OpsWorks 层上运行的代码的源代码的 end-to-end 示例，请参阅 CodePipeline 与一起使用 AWS OpsWorks Stacks。

    • AWS CloudFormation

      请执行以下操作之一：

      • 在操作模式下，选择创建或更新堆栈，输入堆栈名称和模板文件名，然后选择 AWS CloudFormation 要担任的角色的名称。（可选）输入配置文件的名称并选择一个IAM功能选项。

      • 在操作模式下，选择创建或替换更改集，输入堆栈名称和更改集名称，然后选择 AWS CloudFormation 要担任的角色的名称。（可选）输入配置文件的名称并选择一个IAM功能选项。

      有关将 AWS CloudFormation 功能集成到管道中的信息 CodePipeline，请参阅《AWS CloudFormation 用户指南》 CodePipeline中的使用持续交付。

    • Amazon ECS

      在集群名称中，输入或选择现有 Amazon ECS 集群的名称。在服务名称中，输入或选择在集群上运行的服务的名称。您还可以创建集群和服务。在映像文件名中，键入描述服务的容器和映像的映像定义文件的名称。

      注意

      Amazon ECS 部署操作需要一个imagedefinitions.json文件作为部署操作的输入。该文件的默认文件名为 imagedefinitions.json。如果您选择使用不同的文件名，则必须在创建管道部署阶段时提供。有关更多信息，请参阅 用于亚马逊标准部署操作的 imagedefinitions.json 文件 ECS。

      选择下一步。

      注意

      确保您的 Amazon ECS 集群配置了两个或更多实例。Amazon ECS 集群必须包含至少两个实例，这样一个实例才能保留为主实例，另一个用于容纳新的部署。

      有关使用管道部署基于容器的应用程序的教程，请参阅教程：使用进行持续部署。 CodePipeline

    • 亚马逊ECS（蓝色/绿色）

      输入 CodeDeploy 应用程序和部署组、Amazon ECS 任务定义和 AppSpec 文件信息，然后选择 “下一步”。

      注意

      AmazonECS（蓝/绿）操作需要一个 imageDetail .json 文件作为部署操作的输入项目。由于 Amazon s ECR ource 操作会创建此文件，因此带有 Amazon ECR 源操作的管道无需提供imageDetail.json文件。有关更多信息，请参阅 imageDetail用于亚马逊ECS蓝/绿部署操作的.json 文件。

      有关使用创建蓝绿色部署到 Amazon ECS 集群的管道的教程 CodeDeploy，请参阅教程：使用 Amazon ECR 源代码和 ECS-to-部署创建管道 CodeDeploy 。

    • AWS Service Catalog

      如果您要使用控制台中的字段指定配置，请选择输入部署配置，如果您有单独的配置文件，请选择配置文件。输入产品和配置信息，然后选择下一步。

      有关使用管道将产品更改部署到 Service Catalog 的教程，请参阅教程：创建部署到 Service Catalog 的管道。

    • Alexa Skills Kit

      在 Alexa Skill ID 中，为您的 Alexa 技能输入技能 ID。在客户 ID 和客户密钥中，输入使用 Login with Amazon (LWA) 安全配置文件生成的凭证。在刷新令牌中，输入您使用用于检索刷新令牌的ASKCLI命令生成的刷新令牌。选择下一步。

      有关在管道中部署 Alexa 技能和生成LWA证书的教程，请参阅教程：创建部署 Amazon Alexa 技能的管道。

    • Amazon S3

      在存储桶中，您要使用的 S3 存储桶的名称。如果部署阶段的输入对象是文件，请选择部署前提取ZIP文件。如果选择了 “部署前提取文件”，则可以选择为将ZIP文件解压缩到的部署路径输入一个值。如果未选择，则您需要在 S3 对象键中输入一个值。

      注意

      大多数源和构建阶段输出构件都会被压缩。除了 Amazon S3 之外的所有管道源提供方都会先压缩源文件，然后再将它们作为输入构件提供给下一个操作。

      （可选）在 “已安装” 中ACL，输入ACL要应用于部署到 Amazon S3 的对象的封装。

      注意

      应用罐装ACL会覆盖ACL应用于该对象的任何现有内容。

      （可选）在缓存控制中，为从存储桶下载对象的请求指定缓存控制参数。有关有效值的列表，请参阅HTTP操作标Cache-Control题字段。要在缓存控件中输入多个值，请在每个值之间使用逗号。您可以在每个逗号后添加一个空格（可选），如本示例所示。

      

      前面的示例条目显示在中，CLI如下所示：

      "CacheControl": "public, max-age=0, no-transform"

      选择下一步。

      有关使用 Amazon S3 部署操作提供方创建管道的教程，请参阅教程：创建以 Amazon S3 作为部署提供程序的管道。

步骤 5：审核管道

• 在步骤 5：审核页面上，查看您的管道配置，然后选择创建管道以创建管道，或者选择上一步返回并编辑您的选择。要退出向导而不创建管道，请选择 Cancel。

创建 JSON 文件

1. 在终端（Linux、macOS 或 Unix）或命令提示符 (Windows) 处，在本地目录中创建新的文本文件。

2. （可选）您可以添加一个或多个管道级变量。你可以在 CodePipeline 动作配置中引用这个值。您可以在创建管道时添加变量名称和值，也可以在控制台中启动管道时选择赋值。

   注意

   虽然添加管道级变量是可选的，但如果使用管道级变量指定了管道而没有提供变量值，管道执行将失败。

   管道级变量是在管道运行时解析的。所有变量都是不可变的，这意味着它们在赋值后无法更新。已解析值的管道级变量将显示在每个执行的历史记录中。

   您可以使用管道结构中的变量属性提供管道级变量。在以下示例中，变量 Variable1 的值为 Value1。

          "variables": [
               {
                   "name": "Timeout",
                   "defaultValue": "1000",
                   "description": "description"
               }
           ]

   将此结构添加到您的管道中JSON，或者添加到以下步骤JSON中的示例中。有关变量的更多信息，包括命名空间信息，请参阅变量参考。

3. 在纯文本编辑器中打开该文件并编辑值，以反映您要创建的结构。您必须至少更改管道的名称。您还应考虑是否要更改：

   • 用于存储此管道的构件的 S3 存储桶。

   • 代码的源位置。

   • 部署提供程序。

   • 您希望如何部署代码。

   • 管道的标签。

   下面的两阶段示例管道结构突出显示了您应考虑为您的管道更改的值。您的管道可能包含两个以上的阶段：

   {
       "pipeline": {
           "roleArn": "arn:aws:iam::80398EXAMPLE::role/AWS-CodePipeline-Service",  
           "stages": [
               {
                   "name": "Source",
                   "actions": [
                       {
                           "inputArtifacts": [],
                           "name": "Source",
                           "actionTypeId": {
                               "category": "Source",
                               "owner": "AWS",
                               "version": "1",
                               "provider": "S3"
                           },
                           "outputArtifacts": [
                               {
                                   "name": "MyApp"
                               }
                           ],
                           "configuration": {
                               "S3Bucket": "amzn-s3-demo-source-bucket",
                               "S3ObjectKey": "ExampleCodePipelineSampleBundle.zip",
                               "PollForSourceChanges": "false"
                           },
                           "runOrder": 1                       
                       }
                   ]
               },
               {
                   "name": "Staging",
                   "actions": [
                       {
                           "inputArtifacts": [
                               {
                                   "name": "MyApp"
                               }
                           ],
                           "name": "Deploy-CodeDeploy-Application",
                           "actionTypeId": {
                               "category": "Deploy",
                               "owner": "AWS",
                               "version": "1",
                               "provider": "CodeDeploy"
                           },
                           "outputArtifacts": [],
                           "configuration": {
                               "ApplicationName": "CodePipelineDemoApplication",
                               "DeploymentGroupName": "CodePipelineDemoFleet"
                           },
                           "runOrder": 1
                       }
                   ]
               }
           ],
           "artifactStore": {
               "type": "S3",
               "location": "codepipeline-us-east-2-250656481468"
           },
           "name": "MyFirstPipeline",
           "version": 1,
           "variables": [
               {
                   "name": "Timeout",
                   "defaultValue": "1000",
                   "description": "description"
               }
             ]
           },
           "triggers": [
               {
                   "providerType": "CodeStarSourceConnection",
                   "gitConfiguration": {
                       "sourceActionName": "Source",
                       "push": [
                           {
                               "tags": {
                                   "includes": [
                                       "v1"
                                   ],
                                   "excludes": [
                                       "v2"
                                   ]
                               }
                           }
                       ]
                   }
               }
           ]
       "metadata": {
           "pipelineArn": "arn:aws:codepipeline:us-east-2:80398EXAMPLE:MyFirstPipeline",
           "updated": 1501626591.112,
           "created": 1501626591.112
       },
       "tags": [{
         "key": "Project",
         "value": "ProjectA"
       }]
   } 

   此示例通过在管道上包含 Project 标签键和 ProjectA 值来为管道添加标记。有关在中为资源添加标签的更多信息 CodePipeline，请参阅标记资源。

   确保JSON文件中的PollForSourceChanges参数设置如下：

                   "PollForSourceChanges": "false",

   CodePipeline 使用 Amazon Ev CloudWatch ents 来检测您的 CodeCommit 源存储库和分支或 S3 源存储桶中的更改。下一步包括手动为您的管道创建这些资源的说明。将此标记设置为 false 将禁用定期检查，当您使用建议的更改检测方法时不需要定期检查。

4. 要在您的管道所在区域之外的区域创建构建、测试或部署操作，您必须向管道结构添加以下内容。有关说明，请参阅 在中添加跨区域操作 CodePipeline。

   • 将 Region 参数添加到您的操作的管道结构。

   • 使用artifactStores参数为您要执行操作的每个 AWS 区域指定一个对象存储桶。

5. 如果您对其结构感到满意，请使用类似 pipeline.json 的名称保存您的文件。

要创建管道

1. 运行create-pipeline命令并使用--cli-input-json参数指定您之前创建的JSON文件。

   创建名为的管道 MySecondPipeline 还有一个名为 pipeline.json 的JSON文件，其中包含名为”MySecondPipeline“作为name中的值JSON，你的命令将如下所示：

   aws codepipeline create-pipeline --cli-input-json file://pipeline.json

   重要

   务必在文件名前包含 file://。此命令中需要该项。

   该命令会返回您创建的整个管道的结构。

2. 要查看管道，可以打开 CodePipeline 控制台并从管道列表中进行选择，也可以使用get-pipeline-state命令。有关更多信息，请参阅 在中查看管道和详细信息 CodePipeline。

3. 如果您使用创建管道，则必须为管道手动创建推荐的更改检测资源：CLI

   • 对于包含 CodeCommit 存储库的管道，您必须手动创建 CloudWatch 事件规则，如中所述为 CodeCommit 来源创建 EventBridge 规则 (CLI)。

   • 对于包含 Amazon S3 源的管道，您必须手动创建 CloudWatch 事件规则和 AWS CloudTrail 跟踪，如中所述连接到使用 EventBridge 和的 Amazon S3 源操作 AWS CloudTrail。