Verbindung zu GitHub Enterprise herstellen

Auf dieser Seite wird beschrieben, wie Sie Verbindungen zu GitHub Enterprise herstellen und Links zu GitHub Enterprise-Repositories erstellen. Sie können diese Aufgaben über die Google Cloud Console, oder die Google Cloud CLI ausführen.

Diese Anleitung richtet sich an Anwendungsentwickler, Plattformadministratoren und Sicherheitsmanager, die GitHub Enterprise-Quellcode-Repositories mit Google verwenden möchten. Insbesondere können Sie GitHub Enterprise-Repositories mit Gemini Code Assist verwenden.

Weitere Informationen zu Developer Connect finden Sie unter Developer Connect – Übersicht.

Hinweis

  1. Melden Sie sich in Ihrem Google-Konto an.

    Wenn Sie noch kein Konto haben, melden Sie sich hier für ein neues Konto an.

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

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

    8.

    Wenn Sie Developer Connect aktivieren, wird auch die Secret Manager API aktiviert.

  8. Achten Sie darauf, dass Sie Zugriff auf ein Konto bei GitHub Enterprise. haben.

    Um die Arbeit Ihres Teams zu schützen, empfehlen wir, die Aufgaben in dieser Anleitung mit einem Bot-Konto oder einem von Ihrem Team gemeinsam genutzten Konto auszuführen und nicht mit einem persönlichen Konto.

  9. Achten Sie darauf, dass Sie Inhaber eines GitHub Enterprise-Repositorys sind oder Administratorberechtigungen für ein freigegebenes Repository haben.

  10. Wenn Sie ein Repository in einer GitHub Enterprise-Organisation verwenden, achten Sie darauf, dass Sie die Berechtigungen eines GitHub App-Managers haben.

  11. Optional: Erstellen Sie einen vom Kunden verwalteten Verschlüsselungsschlüssel (Customer-Managed Encryption Key, CMEK) zum Verschlüsseln der Authentifizierungs-Secrets, die von Developer Connect erstellt werden.
  12. Optional: Wenn Sie die Befehlszeilenanleitung in dieser Anleitung verwenden möchten, führen Sie die folgenden Schritte aus:
    1. Installieren Sie die Google Cloud CLI. Wenn Sie die gcloud CLI bereits installiert haben, prüfen Sie, ob Sie die neueste verfügbare Version nutzen. Führen Sie dazu gcloud components update aus.
    2. Erstellen Sie ein Developer Connect-Dienstkonto mit dem folgenden Befehl. Dabei ist PROJECT_ID Ihre Google Cloud Projekt-ID: 
              gcloud beta services identity create \
            --service=developerconnect.googleapis.com \
            --project=PROJECT_ID

Erforderliche IAM-Berechtigungen gewähren

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Erstellen von Verbindungen und Links benötigen:

  • Wenn Sie nicht der Projektinhaber sind: Developer Connect-Administrator (roles/developerconnect.admin) für Ihr Nutzerkonto.
  • Wenn Sie einen CMEK verwenden möchten, um die von Developer Connect erstellten Secrets zu verschlüsseln: Cloud KMS CryptoKey-Verschlüsseler/Entschlüsseler (roles/cloudkms.cryptoKeyEncrypterDecrypter) für das Secret Manager-Dienstkonto.
  • Wenn Sie die gcloud CLI verwenden möchten, um die Schritte in dieser Anleitung auszuführen: Secret Manager-Administratorrolle (roles/secretmanager.admin) für das Developer Connect-Dienstkonto.
  • Wenn Sie die Google Cloud Console verwenden möchten, um die Schritte in dieser Anleitung auszuführen: Projekt-IAM-Administrator (roles/resourcemanager.projectIamAdmin) für Ihr Nutzerkonto.

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Verbindung herstellen

In diesem Abschnitt wird beschrieben, wie Sie eine Verbindung zwischen Developer Connect und GitHub Enterprise herstellen. Wenn Sie die Google Cloud Console verwenden, können Sie auch Links zu Repositories hinzufügen, sobald Sie die Einrichtung der Verbindung abgeschlossen haben.

Wählen Sie eine der folgenden Optionen aus, um eine neue GitHub Enterprise-Verbindung zu erstellen:

Console

Führen Sie die folgenden Schritte aus, um eine Verbindung herzustellen:

  1. Öffnen Sie in der Google Cloud Console Developer Connect.

    Zu Developer Connect

    In Developer Connect wird die Seite Git-Repositories angezeigt.

    • Wenn eine Liste von Quellcode-Verwaltungsanbietern angezeigt wird: Starten Sie die Konfiguration Ihrer ersten Verbindung, indem Sie einen Quellcode- Verwaltungsanbieter auswählen. Klicken Sie auf der GitHub Enterprise-Karte auf Verbinden.

    • Wenn eine Tabelle mit vorhandenen Verbindungen angezeigt wird: Legen Sie den Quellcode Verwaltungsanbieter fest, indem Sie auf Verbindung erstellen > GitHub Enterprise klicken.

      Die Seite Verbindung erstellen wird geöffnet.

  2. Wählen Sie unter Region eine Region für Ihre Verbindungsressourcen aus.

    1. Geben Sie unter Name einen Namen für die neue Verbindung ein.

  3. Aktivieren Sie das Kästchen Datenstandortkonforme Verbindung aktivieren , damit diese Verbindung den Anforderungen an den Datenstandort entspricht.

    GitHub-Verbindungen, die mit der Google Cloud Console erstellt wurden, entsprechen den Anforderungen an den Datenstandort, wenn Sie dieses Kästchen beim Erstellen der Verbindung aktivieren. In diesem Fall erstellt Developer Connect eine GitHub-Anwendung.

    Wenn Sie GitHub-Verbindungen mit der Google Cloud CLI erstellen, entsprechen diese Verbindungen nicht den Anforderungen an den Datenstandort. Alle anderen Verbindungstypen entsprechen den Anforderungen an den Datenstandort.

    1. Geben Sie unter Host-URL die URL des Hosts ein, mit dem Sie eine Verbindung herstellen möchten.

  4. Klicken Sie auf Weitere Optionen , um optionale Konfigurationseinstellungen aufzurufen.

    1. Optional: Standardmäßig kann Developer Connect als Proxy für Git-Aufrufe an GitHub Enterprise fungieren. Wenn Sie diese Option deaktivieren möchten, entfernen Sie das Häkchen aus dem Kästchen Developer Connect-Proxy aktivieren.

    2. Wählen Sie unter Netzwerktyp die Option Öffentliches Internet aus.

      Wenn Sie ein privates Netzwerk verwenden möchten, lesen Sie Verbindung zu GitHub Enterprise-Repositories herstellen, die in einem privaten Netzwerk gehostet werden.

    3. Optional: Wählen Sie im Abschnitt Verschlüsselung einen CMEK-Schlüssel aus, um Secret Manager-Secrets zu verschlüsseln, die von Developer Connect erstellt werden.

  5. Klicken Sie auf Weiter.

    Ein GitHub-Dialogfeld wird angezeigt, in dem Sie aufgefordert werden, eine GitHub-Anwendung zu erstellen.

  6. Folgen Sie der Anleitung in GitHub, um diese Aufgaben auszuführen:

    1. Geben Sie einen Namen für die Anwendung ein.

    2. Wählen Sie die Organisation aus, in der Sie die Anwendung installieren möchten.

    3. Wählen Sie die Repositories aus, für die Sie Zugriff gewähren möchten.

    Das Dialogfeld wird geschlossen.

    Developer Connect ruft Ihren privaten Schlüssel von GitHub ab und speichert ihn in Ihrem Google Cloud Projekt als Secret Manager Secret. Wenn Sie Ihre Secrets aufrufen möchten, listen Sie die Secrets in Secret Manager auf.

Sobald die Verbindung hergestellt ist, wird die Seite Repositories verknüpfen angezeigt.

Führen Sie die folgenden Schritte aus, um Repositories mit Ihrer Verbindung zu verknüpfen:

  1. Wählen Sie in der Liste der verfügbaren Repositories die Repositories aus, die Sie verwenden möchten.

  2. Klicken Sie auf OK.

  3. Klicken Sie auf Verknüpfen.

Ihre Verbindung wird der Seite Verbindungen und Ihre Repository Links der Seite Repositories in der Google Cloud Console hinzugefügt. Sie können jederzeit weitere Links zu vorhandenen Verbindungen hinzufügen.

Wenn Sie Gemini Code Assist einrichten, fahren Sie mit dem Prozess fort indem Sie die Schritte unter Codeanpassung für Gemini Code Assist konfigurieren und verwendenbefolgen.

gcloud

Für die folgenden Aufgaben sind einige Aktionen in Ihrem Webbrowser erforderlich.

Führen Sie die folgenden Schritte aus, um eine Verbindung herzustellen:

  1. Führen Sie den gcloud developer-connect connections create Befehl aus, um eine Verbindung zu GitHub Enterprise herzustellen:

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

    Ersetzen Sie Folgendes:

    • CONNECTION_NAME: der Name für Ihre Verbindung.
    • REGION: die Region für Ihre Verbindung.
    • HOST_URI: der URI für den Host, mit dem Sie eine Verbindung herstellen möchten.
    • --git-proxy-config-enabled: ein optionales Flag, mit dem Developer Connect als Proxy für Git-Aufrufe an GitHub Enterprise fungieren kann. Diese Funktion befindet sich in der Vorschau.

  2. Sie müssen eine GitHub-Anwendung erstellen, um Verbindungen mit GitHub zu verwalten. Führen Sie den folgenden Befehl aus, um den URI für die App-Einrichtung abzurufen:

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

    Ersetzen Sie Folgendes:

    • CONNECTION_NAME: der Name für Ihre Verbindung.
    • REGION: die Region für Ihre Verbindung.

    Developer Connect gibt einen Link zurück, über den Sie die nächsten Schritte in einem Browserfenster ausführen können. Kopieren Sie den Link.

  3. Öffnen Sie den Link in einem Webbrowser.

  4. Melden Sie sich bei Aufforderung in Ihrem GitHub-Konto an.

  5. Folgen Sie der Anleitung in GitHub, um diese Aufgaben auszuführen:

    1. Geben Sie einen Namen für die Anwendung ein.

    2. Wählen Sie die Organisation aus, in der Sie die Anwendung installieren möchten.

    3. Wählen Sie die Repositories aus, für die Sie Zugriff gewähren möchten.

    Das Dialogfeld wird geschlossen.

    Developer Connect ruft Ihren privaten Schlüssel von GitHub ab und speichert ihn in Ihrem Google Cloud Projekt als Secret Manager Secret. Wenn Sie Ihre Secrets aufrufen möchten, listen Sie die Secrets in Secret Manager auf.

Verbindung prüfen

Prüfen Sie die Erstellung Ihrer GitHub-Verbindung mit dem folgenden Befehl:

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

Wobei:

  • CONNECTION_NAME: der Name Ihrer Verbindung.
  • REGION: die Region für Ihre Verbindung.

Developer Connect gibt im Feld installationState einen Status zurück. Wenn der Wert dieses Felds COMPLETE ist, ist die App-Installation abgeschlossen. Andernfalls gibt Developer Connect einen URI zurück, über den Sie zur Konfiguration im Browser zurückkehren können.

Sobald die Verbindung hergestellt ist, wählen Sie aus, welche Repositories verknüpft werden sollen, folgen Sie dazu der Anleitung unter Mit Repositories verknüpfen.

Sobald Sie eine Verbindung zu GitHub Enterprise hergestellt haben, können Sie Links zu Repositories erstellen. Sie können diese Schritte später wiederholen, um bei Bedarf weitere Repositories zu verknüpfen.

Wählen Sie eine der folgenden Optionen aus, um Repository-Links für eine vorhandene GitHub Enterprise-Verbindung zu erstellen:

Console

  1. Öffnen Sie in der Google Cloud console die Seite Repositories.

    Seite „Repositories“ öffnen

  2. Klicken Sie auf Repository verknüpfen.

    Der Bereich Git-Repositories verknüpfen wird geöffnet.

  3. Wählen Sie in der Liste der Verbindungen eine Verbindung aus.

  4. Klicken Sie auf Weiter.

  5. Wählen Sie in der Liste der Repositories die Repositories aus, mit denen Sie eine Verknüpfung herstellen möchten.

  6. Klicken Sie auf Erstellen.

Developer Connect erstellt die Repository-Links und zeigt sie in der Google Cloud Console an.

gcloud

Führen Sie dazu diesen Befehl aus:

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

Ersetzen Sie Folgendes:

  • REPO_NAME: ein Name für Ihren Repository-Link.
  • REPO_URI: der Link zu Ihrem Repository. Beispiel: https://github.com/cloud-build/test-repo.git.
  • CONNECTION_NAME: der Name Ihrer Verbindung.
  • REGION: die Region für Ihre Verbindung.

Developer Connect erstellt die Repository-Links.

Führen Sie den developer-connect connections git-repository-links list Befehl aus, um verknüpfte Repositories aufzulisten.

Wenn Sie Gemini Code Assist einrichten, fahren Sie mit dem Prozess fort indem Sie die Schritte unter Codeanpassung für Gemini Code Assist konfigurieren und verwendenbefolgen.

Datenfreigabe

Inhalte von Google Cloud Ressourcen, die mit dieser Verbindung verknüpft sind, werden möglicherweise an GitHub übertragen. Diese Aussage gilt für alle vorhandenen und zukünftigen Ressourcen, die diese Verbindung nutzen. Wenn Sie keine Informationen mehr mit GitHub teilen möchten, löschen Sie Developer Connect-Verbindungen in der Google Cloud Console oder der gcloud CLI und widerrufen Sie den Zugriff in GitHub.

Nächste Schritte