GitHub Enterprise に接続する

このページでは、GitHub Enterprise への接続を作成し、GitHub Enterprise リポジトリへのリンクを作成する方法について説明します。 これらのタスクは、 Google Cloud コンソール、 または Google Cloud CLI を使用して完了できます。

この手順は、Google で GitHub Enterprise ソースコードのリポジトリを使用するアプリケーション開発者、プラットフォーム管理者、セキュリティ管理者を対象としています。 具体的には、 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 API.

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 API

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

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 API

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

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

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

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

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

4. 省略可: Developer Connect が作成する認証シークレットを暗号化するための顧客管理の 暗号鍵（CMEK）を作成します。
5. 省略可: このガイドのコマンドラインの手順を使用するには、次の操作を行います。
   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 が作成するシークレットを暗号化する場合: Cloud KMS CryptoKey の暗号化/復号 （roles/cloudkms.cryptoKeyEncrypterDecrypter） Secret Manager サービス アカウントに対する権限。
• gcloud CLI を使用してこのガイドの手順を完了する場合: Secret Manager 管理者ロール （roles/secretmanager.admin） Developer Connect サービス アカウントに対する
• コンソールを使用してこのガイドの手順を完了する場合: プロジェクト IAM 管理者 （roles/resourcemanager.projectIamAdmin） をユーザー アカウントに付与します。 Google Cloud

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

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

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

接続を作成する

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

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

コンソール

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

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

   Developer Connect に移動

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

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

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

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

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

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

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

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

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

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

4. [詳細を表示] をクリックすると、省略可能な構成設定が表示されます。

   1. 省略可: デフォルトでは、Developer Connect は GitHub Enterprise への Git 呼び出しのプロキシとして機能できます。 このオプションを無効にするには、[Developer Connect プロキシを有効にする] チェックボックスをオフにします。

   2. [**ネットワークの種類**] で [**パブリック インターネット**] を選択します。

      プライベート ネットワークを使用する場合は、 プライベート ネットワークでホストされている GitHub Enterprise リポジトリに接続するをご覧ください。

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

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

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

6. 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 \
       --github-enterprise-config-host-uri=HOST_URI
       --git-proxy-config-enabled
   

   次のように置き換えます。

   • CONNECTION_NAME: 接続の名前。
   • REGION：接続の リージョン。
   • HOST_URI：接続するホストの URI。
   • --git-proxy-config-enabled: Developer Connect が GitHub Enterprise への Git 呼び出しのプロキシとして機能できるようにする省略可能なフラグ。 この機能はプレビュー版です。

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 との情報の共有を停止するには、 コンソールまたは gcloud CLI で Developer Connect 接続を削除し、 GitHub でアクセス権を取り消します。 Google Cloud

次のステップ

• Gemini Code Assist のコード カスタマイズの設定を完了する。
• Gemini Code Assist がソフトウェア開発を加速する仕組みを確認する。
• Developer Connect で利用できる他の統合を確認する。