プライベート ネットワークでホストされている GitHub Enterprise リポジトリに接続する

このページでは、Developer Connect と Service Directory を使用して、プライベート ネットワークでホストされている GitHub Enterprise リポジトリに接続する方法について説明します。これらのタスクは、 Google Cloud コンソールまたは Google Cloud CLI を使用して完了できます。

この手順は、GitHub Enterprise ソースコード リポジトリを Google で使用するアプリケーション デベロッパー、プラットフォーム管理者、セキュリティ マネージャーを対象としています。具体的には、Gemini Code Assist で GitHub Enterprise リポジトリを使用できます。

Developer Connect の詳細については、Developer Connect の概要をご覧ください。

始める前に

Google アカウントにログインします。

Google アカウントをまだお持ちでない場合は、新しいアカウントを登録します。

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

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

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

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

Developer Connect を有効にすると、Secret Manager API も有効になります。

1. GitHub Enterprise のアカウントにアクセスできることを確認します。

   チームの作業を安全に保つため、このガイドのタスクは、個人用アカウントではなく、ボット アカウントまたはチームで共有するアカウントを使用して完了することをおすすめします。

2. GitHub Enterprise リポジトリを所有しているか、共有リポジトリに対する管理者レベルの権限があることを確認します。

3. GitHub Enterprise 組織のリポジトリを使用する場合は、GitHub アプリ マネージャー権限があることを確認してください。

4. プライベート ネットワークに接続するための Service Directory サービス リソースがあることを確認するか、Service Directory サービス リソースを作成します。Service Directory サービス リソースは、Developer Connect で使用しているプロジェクトと同じプロジェクトに作成することも、別のプロジェクトを使用することもできます。
   

   Google Cloudの外部のネットワークへの接続では、Service Directory の構成が異なる場合があります。Service Directory を使用して Google Cloud外のホストにアクセスするをご覧ください。

5. 省略可: Developer Connect が作成する認証シークレットを暗号化するための顧客管理の暗号鍵（CMEK）を作成します。
6. 省略可: このガイドのコマンドラインの手順を使用するには、次の操作を行います。
   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 ロールを付与するよう依頼してください。

• プロジェクト オーナーでない場合: ユーザー アカウントのDeveloper Connect 管理者 （roles/developerconnect.admin）。
• CMEK を使用して Developer Connect が作成するシークレットを暗号化する場合は、Secret Manager サービス アカウントに対する Cloud KMS CryptoKey Encrypter/Decrypter （roles/cloudkms.cryptoKeyEncrypterDecrypter）
• gcloud CLI を使用してこのガイドの手順を完了する場合は、Developer Connect サービス アカウントに対する Secret Manager 管理者ロール （roles/secretmanager.admin）が必要です。
• Google Cloud コンソールを使用してこのガイドの手順を完了する場合は、ユーザー アカウントに対するプロジェクト IAM 管理者 （roles/resourcemanager.projectIamAdmin）

ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

注: プロジェクト IAM 管理者（roles/resourcemanager.projectIamAdmin）ロールがある場合、 Google Cloud コンソールは必要な権限を自動的に付与できます。管理者がプロジェクト IAM 管理者ロールの付与を許可しない場合は、Developer Connect サービス アカウント（service-{projectNumber}@gcp-sa-devconnect.iam.gserviceaccount.com）に対する Secret Manager 管理者（roles/secretmanager.admin）の付与を管理者に依頼してください。

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: Service Directory サービス リソースを含む Google Cloud プロジェクトのプロジェクト ID。

2. Service Directory が VPC ネットワーク リソースにアクセスするための権限を付与します。ネットワーク リソースは別のプロジェクトに配置できます。

   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 Balancer を使用してロードバランサを作成して、トラフィックをホストに転送できます。

Service Directory エンドポイントを作成するときは、ホストの IP アドレスではなく、ロードバランサの転送ルールの IP アドレスを使用してください。エンドポイントの作成時に、内部 HTTPS ロードバランサまたは内部伝送制御プロトコル（TCP）ロードバランサを使用できます。

TCP ロードバランサを作成する場合は、次の点を考慮してください。

• ホストに到達するには、ハイブリッド接続ネットワーク エンドポイント グループ（NEG）のみが必要です。
• TCP ロードバランサでは、SSL 証明書用に暗号化されていない秘密鍵は必要ありません。
• Cloud VPN の設定では、グローバル動的ルーティングで Cloud Router を使用する必要があります。Cloud VPN で静的ルーティングが使用されている場合は、代わりに Cloud Service Mesh を使用するプロキシを使用できます。詳細については、ハイブリッド デプロイ用にネットワーク エッジ サービスを設定するをご覧ください。

HTTPS ロードバランサの作成の詳細については、ハイブリッド接続で内部アプリケーション ロードバランサを設定するをご覧ください。TCP ロードバランサの作成の詳細については、ハイブリッド接続でリージョン内部プロキシ ネットワーク ロードバランサを設定するをご覧ください。

接続を作成する

このセクションでは、Developer Connect と GitHub Enterprise 間の接続を作成する方法について説明します。 Google Cloud コンソールを使用している場合は、接続の設定が完了したら、リポジトリへのリンクの追加を開始することもできます。

新しい GitHub Enterprise 接続を作成するには、次のいずれかのオプションを選択します。

コンソール

次の手順で接続を開始します。

1. Google Cloud コンソールで Developer Connect を開きます。

   Developer Connect に移動

   Developer Connect に [Git リポジトリ] ページが表示されます。

   • ソースコード管理プロバイダのリストが表示された場合: ソースコード管理プロバイダを選択して、最初の接続の構成を開始します。GitHub Enterprise カードで [接続] をクリックします。

   • 既存の接続を一覧表示するテーブルが表示された場合: [接続を作成] > [GitHub Enterprise] をクリックして、ソースコード管理プロバイダを設定します。

     [接続を作成] ページが開きます。

2. [リージョン] で、接続リソースのリージョンを選択します。

   1. [名前] に、新しい接続の名前を入力します。

3. [データ所在地のコンプライアンスを満たす接続を有効化] チェックボックスをオンにすると、この接続がデータ所在地の要件に準拠します。

   Google Cloud コンソールを使用して作成された GitHub 接続は、接続の作成時にこのチェックボックスをオンにすると、データ所在地に準拠します。この操作を行うと、Developer Connect によって GitHub アプリが作成されます。

   Google Cloud CLI を使用して GitHub 接続を作成する場合、これらの接続はデータ所在地に準拠していません。他のすべての接続タイプはデータ所在地のコンプライアンスに準拠しています。

4. [ホスト URL] に、接続するホストの URL を入力します。

5. [詳細を表示] をクリックすると、オプションの構成設定が表示されます。

   1. [Enable Developer Connect proxy] チェックボックスはデフォルトでオンになっているため、Developer Connect は GitHub Enterprise への Git 呼び出しのプロキシとして機能できます。

   2. [ネットワーキング] セクションの [ネットワーク タイプ] で、[プライベート ネットワーク] を選択します。

   3. [CA 証明書] で、[参照] をクリックして自己署名証明書をアップロードします。

      証明書のサイズは 10 KB 以下で、PEM 形式（.pem、.cer、.crt）にする必要があります。このセクションを空白のままにした場合は、代わりにデフォルトの証明書セットが使用されます。

   4. [Service Directory サービス] セクションで、サービスのロケーションを選択します。

      • プロジェクト your-project 内
      • 別のプロジェクト内
      • 手動で入力

      [別のプロジェクト内] または [手動で入力] を選択した場合は、 Google Cloud プロジェクト ID を指定します。プルダウン メニューでプロジェクトを選択するか、プロジェクト ID を手動で入力します。

   5. リージョン: Service Directory サービスのリージョンを選択します。サービス用に指定されるリージョンは、接続に関連付けられたリージョンと一致する必要があります。

   6. 名前空間: Service Directory サービスの名前空間を選択します。

   7. サービス: 名前空間内の Service Directory サービス名を選択します。

   8. 省略可: [暗号化] セクションで、Developer Connect が作成する Secret Manager シークレットを暗号化する CMEK 鍵を選択します。

6. [続行] をクリックします。

   GitHub ダイアログが表示され、GitHub アプリの作成が求められます。

7. GitHub のプロンプトに沿って、次のタスクを完了します。

   1. アプリの名前を入力します。

   2. アプリをインストールする組織を選択します。

   3. アクセス権を付与するリポジトリを選択します。

   ダイアログが閉じます。

   Developer Connect は、GitHub から秘密鍵を取得し、Secret Manager のシークレットとして Google Cloud プロジェクトに保存します。シークレットを表示するには、Secret Manager でシークレットを一覧表示します。

接続が作成されると、[リポジトリをリンク] ページが表示されます。

リポジトリを接続にリンクする手順は次のとおりです。

1. 使用可能なリポジトリのリストで、使用するリポジトリを選択します。

2. [OK] をクリックします。

3. [リンク] をクリックします。

接続が [接続] ページに追加され、リポジトリ リンクが 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 が 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 コンソールで [リポジトリ] ページを開きます。

   [リポジトリ] ページを開く

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 でアクセス権を取り消します。

次のステップ

• Gemini Code Assist のコード カスタマイズの設定を完了する。
• Gemini Code Assist がソフトウェア開発を加速させる方法をご確認ください。
• Developer Connect で利用可能な他の統合について確認する。