Secrets mit Secret Manager in Cloud Code für VS Code verwalten

Mit der Secret Manager-Integration von Cloud Code können Sie in Ihrer IDE Secrets erstellen, aufrufen, aktualisieren und verwenden, ohne dass sie in Ihrer Codebasis enthalten sein müssen.

Auf dieser Seite wird beschrieben, wie Sie in Ihrer IDE auf Secret Manager zugreifen und wie Sie Secrets erstellen und verwalten können.

Secret Manager API aktivieren

Wenn Sie Secrets mit Cloud Code verwalten, werden Secrets sicher im Secret Manager gespeichert und können bei Bedarf programmatisch abgerufen werden. Sie benötigen lediglich die Secret Manager API und die richtigen Berechtigungen zum Verwalten von Secrets:

  1. Achten Sie darauf, dass Sie in dem Projekt arbeiten, in dem sich Ihr Anwendungscode befindet. Ihr Secret muss sich im selben Projekt wie Ihr Anwendungscode befinden.

  2. Klicken Sie auf Symbol: Cloud Code Cloud Code und maximieren Sie den Secret Manager Explorer.

  3. Wenn Sie die Secret Manager API nicht aktiviert haben, klicken Sie im Secret Manager Explorer auf Secret Manager API aktivieren.

Secrets erstellen

So erstellen Sie ein Secret mit dem Secret Manager Explorer:

  1. Klicken Sie in Ihrer IDE auf Symbol: Cloud Code Cloud Code und maximieren Sie den Secret Manager Explorer.

  2. Klicken Sie im Secret Manager Explorer auf Secret erstellen.

    Legen Sie im Dialogfeld Secret erstellen das Projekt, den Namen, den Wert und die Region Ihres Secrets fest und geben Sie Labels an, um Ihre Secrets zu organisieren.

Alternativ können Sie mit dem Editor ein Secret erstellen:

  1. Öffnen Sie im Editor eine Datei mit Text, den Sie als Secret speichern möchten.
  2. Markieren Sie den zu speichernden Text als Secret, klicken Sie mit der rechten Maustaste und klicken Sie dann auf Secret im Secret Manager erstellen.
  3. Passen Sie im Dialogfeld Secret erstellen das Projekt, den Namen, den Wert, die Region und die Labels des Secrets an.

Neue Versionen von Secrets erstellen

So erstellen Sie eine neue Version eines Secrets mit Secret Manager:

  1. Klicken Sie mit der rechten Maustaste auf ein vorhandenes Secret und wählen Sie Secret-Version erstellen aus.

  2. Legen Sie im Dialogfeld Version erstellen den neuen Wert Ihres vorhandenen Secrets über das Feld Secret-Wert oder durch Importieren einer Datei fest.

  3. Wenn Sie alle vorherigen Versionen Ihres Secrets entfernen und nur die neue Version beibehalten möchten, wählen Sie Alle früheren Versionen deaktivieren aus.

  4. Klicken Sie auf Version erstellen. Ihre Version wird hinzugefügt und Sie können die neueste Secret-Version und die vorherigen Versionen unter den Drop-down-Menüs Versionen sehen.

Alternativ können Sie im Editor eine neue Version eines Secrets erstellen:

  1. Öffnen Sie im Editor eine Datei und markieren Sie den Text, der als Secret gespeichert werden soll.

  2. Klicken Sie mit der rechten Maustaste auf den markierten Text und wählen Sie Secret in Secret Manager zu Version hinzufügen aus.

Secret-Versionen verwalten

Wenn Sie ein Secret aktivieren, deaktivieren oder löschen möchten, klicken Sie mit der rechten Maustaste auf das Secret und wählen Sie den Befehl für die Aktion aus, die Sie ausführen möchten. Bei aktivierten Versionen von Secrets können Sie auch den Wert der Version sehen.

Secrets ansehen

Wenn Sie Secrets ansehen möchten, wählen Sie im Explorer Secret Manager ein Secret aus der Liste aus. Details zum Secret, z. B. Name, Replikationsrichtlinie, Erstellungszeitstempel und Ressourcen-ID, werden unter dem Secret-Namen aufgeführt.

Secrets in der Google Cloud Console ansehen

Alternativ können Sie Secrets in der Google Cloud Console aufrufen. Klicken Sie dazu im Secret Manager mit der rechten Maustaste auf das Secret und dann auf In der Cloud Console öffnen.

Klicken Sie in Secret Manager mit der rechten Maustaste auf das Secret, um die Option „In Google Cloud öffnen“ aufzurufen. Das Drop-down-Menü für Eigenschaften ist auch in der Secret Manager-Ansicht verfügbar.

Secrets im Kubernetes Explorer ansehen

So rufen Sie Secrets im Explorer von Kubernetes auf:

  1. Klicken Sie auf Symbol: Cloud Code Cloud Code und maximieren Sie den Kubernetes Explorer.
  2. Maximieren Sie den Cluster und dann Secrets.
  3. Maximieren Sie das Secret, um dessen Details aufzurufen.

Auf Secrets aus Ihrer Anwendung zugreifen

Nachdem Ihr Secret erstellt wurde, können Sie es in Ihren Code aufnehmen und die Authentifizierung einrichten.

So greifen Sie über Ihre Anwendung auf ein Secret zu:

  1. Installieren Sie die Secret Manager-Clientbibliothek.

    1. Klicken Sie auf Symbol: Cloud Code Cloud Code und maximieren Sie dann den Explorer von Cloud APIs.

    2. Maximieren Sie Cloud-Sicherheit > Secret Manager API und folgen Sie der Anleitung im Abschnitt „Clientbibliothek installieren“ für die von Ihnen verwendete Sprache.

  2. Passen Sie das relevante Code-Snippet an und fügen Sie es in den Code Ihrer Anwendung ein.

    Um den Versionsnamen Ihres Secrets zu erhalten, den Sie in Ihrem Code verwenden, können Sie das Secret im Secret Manager-Feld auswählen, mit der rechten Maustaste darauf klicken und Ressourcen-ID kopieren wählen.

  3. Folgen Sie der Authentifizierungsanleitung für Clientbibliotheken, um die Authentifizierung abzuschließen:

    • Lokale Entwicklung: Wenn Sie auf einem lokalen Cluster (z. B. Minikube oder Docker Desktop) oder einem lokalen Emulator entwickeln, sollten Sie die für Ihren Workflow relevanten Abschnitt zur lokalen Entwicklung ausführen.
    • Remote-Entwicklung: Wenn Sie einen GKE-Cluster oder einen Cloud Run-Dienst in Ihrer Anwendung verwenden, sollten Sie die im Abschnitt zur Remote-Entwicklung beschriebenen Schritte für Ihren Workflow ausführen, einschließlich der Secret-spezifischen Anleitung zum Einrichten der erforderlichen Rollen für Ihr Dienstkonto.

Secret als Umgebungsvariable hinzufügen

So fügen Sie der Bereitstellung ein vorhandenes Kubernetes-Secret als Umgebungsvariable hinzu:

  1. Klicken Sie auf Symbol: Cloud Code Cloud Code und maximieren Sie den Kubernetes Explorer.
  2. Maximieren Sie den Minikube-Cluster und dann Secrets.
  3. Klicken Sie mit der rechten Maustaste auf ein Secret, das ein Deployment-Objekt darstellt, und klicken Sie dann auf Secret als Umgebungsvariable hinzufügen.

Secret als Volume bereitstellen

So stellen Sie ein vorhandenes Kubernetes-Secret als Volume im Bereitstellungscontainer bereit:

  1. Klicken Sie auf Symbol: Cloud Code Cloud Code und maximieren Sie den Kubernetes Explorer.
  2. Maximieren Sie den Minikube-Cluster und dann Secrets.
  3. Klicken Sie mit der rechten Maustaste auf ein Secret, das ein Deployment-Objekt darstellt, und klicken Sie dann auf Secret als Volume bereitstellen.

Secrets löschen

So löschen Sie ein Secret mit dem Secret Manager in Cloud Code:

  1. Klicken Sie auf Symbol: Cloud Code Cloud Code und maximieren Sie den Secret Manager Explorer.

  2. Klicken Sie mit der rechten Maustaste auf ein vorhandenes Secret und wählen Sie In Cloud Console öffnen aus.

  3. Klicken Sie auf der Seite Secret-Details auf LÖSCHEN und folgen Sie den Aufforderungen, um das Secret zu löschen.

Support anfragen

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