連結 GitLab

本頁面說明如何建立 GitLab 連線,以及建立 GitLab 存放區連結。您可以使用 Google Cloud 控制台或 Google Cloud CLI 完成這些工作。

以下操作說明適用於想搭配 Google 使用 GitLab 原始碼存放區的應用程式開發人員、平台管理員和資安管理員。具體來說,您可以將 GitLab 存放區與 Gemini Code Assist 搭配使用。

如要進一步瞭解 Developer Connect,請參閱「Developer Connect 總覽」。

事前準備

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

  2. Verify that billing is enabled for your Google Cloud project.

  3. Enable the Developer Connect, Secret Manager APIs, if any are not already enabled.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the APIs

  4. 確認您有權存取 GitLab 帳戶。

    為確保團隊工作安全,建議您使用服務帳戶或團隊共用帳戶 (而非個人帳戶) 完成本指南中的工作。

  5. 確認您擁有 GitLab 存放區,或具備共用存放區的管理員層級權限。
  6. 選用:建立客戶自行管理的加密金鑰 (CMEK),用於加密 Developer Connect 建立的驗證密鑰。
  7. 選用:如要使用本指南中的指令列操作說明,請完成下列步驟:
    1. 安裝 Google Cloud CLI。如果您先前已安裝 gcloud CLI,請務必執行 gcloud components update,確認您使用的是最新版本。
    2. 執行下列指令,建立 Developer Connect 服務帳戶,其中 PROJECT_ID 是您的Google Cloud 專案 ID:
              gcloud beta services identity create \
                  --service=developerconnect.googleapis.com \
                  --project=PROJECT_ID
              

必要的角色

如要取得建立連線和連結所需的權限,請要求管理員授予您下列 IAM 角色:

  • 如果您不是專案擁有者: 使用者帳戶具備 Developer Connect 管理員 (roles/developerconnect.admin) 角色。
  • 如要使用 CMEK 加密 Developer Connect 建立的密鑰: Secret Manager 服務帳戶的 Cloud KMS CryptoKey 加密者/解密者 (roles/cloudkms.cryptoKeyEncrypterDecrypter)。
  • 如要使用 gcloud CLI 完成本指南中的步驟:Developer Connect 服務帳戶的 Secret Manager 管理員角色 (roles/secretmanager.admin)。
  • 如果您打算使用 Google Cloud 控制台完成本指南中的步驟:使用者帳戶須具備專案 IAM 管理員 (roles/resourcemanager.projectIamAdmin) 角色。

如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。

您或許也能透過自訂角色或其他預先定義的角色,取得必要權限。

建立存取權杖

如要在 GitLab 建立存取權杖,請完成下列步驟:

  1. 登入 GitLab。

  2. 請按照 GitLab 說明文件中的指示,建立個人存取權杖、群組存取權杖或專案存取權杖,並授予下列權限:

    • 一個範圍為 api 的權杖,用於連結及取消連結存放區。
    • 一個範圍為 read_api 的權杖,可讓 Developer Connect 讀取存放區中的原始碼。
    • 如果是群組存取權杖和專案存取權杖,權杖必須具備維護者或更高層級的角色。

建立連線

本節說明如何在 Developer Connect 和 GitLab 之間建立連線。如果您使用 Google Cloud 控制台,也可以在完成連線設定後,開始新增存放區連結。

如要建立新的 GitLab 連線,請選取下列其中一個選項:

控制台

請按照下列步驟建立連結:

  1. 在 Google Cloud 控制台開啟「Developer Connect」。

    前往 Developer Connect

    Developer Connect 會顯示「Git repositories」(Git 存放區) 頁面。

    • 如果看到原始碼管理服務供應商清單:請選取原始碼管理服務供應商,開始設定第一個連線。按一下 GitLab 資訊卡上的「Connect」(連結)。
    • 如果看到列出現有連線的表格:請依序點選「Create connection」(建立連線) >「GitLab」,設定原始碼管理服務供應商。

      「Create Connection」(建立連線) 頁面隨即開啟。

  2. 在「Region」(區域) 部分,選擇連線資源的區域。

    1. 在「Name」(名稱) 部分,輸入新連線的名稱。
  3. 在「Access Tokens」(存取權杖) 區段中,輸入帳戶的權杖:

    • API 存取權杖:輸入具有 api 範圍的存取權杖。
    • Read API access token:輸入具有 read_api 範圍的存取權杖。

    您有責任確保 GitLab 權杖有效。除非權杖建立者或管理員另有指定,否則 GitLab 權杖的效期最長為 365 天。如要瞭解如何管理權杖到期設定和通知,請參閱 GitLab 說明文件中的個人存取權杖、群組存取權杖和專案存取權杖。

  4. 按一下「顯示更多」,查看選用的配置設定。

    1. 選用:在「Encryption」(加密) 區段中,選取 CMEK 金鑰,加密 Developer Connect 建立的 Secret Manager 密鑰。

    2. 選用:根據預設,Developer Connect 可做為 Proxy,對 GitLab 執行 Git 呼叫。如要停用這個選項,請取消勾選「Enable Developer Connect proxy」(啟用 Developer Connect Proxy) 核取方塊。

  5. 按一下「繼續」。

建立連線後,系統會顯示「Link repositories」(連結存放區) 頁面。

請按照下列步驟,將存放區連結至連線:

  1. 在可用存放區清單中,選取要使用的存放區。

  2. 按一下 [確定]。

  3. 按一下「Link」(連結)。

連線會新增至「Connections」(連線) 頁面,存放區連結則會新增至 Google Cloud 控制台的「Repositories」(存放區) 頁面。您隨時可以在現有連結中新增更多連結。

如要設定 Gemini Code Assist,請按照「設定及使用 Gemini Code Assist 自訂程式碼」中的步驟繼續操作。

gcloud

  1. 執行下列指令,在 Secret Manager 中建立 Webhook 密鑰,其中 WEBHOOK_SECRET_NAME 是 Webhook 密鑰的名稱:

         cat /proc/sys/kernel/random/uuid | tr -d '\n' | gcloud secrets create WEBHOOK_SECRET_NAME
    
  2. 執行下列指令,將存取權杖儲存在 Secret Manager:

    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=-
    

    更改下列內容:

    • API_SECRET_NAME:儲存權杖的 Secret 名稱,範圍為 api。
    • API_SECRET_DATA:具有 api 範圍的權杖,類似於 glpat-XXXXXXXXXXXXXXXX。
    • READ_SECRET_NAME:儲存權杖的 Secret 名稱,範圍為 read_api。
    • READ_SECRET_DATA:具有 read_api 範圍的權杖,類似於 glpat-XXXXXXXXXXXXXXXX。
  3. 執行 developer-connect connections create 指令,建立與 GitLab 帳戶的連線:

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

    更改下列內容:

    • CONNECTION_NAME:連線名稱。
    • REGION:連線所在的區域。
    • PROJECT_NAME:您的 Google Cloud專案 ID。
    • API_SECRET_NAME:Secret Manager 密鑰名稱,其中包含具有 api 範圍的權杖。
    • READ_SECRET_NAME:Secret Manager 密鑰名稱,其中包含具有 read_api 範圍的權杖。
    • WEBHOOK_SECRET_NAME:Secret Manager 密鑰名稱,其中包含 Webhook 密鑰。
    • VERSION:各個 Secret 的版本編號。這可以是 latest,以使用最新版本號碼。
    • --git-proxy-config-enabled:選用旗標,可讓 Developer Connect 做為 Proxy,對 GitLab 執行 Git 呼叫。

    Developer Connect 會完成與 GitLab 的連線。接下來,請連結至存放區。

與 GitLab 建立連線後,即可連結至存放區。您可以視需要重複這些步驟,連結其他存放區。

如要在現有 GitLab 連線上建立存放區連結,請選取下列其中一個選項:

控制台

請完成下列步驟,建立存放區連結:

  1. 在 Google Cloud 控制台中開啟「Repositories」(存放區) 頁面。

    開啟「Repositories」(存放區) 頁面

  2. 按一下「連結存放區」。

    「Link Git repositories」(連結 Git 存放區) 窗格隨即開啟。

  3. 在連線清單中選擇連線。

  4. 按一下「繼續」。

  5. 在存放區清單中,選取要連結的存放區。

    Developer Connect 會顯示存放區資源的建議名稱。

  6. 選取存放區資源命名選項:

    • Generated:使用系統產生的存放區資源名稱。
    • 手動:自行輸入名稱。
  7. 點選「建立」。

Developer Connect 會建立存放區連結,並顯示在 Google Cloud 控制台中。

gcloud

執行下列指令,連結至 GitLab 存放區:

gcloud developer-connect connections git-repository-links create REPO_NAME \
    --clone-uri=REPO_URI \
    --connection=CONNECTION_NAME \
    --location=REGION

更改下列內容:

  • REPO_NAME:存放區連結的名稱。
  • REPO_URI:存放區連結,類似 https://gitlab.com/my-project/test-repo.git。
  • CONNECTION_NAME:連線名稱。
  • REGION:連線所在區域。

Developer Connect 會建立存放區連結。

如要列出連結的存放區,請執行 developer-connect connections git-repository-links list 指令。

如要設定 Gemini Code Assist,請按照「設定及使用 Gemini Code Assist 自訂程式碼」中的步驟繼續操作。

後續步驟