Cloud APIs und Cloud-Clientbibliotheken in Cloud Code for VS Code verwalten

Für den programmatischen Zugriff auf Google Cloud-Produkte und -Dienste verwenden Sie Cloud APIs. Diese APIs bieten eine einfache JSON-REST-Schnittstelle. Die empfohlene Methode für den Zugriff auf die Cloud APIs ist die Verwendung der Cloud-Clientbibliotheken.

Mit Cloud Code können Sie ganz einfach die Cloud-Clientbibliotheken für die Cloud APIs und die Sprache hinzufügen, die Sie zu Ihrem Projekt verwenden. In derselben Ansicht können Sie nach Beispielen für jede API suchen und einfach Beispiele in Ihre Anwendung einbinden.

Cloud APIs finden

So finden Sie alle verfügbaren Google Cloud APIs:

  1. Klicken Sie auf Cloud Code und maximieren Sie den Bereich Cloud APIs.

    In der Cloud APIs-Ansicht werden Cloud APIs nach Kategorie gruppiert.

  2. Klicken Sie auf den API-Namen, um Details zu einer API aufzurufen. Details wie Dienstname, Status, Installationsanleitungen für Clientbibliotheken, Dokumentation und Codebeispiele werden angezeigt.

Cloud APIs aktivieren

Gehen Sie so vor, um Cloud APIs für ein Projekt über die API-Detailseite zu aktivieren:

  1. Wählen Sie auf der Cloud API-Detailseite das Projekt aus, für das die Cloud API aktiviert werden soll.
  2. Klicken Sie auf API aktivieren. Nach Aktivierung der API wird eine Meldung zur Bestätigung der Änderung angezeigt.

Clientbibliotheken zu Ihrem Projekt hinzufügen

Sie können mit Cloud Code nicht nur Cloud APIs kennenlernen und aktivieren, sondern auch eine sprachenspezifische Clientbibliothek zu Ihrem Projekt hinzufügen.

Folgen Sie der Anleitung auf der API-Detailseite für Ihre Sprache, um eine Clientbibliothek zu installieren.

API-Beispiele verwenden

Sie können im API-Browser für jede API Codebeispiele suchen und verwenden.

  1. Klicken Sie auf Cloud Code und maximieren Sie den Bereich Cloud APIs.

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

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

  4. Wenn Sie die Liste der Beispiele filtern möchten, geben Sie Text für die Suche ein oder wählen Sie in der Liste Sprache eine Programmiersprache aus.

  5. Klicken Sie auf den Namen der Stichprobe, um eine Stichprobe aufzurufen. Sie haben auch die Möglichkeit, das Beispiel in die Zwischenablage zu kopieren oder es in GitHub anzusehen.

Authentifizierung einrichten

Nachdem Sie die erforderlichen APIs aktiviert und die erforderlichen Clientbibliotheken hinzugefügt haben, müssen Sie Ihre Anwendung so konfigurieren, dass sie erfolgreich authentifiziert wird. Ihre Konfiguration hängt von Ihrer Art der Entwicklung und der Plattform ab, auf der Sie arbeiten.

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

Lokale Entwicklung

Lokaler Rechner

Wenn Sie sich in Ihrer IDE in Google Cloud angemeldet haben, legt Cloud Code Ihre Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) fest und Sie können diesen Schritt überspringen. Wenn Sie sich außerhalb Ihrer IDE in Google Cloud angemeldet haben (z. B. über die gcloud CLI), richten Sie Ihren ADC ein und führen Sie den folgenden Befehl aus, um die Google Cloud-Clientbibliotheken über ADC zu authentifizieren:

gcloud auth login --update-adc

minikube

  1. Wenn Sie sich in Ihrer IDE in Google Cloud angemeldet haben, legt Cloud Code Ihre Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) fest und Sie können diesen Schritt überspringen. Wenn Sie sich außerhalb Ihrer IDE in Google Cloud angemeldet haben (z. B. über die gcloud CLI), richten Sie Ihren ADC ein und führen Sie den folgenden Befehl aus, um die Google Cloud-Clientbibliotheken über ADC zu authentifizieren:

    gcloud auth login --update-adc
  2. Starten Sie minikube mit minikube start --addons gcp-auth. Mit diesem Befehl werden Ihre ADC in Ihren Pods bereitgestellt. Ausführliche Informationen zur minikube-Authentifizierung in Google Cloud finden Sie in der minikube gcp-auth-Dokumentation.

Andere lokale K8s-Cluster

  1. Wenn Sie sich in Ihrer IDE in Google Cloud angemeldet haben, legt Cloud Code Ihre Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) fest und Sie können diesen Schritt überspringen. Wenn Sie sich außerhalb Ihrer IDE in Google Cloud angemeldet haben (z. B. über die gcloud CLI), richten Sie Ihren ADC ein und führen Sie den folgenden Befehl aus, um die Google Cloud-Clientbibliotheken über ADC zu authentifizieren:

    gcloud auth login --update-adc
  2. Damit die Google Cloud-Clientbibliotheken Ihre Anmeldedaten finden können, stellen Sie Ihr lokales Verzeichnis ~/.config/gcloud in Ihren Kubernetes-Pods bereit, indem Sie die Bereitstellungsmanifeste bearbeiten.
  3. Legen Sie Ihre Google Cloud-Projekt-ID als Umgebungsvariable namens GOOGLE_CLOUD_PROJECT fest.

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
    env:
    - name: GOOGLE_CLOUD_PROJECT
      value: my-project-id
    volumeMounts:
      - mountPath: /root/.config/gcloud
        name: gcloud-volume
  volumes:
    - name: gcloud-volume
      hostPath:
        path: /path/to/home/.config/gcloud

Cloud Run

Wenn Sie sich in Ihrer IDE in Google Cloud angemeldet haben, legt Cloud Code Ihre Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) fest und Sie können diesen Schritt überspringen. Wenn Sie sich außerhalb Ihrer IDE in Google Cloud angemeldet haben (z. B. über die gcloud CLI), richten Sie Ihren ADC ein und führen Sie den folgenden Befehl aus, um die Google Cloud-Clientbibliotheken über ADC zu authentifizieren:

gcloud auth login --update-adc

Lokale Entwicklung mit APIs, für die ein Dienstkonto erforderlich ist

Für einige APIs, z. B. die Cloud Translation API, ist ein Dienstkonto mit entsprechenden Berechtigungen zur Authentifizierung Ihrer Anfragen erforderlich. Weitere Informationen finden Sie unter Dienstkonten erstellen und verwalten. Eine Kurzanleitung mit einem Dienstkonto finden Sie unter Cloud-Clientbibliotheken in Cloud Code verwenden.

  1. Klicken Sie zum Öffnen eines Terminals auf Terminal > Neues Terminal.

  2. Erstellen Sie ein Dienstkonto zur Authentifizierung Ihrer API-Anfragen:

    gcloud iam service-accounts create \
    SERVICE_ACCOUNT_ID \
    --project PROJECT_ID
    

    Ersetzen Sie die folgenden Werte:

    • PROJECT_ID: die Projekt-ID
    • SERVICE_ACCOUNT_ID: die Dienstkonto-ID
  3. Weisen Sie Ihrem Dienstkonto die entsprechende Rolle zu. Mit dem folgenden Beispielbefehl wird die Cloud Translation API-Nutzerrolle zugewiesen. Informationen zum Ermitteln der zuzuweisenden Rolle finden Sie in der Dokumentation zur verwendeten Cloud API.

    gcloud projects \
    add-iam-policy-binding \
    PROJECT_ID \
    --member='serviceAccount:SERVICE_ACCOUNT_ID@PROJECT_ID.iam.gserviceaccount.com' \
    --role='roles/cloudtranslate.user'
    
  4. Erstellen Sie einen Dienstkontoschlüssel:

    gcloud iam service-accounts keys \
    create key.json --iam-account \
    SERVICE_ACCOUNT_ID@PROJECT_ID.iam.gserviceaccount.com
    
  5. Legen Sie den Schlüssel als Standardanmeldedaten fest:

    export \
     GOOGLE_APPLICATION_CREDENTIALS=key.json
    
  6. Optional: Damit Nutzer die Identität des Dienstkontos annehmen können, führen Sie den Befehl gcloud iam service-accounts add-iam-policy-binding aus, um einem Nutzer die Rolle „Dienstkontonutzer“ (roles/iam.serviceAccountUser) für das Dienstkonto zuzuweisen:

    gcloud iam service-accounts add-iam-policy-binding \
        SERVICE_ACCOUNT_ID@PROJECT_ID.iam.gserviceaccount.com \
        --member="user:USER_EMAIL" \
        --role="roles/iam.serviceAccountUser"
    

    Ersetzen Sie die folgenden Werte:

    • USER_EMAIL: die E-Mail-Adresse des Nutzers

Remote-Entwicklung

GKE

Je nach Umfang des Projekts können Sie auswählen, wie die Google Cloud-Dienste in GKE authentifiziert werden:

  • (Nur Entwicklung)
    1. Erstellen Sie einen GKE-Cluster mit den folgenden Einstellungen:
      • Achten Sie darauf, dass Sie das von GKE standardmäßig verwendete Dienstkonto und das Compute Engine-Standarddienstkonto verwenden und für Zugriffsbereiche die Option Uneingeschränkten Zugriff auf alle Cloud APIs zulassen festgelegt ist. Beide Einstellungen sind im Abschnitt Knotenpools > Sicherheit verfügbar. Da das Compute Engine-Dienstkonto von allen auf Ihrem Knoten bereitgestellten Arbeitslasten gemeinsam genutzt wird, stellt diese Methode Berechtigungen zu häufig bereit 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 Ihrem Dienstkonto 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 Sie das Compute Engine-Standarddienstkonto verwenden, 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.
  • (Empfohlen für die Produktion)
    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-Beispielanwendung 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 diesen für das Google-Dienstkonto zu, das Sie zum Entwickeln Ihrer Anwendung verwenden:

Cloud Run

  1. Wenn Sie ein neues eindeutiges Dienstkonto für die Bereitstellung Ihrer Cloud Run-Anwendung erstellen möchten, rufen Sie die Seite „Dienstkonten“ auf und wählen Sie 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 Rollen, klicken Sie auf Weiter und dann auf Fertig.
  6. So fügen Sie das Dienstkonto Ihrer Bereitstellungskonfiguration hinzu:
    1. Wählen Sie in der Cloud Code-Statusleiste den Befehl Cloud Run: Bereitstellen aus.
    2. Geben Sie in der Cloud Run Deployment-UI unter Einstellungen bearbeiten im Feld Dienstkonto Ihr Dienstkonto an.
    Der Abschnitt Erweiterte Revisionseinstellungen wurde in Cloud Run erweitert: Bereitstellungs- und Dienstkontofeld mit Dienstkontoname ausgefüllt im Format service-account-name@project-name.iam.gserviceaccount.com

Cloud Run

Je nach Umfang des Projekts können Sie auswählen, wie die Google Cloud-Dienste in GKE authentifiziert werden:

  • (Nur Entwicklung)
    1. Erstellen Sie einen GKE-Cluster mit den folgenden Einstellungen:
      • Achten Sie darauf, dass Sie das Dienstkonto nehmen, das GKE standardmäßig verwendet, das Compute Engine-Standarddienstkonto, und dass Zugriffsbereiche festgelegt sind auf Uneingeschränkten Zugriff auf alle Cloud APIs zulassen (beide Einstellungen sind im Abschnitt Knotenpools >Sicherheit zugänglich. Da das Compute Engine-Dienstkonto von allen auf Ihrem Knoten bereitgestellten Arbeitslasten gemeinsam genutzt wird, stellt diese Methode zu viele Berechtigungen bereit 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 Ihrem Dienstkonto 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 Sie das Compute Engine-Standarddienstkonto verwenden, 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.
  • (Empfohlen für die Produktion)
    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. So fügen Sie das Dienstkonto Ihrer Bereitstellungskonfiguration hinzu:
      1. Wählen Sie in der Cloud Code-Statusleiste den Befehl Cloud Run: Bereitstellen aus.
      2. Geben Sie in der Cloud Run Deployment-UI unter Einstellungen bearbeiten im Feld Dienstkonto Ihr Dienstkonto an.
      Der Abschnitt Erweiterte Revisionseinstellungen wurde in Cloud Run erweitert: Bereitstellungs- und Dienstkontofeld mit Kubernetes-Dienstkontoname ausgefüllt im Format service-account-name@project-name.iam.gserviceaccount.com
    3. Wenn für den Google Cloud-Dienst, auf den Sie zugreifen möchten, zusätzliche Rollen erforderlich sind, weisen Sie diesen für das Google-Dienstkonto zu, das Sie zum Entwickeln Ihrer Anwendung verwenden:

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. Klicken Sie auf Symbol: Cloud Code Cloud Code und maximieren Sie den Bereich Secret Manager.

    Secret Manager in Cloud Code wird mit zwei aufgeführten Secrets geöffnet

  2. Klicken Sie mit der rechten Maustaste auf das Secret und wählen Sie Berechtigungen in der Cloud Console bearbeiten aus. Dadurch wird die Konfigurationsseite von Secret Manager für dieses Secret in Ihrem Webbrowser gestartet.

    Rechtsklick auf ein Secret im Feld „Secret Manager“

  3. Klicken Sie in der Konsole auf Berechtigungen und dann auf Hinzufügen.

  4. Geben Sie im Feld Neue Hauptkonten den Namen Ihres Dienstkontos ein.

  5. Wählen Sie im Feld Rolle auswählen die Rolle Secret Manager Secret Accessor aus.

  6. Klicken Sie auf Speichern.

    Ihr Dienstkonto ist jetzt berechtigt, auf dieses Secret zuzugreifen.

Support

Wenn Sie uns Feedback geben möchten, können Sie Probleme auf GitHub melden oder eine Frage in Stack Overflow stellen.