Diese Anleitung richtet sich an Anwendungsentwickler, Plattformadministratoren und Sicherheitsmanager, die Quellcode-Repositories von GitHub Enterprise Cloud mit Google verwenden möchten. Insbesondere können Sie GitHub Enterprise Cloud-Repositories mit Gemini Code Assist verwenden.
Weitere Informationen zu Developer Connect finden Sie in der Übersicht über Developer Connect.
Hinweis
-
Melden Sie sich in Ihrem Google-Konto an.
Wenn Sie noch kein Konto haben, melden Sie sich hier für ein neues Konto an.
-
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 theresourcemanager.projects.createpermission. Learn how to grant roles.
-
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 theserviceusage.services.enablepermission. Learn how to grant roles.-
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 theresourcemanager.projects.createpermission. Learn how to grant roles.
-
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 theserviceusage.services.enablepermission. Learn how to grant roles.-
Sie benötigen Zugriff auf ein Konto in GitHub Enterprise Cloud.
Damit die Arbeit Ihres Teams sicher bleibt, empfehlen wir, die Aufgaben in dieser Anleitung mit einem Bot-Konto oder einem von Ihrem Team gemeinsam genutzten Konto und nicht mit einem persönlichen Konto auszuführen.
- Sie müssen Inhaber eines GitHub Enterprise Cloud-Repositorys sein oder Berechtigungen auf Administratorebene für ein freigegebenes Repository haben.
- 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.
- Optional: Wenn Sie die Befehlszeilenanleitung in diesem Leitfaden verwenden möchten, führen Sie die folgenden Schritte aus:
- Installieren Sie die Google Cloud CLI. Wenn Sie die gcloud CLI bereits installiert haben, prüfen Sie, ob Sie die neueste verfügbare Version haben. Führen Sie dazu den Befehl
gcloud components updateaus. - Erstellen Sie ein Developer Connect-Dienstkonto, indem Sie den folgenden Befehl ausführen. Dabei ist PROJECT_ID Ihre Google Cloud Projekt-ID:
gcloud beta services identity create \ --service=developerconnect.googleapis.com \ --project=PROJECT_ID
- Installieren Sie die Google Cloud CLI. Wenn Sie die gcloud CLI bereits installiert haben, prüfen Sie, ob Sie die neueste verfügbare Version haben. Führen Sie dazu den Befehl
Wenn Sie Developer Connect aktivieren, wird auch die Secret Manager API aktiviert.
Erforderliche Rollen
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 zum Verschlüsseln der von Developer Connect erstellten Secrets verwenden möchten:
Cloud KMS CryptoKey Encrypter/Decrypter (
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:
Rolle „Secret Manager-Administrator“ (
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, benötigen Sie die IAM-Rolle Project IAM Admin (
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 Cloud herstellen. Wenn Sie die Google Cloud -Konsole verwenden, können Sie auch Links zu Repositories hinzufügen, sobald Sie die Einrichtung Ihrer Verbindung abgeschlossen haben.
Wählen Sie eine der folgenden Optionen aus, um eine neue GitHub Enterprise Cloud-Verbindung zu erstellen:
Console
So stellen Sie eine Verbindung her:
Öffnen Sie in der Google Cloud Console Developer Connect.
In Developer Connect wird die Seite Git-Repositories angezeigt.
- Wenn Sie eine Liste von Anbietern für die Quellcodeverwaltung sehen:Konfigurieren Sie Ihre erste Verbindung, indem Sie einen Anbieter für die Quellcodeverwaltung auswählen. Klicken Sie auf der Karte für GitHub Enterprise Cloud auf Verbinden.
Wenn Sie eine Tabelle mit vorhandenen Verbindungen sehen: Legen Sie den Anbieter für die Quellcodeverwaltung fest, indem Sie auf Verbindung erstellen > GitHub Enterprise Cloud klicken.
Die Seite Verbindung erstellen wird geöffnet.
Wählen Sie unter Region eine Region für Ihre Verbindungsressourcen aus.
- Geben Sie unter Name einen Namen für die neue Verbindung ein.
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 dem Datenstandort, wenn Sie dieses Kästchen beim Erstellen der Verbindung aktivieren. Wenn Sie dies tun, erstellt Developer Connect eine GitHub-App.
Wenn Sie GitHub-Verbindungen mit der Google Cloud CLI erstellen, sind diese Verbindungen nicht datenstandortkonform. Alle anderen Verbindungstypen entsprechen den Anforderungen an den Datenstandort.
Klicken Sie auf Mehr anzeigen, um optionale Konfigurationseinstellungen aufzurufen.
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.
Optional: Standardmäßig kann Developer Connect als Proxy für Git-Aufrufe an GitHub Enterprise Cloud fungieren. Wenn Sie diese Option deaktivieren möchten, entfernen Sie das Häkchen aus dem Kästchen Developer Connect-Proxy aktivieren.
Klicken Sie auf Weiter.
Klicken Sie auf Ich stimme zu und fahre fort, um zuzustimmen, dass Ihr GitHub-OAuth-Token für Developer Connect freigegeben und in Secret Manager gespeichert wird.
Melden Sie sich bei GitHub an, wenn Sie dazu aufgefordert werden.
Klicken Sie auf Developer Connect autorisieren, um der Google Developer Connect-App Zugriff auf Ihr GitHub-Konto zu gewähren.
Wenn diese Aufforderung nicht angezeigt wird, wurde die Autorisierung für dieses Konto bereits erteilt.
Wenn Sie Datenstandortkonforme Verbindung aktivieren ausgewählt haben, werden Sie aufgefordert, eine GitHub-App zu erstellen.
Geben Sie einen Namen für diese GitHub-App an.
Klicken Sie auf GitHub-App erstellen.
Wählen Sie das Ziel aus, auf dem Sie die App installieren möchten (Ihr GitHub-Konto oder eine Organisation).
Wählen Sie die Repositories aus, für die die GitHub-App installiert werden soll, oder Alle Repositories und klicken Sie auf Installieren.
Wählen Sie die Repositories aus, die für diese Verbindung verknüpft werden sollen, und klicken Sie auf Ok.
Klicken Sie auf Verknüpfen.
GitHub erstellt ein Token und Developer Connect speichert es in IhremGoogle Cloud -Projekt als Secret Manager-Secret. Weitere Informationen zum Verwalten von Secrets finden Sie unter Secret-Details ansehen.
Wenn Sie den Datenstandort aktiviert haben, haben Sie jetzt eine GitHub-App, die Sie verwalten können, indem Sie auf der Seite Verbindungsdetails auf Installation verwalten klicken.
Verbindung konfigurieren
Die folgenden Schritte sind erforderlich, wenn Sie das Kästchen Enable a data residency compliant connection (Eine datenresidenzkonforme Verbindung aktivieren) nicht angeklickt haben.
Erteilen Sie Berechtigungen für Ihr GitHub-Konto und verknüpfen Sie es mit Repositories. Folgen Sie dazu der Anleitung unten. Die Aufforderungen, die in Ihrem Webbrowser angezeigt werden, hängen davon ab, ob die Developer Connect-GitHub-App bereits im GitHub-Konto installiert ist.
Führen Sie im Dialogfeld „Developer Connect“ die folgenden Schritte aus:
Wenn Sie eine Liste von GitHub-Konten sehen, installieren Sie die App und verknüpfen Sie die Repositorys so:
Wählen Sie das GitHub-Konto aus, das Sie verwenden möchten.
Wählen Sie ein oder mehrere Repositorys aus, auf die Sie Zugriff gewähren möchten.
Wenn Sie aufgefordert werden, eine vorhandene App-Installation wiederzuverwenden, wählen Sie aus, wo die App konfiguriert werden soll, indem Sie diese Schritte ausführen:
Klicken Sie auf GitHub-Konto, um Konten mit installierter Google Developer Connect-App aufzurufen. Wenn das gewünschte Konto angezeigt wird, wählen Sie es aus, indem Sie auf Bestätigen klicken.
Wenn Sie das gewünschte Konto nicht sehen, gehen Sie so vor:
Wählen Sie GitHub-Anwendung in anderem GitHub-Konto installieren aus und klicken Sie auf Bestätigen.
Folgen Sie der GitHub-Anleitung, um die Installation der App zuzulassen.
Wählen Sie ein oder mehrere Repositorys aus, auf die Sie Zugriff gewähren möchten.
Wenn das Dialogfeld geschlossen wird, ist die App-Installation abgeschlossen.
Nachdem die Verbindung erstellt wurde, wird die Seite Repositories verknüpfen angezeigt.
Führen Sie die folgenden Schritte aus, um Repositories mit Ihrer Verbindung zu verknüpfen:
Wählen Sie in der Liste der verfügbaren Repositories die Repositories aus, die Sie verwenden möchten.
Klicken Sie auf OK.
Klicken Sie auf Verknüpfen.
Ihre Verbindung wird der Seite Verbindungen hinzugefügt und Ihre Repository-Links werden der Seite Repositories in der Google Cloud Console hinzugefügt. Sie können bestehenden Verbindungen jederzeit weitere Links hinzufügen.
gcloud
Für die folgenden Aufgaben sind einige Aktionen in Ihrem Webbrowser erforderlich.
So stellen Sie eine Verbindung her:
Führen Sie den Befehl
gcloud developer-connect connections createaus, um eine Verbindung zu GitHub Enterprise Cloud herzustellen.Wenn Sie den Datenstandort aktiviert haben:
gcloud developer-connect connections create CONNECTION_NAME \ --location=REGION \ --github-enterprise-config-app=DEVELOPER-CONNECT \ --github-enterprise-config-host-uri=HOST_URI --git-proxy-config-enabledWenn der Datenstandort nicht aktiviert ist:
gcloud developer-connect connections create CONNECTION_NAME \ --location=REGION \ --github-config-app=DEVELOPER-CONNECT \ --github-config-host-uri=HOST_URI --git-proxy-config-enabledErsetzen Sie Folgendes:
- CONNECTION_NAME: ein Name für Ihre Verbindung.
- REGION: die Region für Ihre Verbindung.
- HOST_URI: Der URI des Hosts, mit dem Sie eine Verbindung herstellen möchten. Wenn Sie den Datenstandort aktiviert haben, wird eine Domain verwendet, die Ihre Subdomain enthält (
YOUR_SUBDOMAIN.ghe.com). Wenn Sie keinen Datenstandort aktiviert haben, wirdgithub.comverwendet. --git-proxy-config-enabled: Ein optionales Flag, mit dem Developer Connect als Proxy für Git-Aufrufe an GitHub Enterprise Cloud fungieren kann. Diese Funktion befindet sich in der Vorschau.
Es wird ein Verbindungsname erstellt.
Schließen Sie die Erstellung der Verbindung ab, indem Sie die Developer Connect-GitHub-App installieren. Führen Sie den folgenden Befehl aus, um den URI für die App-Installation abzurufen:
gcloud developer-connect connections describe CONNECTION_NAME \ --location=REGIONErsetzen Sie Folgendes:
- CONNECTION_NAME: der Name Ihrer Verbindung.
- REGION: die Region Ihrer Verbindung.
Developer Connect gibt einen Link zurück, über den die Google Developer Connect App in einem Browserfenster installiert werden kann. Kopieren Sie den Link.
Öffnen Sie den Link in einem Webbrowser.
Klicken Sie auf Ich stimme zu und fahre fort, um zuzustimmen, dass Ihr GitHub-OAuth-Token für Developer Connect freigegeben und in Secret Manager gespeichert wird.
Melden Sie sich bei GitHub an, wenn Sie dazu aufgefordert werden.
Klicken Sie auf Developer Connect autorisieren, um der Google Developer Connect-App Zugriff auf Ihr GitHub-Konto zu gewähren. Wenn Sie diese Aufforderung nicht sehen, wurde die Autorisierung für dieses Konto bereits erteilt.
GitHub erstellt ein Token und Developer Connect speichert es in IhremGoogle Cloud -Projekt als Secret Manager-Secret. Secrets im Secret Manager auflisten Sie können den Zugriff auf Developer Connect über GitHub jederzeit widerrufen.
Verbindung konfigurieren
Erteilen Sie Berechtigungen für Ihr GitHub-Konto und verknüpfen Sie es mit Repositories. Folgen Sie dazu der Anleitung unten. Die Aufforderungen, die in Ihrem Webbrowser angezeigt werden, hängen davon ab, ob die Developer Connect-GitHub-App bereits im GitHub-Konto installiert ist.
Führen Sie im Dialogfeld „Developer Connect“ die folgenden Schritte aus:
Wenn Sie eine Liste von GitHub-Konten sehen, installieren Sie die App und verknüpfen Sie die Repositorys so:
Wählen Sie das GitHub-Konto aus, das Sie verwenden möchten.
Wählen Sie ein oder mehrere Repositorys aus, auf die Sie Zugriff gewähren möchten.
Wenn Sie aufgefordert werden, eine vorhandene App-Installation wiederzuverwenden, wählen Sie aus, wo die App konfiguriert werden soll, indem Sie diese Schritte ausführen:
Klicken Sie auf GitHub-Konto, um Konten mit installierter Google Developer Connect-App aufzurufen. Wenn das gewünschte Konto angezeigt wird, wählen Sie es aus, indem Sie auf Bestätigen klicken.
Wenn Sie das gewünschte Konto nicht sehen, gehen Sie so vor:
Wählen Sie GitHub-Anwendung in anderem GitHub-Konto installieren aus und klicken Sie auf Bestätigen.
Folgen Sie der GitHub-Anleitung, um die Installation der App zuzulassen.
Wählen Sie ein oder mehrere Repositorys aus, auf die Sie Zugriff gewähren möchten.
Wenn das Dialogfeld geschlossen wird, ist die App-Installation abgeschlossen.
Verbindung prüfen
Prüfen Sie, ob die GitHub Enterprise Cloud-Verbindung erstellt wurde, indem Sie den folgenden Befehl ausführen:
gcloud developer-connect connections describe CONNECTION_NAME \
--location=REGION
Ersetzen Sie Folgendes:
- CONNECTION_NAME: der Name Ihrer Verbindung.
- REGION: die Region für Ihre Verbindung.
Developer Connect gibt einen Status im Feld installationState zurück. Wenn der Wert dieses Felds COMPLETE ist, ist die Installation Ihrer App abgeschlossen.
Andernfalls gibt Developer Connect einen URI zurück, über den Sie zur Konfiguration im Browser zurückkehren können.
Wenn die Verbindung hergestellt ist, wählen Sie die Repositories aus, die Sie verknüpfen möchten. Folgen Sie dazu der Anleitung unter Repository-Links zu bestehenden Verbindungen hinzufügen.
Repository-Links zu vorhandenen Verbindungen hinzufügen
Sobald Sie eine Verbindung zu GitHub Enterprise Cloud hergestellt haben, können Sie eine Verknüpfung zu Repositories herstellen. Sie können diese Schritte später wiederholen, um bei Bedarf weitere Repositories zu verknüpfen.
Wenn Sie Repository-Links für eine vorhandene GitHub Enterprise Cloud-Verbindung erstellen möchten, wählen Sie eine der folgenden Optionen aus:
Console
Öffnen Sie in der Google Cloud Console die Seite Repositories.
Klicken Sie auf Repository verknüpfen.
Der Bereich Git-Repositories verknüpfen wird geöffnet.
Wählen Sie in der Liste der Verbindungen eine Verbindung aus.
Klicken Sie auf Weiter.
Wählen Sie in der Repository-Liste die Repositories aus, mit denen Sie eine Verknüpfung herstellen möchten.
Klicken Sie auf Erstellen.
Developer Connect erstellt die Repository-Links und zeigt sie in der Google Cloud Konsole 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: der Name Ihres Repositorys.
- REPO_URI: Der Link zu Ihrem GitHub Enterprise Cloud-Repository.
Beispiel:
https://github.com/cloud-build/test-repo.git. - CONNECTION_NAME: der Name Ihrer Verbindung.
- REGION: die Region für Ihre Verbindung.
Die Repository-Links werden von Developer Connect erstellt.
Führen Sie den Befehl developer-connect connections git-repository-links list aus, um verknüpfte Repositories aufzulisten.
Wenn Sie Gemini Code Assist einrichten, fahren Sie mit den Schritten unter Codeanpassung für Gemini Code Assist konfigurieren und verwenden fort.
Zulassungslisten für IP-Adressen konfigurieren
Developer Connect ist mit GitHub Enterprise Cloud-Organisationen kompatibel, die IP-Zulassungslisten verwenden, um den Zugriff auf ihre Ressourcen einzuschränken. Führen Sie die folgenden Schritte aus, um die Zulassungsliste für GitHub Enterprise Cloud für die Verwendung mit Developer Connect zu konfigurieren.
Verwenden Sie das Konto des Organisationsinhabers von GitHub Enterprise Cloud, um diese Aufgaben auszuführen.
Melden Sie sich bei GitHub Enterprise Cloud an.
Folgen Sie der Anleitung in der GitHub Enterprise Cloud-Dokumentation, um Zugriff durch GitHub-Apps zuzulassen.
GitHub Enterprise Cloud fügt die Adressen der Developer Connect-GitHub-App Ihrer Zulassungsliste hinzu.
Sie können die Developer Connect-Adressen anhand ihrer Beschreibungen erkennen, die dem folgenden Text ähneln:
managed by the Developer Connect GitHub app.Nachdem die Developer Connect-GitHub-App auf Ihre GitHub Enterprise Cloud-Ressourcen zugreifen kann, konfigurieren Sie Ihre Zulassungsliste so, dass für OAuth-basierte Interaktionen zwischen Developer Connect und GitHub Enterprise Cloud dieselben IP-Adressen verwendet werden. So kann Developer Connect Links zu Ihren Git-Repositories erstellen.
Kopieren Sie alle IP-Adressen der Developer Connect GitHub-App.
Folgen Sie der Anleitung in der GitHub Enterprise Cloud-Dokumentation, um jede Adresse als neuen Eintrag auf die Zulassungsliste zu setzen.
Wenn Sie fertig sind, haben Sie zwei Einträge auf der Zulassungsliste für jede IP-Adresse, die von Developer Connect für die Kommunikation mit GitHub Enterprise Cloud verwendet wird.
Die OAuth-Einträge werden nur zum Erstellen von Links zu Repositories verwendet. Sie können die OAuth-Einträge aus Ihrer Zulassungsliste löschen, wenn Sie die Verknüpfungen zu GitHub Enterprise Cloud-Repositories erstellt haben.
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 die Developer Connect-Verbindungen in der Google Cloud Console oder der gcloud CLI und widerrufen Sie den Zugriff in GitHub.
Nächste Schritte
- Codeanpassung für Gemini Code Assist einrichten
- Informationen dazu, wie Gemini Code Assist Sie bei der Softwareentwicklung unterstützen kann
- Weitere Integrationen ansehen, die über Developer Connect verfügbar sind.