Como criar repositórios do Bitbucket Server

O Cloud Build permite criar gatilhos para criar a partir de repositórios hospedados no Bitbucket Server, permitindo executar versões em resposta a eventos, como envios de confirmação ou solicitações de envio associadas ao repositório do Bitbucket Server.

Nesta página, explicamos como ativar a funcionalidade do gatilho em uma instância do servidor do Bucket e como criar repositórios a partir do servidor do Bucket se a instância estiver hospedada em um ambiente local.

Antes de começar

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

    Ative as APIs

Configuração

Antes de criar um gatilho do servidor do Bitbucket, é preciso receber uma chave de API para autenticar e aceitar eventos recebidos do Bitbucket Server. Além disso, você precisa conceder permissões do IAM no projeto do Google Cloud para criar gatilhos e criar tokens de acesso pessoais no Bitbucket Server para criar webhooks e recuperar dados do repositório.

Nesta seção, abordamos as etapas que você precisa concluir antes de criar um gatilho do Bitbucket Server.

Como receber uma chave de API

Para conectar seus repositórios de 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 com segurança. Você usará esses tokens para se conectar ao repositório do servidor do Bitbucket mais tarde.

Invocação de acionadores do Bitbucket Server

Nesta seção, explicamos como conectar os repositórios do Bitbucket Server ao Cloud Build e criar um gatilho para invocar automaticamente os builds nos seus repositórios conectados. Se quiser usar gatilhos do Bitbucket Server em um ambiente local, consulte Como criar repositórios em um ambiente local no Bitbucket Server para mais instruções.

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 essa 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.

Como se conectar a um repositório do Bitbucket Server

Console

Para conectar um repositório do Bitbucket Server ao Cloud Build usando o Console do Google Cloud:

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

    Abrir a página Acionadores

  2. Clique em Conectar repositório.

    Você verá o painel Conectar repositório.

  3. Em Selecionar origem, selecione Servidor do Bitbucket.

  4. Em Selecionar repositório, selecione os repositórios do Bitbucket Server que você quer conectar ao Cloud Build.

  5. Clique em Conectar para conectar seus repositórios.

    Quando um repositório é conectado, o Cloud Build configura um webhook no repositório na sua instância do Bitbucket Server. Em seguida, o repositório envia webhooks para invocar os gatilhos correspondentes do Bitbucket Server quando você fizer alterações no seu repositório. Um repositório também pode ser conectado várias vezes com várias conexões de host. Para saber como gerenciar webhooks, consulte Gerenciar webhooks.

    Você precisa do ID do webhook para localizá-lo. O ID do webhook para cada repositório conectado pode ser encontrado no BitbucketServerConfig. Digite o seguinte comando para recuperar o ID do webhook, em que CONFIG_NAME é o nome da configuração do Bitbucket Server:

    gcloud alpha builds enterprise-config bitbucketserver describe --config=CONFIG_NAME
    
  6. Clique em Concluído. Também é possível clicar em Criar um acionador.

API

Para conectar seu repositório do Bitbucket Server ao Cloud Build usando a API, use o seguinte modelo JSON:

  {
    "parent": "projects/PROJECT_NUMBER/locations/global/bitbucketServerConfigs/BITBUCKET_SERVER_CONFIG_NAME",
    "requests": {
      "parent": "projects/PROJECT_NUMBER/locations/global/bitbucketServerConfigs/BITBUCKET_SERVER_CONFIG_NAME",
      "bitbucketServerConnectedRepository": {
        "parent": "projects/PROJECT_NUMBER/locations/global/bitbucketServerConfigs/BITBUCKET_SERVER_CONFIG_NAME",
        "repo": {
           "projectKey": "PROJECT_KEY",
           "repoSlug": "REPO_SLUG"
         }
       }
    }
  }

Em que:

  • PROJECT_NUMBER é o número do projeto do Cloud.
  • BITBUCKET_SERVER_CONFIG_NAME é o nome da configuração do servidor do Bitbucket.
  • PROJECT_KEY é a chave do seu projeto do Bitbucket Server. Se você quiser conectar um repositório pessoal, a chave do projeto precisa conter o símbolo do til (~) antes do nome de usuário. Por exemplo, ~${USERNAME}. O URL completo de um repositório de host pode ser semelhante a https://${HOST_URI}/projects/~${USER_NAME}/repos/${REPO_SLUG}.
  • REPO_SLUG é o slug do repositório do servidor do Bitbucket.

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/BITBUCKET_SERVER_CONFIG_NAME/connectedRepositories:batchCreate -d @requests.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 Bitbucket Server.

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 o repositório do Bitbucket Server estiver conectado, você poderá ver o repositório conectado no campo response.bitbucketServerConnectedRepositories. Caso contrário, consulte o campo error para ver um relatório de erros detalhado.

Como criar um gatilho do Bitbucket Server

Console

Para criar um gatilho do Bitbucket Server usando o Console do Google Cloud:

  1. Acesse a página Gatilhos:

    Abrir a página Acionadores

  2. Selecione seu projeto na parte superior da página e clique em Abrir.

  3. Clique em Criar gatilho.

  4. Preencha as configurações de gatilho a seguir:

    • Nome: nome do acionador.

    • Região: selecione a região do gatilho.

    • Descrição (opcional): uma descrição do gatilho.

    • Evento: selecione o evento de repositório para invocar seu gatilho.

      • Enviar para uma ramificação: defina o gatilho para iniciar um build em confirmações de uma ramificação específica.

      • Enviar nova tag por push: configure o gatilho para iniciar um build em confirmações que contenham uma tag específica.

      • Solicitação de envio (o Cloud Source Repositories não é compatível): defina o gatilho para iniciar uma versão em confirmações para uma solicitação de envio.

    • Origem: selecione o repositório a ser criado quando o gatilho do Bitbucket Server for executado.

    • Revisão: selecione a ramificação ou a tag que será criada quando o gatilho do Bitbucket Server for executado.

    • Ramificação: defina um gatilho para criar a ramificação.

    • Tag: defina um acionador para criar essa tag.

    • Configuração: selecione o arquivo de configuração do build localizado no seu repositório ou configure o build in-line no gatilho.

    • Tipo: selecione o tipo de configuração a ser usado para seu build.

      • Arquivo de configuração do Cloud Build (yaml ou json): use um arquivo de configuração do build na sua configuração.
      • Dockerfile: use um Dockerfile para sua configuração.
    • Local: especifique o local de configuração.

      • Repositório: se o arquivo de configuração estiver localizado no repositório, forneça o local do arquivo de configuração de build ou o diretório Dockerfile e um nome para a imagem resultante. Se sua configuração for um Dockerfile, você poderá fornecer um tempo limite para a criação. Depois de fornecer o Dockerfile e o nome da imagem, você verá uma visualização do comando docker build que sua o build executará.

      • Inline: se você selecionou o arquivo de configuração do Cloud Build (yaml ou json) como opção de configuração, pode especificar a configuração do build inline. Clique em Abrir editor para gravar seu arquivo de configuração do build no Console do Google Cloud usando a sintaxe YAML ou JSON. Clique em Concluído para salvar a configuração do build.

  5. Clique em Criar para criar o gatilho do Bitbucket Server.

gcloud

Para criar um gatilho do Bitbucket Server usando comandos gcloud, será necessário executar o seguinte comando gcloud alpha builds triggers create bitbucketserver no seu terminal:

gcloud alpha builds triggers create bitbucketserver
    --name=TRIGGER_NAME \
    --project-key=PROJECT_KEY \
    --repo-slug=REPO_SLUG \
    --bitbucket-server-config-resource=projects/PROJECT_NUMBER/locations/global/bitbucketServerConfigs/ID \
    --branch-pattern=BRANCH_NAME \ # --tag-pattern=TAG_NAME
    --build-config=BUILD_CONFIG

Em que:

  • TRIGGER_NAME é o nome do gatilho.
  • PROJECT_KEY é a chave do seu projeto do Bitbucket Server.
  • REPO_SLUG é o slug do repositório do servidor do Bitbucket.
  • PROJECT_NUMBER é o número do projeto do Cloud.
  • ID é o ID do BitbucketServerConfig.
  • BRANCH_NAME é a regex da ramificação, se você quiser definir o gatilho para criar determinadas ramificações.
  • TAG_NAME é a regex da tag se você quiser definir o gatilho para criar determinadas tags;
  • BUILD_CONFIG é o caminho para seu arquivo de configuração do build.

API

Para criar um gatilho do Bitbucket Server com a API, use o modelo JSON a seguir.

    {
      "filename": "cloudbuild.yaml",
      "name": "curl-trigger",
      "description": "curl trigger",
      "bitbucket_server_trigger_config": {
          "repo_slug": REPO_SLUG
          "project_key": PROJECT_KEY
          "push": {
             "branch": BRANCH_NAME # "tag": TAG_NAME
          }
     "bitbucket_server_config_resource": "projects/PROJECT_NUMBER/locations/global/bitbucketServerConfigs/ID"
      }
  }

Em que:

  • PROJECT_KEY é a chave do seu projeto do Bitbucket Server.
  • REPO_SLUG é o slug do repositório do servidor do Bitbucket.
  • PROJECT_NUMBER é o número do projeto do Cloud.
  • ID é o ID do BitbucketServerConfig.
  • BRANCH_NAME é a regex da ramificação, se você quiser definir o gatilho para criar determinadas ramificações.
  • TAG_NAME é a regex da tag se você quiser definir o gatilho para criar determinadas tags;

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/triggers -d @trigger.json

Em que:

  • PROJECT_NUMBER é o número do projeto do Cloud.
  • PROJECT_ID é seu ID do projeto do Cloud.

Como criar repositórios em um ambiente local no Bitbucket Server

Se a instância do Bitbucket Server estiver hospedada em um ambiente local e não for acessível por uma conexão de Internet pública, será necessário criar uma conexão particular entre a rede VPC e a rede do produtor de serviços. Você também precisa de um Pool privado para criar em um ambiente local.

Para criar um gatilho do Bitbucket Server para criação no seu ambiente local:

  1. Crie uma conexão particular entre sua rede VPC e a rede do produtor de serviços seguindo estas etapas:

    1. Ative a API Service Networking.
    2. Crie uma nova rede VPC ou selecione uma rede VPC.

    3. Aloque um intervalo de IP nomeado na rede VPC. Para usar a rede VPC com o Cloud Build, o comprimento do prefixo precisa ser /23 ou inferior, como /22, /21 etc.

    4. Estabeleça uma conexão de rede VPC particular entre sua rede VPC e o Google Cloud. Para saber mais, consulte Como criar uma conexão particular.

    5. Se você tiver o DNS configurado para sua instância do Bitbucket Server, será necessário fazer o peering manual da zona de DNS com nosso provedor de serviços. Para saber mais, consulte Como compartilhar zonas DNS particulares com produtores de serviço.

    6. [OPTIONAL] Se você não quiser criar uma conexão particular do projeto do Cloud, configure uma VPC compartilhada e faça com que seu projeto do Cloud use essa rede se o projeto fizer parte de uma organização. Você ainda precisa que a VPC compartilhada faça peering para a API Service Networking.

  2. Use pools particulares para executar seus builds. Se você ainda não criou um pool privado, consulte Criar um novo pool privado.

  3. Crie um gatilho do Bitbucket Server para criar repositórios hospedados em uma instância do Bitbucket Server.

Agora, o gatilho do Bitbucket Server invocará automaticamente as versões na sua instância do Bitbucket Server com base na sua configuração. Para saber como executar builds usando um pool de workers particulares, consulte Como executar builds em um pool privado.

A seguir