连接到 Bitbucket Server 主机

本页面介绍了如何将 Bitbucket Server 主机连接到 Cloud Build。连接到 Bitbucket Server 主机可将 Bitbucket Server 代码库与 Cloud Build 集成。这样,您就可以配置 build 触发器,以从 Bitbucket Server 构建代码库,并在专用网络中从 Bitbucket Server 构建代码库。

准备工作

  • 启用 Cloud Build、Secret Manager 和 Compute Engine API(如果尚未启用)。

    启用 API 所需的角色

    如需启用 API,您需要拥有 serviceusage.services.enable 权限。如果您创建了项目,则可能已经通过 Owner 角色 (roles/owner) 拥有此权限。否则,您可以通过 Service Usage Admin 角色 (roles/serviceusage.serviceUsageAdmin) 获取此权限。 了解如何授予角色。

    启用 API

必需的 IAM 权限

如需获得连接到 Bitbucket Server 主机所需的权限,请让您的管理员为您授予用户账号的 Cloud Build Connection Admin (roles/cloudbuild.connectionAdmin) IAM 角色。 如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限。

您也可以通过自定义角色或其他预定义角色来获取所需的权限。

如果您的 Bitbucket Server 实例托管在专用网络中,请参阅在专用网络中从 Bitbucket Server 构建代码库,了解配置主机连接所需的其他 IAM 角色。

创建个人访问令牌

在为 Bitbucket Server 实例创建主机连接之前,请在 Bitbucket Server 中创建个人访问令牌,方法如下:

  1. 登录 Bitbucket Server 实例。

  2. 按照说明为您的用户账号创建 HTTP 访问令牌。

    1. 创建具有代码库管理员范围的访问令牌,用于与代码库建立连接和断开连接。

    2. 创建具有代码库读取范围的访问令牌,以确保 Cloud Build 代码库可以访问代码库中的源代码。

  3. 安全地保存令牌值。您将使用它们连接到 Bitbucket Server 代码库。

连接到 Bitbucket Server 主机

控制台

如需将 Bitbucket Server 主机连接到 Cloud Build,请执行以下操作:

  1. 在 Google Cloud 控制台中打开代码库页面。

    打开“代码库”页面

  2. 选择页面顶部的第 2 代标签页。

  3. 在顶部栏的项目选择器中,选择您的 Google Cloud 项目。

  4. 点击创建主机连接,将新主机连接到 Cloud Build。

  5. 在左侧面板中,选择 Bitbucket 作为您的来源提供方。

  6. 在配置连接部分中,输入以下信息:

    • 区域:为连接选择一个区域。您必须指定区域。您的连接无法全局存在。

    • 名称:输入连接的名称。

  7. 在主机详细信息部分,选择或输入以下信息:

    • Bitbucket 主机:选择 Bitbucket 数据中心作为主机。

    • 主机网址:输入主机的网址。

  8. 可选:如果您想管理用于加密 Bitbucket Server 代码库的访问令牌的加密密钥,请前往加密部分,然后选择 Cloud Key Management Service 密钥。如需了解详情,请参阅为 Secret Manager 启用客户管理的加密密钥。

  9. 在网络部分中,选择以下选项之一:

    • 公共互联网:如果您的实例可通过公共互联网访问,请选择此选项。

    • 专用网络:如果您的实例托管在专用网络上,请选择此选项。然后,配置以下内容:

      1. CA 证书:您的自签名证书。点击浏览,从本地机器中打开证书。

        您的证书大小不得超过 10 KB,并且应采用 PEM 格式(.pem、.cer 或 .crt)。如果您将此字段留空,Cloud Build 将使用一组默认证书中的证书。

      2. 在 Service Directory 服务下,选择服务的位置:

        • 在项目 CURRENT_PROJECT 中
        • 在其他项目中
        • 手动输入
      3. 请输入以下信息:

        • 项目:如果您选择了在另一个项目中或手动输入,请在下拉菜单中输入或选择您的 Google Cloud 项目 ID。

        • 区域:此字段会预先选择连接所在的区域。为服务指定的区域必须与关联的连接的区域一致。

        • 命名空间:选择服务的命名空间。

        • 服务:选择您命名空间中的服务名称。

  10. 在 HTTP 访问令牌部分中,输入以下信息:

    • 管理员访问令牌:输入具有 repository admin 范围访问权限的令牌。此令牌用于与代码库建立连接和断开连接。

    • 读取访问令牌:输入具有代码库读取范围访问权限的令牌。Cloud Build 触发器使用此令牌访问代码库中的源代码。

  11. 点击连接。

    点击关联按钮后,您的个人访问令牌会安全地存储在 Secret Manager 中。连接到 Bitbucket Server 主机后,Cloud Build 会代表您创建网络钩子密钥。您可以在 Secret Manager 页面上查看和管理 Secret。

gcloud

  1. 将令牌存储在 Secret Manager 中。

  2. 运行以下命令,在 Secret Manager 中创建网络钩子 Secret,其中 WEBHOOK_SECRET 是您要为网络钩子 Secret 指定的名称:

      cat /proc/sys/kernel/random/uuid | tr -d '\n' | gcloud secrets create WEBHOOK_SECRET --data-file=-
    
  3. 如果您将密钥存储在不同于计划用于创建主机连接的 Google Cloud 项目中,请运行以下命令,以向您的项目授予对 Cloud Build 服务代理的访问权限:

    PN=$(gcloud projects describe PROJECT_ID --format="value(projectNumber)")
    CLOUD_BUILD_SERVICE_AGENT="service-${PN}@gcp-sa-cloudbuild.iam.gserviceaccount.com"
    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member="serviceAccount:${CLOUD_BUILD_SERVICE_AGENT}" \
        --role="roles/secretmanager.admin"
    

    其中:

    • PROJECT_ID 是 Google Cloud 项目 ID。

您现在可以继续将 Bitbucket Server 主机连接到 Cloud Build。

  1. 运行以下命令以创建 Bitbucket Server 连接:

    gcloud builds connections create bitbucketserver CONNECTION_NAME \
        --host-uri=HOST_URI \
        --project=PROJECT_ID \
        --region=REGION \
        --authorizer-token-secret-version=projects/PROJECT_ID/secrets/ADMIN_TOKEN/versions/SECRET_VERSION \
        --read-authorizer-token-secret-version=projects/PROJECT_ID/secrets/READ_TOKEN/versions/SECRET_VERSION \
        --webhook-secret-secret-version=projects/PROJECT_ID/secrets/WEBHOOK_SECRET/versions/SECRET_VERSION
     ```
    
    Where:
    
    • CONNECTION_NAME 是 Cloud Build 中 Bitbucket Server 主机连接的名称。
    • HOST_URI 是 Bitbucket Server 实例的 URI。
    • PROJECT_ID 是您的 Google Cloud 项目 ID。
    • REGION 是连接的区域。
    • ADMIN_TOKEN 是具有 repository admin 范围的令牌的名称。
    • READ_TOKEN 是具有 repository read 范围的令牌的名称。
    • SECRET_VERSION 是相应 Secret 的版本。
    • WEBHOOK_SECRET 是您的 Webhook 密钥。

Terraform

您可以使用 Terraform 将 Bitbucket Server 主机连接到 Cloud Build。

在以下示例中,相应代码段会执行以下操作:

  • 配置 Terraform Google 提供程序。
  • 创建 Secret Manager Secret 以存储 Bitbucket 令牌。
  • 向 Cloud Build 服务代理授予访问 Secret 的必要权限。
  • 创建 Bitbucket Server 连接。

    // Configure the Terraform Google provider
    terraform {
      required_providers {
        google = {}
      }
    }
    
    provider "google" {
      project = "PROJECT_ID"
      region = "REGION"
    }
    
    // Create secrets and grant permissions to the Cloud Build service agent
    resource "google_secret_manager_secret" "admin-token-secret" {
        project = "PROJECT_ID"
        secret_id = "ADMIN_TOKEN_NAME"
    
        replication {
            auto {}
        }
    }
    
    resource "google_secret_manager_secret_version" "admin-token-secret-version" {
        secret = google_secret_manager_secret.admin-token-secret.id
        secret_data = "ADMIN_TOKEN_VALUE"
    }
    
    resource "google_secret_manager_secret" "read-token-secret" {
        project = "PROJECT_ID"
        secret_id = "READ_TOKEN_NAME"
    
        replication {
            auto {}
        }
    }
    
    resource "google_secret_manager_secret_version" "read-token-secret-version" {
        secret = google_secret_manager_secret.read-token-secret.id
        secret_data = "READ_TOKEN_VALUE"
    }
    
    resource "google_secret_manager_secret" "webhook-secret-secret" {
        project = "PROJECT_ID"
        secret_id = "WEBHOOK_SECRET_NAME"
    
        replication {
            auto {}
        }
    }
    
    resource "google_secret_manager_secret_version" "webhook-secret-secret-version" {
        secret = google_secret_manager_secret.webhook-secret-secret.id
        secret_data = "WEBHOOK_SECRET_VALUE"
    }
    
    data "google_iam_policy" "p4sa-secretAccessor" {
        binding {
            role = "roles/secretmanager.secretAccessor"
            members = ["serviceAccount:service-PROJECT_NUMBER@gcp-sa-cloudbuild.iam.gserviceaccount.com"]
        }
    }
    
    resource "google_secret_manager_secret_iam_policy" "policy-pak" {
      project = google_secret_manager_secret.admin-token-secret.project
      secret_id = google_secret_manager_secret.admin-token-secret.secret_id
      policy_data = data.google_iam_policy.p4sa-secretAccessor.policy_data
    }
    
    resource "google_secret_manager_secret_iam_policy" "policy-rpak" {
      project = google_secret_manager_secret.read-token-secret.project
      secret_id = google_secret_manager_secret.read-token-secret.secret_id
      policy_data = data.google_iam_policy.p4sa-secretAccessor.policy_data
    }
    
    resource "google_secret_manager_secret_iam_policy" "policy-whs" {
      project = google_secret_manager_secret.webhook-secret-secret.project
      secret_id = google_secret_manager_secret.webhook-secret-secret.secret_id
      policy_data = data.google_iam_policy.p4sa-secretAccessor.policy_data
    }
    
    // Create the connection resource
    resource "google_cloudbuildv2_connection" "my-connection" {
        project = "PROJECT_ID"
        location = "REGION"
        name = "CONNECTION_NAME"
    
        bitbucket_server_config {
            host_uri = "BITBUCKET_URI"
            authorizer_credential {
                user_token_secret_version = google_secret_manager_secret_version.admin-token-secret-version.id
            }
            read_authorizer_credential {
                user_token_secret_version = google_secret_manager_secret_version.read-token-secret-version.id
            }
            webhook_secret_secret_version = google_secret_manager_secret_version.webhook-secret-secret-version.id
        }
    
        depends_on = [
            google_secret_manager_secret_iam_policy.policy-pak,
            google_secret_manager_secret_iam_policy.policy-rpak,
            google_secret_manager_secret_iam_policy.policy-whs
        ]
    }
    

其中:

  • PROJECT_ID 是您的 Google Cloud 项目 ID。
  • PROJECT_NUMBER 是您的 Google Cloud 项目编号。
  • ADMIN_TOKEN_NAME 是具有 repository:admin 范围的令牌的名称。
  • ADMIN_TOKEN_VALUE 是 ADMIN_TOKEN_NAME 的值。
  • READ_TOKEN_NAME 是具有 repository:read 范围的令牌的名称。
  • READ_TOKEN_VALUE 是 READ_TOKEN_NAME 的值。
  • WEBHOOK_SECRET_NAME 是您的网络钩子 Secret 的名称。
  • WEBHOOK_SECRET_VALUE 是 WEBHOOK_SECRET_NAME 的值。
  • REGION 是连接的区域。
  • CONNECTION_NAME 是 Cloud Build 中 Bitbucket Server 主机连接的名称。
  • BITBUCKET_URI 是 Bitbucket 数据中心实例的 URI。

轮替旧的或已过期的 Bitbucket Server 访问令牌

轮换访问令牌,以便 Cloud Build 主机连接能够保持与 Bitbucket Server 代码库的连接。如果您的 Bitbucket Server 访问令牌过期,则 Cloud Build 主机连接会与相应的 Bitbucket Server 代码库断开连接。发生这种情况时,您无法停用连接或关联代码库,除非您轮换已过期的令牌。此外,在以下情况下,您会看到错误:

  • 相应连接的连接详情页面会显示一条错误消息,指出 Connection is disconnected due to an invalid or expired access token。

  • 如果您尝试将代码库与令牌已过期的连接相关联,则会看到访问令牌无效消息。点击查看连接后,系统会将您带到令牌已过期的连接的连接详情页面。

Cloud Build 可让您通过输入新的令牌值并将其保存在 Secret Manager 中作为这些令牌的最新 Secret 版本来轮换访问令牌。如需轮换访问令牌,请执行以下操作:

  1. 在 Bitbucket Server 中轮换每个访问令牌:

    1. 前往已连接到 Cloud Build 主机连接的 Bitbucket Server 代码库。

    2. 按照 Bitbucket 文档中的说明轮换访问令牌。 当您轮换令牌时,Bitbucket Server 会创建具有新凭据的新令牌,并使该令牌的先前版本失效。轮换后的令牌与原始令牌具有相同的权限和范围。

    3. 复制已轮换的令牌的 ID。

  2. 在 Cloud Build 中更新访问令牌:

    1. 前往相应连接的连接详情页面。

    2. 选择更新访问令牌。

    3. 在令牌轮换菜单中,在 API 访问令牌和读取访问令牌字段中输入新令牌。

    4. (可选):如果您希望连接始终使用令牌的最新版密钥,请选择更新连接以始终使用最新版本。如果您的连接使用特定的密钥版本号,则取消选中此选项可能会有所帮助。

    5. 选择更新以保存更改。

      Cloud Build 会将新的访问令牌保存为 Secret Manager 中 Secret 的最新版本。

如需了解详情,请参阅 Bitbucket Server 文档中的访问令牌和增强 Bitbucket 中的安全性:引入访问令牌过期功能。

后续步骤