Criar e adicionar uma ação personalizada no CodePipeline

Para criar uma ação personalizada com o AWS CLI

1. Abra um editor de texto e crie um arquivo JSON para sua ação personalizada que inclua a categoria da ação, o provedor da ação e as configurações necessárias para sua ação personalizada. Por exemplo, para criar uma ação de construção personalizada que requeira apenas uma propriedade, seu arquivo JSON pode ter a seguinte aparência:

   {
       "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"
       }]
   }

   Este exemplo adiciona tags à ação personalizada por meio da inclusão da chave de tag Project e o valor ProjectA na ação personalizada. Para obter mais informações sobre a marcação de recursos em CodePipeline, consulteMarcando atributos .

   Há duas propriedades incluídas no arquivo JSON, entityUrlTemplate e executionUrlTemplate. Você pode consultar um nome nas propriedades de configuração da ação personalizada dentro dos modelos de URL, seguindo o formato {Config:name}, desde que a propriedade de configuração seja necessária e não secreta. Por exemplo, no exemplo acima, o entityUrlTemplate valor se refere à propriedade de configuraçãoProjectName.

   • entityUrlTemplate: o link estático que fornece informações sobre o provedor de serviços para a ação. No exemplo, o sistema de construção inclui um link estático para cada projeto de construção. O formato do link poderá variar, dependendo do seu provedor de construção (ou, se estiver criando um outro tipo de ação, como teste, outro provedor de serviços). Você deve fornecer este formato de link de forma que quando a ação personalizada for adicionada, o usuário possa escolher este link para abrir um navegador em uma página de seu site que forneça informações específicas para o projeto de criação (ou ambiente de teste).

   • executionUrlTemplate: o link dinâmico que será atualizado com informações sobre a execução atual ou mais recente da ação. Quando seu operador de trabalho personalizado atualiza o status de uma tarefa (por exemplo, sucesso, falha ou em andamento), ele também fornece uma externalExecutionId que será usada para completar o link. Este link pode ser usado para fornecer detalhes sobre a execução de uma ação.

   Por exemplo, quando você visualizar a ação no pipeline, você verá os dois links a seguir:

   

   Este link estático é exibido depois que você adicionar sua ação personalizada e aponta para o endereço no entityUrlTemplate, que você especifica ao criar sua ação personalizada.

   Este link dinâmico é atualizado após cada execução da ação e aponta para o endereço no executionUrlTemplate, que você especifica ao criar sua ação personalizada.

   Para obter mais informações sobre esses tipos de link, bem como RevisionURLTemplate eThirdPartyURL, consulte ActionTypeSettingse CreateCustomActionTypena Referência da CodePipeline API. Para mais informações sobre os requisitos de estrutura de ação e como criar uma ação, consulte CodePipeline referência de estrutura de tubulação.

2. Salve o arquivo JSON e dê a ele um nome fácil de lembrar (por exemplo, MyCustomAction .json).

3. Abra uma sessão de terminal (Linux, OS X, Unix) ou prompt de comando (Windows) em um computador onde você tenha instalado o AWS CLI.

4. Use o AWS CLI para executar o aws codepipeline create-custom-action-type comando, especificando o nome do arquivo JSON que você acabou de criar.

   Por exemplo, para criar uma ação personalizada de compilação:

   Importante

   Não se esqueça de incluir file:// antes do nome de arquivo. Ele é obrigatório nesse comando.

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

5. Este comando retorna a estrutura inteira da ação personalizada que você criou, bem como a propriedade de configuração da ação JobList, que é adicionada para você. Quando você adiciona a ação personalizada a um pipeline, você pode usar JobList para especificar quais projetos do provedor você pode consultar para tarefas. Se você não configurar isso, todos as tarefas disponíveis serão retornadas quando o operador do trabalho personalizado efetuar uma consulta por tarefas.

   Por exemplo, o comando anterior pode retornar uma estrutura similar ao seguinte:

   {
       "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}/"
           }
       }
   }

   nota

   Como parte da saída do create-custom-action-type comando, a id seção inclui"owner": "Custom". CodePipeline é automaticamente atribuído Custom como proprietário dos tipos de ação personalizados. Esse valor não pode ser atribuído ou alterado quando você usar o comando create-custom-action-type ou o comando update-pipeline.

Para configurar EC2 instâncias da Amazon

1. Saiba mais sobre a Amazon EC2 e determine se ela é a escolha certa para sua integração. Para obter informações, consulte Amazon EC2 - Virtual Server Hosting.

2. Comece a criar suas EC2 instâncias da Amazon. Para obter mais informações, consulte Conceitos básicos das instâncias EC2 Linux da Amazon.

Para configurar a federação de identidades

1. Saiba mais sobre a federação de identidades do IAM. Para mais informações, consulte Gerenciar federação.

2. Analise os exemplos em Situações de concessão de acesso temporário para identificar o cenário para acesso temporário que melhor atenda às necessidades de sua ação personalizada.

3. Revise os exemplos de código de federação de identidades relevantes para sua infraestrutura, como:

   • Aplicativo de amostra de federação de identidades para um caso de uso do diretório ativo

4. Comece a configuração da federação de identidades. Para obter informações, consulte Provedores e federação de identidades no Guia do usuário do IAM.

1. Abra uma sessão de terminal (Linux, macOS ou Unix) ou prompt de comando (Windows) e execute o comando get-pipeline para copiar a estrutura do pipeline a ser editada para um arquivo JSON. Por exemplo, para um pipeline chamado MyFirstPipeline, você deve digitar o seguinte comando:

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

   Este comando retorna nada, mas o arquivo que você criou deve aparecer no diretório onde você executou o comando.

2. Abra o arquivo JSON em qualquer editor de texto e modifique a estrutura do arquivo para adicionar sua ação personalizada a um estágio existente.

   nota

   Se você deseja que a sua ação seja executada em paralelo com outra ação naquele estágio, certifique-se de atribuir-lhe o mesmo valor runOrder da ação.

   Por exemplo, para modificar a estrutura de um pipeline para adicionar um estágio chamado construção e adicionar uma ação de construção personalizada para esse estágio, você deve modificar o JSON para adicionar o estágio Construção antes de um estágio de implantação, conforme a seguir:

   ,
       {
         "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. Para aplicar suas alterações, execute o comando update-pipeline, especificando o pipeline do arquivo JSON, de modo semelhante ao seguinte:

   Importante

   Não se esqueça de incluir file:// antes do nome de arquivo. Ele é obrigatório nesse comando.

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

   Este comando retorna toda a estrutura do pipeline editado.

4. Abra o CodePipeline console e escolha o nome do pipeline que você acabou de editar.

   O pipeline exibirá suas alterações. Na próxima vez que você alterar a localização de origem, o pipeline executará a revisão através da estrutura revisada do pipeline.