Referência do modelo de integração

Há várias integrações predefinidas para serviços de terceiros que ajudarão a incorporar as ferramentas existentes do cliente no processo de liberação do pipeline. Parceiros ou provedores de serviços terceirizados usam um modelo de integração para implementar tipos de ação a serem usados no CodePipeline.

Use essa referência ao planejar ou trabalhar com tipos de ação gerenciados com um modelo de integração compatível no CodePipeline.

Para certificar seu tipo de ação de terceiros como uma integração de parceiro com o CodePipeline, consulte a Rede de Parceiros da AWS (APN). Essas informações são um complemento à Referência da AWS CLI.

Como os tipos de ação de terceiros funcionam com o integrador

Você pode adicionar tipos de ação de terceiros aos pipelines do cliente para concluir tarefas nos recursos do cliente. O integrador gerencia as solicitações de trabalho e executa a ação com o CodePipeline. O diagrama a seguir mostra um tipo de ação de terceiros criado para os clientes usarem em seu pipeline. Depois que o cliente configura a ação, ela é executada e cria solicitações de trabalho que são processadas pelo mecanismo de ação do integrador.

O diagrama mostra as seguintes etapas:

Para obter informações sobre as etapas que você pode usar para solicitar, visualizar e atualizar um tipo de ação, consulte Como trabalhar com tipos de ação.

Conceitos

Esta seção usa os seguintes termos para tipos de ação de terceiros:

Modelos de integração compatíveis

O CodePipeline tem dois modelos de integração:

Para fins de comparação, a tabela a seguir descreve os atributos dos dois modelos:

Modelo de integração do Lambda

O modelo de integração do Lambda compatível inclui a criação da função do Lambda e a definição da saída para o tipo de ação de terceiros.

Atualize a função do Lambda para processar a entrada do CodePipeline

Crie uma nova função do Lambda. Você pode adicionar lógica de negócios à função do Lambda, que é executada sempre que há um trabalho disponível no pipeline para o tipo de ação. Por exemplo, considerando o contexto do cliente e do pipeline, talvez você queira começar a criar seu serviço para o cliente.

Use os parâmetros a seguir para atualizar a função do Lambda a fim de processar a entrada do CodePipeline.

Formato:

Tipos de dados:

Exemplo:

{
    "jobId": "01234567-abcd-abcd-abcd-012345678910",
    "accountId": "012345678910",
    "data": {
        "actionConfiguration": {
            "key1": "value1",
            "key2": "value2"
        },
        "encryptionKey": {
            "id": "123-abc",
            "type": "KMS"
        },
        "inputArtifacts": [
            {
                "name": "input-art-name",
                "location": {
                    "type": "S3",
                    "s3Location": {
                        "bucketName": "inputBucket",
                        "objectKey": "inputKey"
                    }
                }
            }
        ],
        "outputArtifacts": [
            {
                "name": "output-art-name",
                "location": {
                    "type": "S3",
                    "s3Location": {
                        "bucketName": "outputBucket",
                        "objectKey": "outputKey"
                    }
                }
            }
        ],
        "actionExecutionId": "actionExecutionId",
        "actionCredentials": {
            "accessKeyId": "access-id",
            "secretAccessKey": "secret-id",
            "sessionToken": "session-id"
        },
        "continuationToken": "continueId-xxyyzz"
    }
}

Retornar os resultados da função do Lambda ao CodePipeline

O operador de trabalho do integrador deve retornar uma payload válida em casos de êxito, falha ou continuação.

Formato:

Exemplo:

{
    "result": "success",
    "failureType": null,
    "continuation": null,
    "status": {
        "externalExecutionId": "my-commit-id-123",
        "summary": "everything is dandy"
    },
    "outputVariables": {
        "FirstOne": "Nice",
        "SecondOne": "Nicest",
        ...
    }        
}

Use tokens de continuação para aguardar os resultados de um processo assíncrono

O token continuation faz parte da payload e do resultado da função do Lambda. É uma forma de passar o estado do trabalho para o CodePipeline e indicar que o trabalho precisa ser continuado. Por exemplo, depois que um integrador inicia uma compilação para o cliente em seu recurso, ele não espera a conclusão da compilação, mas indica ao CodePipeline que não tem um resultado "terminal" ao retornar result como continue e retornar o ID exclusivo da compilação ao CodePipeline como token continuation.

A equipe do CodePipeline chama o integrador após 30 segundos com o mesmo token continuation em sua payload para que ele possa verificar sua conclusão. Se a compilação for concluída, o integrador retornará o resultado terminal de êxito/falha; caso contrário, ela continuará.

Forneça ao CodePipeline as permissões para chamar a função do Lambda do integrador em runtime

Você adiciona permissões à função do Lambda do integrador para fornecer ao serviço do CodePipeline permissões para chamá-lo usando a entidade principal do CodePipeline: codepipeline.amazonaws.com. Você pode adicionar permissões usando o CloudFormation ou a linha de comando. Para obter um exemplo, consulte Como trabalhar com tipos de ação.

Modelo de integração do operador de trabalho

Após designar o fluxo de trabalho de alto nível, você poderá criar o operador de trabalho. Embora as especificidades da ação de terceiros determine o que é necessário para o operador de trabalho, a maioria dos operadores de trabalho das ações de terceiros incluem a seguinte funcionalidade:

Escolher e configurar uma estratégia de gerenciamento de permissões para o operador de trabalho

Para desenvolver um operador de trabalho para a ação de terceiros do CodePipeline, será necessária uma estratégia para a integração de gerenciamento de usuários e permissões.

A estratégia mais simples é adicionar a infraestrutura necessária para seu operador de trabalho criando instâncias do Amazon EC2 com uma função de instância do AWS Identity and Access Management (IAM), que permite aumentar verticalmente a escala dos recursos necessários à integração. Você pode usar a integração incorporada com a AWS para simplificar a interação entre o operador de trabalho e o CodePipeline.

Saiba mais sobre o Amazon EC2 e determine se essa é a escolha certa para sua integração. Para obter mais informações, consulte Amazon EC2 – Hospedagem de servidor virtual. Para obter informações sobre como configurar uma instância do Amazon EC2, consulte Conceitos básicos das instâncias do Linux do Amazon EC2.

Outra estratégia a ser considerada é usar a federação de identidades com o IAM para integrar o sistema e os recursos existentes do provedor de identidades. Essa estratégia é útil se você já tiver um provedor de identidades corporativas ou já estiver configurado para oferecer suporte aos usuários usando provedores de identidades da web. A federação de identidades permite que você conceda acesso seguro aos recursos da AWS, incluindo o CodePipeline, sem precisar criar ou gerenciar usuários do IAM. É possível usar recursos e políticas para requisitos de segurança de senhas e rotação de credenciais. Você pode usar aplicações de exemplo como modelos para seu próprio design. Para mais informações, consulte Gerenciar federação.

Para conceder acesso, adicione as permissões aos seus usuários, grupos ou perfis:

Veja a seguir uma política de exemplo que você pode criar para usar com o operador de trabalho de terceiros. Essa política serve somente como exemplo e é fornecida no estado em que encontra.

JSON

{
  "Version":"2012-10-17",		 	 	 
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codepipeline:PollForThirdPartyJobs",
        "codepipeline:AcknowledgeThirdPartyJob",
        "codepipeline:GetThirdPartyJobDetails",
        "codepipeline:PutThirdPartyJobSuccessResult",
        "codepipeline:PutThirdPartyJobFailureResult"
      ],
      "Resource": [
        "arn:aws:codepipeline:us-east-2::actionType:ThirdParty/Build/Provider/1/"  
      ]              
    }
  ]
}