Connect to GitHub Enterprise repositories hosted in a private network

This page describes how to connect to GitHub Enterprise repositories hosted in a private network by using Developer Connect and Service Directory. You can complete these tasks using the Google Cloud console, or the Google Cloud CLI.

These instructions are for application developers, platform administrators, and security managers who want to use GitHub Enterprise source code repositories with Google. Specifically, you can use GitHub Enterprise repositories with Gemini Code Assist.

To learn more about Developer Connect, see Developer Connect overview.

Before you begin

1. Sign in to your Google Account.

   If you don't already have one, sign up for a new account.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   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

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Developer Connect and Service Directory APIs.

   Enable the APIs

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   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

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Developer Connect and Service Directory APIs.

   Enable the APIs

Enabling Developer Connect also enables the Secret Manager API.

8. Ensure that you have access to an account on GitHub Enterprise.

   To help keep your team's work secure, we recommend that you complete the tasks in this guide using a bot account or an account shared by your team, not a personal account.

9. Ensure that you own a GitHub Enterprise repository, or have admin-level permissions on a shared repository.

10. When using a repository in a GitHub Enterprise organization, ensure that you have GitHub App Manager permissions.

11. Ensure that you have a Service Directory service resource for connecting to private networks, or create a Service Directory service resource. You can create the Service Directory service resource in the same project that you're using with Developer Connect, or you can use a different project.
    

    For connections to networks outside of Google Cloud, you might need to configure Service Directory differently. See Use Service Directory to reach hosts outside Google Cloud.

12. Optional: Create a customer-managed encryption key (CMEK) for encrypting the authentication secrets that Developer Connect creates.
13. Optional: To use the command-line instructions in this guide, complete the following steps:
    1. Install the Google Cloud CLI. If you've installed gcloud CLI previously, make sure you have the latest available version by running gcloud components update.
    2. Create a Developer Connect service account by running the following command, where PROJECT_ID is your Google Cloud project ID:

               gcloud beta services identity create \
                   --service=developerconnect.googleapis.com \
                   --project=PROJECT_ID
               

Grant the required IAM permissions

To get the permissions that you need to create connections and links, ask your administrator to grant you the following IAM roles:

• If you aren't the project owner: Developer Connect Admin (roles/developerconnect.admin) on your user account
• If you plan to use a CMEK to encrypt the secrets that Developer Connect creates: Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter) on the Secret Manager Service Account
• If you plan to allow Developer Connect to act as a proxy for running Git calls: Developer Connect Git Proxy Reader (developerconnect.gitProxyReader) and Developer Connect Git Proxy User (developerconnect.gitProxyUser) on the account you use to make Git calls. This feature is required for Gemini Code Assist code customization.
• If you plan to use the gcloud CLI steps in this guide: Secret Manager Admin role (roles/secretmanager.admin) on the Developer Connect Service Account

For more information about granting roles, see Manage access to projects, folders, and organizations.

You might also be able to get the required permissions through custom roles or other predefined roles.

Grant permissions to use Service Directory

Complete the following steps to let Developer Connect use Service Directory, and to let Service Directory access your VPC network resource.

1. Grant permissions for the Developer Connect service account to use Service Directory by running the following commands:

   PROJECT_NUMBER=$(gcloud projects describe PROJECT_ID --format="value(projectNumber)")
   
   SERVICE_ACCOUNT="service-${PROJECT_NUMBER}@gcp-sa-developerconnect.iam.gserviceaccount.com"
   
   gcloud projects add-iam-policy-binding SERVICE_DIRECTORY_RESOURCE_PROJECT_ID \
       --member="serviceAccount:${SERVICE_ACCOUNT}" \
       --role="roles/servicedirectory.viewer"
   

   Replace the following:

   • PROJECT_ID: your Google Cloud project ID.
   • SERVICE_DIRECTORY_RESOURCE_PROJECT_ID: the project ID for the Google Cloud project that contains your Service Directory service resource.

2. Grant permissions for Service Directory to access your VPC network resource. The network resource can be in a different project.

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

   Replace NETWORK_RESOURCE_PROJECT_ID with the project ID for the project that contains your VPC network resource.

Use Service Directory to reach hosts outside Google Cloud

Service Directory uses the IP address range 35.199.192.0/19 to connect your host outside of Google Cloud. You must add this range to an allowlist in your firewall. Additionally, your private network needs to be configured to route this range through the Cloud VPN or Cloud Interconnect connection.

If your connection uses a Cloud Router, you can configure your connection to communicate the range to your private network.

To learn more, see Configure private network access.

Use Cloud Load Balancing to reach hosts outside Google Cloud

If your network configuration does not allow you to route the Service Directory IP address range 35.199.192.0/19 to the Cloud VPN or Cloud Interconnect, you can create a load balancer using Cloud Load Balancing that directs traffic to your host.

When you create the Service Directory endpoint, make sure to use the IP address of the forwarding rule of the load balancer instead of the IP address of your host. You can use an internal HTTPS load balancer or an internal transmission control protocol (TCP) load balancer when creating your endpoint.

When creating your TCP load balancer, consider the following:

• Only a hybrid connectivity network endpoint group (NEG) is required to reach your host.
• The TCP load balancer does not require the unencrypted private key for your SSL certificate.
• Your Cloud VPN setup needs to use Cloud Router with global dynamic routing. If your Cloud VPN uses static routing, you can use a proxy that uses Cloud Service Mesh instead. To learn more, see Set up network edge services for hybrid deployments.

To learn more about creating an HTTPS load balancer, see Set up an internal Application Load Balancer with hybrid connectivity. To learn more about creating a TCP load balancer, see Set up a regional internal proxy Network Load Balancer with hybrid connectivity.

Create a connection

This section describes how to create a connection between Developer Connect and GitHub Enterprise. If you're using the Google Cloud console, then you can also start adding links to repositories as you finish setting up your connection.

To create a new GitHub Enterprise connection, select one of the following options:

Console

Initiate a connection by completing the following steps:

1. In the Google Cloud console, open Developer Connect.

   Go to Developer Connect

   Developer Connect displays the Git repositories page.

   • If you see a list of source code management providers: Start configuring your first connection by selecting a source code management provider. Click Connect on the GitHub Enterprise card.

   • If you see a table listing existing connections: Set the source code management provider by clicking Create connection > GitHub Enterprise.

     The Create Connection page opens.

2. In the Configure details pane, specify the following:

   1. For Region, choose a region for your connection resources.

   2. For Name, enter a name for your new connection.

   3. For Host URL, enter the URL of the host you want to connect to.

   4. Optional: To let Developer Connect act as a proxy for Git calls to GitHub Enterprise, select Enable git proxy (Preview). This feature is required when running Gemini Code Assist code customization on GitHub Enterprise source code repositories hosted in private networks.

   5. In the Networking section, for Network type, choose Private network.

   6. For CA Certificate, click Browse to upload your self-signed certificate.

      Your certificate must not exceed 10 KB in size and should be in PEM format (.pem, .cer, or .crt). If this section is left blank, a default set of certificates will be used in place.

   7. In the Service Directory service section, select the location of your service:

      • In project your-project
      • In another project
      • Enter manually

      If you select In another project or Enter manually, specify your Google Cloud project ID. Select the project in the drop-down menu, or enter the project ID manually.

   8. Region: Select the region of your Service Directory service. The region specified for your service must match the region associated with your connection.

   9. Namespace: Select the namespace of your Service Directory service.

   10. Service: Select the Service Directory service name in your namespace.

3. Optional: In the Encryption section, select a CMEK key to encrypt Secret Manager secrets that Developer Connect creates.

4. Click Continue.

   A GitHub dialog appears, inviting you to create a GitHub app.

5. Following the prompts in GitHub, complete these tasks:

   1. Input a name for your app.

   2. Choose the organization where you want to install the app.

   3. Select the repositories you want to grant access to.

   The dialog closes.

   Developer Connect fetches your private key from GitHub and stores it in your Google Cloud project as a Secret Manager secret. To view your secrets, list secrets in Secret Manager.

Once the connection is created, the Link repositories page appears.

Complete the following steps to link repositories to your connection:

1. In the list of available repositories, select the repositories you want to use.

2. Click OK.

   Developer Connect displays suggested names for your repository resources.

3. Select a repository resource naming option:

   • Generated: Use the generated repository resource names.
   • Manual: Input names of your own.

4. Click Link.

Your connection is added to the Connections page and your repository links are added to the Repositories page in the Google Cloud console. You can add more links to existing connections at any time.

If you're setting up Gemini Code Assist, continue the process by following the steps in Configure and use Gemini Code Assist code customization.

gcloud

The following tasks require some actions in your web browser.

1. Run the gcloud developer-connect connections create command to create a connection to 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
   

   Replace the following:

   • CONNECTION_NAME: the name for your connection.
   • REGION: the region for your connection.
   • HOST_URI: the URI for the host you want to connect to.
   • SERVICE_DIRECTORY_RESOURCE: your Service Directory resource path, in the format projects/PROJECT_ID/locations/REGION/namespaces/NAMESPACE/services/SERVICE.
   • --git-proxy-config-enabled is an optional flag that allows Developer Connect to as a proxy for Git calls to GitHub Enterprise. You must enable this feature when running Gemini Code Assist code customization on GitHub Enterprise source code repositories hosted in private networks. This capability is in Preview.
   • --github-enterprise-config-ssl-ca-certificate is an optional flag to add an SSL certificate, in the format $HOME/my-ssl-ca.txt.

2. You must create a GitHub app to manage connections with GitHub. Run the following command to get URI for app setup:

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

   Replace the following:

   • CONNECTION_NAME: the name for your connection.
   • REGION: the region for your connection.

   Developer Connect returns a link to complete the next steps in a browser window. Copy this link.

3. Open the link in a web browser.

4. Sign in to your GitHub account if prompted to do so.

5. Following the prompts in GitHub, complete these tasks:

   1. Input a name for your app.

   2. Choose the organization where you want to install the app.

   3. Select the repositories you want to grant access to.

   The dialog closes.

   Developer Connect fetches your private key from GitHub and stores it in your Google Cloud project as a Secret Manager secret. To view your secrets, list secrets in Secret Manager.

Verify the connection

Verify the creation of your GitHub connection by running the following command:

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

Where:

• CONNECTION_NAME: the name of your connection.
• REGION: the region for your connection.

Developer Connect returns a status in the installationState field. If the value of this field is COMPLETE, your app installation is done. Otherwise, Developer Connect returns a URI to return you to configuration in the browser.

Once your connection is completed, choose which repositories to link by following the instructions in Link to repositories.

Add repository links to existing connections

Once you have established a connection to GitHub Enterprise, you can link to repositories. You can repeat these steps later to link additional repositories as needed.

To create repository links on an existing GitHub Enterprise connection, select one of the following options:

Console

1. Open the Repositories page in the Google Cloud console.

   Open the Repositories page

2. Click Link repository.

   The Link Git repositories pane opens.

3. In the connections list, choose a connection.

4. Click Continue.

5. In the repositories list, select the repositories you want to link to.

   Developer Connect displays suggested names for your repository resources.

6. Select a repository resource naming option:

   • Generated: Use the generated repository resource names.
   • Manual: Input names of your own.

7. Click Create.

Developer Connect creates the repository links and displays them in the Google Cloud console.

gcloud

Run the following command:

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

Replace the following:

• REPO_NAME: a name for your repository link.
• REPO_URI: the link to your repository. For example, https://github.com/cloud-build/test-repo.git.
• CONNECTION_NAME: the name of your connection.
• REGION: the region for your connection.

Developer Connect creates the repository links.

To list linked repositories, run the developer-connect connections git-repository-links list command.

If you're setting up Gemini Code Assist, continue the process by following the steps in Configure and use Gemini Code Assist code customization.

Data sharing

Content from Google Cloud resources linked to this connection might be transferred to GitHub. This statement applies to all existing and future resources utilizing this connection. To stop sharing information with GitHub, delete Developer Connect connections in the Google Cloud console or gcloud CLI, and revoke access in GitHub.

What's next

• Finish setting up Gemini Code Assist code customization.
• Learn how Gemini Code Assist helps you accelerate software development.
• Explore other integrations available through Developer Connect.