Conectar-se a um host do GitHub Enterprise

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Nesta página, explicamos como conectar um host do GitHub Enterprise ao Cloud Build.

Antes de começar

  • Ative as APIs Cloud Build and Secret Manager.

    Ative as APIs

Permissões do IAM obrigatórias

Para conectar o host do GitHub Enterprise, conceda à sua conta de usuário o papel Editor do Cloud Build (roles/cloudbuild.builds.editor) e Proprietário das integrações do Cloud Build (cloudbuild.integrations.owner).

Para adicionar os papéis necessários à conta de usuário, consulte Como configurar o acesso aos recursos do Cloud Build. Para saber mais sobre os papéis do IAM associados ao Cloud Build, consulte Papéis e permissões do IAM.

Como se conectar a um host do GitHub Enterprise

Você precisa criar um aplicativo do GitHub na sua instância do GitHub Enterprise. O app envia eventos do webhook para um endpoint do Cloud Build. Ao receber esses eventos, o Cloud Build validará o payload e executará uma versão se o evento corresponder a um gatilho do GitHub para o Cloud Build.

Nesta seção, explicamos como criar um app do GitHub:

  1. Faça login na sua instância do GitHub Enterprise.
  2. Verifique se você tem a versão mais recente instalada do GitHub Enterprise.

    Algumas versões do GitHub Enterprise podem exigir que os cookies SameSite sejam desativados para concluir as seguintes etapas em um navegador Chrome. Se você tiver uma versão do GitHub Enterprise anterior à versão 2.21.3, será necessário desativar os cookies do SameSite:

    1. Acesse chrome://flags/.
    2. Digite samesite na barra de filtros.
    3. Verifique se o SameSite por padrão está DESATIVADO.

      Captura de tela do SameSite desativada

    4. Reinicie seu navegador.

  3. Abra a página Gerenciar repositórios do Cloud Build:

    Abrir a página Gerenciar repositórios

  4. Clique em Conectar host.

    Você verá o painel Conectar host, que solicita a criação de uma conexão de host para conectar seus repositórios GitHub Enterprise ao Cloud Build.

  5. Na seção URL do host, insira o URL da instância do GitHub Enterprise. Por exemplo, ghe.example.com.

  6. Na seção Chave de API, clique em Gerar para gerar uma chave de API ou insira uma chave de API, se você já tiver uma.

    Se você quiser criar uma chave de API manualmente, siga estas etapas:

    Para gerar uma chave de API:

    1. Abra a página Credenciais no Console do Cloud:

      Abra a página Credenciais

    2. Clique em Criar credenciais.

    3. Clique em Chave de API.

      Você verá uma caixa pop-up com a chave de API criada.

    4. Clique em Restringir chave.

    5. Em Restrições de API, selecione API Cloud Build no menu suspenso.

    6. Clique em Save.

  7. [OPCIONAL] Na seção Organização, insira a organização para a qual o aplicativo GitHub será criado. Se esta seção for deixada em branco, o aplicativo será criado na conta de usuário atual.

  8. [OPCIONAL] Na seção Certificado de CA, clique em Procurar para fazer upload do certificado autoassinado. O certificado não pode ter mais de 10 KB e precisa estar no formato PEM (.pem, .cer ou .crt). Se essa seção for deixada em branco, um conjunto padrão de certificados será usado.

  9. [OPCIONAL] Na seção Rede, insira o nome do projeto de rede e um Nome de rede para a rede, caso a instância do GitHub Enterprise seja hospedada em uma rede privada. Conclua essa etapa se quiser criar repositórios em uma rede particular. Para saber mais, consulte Criar repositórios do GitHub Enterprise em uma rede privada.

  10. Clique em Conectar host.

    Se a instância do GitHub Enterprise estiver em uma rede particular, o processo de conexão do host poderá levar vários minutos para ser concluído.

  11. Se você quiser conectar seus repositórios ao Cloud Build, clique em Conectar repositórios. Caso contrário, clique em Concluído.

  12. Depois de conectar o host, uma caixa pop-up será exibida solicitando que você insira o nome do seu aplicativo GitHub Enterprise. Antes de inserir o nome do seu aplicativo, talvez seja necessário fazer login. Se você estiver usando o Google Chrome como navegador, a página pop-up poderá solicitar que você insira manualmente informações sobre seu aplicativo do GitHub Enterprise.

  13. Depois de fazer login, insira um nome para seu aplicativo do GitHub.

  14. Clique em Criar app GitHub.

    Você acabou de criar um app do GitHub na sua instância do GitHub Enterprise. O Cloud Build armazenará automaticamente suas credenciais no Secret Manager e conectará o host ao projeto do Cloud. Na API, essa conexão é representada como um recurso GitHubEnterpriseConfig ou uma associação entre o Cloud Build e o servidor do GitHub Enterprise.

    Agora seu host está conectado com sucesso. Clique em Conectar repositórios se quiser conectar repositórios ao Cloud Build. Para saber mais, consulte Conectar-se a um repositório do GitHub Enterprise.

Próximas etapas