Conectar-se ao GitHub Enterprise Cloud

Nesta página, descrevemos como criar conexões com o GitHub Enterprise Cloud e links para repositórios do GitHub Enterprise Cloud. Você pode concluir essas tarefas usando o console Google Cloud ou a Google Cloud CLI.

Estas instruções são destinadas a desenvolvedores de aplicativos, administradores de plataforma e gerentes de segurança que querem usar repositórios de código-fonte do GitHub Enterprise Cloud com o Google. Especificamente, você pode usar repositórios do GitHub Enterprise Cloud com o Gemini Code Assist.

Para saber mais sobre o Developer Connect, consulte a Visão geral do Developer Connect.

Antes de começar

  1. Faça login na sua Conta do Google.

    Se você ainda não tiver uma, inscreva-se agora.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Developer Connect API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Developer Connect API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

    8.

    Ao ativar o Developer Connect, você também ativa a API Secret Manager.

  8. Verifique se você tem acesso a uma conta no GitHub Enterprise Cloud.

    Para ajudar a manter o trabalho da sua equipe seguro, recomendamos que você conclua as tarefas deste guia usando uma conta de bot ou uma conta compartilhada pela equipe, não uma conta pessoal.

  9. Verifique se você tem um repositório do GitHub Enterprise Cloud ou permissões de administrador em um repositório compartilhado.
  10. Opcional: crie uma chave de criptografia gerenciada pelo cliente (CMEK) para criptografar os secrets de autenticação criados pelo Developer Connect.
  11. Opcional: para usar as instruções de linha de comando deste guia, siga estas etapas:
    1. Instale a CLI do Google Cloud. Se você já instalou a CLI gcloud anteriormente, verifique se tem a versão mais recente disponível executando gcloud components update.
    2. Crie uma conta de serviço do Developer Connect executando o seguinte comando, em que PROJECT_ID é o Google Cloud ID do projeto: 
              gcloud beta services identity create \
            --service=developerconnect.googleapis.com \
            --project=PROJECT_ID

Funções exigidas

Para receber as permissões necessárias para criar conexões e links, peça ao administrador que conceda a você os seguintes papéis do IAM:

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Também é possível conseguir as permissões necessárias usando papéis personalizados ou outros papéis predefinidos.

Crie uma conexão

Nesta seção, descrevemos como criar uma conexão entre o Developer Connect e o GitHub Enterprise Cloud. Se você estiver usando o console do Google Cloud , também poderá começar a adicionar links a repositórios ao terminar de configurar sua conexão.

Para criar uma conexão do GitHub Enterprise Cloud, selecione uma das seguintes opções:

Console

Para iniciar uma conexão, siga estas etapas:

  1. No console do Google Cloud , abra o Developer Connect.

    Acessar o Developer Connect

    O Developer Connect mostra a página Repositórios Git.

    • Se uma lista de provedores de gerenciamento de código-fonte aparecer:comece a configurar sua primeira conexão selecionando um provedor de gerenciamento de código-fonte. Clique em Conectar no card do GitHub Enterprise Cloud.

    • Se uma tabela com as conexões atuais aparecer: clique em Criar conexão > GitHub Enterprise Cloud para definir o provedor de gerenciamento de código-fonte.

      A página Criar conexão é aberta.

  2. Em Região, escolha uma região para os recursos de conexão.

    1. Em Nome, insira um nome para a nova conexão.

  3. Marque a caixa de seleção Ativar uma conexão compatível com a residência de dados para que ela atenda aos requisitos de residência de dados.

    As conexões do GitHub criadas usando o console Google Cloud obedecem à residência de dados se você marcar essa caixa de seleção ao criar a conexão. Ao fazer isso, o Developer Connect cria um app GitHub

    Quando você cria conexões do GitHub usando a Google Cloud CLI, elas não obedecem à residência de dados. Todos os outros tipos de conexão estão em conformidade com a residência de dados.

  4. Clique em Mostrar mais para conferir as configurações opcionais.

    1. Opcional: na seção Criptografia, selecione uma chave CMEK para criptografar os secrets do Secret Manager que o Developer Connect cria.

    2. Opcional: por padrão, o Developer Connect pode funcionar como um proxy para chamadas do Git no GitHub Enterprise Cloud. Para desativar essa opção, desmarque a caixa de seleção Ativar o proxy do Developer Connect.

  5. Clique em Continuar.

  6. Clique em Entendi e quero continuar para concordar em compartilhar seu token OAuth do GitHub com o Developer Connect e armazená-lo no Secret Manager.

  7. Faça login no GitHub se for solicitado.

  8. Clique em Autorizar o Developer Connect para permitir que o app Google Developer Connect acesse sua conta do GitHub.

    Se essa solicitação não aparecer, a autorização já foi concedida nesta conta.

  9. Se você selecionou Ativar uma conexão compatível com a residência de dados, será solicitado que você crie um app do GitHub.

    1. Dê um nome a esse app do GitHub.

    2. Clique em Criar app GitHub.

    3. Selecione o destino em que você quer instalar o app (sua conta do GitHub ou uma organização).

    4. Selecione os repositórios em que você quer instalar o app do GitHub ou Todos os repositórios e clique em Instalar.

    5. Selecione os repositórios a serem vinculados para essa conexão e clique em Ok.

    6. Clique em Vincular.

O GitHub cria um token, e o Developer Connect o armazena no seu projeto Google Cloud como um secret do Secret Manager. Para mais informações sobre como gerenciar secrets, consulte ver detalhes do secret.

Se você ativou a residência de dados, agora tem um app GitHub, que pode ser gerenciado clicando em Gerenciar instalação na página Detalhes da conexão.

Configurar a conexão

As etapas a seguir são necessárias se você não tiver marcado a caixa de seleção Ativar uma conexão compatível com a residência de dados.

Conceda permissões na sua conta do GitHub e vincule aos repositórios seguindo as instruções abaixo. Os comandos que aparecem no navegador da Web dependem de se a conta do GitHub já tem o app GitHub do Developer Connect instalado.

Na caixa de diálogo "Developer Connect", siga estas etapas:

Se uma lista de contas do GitHub aparecer, instale o app e vincule repositórios seguindo estas etapas:

  1. Escolha a conta do GitHub que você quer usar.

  2. Selecione um ou mais repositórios a que você quer conceder acesso.

Se aparecer uma solicitação para reutilizar uma instalação de app, escolha onde configurar o app seguindo estas etapas:

  1. Clique em Conta do GitHub para ver as contas que têm o app Google Developer Connect instalado. Se a conta que você quer usar aparecer, clique em Confirmar.

  2. Se a conta que você quer usar não aparecer, faça o seguinte:

    1. Escolha Instalar o app GitHub em outra conta do GitHub e clique em Confirmar.

    2. Siga as etapas do GitHub para permitir a instalação do app.

    3. Selecione um ou mais repositórios a que você quer conceder acesso.

Quando a caixa de diálogo for fechada, a instalação do app será concluída.

Depois que a conexão é criada, a página Vincular repositórios aparece.

Conclua as etapas a seguir para vincular repositórios à sua conexão:

  1. Na lista de repositórios disponíveis, selecione os que você quer usar.

  2. Clique em OK.

  3. Clique em Vincular.

Sua conexão é adicionada à página Conexões, e os links do repositório são adicionados à página Repositórios no console do Google Cloud . Você pode adicionar mais links às conexões atuais a qualquer momento.

gcloud

As seguintes tarefas exigem algumas ações no seu navegador da Web.

Para iniciar uma conexão, siga estas etapas:

  1. Execute o comando gcloud developer-connect connections create para criar uma conexão com o GitHub Enterprise Cloud.

    Se a residência de dados estiver ativada:

    gcloud developer-connect connections create CONNECTION_NAME \
    --location=REGION \
    --github-enterprise-config-app=DEVELOPER-CONNECT \
    --github-enterprise-config-host-uri=HOST_URI
    --git-proxy-config-enabled

    Se a residência de dados não estiver ativada:

    gcloud developer-connect connections create CONNECTION_NAME \
    --location=REGION \
    --github-config-app=DEVELOPER-CONNECT \
    --github-config-host-uri=HOST_URI
    --git-proxy-config-enabled

    Substitua:

    • CONNECTION_NAME: um nome para sua conexão.
    • REGION: a região da sua conexão.
    • HOST_URI: o URI do host a que você quer se conectar. Se a residência de dados estiver ativada, isso vai usar um domínio que inclui seu subdomínio (YOUR_SUBDOMAIN.ghe.com). Se a residência de dados não estiver ativada, isso vai usar github.com.
    • --git-proxy-config-enabled: uma flag opcional que permite que o Developer Connect atue como um proxy para chamadas do Git ao GitHub Enterprise Cloud. Essa capacidade está em pré-lançamento.

    Um nome de conexão é criado.

  2. Conclua a criação da conexão instalando o app GitHub do Developer Connect. Execute o comando a seguir para receber o URI para instalação do app:

    gcloud developer-connect connections describe CONNECTION_NAME \
    --location=REGION

    Substitua:

    • CONNECTION_NAME: o nome da conexão.
    • REGION: a região da sua conexão.

    O Developer Connect retorna um link para instalar o app Google Developer Connect em uma janela do navegador. Copie esse link.

  3. Abra o link em um navegador da Web.

  4. Clique em Entendi e quero continuar para concordar em compartilhar seu token OAuth do GitHub com o Developer Connect e armazená-lo no Secret Manager.

  5. Faça login no GitHub se for solicitado.

  6. Clique em Autorizar o Developer Connect para permitir que o app Google Developer Connect acesse sua conta do GitHub. Se você não encontrar essa solicitação, a autorização já foi concedida nessa conta.

O GitHub cria um token, e o Developer Connect o armazena no seu projeto Google Cloud como um secret do Secret Manager. Para ver seus secrets, liste os secrets no Secret Manager. É possível revogar o acesso ao Developer Connect pelo GitHub a qualquer momento.

Configurar a conexão

Conceda permissões na sua conta do GitHub e vincule aos repositórios seguindo as instruções abaixo. Os comandos que aparecem no navegador da Web dependem de se a conta do GitHub já tem o app GitHub do Developer Connect instalado.

Na caixa de diálogo "Developer Connect", siga estas etapas:

Se uma lista de contas do GitHub aparecer, instale o app e vincule repositórios seguindo estas etapas:

  1. Escolha a conta do GitHub que você quer usar.

  2. Selecione um ou mais repositórios a que você quer conceder acesso.

Se aparecer uma solicitação para reutilizar uma instalação de app, escolha onde configurar o app seguindo estas etapas:

  1. Clique em Conta do GitHub para ver as contas que têm o app Google Developer Connect instalado. Se a conta que você quer usar aparecer, clique em Confirmar.

  2. Se a conta que você quer usar não aparecer, faça o seguinte:

    1. Escolha Instalar o app GitHub em outra conta do GitHub e clique em Confirmar.

    2. Siga as etapas do GitHub para permitir a instalação do app.

    3. Selecione um ou mais repositórios a que você quer conceder acesso.

Quando a caixa de diálogo for fechada, a instalação do app será concluída.

Verificar a conexão

Verifique a criação da conexão do GitHub Enterprise Cloud executando o seguinte comando:

gcloud developer-connect connections describe CONNECTION_NAME \
    --location=REGION

Substitua:

  • CONNECTION_NAME: o nome da conexão.
  • REGION: a região da sua conexão.

O Developer Connect retorna um status no campo installationState. Se o valor desse campo for COMPLETE, a instalação do app estará concluída. Caso contrário, o Developer Connect vai retornar um URI para você voltar à configuração no navegador.

Depois que a conexão for concluída, escolha quais repositórios vincular seguindo as instruções em Adicionar links de repositório a conexões atuais.

Depois de estabelecer uma conexão com o GitHub Enterprise Cloud, você pode vincular repositórios. Você pode repetir essas etapas mais tarde para vincular outros repositórios, se necessário.

Para criar links de repositório em uma conexão do GitHub Enterprise Cloud, selecione uma das seguintes opções:

Console

  1. Abra a página Repositórios no console do Google Cloud .

    Abra a página Repositórios

  2. Clique em Vincular repositório.

    O painel Vincular repositórios Git é aberto.

  3. Na lista de conexões, escolha uma.

  4. Clique em Continuar.

  5. Na lista de repositórios, selecione aqueles que você quer vincular.

  6. Clique em Criar.

O Developer Connect cria os links do repositório e os mostra no console Google Cloud .

gcloud

Execute este comando:

gcloud developer-connect connections git-repository-links create REPO_NAME \
    --clone-uri=REPO_URI \
    --connection=CONNECTION_NAME \
    --location=REGION

Substitua:

  • REPO_NAME: o nome do seu repositório
  • REPO_URI: o link para seu repositório do GitHub Enterprise Cloud. Por exemplo, https://github.com/cloud-build/test-repo.git.
  • CONNECTION_NAME: o nome da conexão.
  • REGION: a região da conexão.

O Developer Connect cria os links do repositório.

Para listar os repositórios vinculados, execute o comando developer-connect connections git-repository-links list.

Se você estiver configurando o Gemini Code Assist, siga as etapas em Configurar e usar a personalização de código do Gemini Code Assist.

Configurar listas de permissões de IP

O Developer Connect é compatível com organizações do GitHub Enterprise Cloud que usam listas de permissão de IP para restringir o acesso aos recursos. Para configurar a lista de permissões do GitHub Enterprise Cloud para uso com o Developer Connect, siga estas etapas.

Use a conta de proprietário da organização do GitHub Enterprise Cloud para concluir essas tarefas.

  1. Faça login no GitHub Enterprise Cloud.

  2. Siga as instruções na documentação do GitHub Enterprise Cloud para permitir o acesso por apps do GitHub.

    O GitHub Enterprise Cloud adiciona os endereços do app GitHub do Developer Connect à sua lista de permissões.

    É possível identificar os endereços do Developer Connect pelas descrições, que são semelhantes ao seguinte texto: managed by the Developer Connect GitHub app.

  3. Agora que o app GitHub do Developer Connect pode acessar seus recursos do GitHub Enterprise Cloud, configure sua lista de permissões para usar os mesmos endereços IP nas interações baseadas em OAuth entre o Developer Connect e o GitHub Enterprise Cloud. Isso permite que o Developer Connect crie links para seus repositórios Git.

    1. Copie todos os endereços IP do app Developer Connect no GitHub.

    2. Siga as instruções na documentação do GitHub Enterprise Cloud para adicionar cada endereço à sua lista de permissões como uma nova entrada.

Quando terminar, você terá duas entradas de lista de permissões para cada endereço IP que o Developer Connect usa para se comunicar com o GitHub Enterprise Cloud.

As entradas do OAuth são usadas apenas para criar links para repositórios. Você pode excluir as entradas do OAuth da lista de permissões quando terminar de criar links para repositórios do GitHub Enterprise Cloud.

Compartilhamento de dados

O conteúdo dos recursos do Google Cloud vinculados a essa conexão pode ser transferido para o GitHub. Essa declaração se aplica a todos os recursos atuais e futuros que usam essa conexão. Para parar de compartilhar informações com o GitHub, exclua as conexões do Developer Connect no console Google Cloud ou na CLI gcloud e revogue o acesso no GitHub.

A seguir