Anmerkungen erstellen und verwalten

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

Überblick

Mit Annotationen können Sie benutzerdefinierte Metadaten zu einem Secret speichern. Beispielsweise können Sie ein Secret mit dem Dateipfad annotieren, in dem es bereitgestellt wird. Annotationen können auch zur Verwaltung und Nutzung durch Arbeitslasten verwendet werden.

Annotationen sind nicht mit Labels identisch. Labels werden zum Sortieren, Filtern und Gruppieren von Ressourcen verwendet, während Annotationen zum Speichern beliebiger, nicht identifizierbarer Metadaten für ein Secret dienen. Beim Angeben von Metadaten in einem Label gelten Einschränkungen in Bezug auf Zeichen und Zeichenlänge. Die Metadaten in einer Annotation können klein oder groß, strukturiert oder unstrukturiert sein und Zeichen enthalten, die für Labels nicht zulässig sind.

Erforderliche Rollen

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

  • Zum Ansehen von Annotationen ist die Rolle „Secret Manager-Betrachter“ (roles/secretmanager.viewer) für das Secret, das Projekt, den Ordner oder die Organisation erforderlich.

IAM-Rollen können in einer Secret-Version nicht zugewiesen werden. Weitere Informationen finden Sie unter Zugriffssteuerung mit IAM.

Einem Secret Anmerkungen hinzufügen

Sie können Anmerkungen hinzufügen, wenn Sie ein neues Secret erstellen oder ein vorhandenes Secret aktualisieren. Die Metadaten in einer Annotation werden 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 Sie zuerst die gcloud CLI oder führen Sie ein Upgrade auf Version 378.0.0 oder höher aus. In Compute Engine oder Google Kubernetes Engine müssen Sie sich mit dem Bereich cloud-platform authentifizieren.

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

Führen Sie die Schritte unter Annotationen bearbeiten aus, um einem vorhandenen Secret Anmerkungen hinzuzufügen.

Beachten Sie Folgendes zu Annotationsschlüsseln:

  • Schlüssel müssen für ein Secret eindeutig sein. Ein Schlüssel kann nicht im selben Secret wiederholt werden.
  • Schlüssel müssen zwischen 1 und 63 Zeichen lang sein.
  • Schlüssel müssen eine UTF-8-Codierung von 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 Annotationsschlüssel und -werte muss kleiner als 16 KiB sein.

Anmerkungen ansehen

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

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.Die Schlüssel werden in der linken Spalte aufgelistet, die Werte in der rechten Spalte.

gcloud-CLI

Wenn Sie Secret Manager in der Befehlszeile verwenden möchten, installieren Sie zuerst die gcloud CLI oder führen Sie ein Upgrade auf Version 378.0.0 oder höher aus. In Compute Engine oder Google Kubernetes Engine müssen Sie sich mit dem Bereich cloud-platform authentifizieren.

 gcloud secrets describe mysecret

Anmerkungen bearbeiten

Sie können Anmerkungen 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 Annotationen.

  4. Sie können den Wert einer vorhandenen Annotation ändern oder löschen oder eine neue Annotation 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 Sie zuerst die gcloud CLI oder führen Sie ein Upgrade auf Version 378.0.0 oder höher aus. In Compute Engine oder Google Kubernetes Engine müssen Sie sich mit dem Bereich cloud-platform authentifizieren.

 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