在 CodePipeline 中创建和添加自定义操作

使用 AWS CLI 创建自定义操作

1. 打开文本编辑器，为您的自定义操作创建一个 JSON 文件，其中包括操作类别、操作提供程序以及您的自定义操作所需的任何设置。例如，要创建一个只需一个属性的自定义生成操作，您的 JSON 文件可能类似下面这样：

   {
       "category": "Build",
       "provider": "My-Build-Provider-Name",
       "version": "1",
       "settings": {
           "entityUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/",
           "executionUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/"
       },
       "configurationProperties": [{
           "name": "ProjectName",
           "required": true,
           "key": true,
           "secret": false,
           "queryable": false,
           "description": "The name of the build project must be provided when this action is added to the pipeline.",
           "type": "String"
       }],
       "inputArtifactDetails": {
           "maximumCount": integer,
           "minimumCount": integer
       },
       "outputArtifactDetails": {
           "maximumCount": integer,
           "minimumCount": integer
       },
       "tags": [{
         "key": "Project",
         "value": "ProjectA"
       }]
   }

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

   JSON 文件中有两个属性：entityUrlTemplate 和 executionUrlTemplate。只要配置属性是必需的且不为私有，您就可以遵照以下格式在 URL 模板内引用自定义操作的配置属性中的名称：{Config:name}。例如，在以上示例中，entityUrlTemplate 值是指配置属性 ProjectName。

   • entityUrlTemplate：用于提供操作服务提供方相关信息的静态链接。在示例中，构建系统包含一个指向每个构建项目的静态链接。链接格式可能不同，具体取决于您的构建提供程序（或者如果您创建的是其他操作类型，比如测试，则取决于其他服务提供方）。您必须提供此链接格式，以便在添加自定义操作时，用户可以选择此链接来打开浏览器，从而打开您的网站上提供生成项目 (或测试环境) 具体细节的页面。

   • executionUrlTemplate：将会使用有关当前或最新运行的操作进行更新的动态链接。当您的自定义作业辅助角色更新作业的状态（例如成功、失败或正在进行）时，它还将提供一个 externalExecutionId 用于完成此链接。此链接可用于提供有关操作运行的详细信息。

   例如，当您查看管道中的操作时，您将看到以下两个链接：

   

   此静态链接在您添加自定义操作时显示，指向 entityUrlTemplate 中您在创建自定义操作时指定的地址。

   此动态链接在每次操作运行后更新，指向 executionUrlTemplate 中您在创建自定义操作时指定的地址。

   有关这些链接类型以及 RevisionURLTemplate 和 ThirdPartyURL 的更多信息，请参阅 CodePipeline API 参考中的 ActionTypeSettings 和 CreateCustomActionType。有关操作结构要求以及如何创建操作的更多信息，请参阅 CodePipeline 管道结构参考。

2. 保存 JSON 文件，并为其提供一个方便记忆的名称（例如，MyCustomAction.json）。

3. 在您安装了 AWS CLI 的计算机上打开终端会话 (Linux、OS X、Unix) 或命令提示符 (Windows)。

4. 使用 AWS CLI 运行 aws codepipeline create-custom-action-type 命令，并指定您刚创建的 JSON 文件的名称。

   例如，要创建一个构建自定义操作：

   重要

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

   aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json

5. 该命令将返回您创建的自定义操作的整个结构以及为您添加的 JobList 操作配置属性。在管道中添加自定义操作时，您可以使用 JobList 来指定您可以在提供程序的哪些项目中轮询作业。如果您不配置此操作，则您的自定义作业辅助角色轮询作业时将会返回所有可用作业。

   例如，上述命令可能会返回类似以下的结构：

   {
       "actionType": {
           "inputArtifactDetails": {               
               "maximumCount": 1,                
               "minimumCount": 1
          },
          "actionConfigurationProperties": [
               {
                   "secret": false,
                   "required": true,
                   "name": "ProjectName",
                   "key": true,
                   "description": "The name of the build project must be provided when this action is added to the pipeline."
               }
           ],
           "outputArtifactDetails": {               
               "maximumCount": 0,                
               "minimumCount": 0
           },
           "id": {
               "category": "Build",
               "owner": "Custom",
               "version": "1",
               "provider": "My-Build-Provider-Name"
           },
           "settings": {
               "entityUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/",
               "executionUrlTemplate": "https://my-build-instance/job/mybuildjob/lastSuccessfulBuild/{ExternalExecutionId}/"
           }
       }
   }

   注意

   作为 create-custom-action-type 命令输出的一部分，id 部分包括 "owner": "Custom"。CodePipeline 会自动分配 Custom 以作为自定义操作类型的拥有者。使用 create-custom-action-type 命令或 update-pipeline 命令时，无法分配或更改此值。

设置 Amazon EC2 实例

1. 了解更多有关 Amazon EC2 的信息，并确定其是否为适合您的集成的正确选择。有关信息，请参阅 Amazon EC2 – 虚拟服务器托管。

2. 开始创建您的 Amazon EC2 实例。有关信息，请参阅开始使用 Amazon EC2 Linux 实例。

若要设置身份联合验证

1. 了解有关 IAM 身份联合验证的更多信息。有关信息，请参阅管理联合身份验证。

2. 查看授予临时访问权限的情形中的示例，以确定最适合您的自定义操作需求的临时访问情形。

3. 查看与您的基础设施相关的联合身份验证代码示例，例如：

   • Identity Federation Sample Application for an Active Directory Use Case。

4. 开始配置联合身份验证。有关信息，请参阅 IAM 用户指南 中的身份提供程序和联合身份验证。

1. 打开终端会话（Linux、macOS 或 Unix）或命令提示符 (Windows)，然后运行 get-pipeline 命令，将要编辑的管道结构复制到 JSON 文件中。例如，对于名为 MyFirstPipeline 的管道，可以键入以下命令：

   aws codepipeline get-pipeline --name MyFirstPipeline >pipeline.json

   该命令不会返回任何结果，但您创建的文件将出现在您运行命令所在的目录中。

2. 在任何文本编辑器中打开 JSON 文件，修改文件结构，以便将您的自定义操作添加到一个现有阶段中。

   注意

   如果您希望您的操作与此阶段中的另一操作并行运行，请确保为其分配与另一操作相同的 runOrder 值。

   例如，要修改管道结构，以添加一个名为 Build 的阶段并将一个生成自定义操作添加到该阶段中，您可以将 JSON 修改为在部署阶段之前添加 Build 阶段，如下所示：

   ,
       {
         "name": "MyBuildStage",
         "actions":  [
                 {
                   "inputArtifacts": [
                   {
                      "name": "MyApp"
                    }
                      ],
                       "name": "MyBuildCustomAction",
                       "actionTypeId": {
                           "category": "Build",
                           "owner": "Custom",
                           "version": "1",
                           "provider": "My-Build-Provider-Name"
                       },
                       "outputArtifacts": [
                           {
                             "name": "MyBuiltApp"
                           }
                       ],
                       "configuration": {
                           "ProjectName": "MyBuildProject"
                       },
                       "runOrder": 1
                   }
               ]
           },      
           {
               "name": "Staging",
               "actions": [
                       {
                           "inputArtifacts": [
                               {
                                   "name": "MyBuiltApp"
                               }
                           ],
                           "name": "Deploy-CodeDeploy-Application",
                           "actionTypeId": {
                               "category": "Deploy",
                               "owner": "AWS",
                               "version": "1",
                               "provider": "CodeDeploy"
                           },
                           "outputArtifacts": [],
                           "configuration": {
                               "ApplicationName": "CodePipelineDemoApplication",
                               "DeploymentGroupName": "CodePipelineDemoFleet"
                           },
                           "runOrder": 1
                       }
                   ]
                }      
       ]
   }

3. 要应用更改，请运行 update-pipeline 命令并指定一个管道 JSON 文件，类似于以下内容：

   重要

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

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

   该命令会返回编辑后的管道的整个结构。

4. 打开 CodePipeline 控制台，并选择刚才编辑的管道的名称。

   管道将显示您的更改。当您下一次更改源位置时，管道会通过管道修订后的结构运行该修订。