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.


Eine detaillierte Anleitung zu dieser Aufgabe finden Sie direkt im Cloud Shell-Editor. Klicken Sie dazu einfach auf Anleitung:

Anleitung


Die folgenden Abschnitte führen Sie durch dieselben Schritte wie das Klicken auf Anleitung.

Secret Manager 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 Cloud Code und maximieren Sie den Abschnitt Secret Manager.

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

    Im Abschnitt „Secret Manager“ verfügbare API-Verknüpfung aktivieren

Secrets mit der Secret Manager-Ansicht erstellen

  1. Klicken Sie auf Cloud Code und maximieren Sie den Abschnitt Secret Manager.

  2. Klicke im Abschnitt Secret Manager auf Secret erstellen.

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

    Dialogfeld „Secret erstellen“ geöffnet. Das Feld „Name“ muss als 'test-secret-1' und der Wert für „Secret“ als '42' ausgefüllt sein.

Secrets mit der Editoransicht 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 mit dem Secret Manager erstellen

Um ein vorhandenes Secret zu aktualisieren, können Sie eine neue Version des Secrets erstellen:

  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.

    Dialogfeld „Secret-Version erstellen“ mit Secret-Wert-Feld für Secret „test-secret“ geöffnet, das als „bar“ aktualisiert wurde

  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.

Neue Versionen von Secrets mit dem Editor erstellen

Um ein vorhandenes Secret zu aktualisieren, können Sie eine neue Version des 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 dann Version zum Secret in Secret Manager hinzufügen aus.

Secrets aufrufen

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

Secrets löschen

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

  1. Klicken Sie auf Cloud Code und maximieren Sie den Abschnitt Secret Manager.

  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 der Anleitung, um das Secret zu löschen.

Secrets aufrufen

Wählen Sie im Abschnitt „Secret Manager“ aus der Liste ein Secret aus, um sich Secrets anzusehen. Details zum Secret, z. B. Name, Replikationsrichtlinie, Erstellungszeitstempel und Ressourcen-ID, werden unter dem Secret-Namen aufgeführt.

Secret-Versionen verwalten

Klicken Sie zum Aktivieren, Deaktivieren oder Löschen einer Version eines Secrets mit der rechten Maustaste auf das Secret und wählen Sie dann den Befehl für die auszuführende Aktion aus. Bei aktivierten Versionen von Secrets können Sie auch den Wert der Version sehen.

Secrets in der Google Cloud Console verwalten

Wenn Sie ein Secret in Ihrem Browser ansehen und verwalten möchten, klicken Sie 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 Console öffnen“ aufzurufen. Das Drop-down-Menü für Eigenschaften ist auch in der Secret Manager-Ansicht verfügbar.

Von Ihrer Anwendung aus auf Secrets 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 Cloud Code und maximieren Sie den Abschnitt Cloud APIs.

    2. Maximieren Sie Secret Manager & Secret Manager API und folgen Sie der Anleitung im Abschnitt „Clientbibliothek installieren“ für die Sprache, die Sie verwenden.

  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 du die Entwicklung auf einem lokalen Cluster (z. B. Minikube oder Docker Desktop) oder einem lokalen Emulator implementierst, solltest du die Schritte ausführen, die im Abschnitt zur lokalen Entwicklung erläutert werden, der für deinen Workflow relevant ist.
    • 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 ausführen, die für Ihren Workflow relevant sind, einschließlich der Secret Manager-spezifischen Anleitung für die Einrichtung der erforderlichen Rollen in Ihrem Dienstkonto.

Secret als Umgebungsvariable hinzufügen

So fügen Sie dem Deployment ein vorhandenes Kubernetes-Secret als Umgebungsvariable hinzu:

  1. Klicken Sie auf Cloud Code und maximieren Sie den Abschnitt Kubernetes.
  2. Maximieren Sie Ihren Minikube-Cluster und maximieren Sie 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 Container des Deployments bereit:

  1. Klicken Sie auf Cloud Code und maximieren Sie den Abschnitt Kubernetes.
  2. Maximieren Sie Ihren Minikube-Cluster und maximieren Sie 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.

Support

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