Conectar-se ao GitLab Enterprise

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

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

Para mais informações sobre o Developer Connect, consulte 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.

    A ativação do Developer Connect também ativa a API Secret Manager.

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

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

  9. Verifique se você é proprietário de um repositório do GitLab Enterprise ou se tem 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 neste guia, siga estas etapas:
    1. Instale a Google Cloud CLI. Se você já instalou a CLI gcloud, 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

Requisitos do host

Se você não instalou uma instância do servidor do GitLab Enterprise Edition, consulte o guia de instalação do GitLab Enterprise Edition para instruções.

Ao seguir as instruções para instalar uma instância do servidor do GitLab Enterprise Edition, observe o seguinte:

  • Você precisa configurar o host para processar o protocolo HTTPS. Hosts configurados com o protocolo HTTP não são aceitos.

  • Você precisa configurar o host com o mesmo URL usado para acessá-lo do Google Cloud. Para saber mais, consulte a documentação do GitLab sobre como configurar o URL externo.

Funções exigidas

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

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 personalizados papéis ou outros predefinidos papéis.

Criar tokens de acesso

Para criar tokens de acesso no GitLab, siga estas etapas:

  1. Faça login no GitLab.

  2. Siga as instruções na documentação do GitLab para criar tokens de acesso pessoal, de grupo, ou de projeto com as seguintes permissões:

    • Um token com escopo api para conectar e desconectar repositórios.
    • Um token com escopo read_api para permitir que o Developer Connect leia o código-fonte nos seus repositórios.
    • Para tokens de acesso de grupo e de projeto, os tokens precisam ter um papel de mantenedor ou superior.

Crie uma conexão

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

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

Console

Inicie uma conexão seguindo estas etapas:

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

    Acessar o Developer Connect

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

    • Se você vir uma lista de provedores de gerenciamento de código-fonte: Comece a configurar sua primeira conexão selecionando um provedor de gerenciamento de código fonte. Clique em Conectar no card do GitLab Enterprise.

    • Se você vir uma tabela listando as conexões atuais: defina o provedor de gerenciamento de código-fonte clicando em Criar conexão > GitLab Enterprise.

      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 sua nova conexão.

  3. Em URL do host, insira o URL do host a que você quer se conectar.

  4. Na seção Tokens de acesso , insira os tokens da sua conta:

    • Token de acesso de API: insira o token de acesso com escopo api.
    • Ler token de acesso à API: insira o token de acesso com read_api escopo.

    Você é responsável por garantir que os tokens do GitLab permaneçam válidos. Os tokens do GitLab têm uma vida útil máxima de 365 dias, a menos que especificado de outra forma pelo criador do token ou por um administrador. Para saber como gerenciar as configurações e notificações de expiração de tokens, consulte a documentação do GitLab sobre tokens de acesso pessoal, tokens de acesso de grupo, e tokens de acesso de projeto.

  5. Clique em Mostrar mais para conferir as configurações de configuração opcionais.

    1. Opcional: por padrão, o Developer Connect pode atuar como um proxy para chamadas Git para o GitLab Enterprise. Para desativar essa opção, desmarque a caixa de seleção Ativar 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 GitLab Enterprise hospedados em uma rede particular.

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

  6. Clique em Continuar.

Depois que a conexão for criada, a página Vincular repositórios vai aparecer.

Siga estas etapas 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 Google Cloud console. Você pode adicionar mais links a conexões atuais a qualquer momento.

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

gcloud

  1. Crie um secret de webhook no Secret Manager executando o seguinte comando, em que WEBHOOK_SECRET_NAME é um nome para o secret de webhook:

         cat /proc/sys/kernel/random/uuid | tr -d '\n' | gcloud secrets create WEBHOOK_SECRET_NAME

  2. Armazene seus tokens de acesso no Secret Manager executando os seguintes comandos:

    gcloud secrets create API_SECRET_NAME

echo -n API_SECRET_DATA | gcloud secrets versions add API_SECRET_NAME --data-file=-

gcloud secrets create READ_SECRET_NAME

echo -n READ_SECRET_DATA | gcloud secrets versions add READ_SECRET_NAME --data-file=-

    Substitua:

    • API_SECRET_NAME: um nome para o secret que armazena o token com api escopo.
    • API_SECRET_DATA: o token com api escopo, semelhante a glpat-XXXXXXXXXXXXXXXX.
    • READ_SECRET_NAME: um nome para o secret que armazena o token com read_api escopo.
    • READ_SECRET_DATA: o token com read_api escopo, semelhante a glpat-XXXXXXXXXXXXXXXX.

  3. Inicie uma conexão com sua conta corporativa do GitLab executando o developer-connect connections create comando:

    gcloud developer-connect connections create CONNECTION_NAME \
    --location=REGION \
    --gitlab-config-read-authorizer-credential-user-token-secret-version=projects/PROJECT_ID/secrets/READ_SECRET_NAME/versions/VERSION \
    --gitlab-config-authorizer-credential-user-token-secret-version=projects/PROJECT_ID/secrets/API_SECRET_NAME/versions/VERSION \
    --gitlab-enterprise-config-host-uri=HOST_URI
    --gitlab-enterprise-config-webhook-secret-version=projects/PROJECT_ID/secrets/WEBHOOK_SECRET_NAME/versions/VERSION
    --git-proxy-config-enabled

    Substitua:

    • CONNECTION_NAME: o nome da sua conexão.
    • REGION: a região da sua conexão.
    • PROJECT_ID: o ID do seu Google Cloud projeto.
    • READ_SECRET_NAME: o nome do secret do Secret Manager que contém o token com read_api escopo.
    • API_SECRET_NAME: o nome do secret do Secret Manager que contém o token com api escopo.
    • VERSION: o número da versão de cada secret. Pode ser latest para usar o número de versão mais recente.
    • HOST_URI: o URI do host a que você quer se conectar.
    • WEBHOOK_SECRET_NAME: o nome do secret do Secret Manager que contém seu webhook
    • --git-proxy-config-enabled: uma flag opcional que permite que o Developer Connect atue como um proxy para chamadas Git para o GitLab Enterprise. Essa capacidade está em pré-lançamento.

    O Developer Connect conclui a conexão com o GitLab. Em seguida, vincule aos repositórios.

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

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

Console

Crie links para repositórios seguindo estas etapas:

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

    Abrir 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 conexão.

  4. Clique em Continuar.

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

    O Developer Connect mostra nomes sugeridos para os recursos do repositório.

  6. Selecione uma opção de nomenclatura de recursos de repositório:

    • Gerado: use os nomes de recursos de repositório gerados.
    • Manual: insira seus próprios nomes.

  7. Clique em Criar.

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

gcloud

Para vincular a um repositório do GitLab, execute o seguinte 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 link do repositório.
  • REPO_URI: o link para o repositório, semelhante a https://gitlab.com/my-project/test-repo.git.
  • CONNECTION_NAME: o nome da sua conexão.
  • REGION: a região da sua conexão.

O Developer Connect cria os links do repositório.

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

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

A seguir