View a markdown version of this page

Conectando GitHub - AWS DevOps Agente

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Conectando GitHub

GitHub a integração permite que o AWS DevOps Agente acesse repositórios de código e receba eventos de implantação durante investigações de incidentes. Essa integração segue um processo de duas etapas: registro em nível de conta GitHub, seguido pela conexão de repositórios específicos a Agent Spaces individuais.

AWS DevOps O agente é compatível com GitHub instâncias.com (SaaS) e GitHub Enterprise Server (auto-hospedadas).

Pré-requisitos

Antes de se conectar GitHub, verifique se você tem:

  • Acesso ao console de administração do AWS DevOps agente

  • Uma conta de GitHub usuário ou organização com permissões de administrador

  • Autorização para instalar GitHub aplicativos em sua conta ou organização

Para o GitHub Enterprise Server, você também precisa:

  • Uma instância do GitHub Enterprise Server (versão 3.x ou posterior) acessível por HTTPS

  • O URL HTTPS da sua instância do GitHub Enterprise Server (por exemplo,https://github.example.com)

  • (Opcional) Uma conexão privada, se sua instância do GitHub Enterprise Server não estiver acessível publicamente

Registro GitHub (nível da conta)

GitHub é registrado no nível da AWS conta e compartilhado entre todos os Agent Spaces dessa conta. Você só precisa se registrar GitHub uma vez por AWS conta.

Etapa 1: Navegar até os fornecedores de funil

  1. Faça login no console AWS de gerenciamento

  2. Navegue até o console do AWS DevOps agente

  3. Vá para a guia Capacidades

  4. Na seção Pipeline, clique em Adicionar

  5. GitHubSelecione na lista de provedores disponíveis

Se GitHub ainda não tiver sido registrado, você será solicitado a registrá-lo primeiro.

Etapa 2: Escolha o tipo de conexão

Na tela “Registrar GitHub conta/organização”, selecione se você está se conectando como usuário ou organização:

  • Usuário — Sua GitHub conta pessoal com nome de usuário e perfil

  • Organização — Uma GitHub conta compartilhada em que várias pessoas podem colaborar em vários projetos ao mesmo tempo

Se você estiver se conectando a uma instância do GitHub Enterprise Server, marque a caixa de seleção Usar GitHub Enterprise Server e insira a URL HTTPS da sua instância (por exemplo,https://github.example.com).

Se sua instância do GitHub Enterprise Server não estiver acessível publicamente, você pode, opcionalmente, configurar uma conexão privada para permitir que o AWS DevOps Agente acesse sua instância com segurança. Para obter mais informações, consulte Conectando-se a ferramentas hospedadas de forma privada.

nota

Não /api/v3 inclua nenhum caminho final no URL — insira somente o URL base.

Etapa 3: configurar o GitHub aplicativo

Clique em Enviar para iniciar o processo de configuração do aplicativo. As próximas etapas são diferentes dependendo se você está se conectando a GitHub .com ou ao GitHub Enterprise Server.

Para GitHub .com

  1. Você será redirecionado para GitHub instalar o GitHub aplicativo AWS DevOps Agent.

  2. Selecione em qual conta ou organização instalar o aplicativo.

  3. O aplicativo permite que o AWS DevOps Agente receba eventos de repositórios conectados, incluindo eventos de implantação.

Para servidor GitHub corporativo

GitHub O Enterprise Server usa um fluxo de manifesto de GitHub aplicativo, que configura automaticamente um novo GitHub aplicativo na sua instância. Isso envolve dois redirecionamentos para sua instância do GitHub Enterprise Server.

  1. Seu navegador será redirecionado para a página “Criar GitHub aplicativo” da sua instância do GitHub Enterprise Server.

  2. Você verá o nome do aplicativo pré-preenchido. Sinta-se à vontade para alterar o nome conforme necessário. Clique em Criar GitHub aplicativo.

  3. Você será redirecionado de volta para o AWS DevOps Agent, que troca o código do manifesto pelas credenciais do aplicativo.

Etapa 4: selecionar repositórios e concluir a instalação

  1. Você verá a página Instalar e Autorizar do GitHub aplicativo.

  2. Selecione quais repositórios permitir que o aplicativo acesse:

    • Todos os repositórios — Conceda acesso a todos os repositórios atuais e futuros

    • Selecione somente repositórios — Escolha repositórios específicos da sua conta ou organização

  3. Clique em Instalar e autorizar.

  4. Você será redirecionado de volta ao console do AWS DevOps agente, onde GitHub aparecerá como registrado no nível da conta.

Conectando repositórios a um Espaço do Agente

Depois de se registrar GitHub no nível da conta, você pode conectar repositórios específicos a Agent Spaces individuais:

  1. No console do AWS DevOps agente, selecione seu Espaço do agente

  2. Vá para a guia Capacidades

  3. Na seção Pipeline, clique em Adicionar

  4. GitHubSelecione na lista de provedores disponíveis

  5. Selecione o subconjunto de repositórios relevantes para esse Espaço do Agente

  6. Clique em Adicionar para concluir a conexão

Você pode conectar diferentes conjuntos de repositórios a diferentes Agent Spaces com base nas suas necessidades organizacionais.

Entendendo o GitHub aplicativo

O GitHub aplicativo AWS DevOps Agent:

  • Solicita acesso aos seus repositórios — você pode revisar as permissões específicas durante a instalação do GitHub aplicativo

  • Recebe eventos de implantação e outros eventos do repositório

  • Permite que o AWS DevOps agente correlacione alterações de código com incidentes operacionais

  • Pode ser desinstalado a qualquer momento por meio de suas configurações GitHub

Para o GitHub Enterprise Server, o GitHub aplicativo é criado automaticamente na sua instância durante o registro. Você pode gerenciar o acesso ao repositório do aplicativo ou desinstalá-lo em Configurações > Aplicativos > GitHub Aplicativos instalados. Para excluir totalmente a definição do aplicativo, acesse Configurações > Configurações do desenvolvedor > GitHub Aplicativos.

GitHub Atualizações de permissões do aplicativo

AWS DevOps O agente pode solicitar atualizações de permissão após a instalação do GitHub aplicativo para oferecer suporte a novos recursos. Quando isso acontece:

  1. Você receberá uma notificação GitHub sobre a solicitação de atualização de permissão.

  2. Analise os detalhes da atualização para entender quais novas permissões estão sendo solicitadas.

  3. Aceite a solicitação para conceder as permissões atualizadas.

Nenhuma alteração é necessária em seu serviço ou aplicativo. Depois de aceitar as permissões atualizadas, o próximo token de acesso de instalação solicitado pelo AWS DevOps Agente GitHub incluirá automaticamente as novas permissões.

nota

Até que você aceite uma atualização de permissão, o AWS DevOps Agente continua operando com as permissões concedidas anteriormente. Novos recursos que dependem das permissões atualizadas não estarão disponíveis até que você aprove a solicitação.

Gerenciando GitHub conexões

  • Atualizando o acesso ao repositório — Para alterar quais repositórios o GitHub aplicativo pode acessar, acesse as configurações da sua GitHub conta ou organização (ou as configurações da instância do GitHub Enterprise Server), navegue até os GitHub aplicativos instalados e modifique a configuração do aplicativo do AWS DevOps Agente.

  • Visualizando repositórios conectados — No console do AWS DevOps Agente, selecione seu Espaço do Agente e vá até a guia Capacidades para visualizar os repositórios conectados na seção Pipeline.

  • Removendo a GitHub conexão — Para se desconectar GitHub de um Espaço do Agente, selecione a conexão na seção Pipeline e clique em Remover. Para desinstalar completamente o GitHub aplicativo, desinstale-o das configurações da sua GitHub conta ou organização. Para o GitHub Enterprise Server, como o GitHub aplicativo é criado diretamente na sua instância durante o registro, você pode, opcionalmente, limpar o aplicativo por completo executando as duas ações a seguir:

    • Desinstalar o aplicativo — Vá para Configurações > Aplicativos > GitHub Aplicativos instalados, clique em Configurar no aplicativo e, em seguida, desinstale-o.

    • Excluir o aplicativo — Vá para Configurações > Configurações do desenvolvedor > GitHub Aplicativos, selecione o aplicativo, vá até a guia Avançado e escolha Excluir GitHub aplicativo. Aviso: a exclusão do GitHub aplicativo é permanente e não pode ser desfeita. Se você excluí-lo, precisará registrar novamente o GitHub Enterprise Server desde o início no console do AWS DevOps Agente para criar um novo aplicativo.