連線至私人網路中託管的 GitHub Enterprise 存放區

本頁說明如何使用 Developer Connect 和 Service Directory，連線至私人網路中代管的 GitHub Enterprise 存放區。您可以使用 Google Cloud 控制台或 Google Cloud CLI 完成這些工作。

這些操作說明適用於應用程式開發人員、平台管理員和安全管理員，他們想搭配 Google 使用 GitHub Enterprise 原始碼存放區。具體來說，您可以搭配 Gemini Code Assist 使用 GitHub Enterprise 存放區。

如要進一步瞭解 Developer Connect，請參閱這篇文章。

事前準備

  1. 登入 Google 帳戶。

    如果沒有帳戶，請 申請新帳戶。

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

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

  4. Enable the Developer Connect and Service Directory APIs.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the APIs

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

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

  7. Enable the Developer Connect and Service Directory APIs.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the APIs

    8.

    啟用 Developer Connect 時，系統也會啟用 Secret Manager API。

  8. 確認您有權存取 GitHub Enterprise 帳戶。

    為確保團隊工作安全，建議您使用機器人帳戶或團隊共用的帳戶，完成本指南中的工作，而非個人帳戶。

  9. 請確認您擁有 GitHub Enterprise 存放區，或對共用存放區具備管理員層級的權限。

  10. 在 GitHub Enterprise 機構中使用存放區時，請確認您擁有 GitHub 應用程式管理員權限。

  11. 請確認您有 Service Directory 服務資源可連線至私人網路，或建立 Service Directory 服務資源。您可以在與 Developer Connect 搭配使用的專案中，建立 Service Directory 服務資源，也可以使用其他專案。

    如要連線至 Google Cloud以外的網路，您可能需要以不同方式設定 Service Directory。請參閱「使用 Service Directory 連線至 Google Cloud外部主機」。

  12. 選用：建立客戶自行管理的加密金鑰 (CMEK)，用於加密 Developer Connect 建立的驗證密鑰。
  13. 選用：如要使用本指南中的指令列操作說明，請完成下列步驟：
    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 權限

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

  • 如果您不是專案擁有者： 使用者帳戶的開發人員連線管理員 (roles/developerconnect.admin) 。
  • 如果您打算使用 CMEK 加密 Developer Connect 建立的密鑰： Secret Manager 服務帳戶的「Cloud KMS CryptoKey Encrypter/Decrypter」(Cloud KMS 加密編譯金鑰加密者/解密者) (roles/cloudkms.cryptoKeyEncrypterDecrypter) 。
  • 如果您打算使用 gcloud CLI 完成本指南中的步驟： Developer Connect 服務帳戶的Secret Manager 管理員角色 (roles/secretmanager.admin)。
  • 如果您打算使用 Google Cloud 控制台完成本指南中的步驟： 專案 IAM 管理員 (roles/resourcemanager.projectIamAdmin) 使用者帳戶。

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

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

授予使用 Service Directory 的權限

請完成下列步驟，允許 Developer Connect 使用 Service Directory，並允許 Service Directory 存取您的 VPC 網路資源。

  1. 執行下列指令，授予 Developer Connect 服務帳戶使用 Service Directory 的權限：

    PROJECT_NUMBER=$(gcloud projects describe PROJECT_ID --format="value(projectNumber)")

SERVICE_ACCOUNT="service-${PROJECT_NUMBER}@gcp-sa-devconnect.iam.gserviceaccount.com"

gcloud projects add-iam-policy-binding SERVICE_DIRECTORY_RESOURCE_PROJECT_ID \
    --member="serviceAccount:${SERVICE_ACCOUNT}" \
    --role="roles/servicedirectory.viewer"

    更改下列內容：

    • PROJECT_ID：您的 Google Cloud 專案 ID。
    • SERVICE_DIRECTORY_RESOURCE_PROJECT_ID：專案 ID，用於存放您的 Service Directory 服務資源。 Google Cloud

  2. 授予 Service Directory 存取虛擬私有雲網路資源的權限。網路資源可以位於不同專案。

    gcloud projects add-iam-policy-binding NETWORK_RESOURCE_PROJECT_ID \
    --member="serviceAccount:${SERVICE_ACCOUNT}" \
    --role="roles/servicedirectory.pscAuthorizedService"

    將 NETWORK_RESOURCE_PROJECT_ID 替換為含有 VPC 網路資源的專案 ID。

使用 Service Directory 觸及外部主機 Google Cloud

Service Directory 會使用 IP 位址範圍 35.199.192.0/19，將主機連線到 Google Cloud外部。您必須將這個範圍新增至防火牆的許可清單。此外，您必須設定私人網路，透過 Cloud VPN 或 Cloud Interconnect 連線轉送這個範圍。

如果連線使用 Cloud Router，您可以設定連線，將範圍傳達至私有網路。

詳情請參閱「設定私人網路存取權」。

使用 Cloud Load Balancing 連線至外部主機 Google Cloud

如果網路設定不允許您將 Service Directory IP 位址範圍 35.199.192.0/19 路由至 Cloud VPN 或 Cloud Interconnect，可以使用 Cloud Load Balancing 建立負載平衡器，將流量導向主機。

建立 Service Directory 端點時，請務必使用負載平衡器轉送規則的 IP 位址，而非主機的 IP 位址。建立端點時，您可以使用內部 HTTPS 負載平衡器或內部傳輸控制通訊協定 (TCP) 負載平衡器。

建立 TCP 負載平衡器時，請注意下列事項：

  • 您只需要混合式連線網路端點群組 (NEG)，即可連上主機。
  • TCP 負載平衡器不需要 SSL 憑證的未加密私密金鑰。
  • Cloud VPN 設定必須使用 Cloud Router 和全域動態轉送。如果 Cloud VPN 使用靜態路徑，您可以改用 Cloud Service Mesh 的 Proxy。詳情請參閱「為混合式部署設定網路邊緣服務」。

如要進一步瞭解如何建立 HTTPS 負載平衡器，請參閱「設定具備混合式連線功能的內部應用程式負載平衡器」。如要進一步瞭解如何建立 TCP 負載平衡器，請參閱「使用混合式連線設定區域性內部 Proxy 網路負載平衡器」。

建立連線

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

如要建立新的 GitHub Enterprise 連線，請選取下列任一選項：

控制台

請完成下列步驟來啟動連線：

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

    前往 Developer Connect

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

    • 如果看到原始碼管理服務供應商清單：選取原始碼管理服務供應商，開始設定第一個連線。按一下 GitHub Enterprise 資訊卡上的「連結」。

    • 如果看到列出現有連線的表格：按一下「建立連線」 >「GitHub Enterprise」，設定來源程式碼管理服務供應商。

      「建立連線」頁面隨即開啟。

  2. 在「Region」(區域)，為連線資源選擇區域。

    1. 在「Name」(名稱) 部分，輸入新連線的名稱。

  3. 勾選「啟用符合資料落地規定的連線」核取方塊，讓這個連線符合資料落地規定。

    使用 Google Cloud 控制台建立 GitHub 連線時，只要啟用這個核取方塊，連線就會符合資料落地規定。這麼做時，Developer Connect 會建立 GitHub 應用程式

    使用 Google Cloud CLI 建立 GitHub 連線時，這些連線不符合資料落地規定。所有其他連線類型均符合資料落地規定。

  4. 在「主機網址」部分，輸入要連線的主機網址。

  5. 按一下「顯示更多」即可查看選用設定。

    1. 「啟用 Developer Connect Proxy」核取方塊預設為選取狀態，因此 Developer Connect 可做為 Proxy，對 GitHub Enterprise 執行 Git 呼叫。

    2. 在「網路」部分的「網路類型」中，選擇「私人網路」。

    3. 在「CA Certificate」部分，按一下「Browse」上傳自簽憑證。

      憑證大小不得超過 10 KB，且必須採用 PEM 格式 (.pem、.cer 或 .crt)。如果將這個部分留空，系統會改用預設的憑證集。

    4. 在「Service Directory service」(服務目錄服務) 區段中，選取服務位置：

      • 在「your-project」專案中
      • 在其他專案中
      • 手動輸入

      如果選取「In another project」(位在其他專案) 或「Enter manually」(手動輸入)，請指定專案 ID。 Google Cloud 在下拉式選單中選取專案，或手動輸入專案 ID。

    5. 區域：選取 Service Directory 服務的區域。為服務指定的地區必須與連線相關聯的地區相符。

    6. 命名空間：選取 Service Directory 服務的命名空間。

    7. 服務：選取命名空間中的 Service Directory 服務名稱。

    8. 選用步驟：在「Encryption」(加密) 部分中，選取 CMEK 金鑰，加密 Developer Connect 建立的 Secret Manager 密鑰。

  6. 按一下「繼續」。

    系統會顯示 GitHub 對話方塊，邀請您建立 GitHub 應用程式。

  7. 按照 GitHub 中的提示完成下列工作：

    1. 輸入應用程式名稱。

    2. 選擇要安裝應用程式的機構。

    3. 選取要授予存取權的存放區。

    對話方塊隨即關閉。

    Developer Connect 會從 GitHub 擷取私密金鑰，並以 Secret Manager 密鑰的形式儲存在 Google Cloud 專案中。如要查看密鑰，請列出 Secret Manager 中的密鑰。

連線建立完成後，系統會顯示「連結存放區」頁面。

如要將存放區連結至連線，請完成下列步驟：

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

  2. 按一下 [確定]。

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

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

如要設定 Gemini Code Assist，請按照「設定及使用 Gemini Code Assist 程式碼自訂功能」一文中的步驟，繼續完成設定程序。

gcloud

下列工作需要透過網路瀏覽器完成一些動作。

  1. 執行 gcloud developer-connect connections create 指令，建立與 GitHub Enterprise 的連線：

    gcloud developer-connect connections create CONNECTION_NAME \
    --location=REGION \
    --project=PROJECT_ID \
    --github-enterprise-config-host-uri=HOST_URI
    --github-enterprise-config-service-directory=SERVICE_DIRECTORY_RESOURCE
    --git-proxy-config-enabled

    更改下列內容：

    • CONNECTION_NAME：連線名稱。
    • REGION：連線的區域。
    • HOST_URI：要連線的主機 URI。
    • SERVICE_DIRECTORY_RESOURCE：您的 Service Directory 資源路徑，格式為 projects/PROJECT_ID/locations/REGION/namespaces/NAMESPACE/services/SERVICE。
    • --git-proxy-config-enabled 是選用旗標，可讓 Developer Connect 做為 Proxy，對 GitHub Enterprise 執行 Git 呼叫。在私人網路中執行的 GitHub Enterprise 原始碼存放區上，啟用 Gemini Code Assist 程式碼自訂功能時，必須啟用這項功能。
    • --github-enterprise-config-ssl-ca-certificate 是選用標記，可新增 SSL 憑證，格式為 $HOME/my-ssl-ca.txt。

  2. 您必須建立 GitHub 應用程式，才能管理與 GitHub 的連線。執行下列指令，取得應用程式設定的 URI：

    gcloud developer-connect connections describe CONNECTION_NAME \
    --location=REGION

    更改下列內容：

    • CONNECTION_NAME：連線名稱。
    • REGION：連線的區域。

    Developer Connect 會傳回連結，讓您在瀏覽器視窗中完成後續步驟。複製這個連結。

  3. 在網路瀏覽器中開啟連結。

  4. 如果系統提示，請登入 GitHub 帳戶。

  5. 按照 GitHub 中的提示完成下列工作：

    1. 輸入應用程式名稱。

    2. 選擇要安裝應用程式的機構。

    3. 選取要授予存取權的存放區。

    對話方塊隨即關閉。

    Developer Connect 會從 GitHub 擷取私密金鑰，並以 Secret Manager 密鑰的形式儲存在 Google Cloud 專案中。如要查看密鑰，請列出 Secret Manager 中的密鑰。

驗證連線

執行下列指令，確認 GitHub 連線是否已建立：

gcloud developer-connect connections describe CONNECTION_NAME \
    --location=REGION

其中：

  • CONNECTION_NAME：連線名稱。
  • REGION：連線的區域。

Developer Connect 會在 installationState 欄位中傳回狀態。如果這個欄位的值為 COMPLETE，表示應用程式安裝完成。否則，Developer Connect 會傳回 URI，讓您返回瀏覽器中的設定。

連線完成後，請按照「連結至存放區」一文中的操作說明，選擇要連結的存放區。

建立與 GitHub Enterprise 的連線後，即可連結至存放區。之後可以視需要重複這些步驟，連結其他存放區。

如要在現有的 GitHub Enterprise 連線上建立存放區連結，請選取下列其中一個選項：

控制台

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

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

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

    「連結 Git 存放區」窗格隨即開啟。

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

  4. 按一下「繼續」。

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

  6. 點選「建立」。

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

gcloud

執行下列指令：

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

更改下列內容：

  • REPO_NAME：存放區連結的名稱。
  • REPO_URI：存放區的連結。例如：https://github.com/cloud-build/test-repo.git。
  • CONNECTION_NAME：連線名稱。
  • REGION：連線的區域。

Developer Connect 會建立存放區連結。

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

如要設定 Gemini Code Assist，請按照「設定及使用 Gemini Code Assist 程式碼自訂功能」一文中的步驟，繼續完成設定程序。

資料共用

連結至這項連線的 Google Cloud 資源內容可能會移轉至 GitHub。這項聲明適用於使用這項連線的所有資源，包括現有和日後的資源。如要停止與 GitHub 分享資訊，請在 Google Cloud 控制台或 gcloud CLI 中刪除 Developer Connect 連線，並在 GitHub 中撤銷存取權。

後續步驟