Anmerkungen erstellen und verwalten

In diesem Thema wird die Unterstützung von Anmerkungen in Secret Manager erläutert.

Übersicht

Mit Annotationen können Sie benutzerdefinierte Metadaten zu einem Secret speichern. Zum Beispiel könnten Sie ein Secret mit dem Dateipfad zur Bereitstellung annotieren möchten. Anmerkungen können die auch zur Verwaltung und Nutzung durch Arbeitslasten verwendet werden.

Anmerkungen sind nicht mit Labels identisch. Labels dienen zum Sortieren, Filtern, und Gruppieren von Ressourcen, während Anmerkungen verwendet werden, um beliebige, nicht identifizierende Metadaten für ein Secret. Bei der Angabe von Metadaten in einem Label gibt es Einschränkungen bei Zeichen und Zeichenlänge. Die Metadaten in einer Anmerkung können mehr oder weniger umfangreich, strukturiert oder unstrukturiert sein sowie Zeichen enthalten, die für Labels nicht zulässig sind.

Erforderliche Rollen

  • Zum Hinzufügen von Anmerkungen zu einem Secret und zum Aktualisieren von Anmerkungen ist die Rolle „Secret Manager-Administrator“ (roles/secretmanager.admin) für das Secret, Projekt, den Ordner oder die Organisation erforderlich.

  • Wenn Sie Anmerkungen aufrufen möchten, benötigen Sie die Rolle „Secret Manager-Betrachter“ (roles/secretmanager.viewer) für das Secret, Projekt, den Ordner oder die Organisation.

IAM-Rollen können in einer Secret-Version nicht zugewiesen werden. Siehe Zugriffssteuerung mit IAM .

Anmerkungen zu einem Secret hinzufügen

Sie können Anmerkungen beim Erstellen eines neuen Secrets oder beim Aktualisieren eines vorhandenen Secrets hinzufügen. Die Metadaten in einer Annotation als Schlüssel/Wert-Paare gespeichert.

Console

  1. Rufen Sie in der Google Cloud Console die Seite Secret Manager auf.

    Zur Seite „Secret Manager“

  2. Klicken Sie auf der Seite Secret Manager auf Secret erstellen.

  3. Geben Sie auf der Seite Secret erstellen unter Name einen Namen für das Secret ein (z. B. my-secret).

  4. (Optional) Wenn Sie beim Erstellen des ersten Secrets auch eine Secret-Version hinzufügen möchten, geben Sie im Feld Secret-Wert einen Wert für das Secret ein (z. B. abcd1234).

  5. Klicken Sie auf Anmerkung hinzufügen.

  6. Geben Sie den Schlüssel und den entsprechenden Wert ein.

  7. Lassen Sie den Abschnitt Regionen unverändert.

  8. Klicken Sie auf Secret erstellen.

gcloud-CLI

Wenn Sie Secret Manager in der Befehlszeile verwenden möchten, installieren oder aktualisieren Sie zuerst die gcloud CLI auf Version 378.0.0 oder höher. An Compute Engine oder Google Kubernetes Engine, müssen Sie sich über die cloud-platform authentifizieren erfasst werden.

 gcloud secrets create mysecret
--set-annotations= mykey=myval,mykey2=myval2

Gehen Sie wie unter Annotationen bearbeiten beschrieben vor, um einem vorhandenen Secret Annotationen hinzuzufügen.

Beachten Sie Folgendes zu Annotationsschlüsseln:

  • Schlüssel müssen für ein Secret eindeutig sein. Ein Schlüssel darf nicht zweimal im selben Secret vorkommen.
  • Schlüssel müssen zwischen 1 und 63 Zeichen lang sein.
  • Schlüssel müssen eine UTF-8-Codierung mit maximal 128 Byte haben.
  • Schlüssel müssen mit einem alphanumerischen Zeichen beginnen und enden.
  • Schlüssel können Bindestriche, Unterstriche und Punkte zwischen den alphanumerischen Zeichen enthalten.
  • Die Gesamtgröße der Anmerkungsschlüssel und -werte muss kleiner als 16 KiB sein.

Anmerkungen ansehen

An ein Secret angehängte Annotationen sind auf der Seite Secret-Details auf dem Tab Übersicht sichtbar.

Console

  1. Rufen Sie in der Google Cloud Console die Seite Secret Manager auf.

    Zur Seite „Secret Manager“

  2. Klicken Sie auf der Seite Secret Manager auf den Namen des Secrets.

  3. Die Seite Secret-Details wird geöffnet. Wähle den Tab Übersicht aus. Hier sehen Sie die mit dem Secret verknüpften Annotationen. während die Werte in der rechten Spalte angezeigt werden.

gcloud-CLI

Wenn Sie Secret Manager in der Befehlszeile verwenden möchten, installieren oder aktualisieren Sie zuerst auf Version 378.0.0 oder höher der gcloud CLI verwenden. An Compute Engine oder Google Kubernetes Engine, müssen Sie sich über die cloud-platform authentifizieren erfasst werden.

 gcloud secrets describe mysecret

Anmerkungen bearbeiten

Sie können Annotationen auf der Seite Secret bearbeiten aktualisieren.

Console

  1. Rufen Sie in der Google Cloud Console die Seite Secret Manager auf.

    Zur Seite „Secret Manager“

  2. Klicken Sie auf der Seite Secret Manager auf den Namen des Secrets.

  3. Die Seite Secret-Details wird geöffnet. Klicken Sie auf Secret bearbeiten und scrollen Sie nach unten zu Anmerkungen.

  4. Sie können den Wert einer vorhandenen Anmerkung ändern, die Anmerkung löschen oder eine neue Anmerkung hinzufügen.

  5. Klicken Sie auf Secret aktualisieren, um die Änderungen zu speichern.

gcloud-CLI

Wenn Sie Secret Manager in der Befehlszeile verwenden möchten, installieren oder aktualisieren Sie zuerst auf Version 378.0.0 oder höher der gcloud CLI verwenden. An Compute Engine oder Google Kubernetes Engine, müssen Sie sich über die cloud-platform authentifizieren erfasst werden.

 gcloud secrets update mysecret --update-annotations=mykey3=myval3
 
 gcloud secrets update mysecret --remove-annotations=mykey3=myval3
 
 gcloud secrets update mysecret --clear-annotations

Nächste Schritte