Cloud APIs und Bibliotheken in Cloud Code for IntelliJ verwalten

Mithilfe von Cloud APIs können Sie direkt aus Ihrem Code auf Google Cloud-Produkte und -Dienste zugreifen. Diese Cloud APIs bieten eine einfache JSON-REST-Schnittstelle, die Sie über Clientbibliotheken aufrufen können.

In diesem Dokument wird beschrieben, wie Sie Cloud APIs aktivieren und Cloud-Clientbibliotheken zu Ihrem Projekt hinzufügen.

Hinweis: Bei Projekten, die nicht sowohl Java als auch Maven verwenden, fügt Cloud Code die Cloud-Clientbibliotheken nicht automatisch Ihrem Build hinzu. Es unterstützt jedoch die anderen hier beschriebenen Features und stellt Build-Snippets für Ihr Build-System bereit.

Nach Cloud APIs suchen

Hinweis: Die Liste der APIs und Bibliotheken von Cloud Code deckt die meisten, aber nicht alle APIs ab.

So entdecken Sie alle verfügbaren Google Cloud APIs in Ihrer IDE:

1. Gehen Sie zu Tools > Google Cloud Code > Cloud APIs.

2. Im Fenster Google Cloud APIs verwalten werden Cloud APIs nach Kategorie gruppiert. Sie können auch die Suchleiste der APIs suchen verwenden, um bestimmte APIs zu finden.

   

3. Klicken Sie auf eine API, um weitere Details wie den Status, sprachspezifische Installationsanleitungen für die entsprechenden Clientbibliotheken und die entsprechende Dokumentation aufzurufen.

Cloud APIs aktivieren

So aktivieren Sie Cloud APIs für ein Projekt mithilfe der API-Details:

1. Wählen Sie in der Cloud API-Detailansicht ein Google Cloud-Projekt aus, für das Sie die Cloud API aktivieren möchten.

2. Klicken Sie auf API aktivieren.

   Wenn die API aktiviert ist, wird eine Meldung angezeigt, mit der die Änderung bestätigt wird.

Cloud-Clientbibliotheken hinzufügen

So fügen Sie Bibliotheken zu Ihrem Projekt in IntelliJ hinzu:

Für Java Maven-Projekte

1. Gehen Sie zu Tools > Google Cloud Code > Cloud APIs.

Im Dialogfeld Google Cloud APIs verwalten werden im Abschnitt Clientbibliothek installieren die unterstützten Bibliotheken angezeigt.

2. Wählen Sie als Bibliothekstyp Google Cloud-Clientbibliothek (für die meisten Projekte empfohlen) oder Java Spring Google Cloud (empfohlen, wenn Ihr Projekt Java Spring verwendet) aus.
3. Folgen Sie gegebenenfalls der Anleitung unter Clientbibliothek installieren in Ihrer IDE.
Hinweis: Google Cloud Java löst Versionskonflikte zwischen Bibliotheken, indem die Google Cloud Java-BOM in die pom.xml-Datei Ihrer Projekte aufgenommen wird.
4. Wenn Sie fertig sind, klicken Sie auf Schließen.

Für alle anderen Projekte

1. Gehen Sie zu Tools > Google Cloud Code > Cloud APIs.

Im Dialogfeld Google Cloud APIs verwalten werden im Abschnitt Clientbibliothek installieren die unterstützten Bibliotheken angezeigt.

2. Folgen Sie zum Installieren der API der Installationsanleitung auf der Seite „API-Details“ für Ihre bevorzugte Sprache.

   Wenn Sie eine Java-Anwendung entwickeln, müssen Sie auch Ihre Bibliothekseinstellung als Google Cloud-Clientbibliothek (empfohlen) oder Java Spring Google Cloud angeben.

3. Wenn Sie fertig sind, klicken Sie auf Schließen.

API-Codebeispiele verwenden

So suchen und verwenden Sie für jede API im API Explorer Codebeispiele:

1. Gehen Sie zu Tools > Google Cloud Code > Cloud APIs.

2. Klicken Sie zum Öffnen der Detailansicht auf den Namen einer API.

3. Klicken Sie auf den Tab Codebeispiele, um Codebeispiele für die API aufzurufen.

4. Sie können die Liste der Beispiele filtern, indem Sie Text eingeben, nach dem gesucht werden soll, oder eine Programmiersprache aus dem Drop-down-Menü Sprache auswählen.

Authentifizierung einrichten

Nachdem Sie die erforderlichen APIs aktiviert und die erforderlichen Clientbibliotheken hinzugefügt haben, müssen Sie Ihre Anwendung für die Authentifizierung konfigurieren. Ihre Konfiguration hängt von Ihrer Art der Entwicklung und der Plattform ab, auf der Sie arbeiten.

Nachdem Sie die erforderlichen Authentifizierungsschritte abgeschlossen haben, kann sich Ihre Anwendung authentifizieren und bereitgestellt werden.

Lokale Entwicklung

Lokaler Rechner

Cloud Code stellt sicher, dass Ihre Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) festgelegt sind, wenn Sie sich über Ihre IDE in Google Cloud anmelden. Wenn Sie sich nicht mit Cloud Code anmelden, führen Sie gcloud auth application-default login manuell aus.

minikube

1. Cloud Code stellt sicher, dass Ihre Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) festgelegt sind, wenn Sie sich über Ihre IDE in Google Cloud anmelden. Wenn Sie sich nicht mit Cloud Code anmelden, führen Sie gcloud auth application-default login manuell aus.
2. Starten Sie minikube mit minikube start --addons gcp-auth. Dadurch werden Ihre ADC in Ihren Pods bereitgestellt. Eine detaillierte minikube-Authentifizierungsanleitung für Google Cloud finden Sie in der minikube gcp-auth-Dokumentation.

Andere lokale K8s-Cluster

1. Cloud Code stellt sicher, dass Ihre Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) festgelegt sind, wenn Sie sich über Ihre IDE in Google Cloud anmelden. Wenn Sie sich nicht mit Cloud Code anmelden, führen Sie gcloud auth application-default login manuell aus.
2. Stellen Sie das lokale Verzeichnis gcloud in Ihren Kubernetes-Pods bereit. Bearbeiten Sie dazu die Pod-Spezifikation in den Pod- oder Deployment-Manifesten, damit die Google Cloud-Clientbibliotheken Ihre Anmeldedaten finden können. Beispiel für eine Kubernetes-Pod-Konfiguration:

   apiVersion: v1
   kind: Pod
   metadata:
     name: my-app
     labels:
       name: my-app
   spec:
     containers:
     - name: my-app
       image: gcr.io/google-containers/busybox
       ports:
         - containerPort: 8080
       volumeMounts:
         - mountPath: /root/.config/gcloud
           name: gcloud-volume
     volumes:
       - name: gcloud-volume
         hostPath:
           path: /path/to/home/.config/gcloud

Cloud Run

Cloud Code stellt sicher, dass Ihre Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) festgelegt sind, wenn Sie sich über Ihre IDE in Google Cloud anmelden. Wenn Sie sich nicht mit Cloud Code anmelden, führen Sie gcloud auth application-default login manuell aus.

Remote-Entwicklung

Google Kubernetes Engine

Je nach Umfang Ihres Projekts können Sie auswählen, wie Sie Google Cloud-Dienste in GKE authentifizieren:

• (Nur Entwicklung)
  Hinweis: Die Einstellungen für das GKE-Cluster-Dienstkonto und den Zugriffsbereich sind dauerhaft. Nachdem der Cluster erstellt wurde, können diese Einstellungen nicht mehr geändert werden. Geben Sie die Einstellungen wie empfohlen an.
  1. Erstellen Sie einen GKE-Cluster mit den folgenden Einstellungen:
     • Achten Sie darauf, dass Sie das Dienstkonto verwenden, das GKE standardmäßig verwendet, das Compute Engine-Standarddienstkonto, und dass für Zugriffsbereiche die Einstellung Uneingeschränkten Zugriff auf alle Cloud APIs erlauben (beide Einstellungen im Abschnitt Knotenpools > Sicherheit verfügbar) eingestellt ist.
       Da das Compute Engine-Dienstkonto von allen auf Ihrem Knoten bereitgestellten Arbeitslasten gemeinsam genutzt wird, überdimensioniert diese Methode die Berechtigungen und sollte nur für die Entwicklung verwendet werden.
     • Achten Sie darauf, dass Workload Identity in Ihrem Cluster nicht aktiviert ist. Dies geschieht unter Cluster > Sicherheit.
  2. Weisen Sie dem Compute Engine-Standarddienstkonto die erforderlichen Rollen zu:
     • Wenn Sie auf ein Secret zugreifen möchten, folgen Sie den Schritten für Secret Manager, um die erforderlichen Rollen für Ihr Dienstkonto einzurichten.
     • Wenn das Compute Engine-Standarddienstkonto verwendet wird, werden möglicherweise bereits die richtigen IAM-Rollen angewendet.

     • Eine Liste der IAM-Rollentypen und vordefinierten Rollen, die Sie Identitäten zuweisen können, finden Sie in der Anleitung zu Rollen.

       Die Schritte zum Zuweisen der Rollen finden Sie unter Zugriff auf Ressourcen erteilen, ändern und entziehen.

• (Für Produktion empfohlen)
  1. Konfigurieren Sie Ihren GKE-Cluster und Ihre Anwendung mit Workload Identity, um Google Cloud-Dienste in GKE zu authentifizieren. Dadurch wird Ihr Kubernetes-Dienstkonto mit Ihrem Google-Dienstkonto verknüpft.
  2. Konfigurieren Sie Ihre Kubernetes-Bereitstellung so, dass sie auf das Kubernetes-Dienstkonto verweist. Legen Sie dazu das Feld .spec.serviceAccountName in der YAML-Datei Ihrer Kubernetes-Bereitstellung fest.
     Wenn Sie an einer Anwendung arbeiten, die mit einer Cloud Code-Vorlage erstellt wurde, befindet sich diese Datei im Ordner „kubernetes-manifests“.
  3. Wenn für den Google Cloud-Dienst, auf den Sie zugreifen möchten, zusätzliche Rollen erforderlich sind, weisen Sie diese dem Google-Dienstkonto zu, mit dem Sie Ihre Anwendung entwickeln:
     • Wenn Sie auf ein Secret zugreifen möchten, folgen Sie den Schritten für Secret Manager, um die erforderlichen Rollen für Ihr Dienstkonto einzurichten.

     • Eine Liste der IAM-Rollentypen und vordefinierten Rollen, die Sie Identitäten zuweisen können, finden Sie in der Anleitung zu Rollen.

       Die Schritte zum Zuweisen der Rollen finden Sie unter Zugriff auf Ressourcen erteilen, ändern und entziehen.

Cloud Run

1. Wenn Sie ein neues eindeutiges Dienstkonto für die Bereitstellung Ihrer Cloud Run-Anwendung erstellen möchten, wählen Sie auf der Seite "Dienstkonten" das Projekt aus, in dem Ihr Secret gespeichert ist.
   

   Zur Seite „Dienstkonten“

2. Klicken Sie auf Dienstkonto erstellen.
3. Geben Sie in das Dialogfeld Dienstkonto erstellen einen aussagekräftigen Namen für das Dienstkonto ein.
4. Ändern Sie die Dienstkonto-ID in einen eindeutigen, erkennbaren Wert und klicken Sie dann auf Erstellen.
5. Wenn der Google Cloud-Dienst, auf den Sie zugreifen möchten, zusätzliche Rollen benötigt, gewähren Sie diese. Klicken Sie auf Weiter und dann auf Fertig.
6. Gehen Sie zu Ausführen > Konfigurationen bearbeiten und geben Sie Ihr Dienstkonto im Feld Dienstname an, um Ihr Kubernetes-Dienstkonto zu Ihrer Bereitstellungskonfiguration hinzuzufügen.

Cloud Run

Je nach Umfang Ihres Projekts können Sie auswählen, wie Sie Google Cloud-Dienste in GKE authentifizieren:

• (Nur Entwicklung)
  Hinweis: Die Einstellungen für das GKE-Cluster-Dienstkonto und den Zugriffsbereich sind dauerhaft. Nachdem der Cluster erstellt wurde, können diese Einstellungen nicht mehr geändert werden. Geben Sie die Einstellungen wie empfohlen an.
  1. Erstellen Sie einen GKE-Cluster mit den folgenden Einstellungen:
     • Achten Sie darauf, dass Sie das Dienstkonto verwenden, das GKE standardmäßig verwendet, das Compute Engine-Standarddienstkonto, und dass für Zugriffsbereiche die Einstellung Uneingeschränkten Zugriff auf alle Cloud APIs erlauben (beide Einstellungen im Abschnitt Knotenpools > Sicherheit verfügbar) eingestellt ist.
       Da das Compute Engine-Dienstkonto von allen auf Ihrem Knoten bereitgestellten Arbeitslasten gemeinsam genutzt wird, überdimensioniert diese Methode die Berechtigungen und sollte nur für die Entwicklung verwendet werden.
       
     • Achten Sie darauf, dass Workload Identity in Ihrem Cluster nicht aktiviert ist. Dies geschieht unter Cluster > Sicherheit.
  2. Weisen Sie dem Compute Engine-Standarddienstkonto die erforderlichen Rollen zu:
     • Wenn Sie auf ein Secret zugreifen möchten, folgen Sie den Schritten für Secret Manager, um die erforderlichen Rollen für Ihr Dienstkonto einzurichten.
     • Wenn das Compute Engine-Standarddienstkonto verwendet wird, werden möglicherweise bereits die richtigen IAM-Rollen angewendet.

     • Eine Liste der IAM-Rollentypen und vordefinierten Rollen, die Sie Identitäten zuweisen können, finden Sie in der Anleitung zu Rollen.

       Die Schritte zum Zuweisen der Rollen finden Sie unter Zugriff auf Ressourcen erteilen, ändern und entziehen.

• (Für Produktion empfohlen)
  1. Konfigurieren Sie Ihren GKE-Cluster und Ihre Anwendung mit Workload Identity, um Google Cloud-Dienste in GKE zu authentifizieren. Dadurch wird Ihr Kubernetes-Dienstkonto mit Ihrem Google-Dienstkonto verknüpft.
  2. Gehen Sie zu Ausführen > Konfigurationen bearbeiten und geben Sie dann Ihr Kubernetes-Dienstkonto im Feld Dienstname an, um Ihr Kubernetes-Dienstkonto in die Bereitstellungskonfiguration aufzunehmen.
     
  3. Wenn für den Google Cloud-Dienst, auf den Sie zugreifen möchten, zusätzliche Rollen erforderlich sind, weisen Sie diese dem Google-Dienstkonto zu, mit dem Sie Ihre Anwendung entwickeln:
     • Wenn Sie auf ein Secret zugreifen möchten, folgen Sie den Schritten für Secret Manager, um die erforderlichen Rollen für Ihr Dienstkonto einzurichten.

     • Eine Liste der IAM-Rollentypen und vordefinierten Rollen, die Sie Identitäten zuweisen können, finden Sie in der Anleitung zu Rollen.

       Die Schritte zum Zuweisen der Rollen finden Sie unter Zugriff auf Ressourcen erteilen, ändern und entziehen.

Remote-Entwicklung mit aktivierten Secret Manager-Berechtigungen

Wenn Sie aus der Ferne entwickeln, ein Dienstkonto zur Authentifizierung verwenden und Ihre Anwendung secrets verwendet, müssen Sie zusätzlich zur Anleitung für die Remote-Entwicklung noch ein paar weitere Schritte ausführen. Durch diese Schritte wird Ihrem Google-Dienstkonto die Rolle zugewiesen, die für den Zugriff auf ein bestimmtes Secret Manager-Secret erforderlich ist:

1. Gehen Sie zum Öffnen des Fensters mit dem Secret Manager-Tool zu Tools > Google Cloud Code > Secret Manager.

2. Wählen Sie das Secret aus, auf das Sie im Code zugreifen möchten.

3. Klicken Sie auf den Tab Berechtigungen und konfigurieren Sie die Berechtigungen für Ihr Secret, indem Sie auf Bearbeiten Berechtigung bearbeiten klicken.

   

   Die Google Cloud Console wird in einem neuen Fenster Ihres Webbrowsers geöffnet und die Secret Manager-Konfigurationsseite Ihres Secrets wird angezeigt.

4. Klicken Sie in der Google Cloud Console auf den Tab Berechtigungen und dann auf Zugriff gewähren.

5. Geben Sie im Feld Neue Hauptkonten Ihr Dienstkonto ein.

6. Wählen Sie im Drop-down-Feld Rolle auswählen die Rolle Zugriffsfunktion für Secret Manager-Secret aus.

7. Klicken Sie abschließend auf Save (Speichern).

   Ihr Dienstkonto hat die Berechtigung, auf dieses Secret zuzugreifen.

Support kontaktieren

So senden Sie Feedback oder melden ein Problem in Ihrer IntelliJ-IDE: Tools > Cloud Code > Hilfe / Info > Feedback geben oder Problem melden, um ein Problem auf GitHub zu melden oder stellen Sie eine Frage zu Stack Overflow.