Conectar-se ao GitHub Enterprise

Nesta página, descrevemos como criar conexões com o GitHub Enterprise e links para repositórios do GitHub Enterprise. 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 com o Google. Especificamente, você pode usar repositórios do GitHub Enterprise com o Gemini Code Assist.

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

Antes de começar

Faça login na sua Conta do Google.

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

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

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

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

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

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

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

   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.

2. Verifique se você tem um repositório do GitHub Enterprise ou permissões de administrador em um repositório compartilhado.

3. Ao usar um repositório em uma organização do GitHub Enterprise, verifique se você tem permissões de Gerenciador de apps do GitHub.

4. Opcional: crie uma chave de criptografia gerenciada pelo cliente (CMEK) para criptografar os secrets de autenticação criados pelo Developer Connect.
5. 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
              

Conceder as permissões necessárias do IAM

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:

• Se você não for o proprietário do projeto: Administrador do Developer Connect (roles/developerconnect.admin) na sua conta de usuário.
• Se você planeja usar uma CMEK para criptografar os secrets criados pelo Developer Connect: Criptografador/descriptografador de CryptoKey do Cloud KMS (roles/cloudkms.cryptoKeyEncrypterDecrypter) na conta de serviço do Secret Manager.
• Se você planeja usar a CLI gcloud para concluir as etapas deste guia: Papel de administrador do Secret Manager (roles/secretmanager.admin) na conta de serviço do Developer Connect.
• Se você planeja usar o console do Google Cloud para concluir as etapas deste guia: Administrador do IAM do projeto (roles/resourcemanager.projectIamAdmin) na sua conta de usuário.

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.

Observação: quando você tem o papel de administrador de IAM do projeto (roles/resourcemanager.projectIamAdmin), o console Google Cloud pode conceder automaticamente as permissões necessárias em seu nome. Se o administrador não permitir que você tenha o papel de administrador do IAM do projeto, peça a ele para conceder o papel de administrador do Secret Manager (roles/secretmanager.admin) na conta de serviço do Developer Connect (service-{projectNumber}@gcp-sa-devconnect.iam.gserviceaccount.com).

Crie uma conexão

Esta seção descreve como criar uma conexão entre o Developer Connect e o GitHub Enterprise. 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, 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.

   • Se uma tabela com as conexões atuais aparecer: clique em Criar conexão > GitHub Enterprise 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.

   1. Em URL do host, digite o URL do host a que você quer se conectar.

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

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

   2. Em Tipo de rede, selecione Internet pública.

      Se você quiser usar uma rede particular, consulte Conectar-se a repositórios do GitHub Enterprise hospedados em uma rede particular.

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

5. Clique em Continuar.

   Uma caixa de diálogo do GitHub vai aparecer, convidando você a criar um app do GitHub.

6. Seguindo os comandos no GitHub, conclua estas tarefas:

   1. Insira um nome para o app.

   2. Escolha a organização em que você quer instalar o app.

   3. Selecione os repositórios a que você quer conceder acesso.

   A caixa de diálogo é fechada.

   O Developer Connect busca sua chave privada do GitHub e a armazena no projeto do Google Cloud como um secret do Secret Manager secret. Para ver seus secrets, liste os secrets no Secret Manager.

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.

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.

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:

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

   Substitua:

   • CONNECTION_NAME: o nome da conexão.
   • REGION: a região da conexão.
   • HOST_URI: o URI do host a que você quer se conectar.
   • --git-proxy-config-enabled: uma flag opcional que permite que o Developer Connect atue como um proxy para chamadas do Git ao GitHub Enterprise. Essa capacidade está em pré-lançamento.

2. Você precisa criar um app do GitHub para gerenciar conexões com o GitHub. Execute o comando a seguir para receber o URI da configuraçã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 conexão.

   O Developer Connect retorna um link para concluir as próximas etapas em uma janela do navegador. Copie esse link.

3. Abra o link em um navegador da Web.

4. Faça login na sua conta do GitHub se for solicitado.

5. Seguindo os comandos no GitHub, conclua estas tarefas:

   1. Insira um nome para o app.

   2. Escolha a organização em que você quer instalar o app.

   3. Selecione os repositórios a que você quer conceder acesso.

   A caixa de diálogo é fechada.

   O Developer Connect busca sua chave privada do GitHub e a armazena no projeto do Google Cloud como um secret do Secret Manager secret. Para ver seus secrets, liste os secrets no Secret Manager.

Verificar a conexão

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

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

Em que:

• 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 Vincular a repositórios.

Adicionar links de repositório a conexões atuais

Depois de estabelecer uma conexão com o GitHub Enterprise, é possível 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, 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: um nome para o link do repositório.
• REPO_URI: o link para seu repositório. 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.

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

• Conclua a configuração da personalização de código do Gemini Code Assist.
• Saiba como o Gemini Code Assist ajuda você a acelerar o desenvolvimento de software.
• Conheça outras integrações disponíveis no Developer Connect.