Conectar-se a um host do servidor do Bitbucket

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

Nesta página, explicamos como se conectar a um host do servidor Bitbucket para o Cloud Build.

Antes de começar

  • Ative as APIs Cloud Build, Secret Manager, and Compute Engine.

    Ative as APIs

Configuração

Antes de conectar o host do servidor do Bitbucket, você precisa de uma chave de API para autenticar e aceitar eventos recebidos do Bitbucket Server. Além disso, conceda permissões do IAM no seu projeto do Google Cloud para criar tokens de acesso pessoal no Bitbucket Server. O objetivo é criar webhooks e recuperar dados do repositório.

Como receber uma chave de API

Para conectar seu host e autenticar eventos de webhook recebidos, você precisa de uma chave de API.

Para gerar uma chave de API:

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

    Abra a página Credenciais

  2. Clique em Criar credenciais.

  3. Clique em Chave de API.

    Você vai ver uma caixa de diálogo com a chave de API criada. Anote a sua chave de API.

  4. Se quiser restringir a chave para aplicativos de produto, clique em Restringir chave para concluir as etapas adicionais para protegê-la. Caso contrário, clique em Fechar.

    Para saber como restringir sua chave, consulte Como aplicar restrições de chave de API.

Permissões do IAM obrigatórias

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

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 criar tokens de acesso pessoal

Crie dois tokens de acesso pessoal no Bitbucket Server para realizar as seguintes tarefas:

Esses tokens de acesso pessoal são as permissões mínimas necessárias. Talvez seja necessário configurar permissões adicionais no servidor do Bitbucket conforme necessário. Por exemplo, é possível selecionar a conta do servidor do Bitbucket para ter acesso somente a um subconjunto dos repositórios na instância do Bitbucket Server. Isso permite um controle mais refinado sobre o que está disponível no Cloud Build.

Depois de criar seus tokens de acesso pessoal, salve os valores do token com segurança para se conectar ao repositório do Bitbucket Server.

Como se conectar a um host do servidor do Bitbucket

Console

Para conectar seu host do Bitbucket Server ao Cloud Build usando o Console do Google Cloud:

  1. Abra a página Gerenciar repositórios no Console do Google Cloud:

    Abrir a página "Gerenciar repositórios"

  2. Clique em Conectar host.

    Você verá o painel Conectar host.

    Digite as seguintes informações para conectar a instância do servidor do Bitbucket ao Cloud Build:

    • URL do host: o URL do host da instância do Bitbucket Server. Por exemplo, https://bbs.example-test.com:7990.
    • Chave de API do Google Cloud: chave de API usada para autenticar suas credenciais.
    • [OPCIONAL] Certificado de CA: seu certificado autoassinado. O certificado não pode exceder 10 KB e precisa estar no formato PEM (.pem, .cer ou .crt). Se esta seção for deixada em branco, um conjunto padrão de certificados será usado.

    • Nome de usuário: o nome de usuário da sua conta do Bitbucket Server. Essa conta precisa ter acesso de administrador aos repositórios que você quer conectar ao Cloud Build.

    • Token de acesso de leitura: o token de acesso pessoal da conta do Bitbucket Server com permissões de leitura.

    • Token de acesso de administrador: token de acesso pessoal da conta do Bitbucket Server com permissões de administrador em projetos e repositórios.

    • [OPCIONAL] Projeto de rede: é o ID do projeto de rede da rede local.

    • [OPCIONAL] Nome da rede: o nome da sua rede local.

  3. Clique em Conectar host.

    Se a instância do Bitbucket Server estiver em uma rede com peering, a conexão do host poderá levar vários minutos para ser concluída.

    Você será redirecionado para o painel Connect Repository.

    Depois de criar uma conexão de host, seus tokens de acesso pessoal e a chave secreta do webhook serão armazenados com segurança no Secret Manager. É possível ver e gerenciar seus secrets na página Gerenciador de secrets.

gcloud

Para conectar seu host do Bitbucket Server ao Cloud Build usando comandos gcloud, é necessário executar o comando gcloud alpha builds enterprise-config bitbucketserver create no seu terminal. Diferentemente de conectar seu host usando o Console do Google Cloud, você precisará armazenar manualmente seus tokens de acesso pessoal e a chave secreta do webhook no Gerenciador de secrets antes de executar o seguinte comando:

gcloud alpha builds enterprise-config bitbucketserver create
    --name=BITBUCKET_SERVER_CONFIG_NAME \
    --user-name=USERNAME \
    --host-uri=HOST_URI \
    --admin-access-token-secret-version=ADMIN_ACCESS_TOKEN_SECRET_VERSION \
    --read-access-token-secret-version=READ_ACCESS_TOKEN_SECRET_VERSION \
    --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION \
    --api-key=API_KEY \
    --peered-network=PEERED_NETWORK \
    --ssl-ca-file=SSL_CA_FILE

Em que:

  • BITBUCKET_SERVER_CONFIG_NAME é o nome da configuração do servidor do Bitbucket.
  • USERNAME é seu nome de usuário do Bitbucket Server;
  • HOST_URI é o URI do host da instância do Bitbucket Server.
  • ADMIN_ACCESS_TOKEN_SECRET_VERSION é o nome do recurso do token de acesso de administrador armazenado no Secret Manager. O formato esperado para secrets armazenados no Secret Manager é projects/${PROJECT_ID}/secrets/${SECRET_NAME}/versions/${VERSION_NUMBER}. Especifique latest como a versão para usar a versão mais recente do secret. Isso se aplica a cada recurso armazenado no Secret Manager.
  • READ_ACCESS_TOKEN_SECRET_VERSION é o nome do recurso do token de acesso de leitura armazenado no Secret Manager.
  • WEBHOOK_SECRET_SECRET_VERSION é o nome do recurso do secret do webhook armazenado no Secret Manager.
  • API_KEY é a chave de API do Google Cloud.
  • [Opcional] PEERED_NETWORK é a rede VPC para se conectar às instâncias do Bitbucket Server no local.
  • SSL_CA_FILE é o caminho para um arquivo local que contém seu certificado SSL a ser usado para solicitações para o Bitbucket Server. O certificado deve estar no formato PEM.

API

Para conectar seu host do Bitbucket Server ao Cloud Build usando a API, use o modelo JSON a seguir. Antes de conectar seu host usando o Console do Google Cloud, você precisa armazenar manualmente seus tokens de acesso pessoal e a chave secreta do webhook no Gerenciador de secrets antes de chamar a API:

  {
      "hostUri": HOST_URI,
      "username": USERNAME,
      "apiKey": API_KEY,
      "secrets": {
        "adminAccessTokenVersionName": ADMIN_ACCESS_TOKEN_SECRET_VERSION,
        "readAccessTokenVersionName": READ_ACCESS_TOKEN_SECRET_VERSION,
        "webhookSecretVersionName": WEBHOOK_SECRET_SECRET_VERSION,
      },
      "peeredNetwork": PEERED_NETWORK,
      "sslCa": SSL_CERTIFICATE
  }

Em que:

  • HOST_URI é o URI do host da instância do Bitbucket Server.
  • USERNAME é seu nome de usuário do Bitbucket Server;
  • API_KEY é a chave de API do Google Cloud.
  • ADMIN_ACCESS_TOKEN_SECRET_VERSION é o nome do recurso do token de acesso de administrador armazenado no Secret Manager. Talvez seja necessário conceder o papel Secret Manager à sua conta de serviço do Cloud Build, service-${PROJECT_NUMBER}@gcp-sa-cloudbuild.iam.gserviceaccount.com. Para saber mais, consulte Como atribuir o papel Secret Manager à sua conta de serviço.

  • READ_ACCESS_TOKEN_SECRET_VERSION é o nome do recurso do token de acesso de leitura armazenado no Secret Manager.

  • WEBHOOK_SECRET_SECRET_VERSION é o nome do recurso do secret do webhook armazenado no Secret Manager.

  • [Opcional] PEERED_NETWORK é a rede VPC a ser pareada para as instâncias do Bitbucket Server no local.

  • [Opcional] SSL_CERTIFICATE é o certificado SSL usado para as instâncias do Bitbucket Server no local.

Digite o seguinte comando curl no seu terminal:

  curl -X POST -H "Authorization: Bearer "$(gcloud auth print-access-token) -H "Content-Type: application/json; charset=utf-8"  -H "x-goog-user-project: PROJECT_NUMBER" https://cloudbuild.googleapis.com/v1/projects/PROJECT_ID/locations/global/bitbucketServerConfigs/?bitbucketServerConfigId=BITBUCKET_SERVER_CONFIG_NAME -d @config.json

Em que:

  • PROJECT_NUMBER é o número do projeto do Cloud.
  • PROJECT_ID é seu ID do projeto do Cloud.
  • BITBUCKET_SERVER_CONFIG_NAME é o nome da configuração do servidor do Bitbucket.

Se a solicitação for concluída, o corpo da resposta incluirá uma instância de Operation.

Digite o seguinte comando curl no seu terminal:

  curl -X GET -H "Authorization: Bearer "$(gcloud auth print-access-token) -H "Content-Type: application/json; charset=utf-8"  -H "x-goog-user-project: PROJECT_NUMBER" https://cloudbuild.googleapis.com/v1/projects/PROJECT_ID/locations/global/operations/OPERATION_ID

Em que:

  • PROJECT_NUMBER é o número do projeto do Cloud.
  • PROJECT_ID é seu ID do projeto do Cloud.
  • OPERATION_ID é o ID da operação de criação da configuração do Bitbucket Server.

Talvez seja necessário continuar executando o comando da API GetOperation até que a resposta contenha done: true, o que indica que a operação foi concluída. Se a configuração do Bitbucket Server tiver sido criada corretamente, você poderá vê-la no campo response.value. Caso contrário, consulte o campo error para ver um relatório de erros detalhado.

A seguir