Conectar-se a um host do Bitbucket Server

Esta página explica como se conectar a um host do servidor Bitbucket para o Cloud Build.

Antes de começar

  • Enable the Cloud Build, Secret Manager, and Compute Engine APIs.

    Enable the APIs

Como configurar

Antes de se conectar ao host do Bitbucket Server, é preciso ter um Chave de API para autenticar e aceitar eventos de entrada do Bitbucket Servidor. Além disso, é preciso conceder ao IAM permissões no projeto do Google Cloud para criar acesso pessoal no Bitbucket Server para criar webhooks e recuperar o repositório dados.

Como receber uma chave de API

Para conectar seu host e autenticar eventos de webhook recebidos, faça o seguinte: 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 o host do Bitbucket Server, conceda o papel de Editor do Cloud Build (roles/cloudbuild.builds.editor) e de Proprietário de 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

É preciso criar 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. Pode ser necessário configurar permissões adicionais em o Bitbucket Server, conforme necessário. Por exemplo, você pode selecionar Conta do Bitbucket Server para ter acesso apenas a um subconjunto dos repositórios na sua instância do Bitbucket Server para permitir um controle mais granular sobre o que está disponível no Cloud Build.

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

Como se conectar a um host do Bitbucket Server

Console

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

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

    Abrir a página Repositórios

  2. Na parte de cima da página, selecione a guia 1a geração.

  3. Clique em Conectar host.

  4. Selecione Bitbucket Server no menu suspenso.

    Você vai encontrar o painel Conectar host.

    Insira as seguintes informações para conectar sua instância do Bitbucket Server ao Cloud Build:

    • Região: selecione a região da sua conexão.

    • Nome: digite um nome para sua conexão.

    1. URL do host: o URL do host da instância do Bitbucket Server. Por exemplo, https://bbs.example-test.com:7990.

    2. Chave de API do Google Cloud: sua chave de API usada para autenticar o credenciais.

    3. Certificado de AC: seu certificado autoassinado. Seu certificado não pode ter mais de 10 KB e estar no formato PEM (.pem, .cer ou .crt). Se esta seção for deixada em branco, um conjunto padrão de certificados será usado.

    4. Nome de usuário: seu nome de usuário da conta do Bitbucket Server. Esta conta devem ter acesso de administrador aos repositórios conectar ao Cloud Build.

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

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

    7. Em Tipo de rede, selecione uma das seguintes opções:

      1. Internet pública: selecione essa opção se a instância for acessível pela Internet pública.

      2. Rede privada: selecione essa opção se a instância for hospedada em uma rede privada.

        1. Projeto: selecione o ID do projeto do Google Cloud.

        2. Rede: selecione sua rede no menu suspenso. Se você não criou uma rede, consulte Criar e gerenciar redes VPC para saber como criar uma.

        3. Intervalo de IP: insira o intervalo de IP interno que pode ser atribuído às VMs em um intervalo alocado em uma rede com peering.

          É possível especificar o intervalo usando a notação de roteamento entre domínios sem classe (CIDR) no formato STARTING_IP/SUBNET_PREFIX_SIZE. Por exemplo, 192.0.2.0/24 tem uma prefixo de 24. Os primeiros 24 bits do intervalo de IP são usados como a máscara de sub-rede (192.0.2.0), enquanto os possíveis endereços de hosts variam de 192.0.2.0 a 192.0.2.255.

          O valor do tamanho do prefixo não pode exceder /29. Em caso negativo for especificado para o intervalo, um valor padrão /24 será atribuído automaticamente. Se nenhum valor for especificado para o tamanho do prefixo, os endereços IP serão atribuídos automaticamente na rede VPC com peering. Se nenhum valor for especificado para o IP endereço IP recebe automaticamente um intervalo dentro da rede VPC com peering.

  5. Clique em Conectar host.

    Se a instância do Bitbucket Server estiver em uma rede com peering, conecte o host pode levar vários minutos para concluir.

    Você será redirecionado para o painel Conectar repositório.

    Depois de criar uma conexão de host, seus tokens de acesso pessoais e o secret do webhook será armazenado com segurança no Secret Manager. Você pode conferir e gerenciar seus segredos na página Secret Manager.

gcloud

Para conectar o host do servidor Bitbucket ao Cloud Build usando os comandos gcloud, execute o gcloud alpha builds enterprise-config bitbucketserver create no seu terminal. Diferentemente de conectar seu host usando o console do Google Cloud, você vai precisar armazenar manualmente de acesso a tokens de acesso e o secret do webhook no Secret Manager 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 \
    --peered-network-ip-range=PEERED_NETWORK_IP_RANGE \
    --ssl-ca-file=SSL_CA_FILE

Em que:

  • BITBUCKET_SERVER_CONFIG_NAME é o nome da configuração do Bitbucket Server.
  • USERNAME é seu nome de usuário do Bitbucket Server.
  • HOST_URI é o URI do host da sua 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}. É possível especificar latest como a versão para usar a versão mais recente do secret. Isso se aplica a cada recurso armazenado no Gerenciador de secrets.
  • READ_ACCESS_TOKEN_SECRET_VERSION é o nome do recurso da token de acesso somente 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 da API Google Cloud.

  • [Opcional] PEERED_NETWORK é a rede VPC a que você vai se conectar para as instâncias locais do Bitbucket Server. Para saber mais, consulte Criar repositórios do Bitbucket Server em uma rede particular.

  • [Opcional] PEERED_NETWORK_IP_RANGE é o IP interno em que as VMs podem ser atribuídas dentro de um intervalo alocado em uma rede com peering.

  • SSL_CA_FILE é o caminho para um arquivo local que contém seu certificado SSL a ser usado para solicitações ao Bitbucket Server. O certificado precisa estar no formato PEM.

API

Para conectar o host do servidor Bitbucket ao Cloud Build usando a API, use o modelo JSON a seguir. Ao contrário de conectar sua host usando o console do Google Cloud, você precisa armazenar manualmente acessar tokens de acesso e o secret do webhook no Secret Manager 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",
      "peeredNetworkIpRange": "PEERED_NETWORK_IP_RANGE",
      "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 de Acessador do secret do Secret Manager ao agente de serviço do Cloud Build, service-${PROJECT_NUMBER}@gcp-sa-cloudbuild.iam.gserviceaccount.com. Para saber mais, consulte Como conceder o papel de Secret Manager à sua conta de serviço.

  • READ_ACCESS_TOKEN_SECRET_VERSION é o nome do recurso da token de acesso somente 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 para fazer peering das instâncias do Bitbucket Server no local.

    É possível especificar o intervalo usando a notação de roteamento de roteamento entre domínios sem classe (CIDR) no formato STARTING_IP/SUBNET_PREFIX_SIZE. Por exemplo: 192.0.2.0/24 tem um comprimento de prefixo de 24. Os primeiros 24 bits do intervalo de IP são usados como máscara de sub-rede (192.0.2.0), enquanto os possíveis endereços de host de 192.0.2.0 a 192.0.2.225.

  • [Opcional] PEERED_NETWORK_IP_RANGE é o IP interno em que as VMs podem ser atribuídas dentro de um intervalo alocado em uma rede com peering.

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

Digite o seguinte comando curl no 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/REGION/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.
  • REGION é a região associada à configuração do Bitbucket Server.
  • BITBUCKET_SERVER_CONFIG_NAME é o nome da configuração do Bitbucket Server.

Se a solicitação for bem-sucedida, 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/REGION/operations/OPERATION_ID

Em que:

  • PROJECT_NUMBER é o número do projeto do Cloud.
  • PROJECT_ID é seu ID do projeto do Cloud.
  • REGION é a região associada à configuração do Bitbucket Server.
  • OPERATION_ID é o ID da operação de criação de 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 for criada, você vai encontrar a configuração no campo response.value. Caso contrário, consulte o campo error para um relatório de erros detalhado.

A seguir