Créer et gérer des annotations

Cet article traite de la prise en charge des annotations dans Secret Manager.

Présentation

Utilisez des annotations pour stocker des métadonnées personnalisées sur un secret. Par exemple, vous pouvez annoter un secret avec le chemin d'accès au fichier sur lequel il sera installé. Les annotations peuvent également être utilisées pour faciliter l'administration et la consommation par les charges de travail.

Les annotations ne sont pas les mêmes que les libellés. Les étiquettes sont utilisées pour trier, filtrer et regrouper des ressources, tandis que les annotations permettent de stocker des métadonnées arbitraires ne permettant pas d'identifier l'utilisateur dans un secret. Lorsque vous spécifiez des métadonnées dans un libellé, des restrictions s'appliquent au nombre de caractères et à la longueur des caractères. Les métadonnées d'une annotation peuvent être petites, volumineuses, structurées ou non structurées, et peuvent inclure des caractères non autorisés par les libellés.

Rôles requis

Pour ajouter des annotations à un secret et mettre à jour des annotations, vous devez disposer du rôle d'administrateur Secret Manager (roles/secretmanager.admin) au niveau du secret, du projet, du dossier ou de l'organisation.
Pour afficher les annotations, vous devez disposer du rôle de lecteur Secret Manager (roles/secretmanager.viewer) sur le secret, le projet, le dossier ou l'organisation.

Les rôles IAM ne peuvent être attribués au niveau de la version d'un secret. Pour en savoir plus, consultez la page Contrôle des accès avec IAM.

Ajouter des annotations à un secret

Vous pouvez ajouter des annotations lorsque vous créez un secret ou que vous mettez à jour un secret existant. Les métadonnées d'une annotation sont stockées sous forme de paires clé/valeur.

Console

Accédez à la page Secret Manager dans la console Google Cloud.

Accéder à la page Secret Manager
Sur la page Secret Manager, cliquez sur Créer un secret.
Sur la page Créer un secret, sous Nom, saisissez un nom pour le secret (par exemple, my-secret).
(Facultatif) Pour ajouter une version de secret lors de la création de ce dernier, saisissez une valeur dans le champ Valeur du secret (par exemple, abcd1234).
Cliquez sur Ajouter une annotation.
Saisissez la clé et la valeur correspondante.
Ne modifiez pas la section Régions.
Cliquez sur le bouton Créer un secret.

gcloud CLI

Pour utiliser Secret Manager dans la ligne de commande, commencez par installer ou mettre à niveau Secret Manager vers la version 378.0.0 ou une version ultérieure de gcloud CLI. Sur Compute Engine ou Google Kubernetes Engine, vous devez vous authentifier avec le champ d'application cloud-platform.

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

Pour ajouter des annotations à un secret existant, suivez la procédure décrite dans la section Modifier les annotations.

Notez les points suivants à propos des clés d'annotation:

Les clés doivent être uniques à un secret. Vous ne pouvez pas répéter une clé dans le même code secret.
Les clés doivent comporter entre 1 et 63 caractères.
Les clés doivent utiliser un encodage UTF-8 de 128 octets au maximum.
Les clés doivent commencer et se terminer par un caractère alphanumérique.
Les clés peuvent contenir des tirets, des traits de soulignement et des points entre les caractères alphanumériques.
La taille totale des clés et des valeurs d'annotation doit être inférieure à 16 Kio.

Afficher les annotations

Les annotations associées à un secret sont visibles dans l'onglet Présentation de la page Détails du secret.

Console

Accédez à la page Secret Manager dans la console Google Cloud.

Accéder à la page Secret Manager
Sur la page Secret Manager, cliquez sur le nom du secret.
La page Détails du secret s'ouvre. Sélectionnez l'onglet Présentation. Vous pouvez voir ici les annotations associées au secret.Les clés sont répertoriées dans la colonne de gauche tandis que les valeurs sont affichées dans la colonne de droite.

gcloud CLI

 gcloud secrets describe mysecret

Modifier les annotations

Vous pouvez mettre à jour les annotations sur la page Modifier le secret.

Console

Accédez à la page Secret Manager dans la console Google Cloud.

Accéder à la page Secret Manager
Sur la page Secret Manager, cliquez sur le nom du secret.
La page Détails du secret s'ouvre. Cliquez sur Modifier le secret, puis faites défiler la page jusqu'à Annotations.
Vous pouvez modifier la valeur d'une annotation existante, la supprimer ou ajouter une annotation.
Cliquez sur Mettre à jour le secret pour enregistrer les modifications.

gcloud CLI

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

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

 gcloud secrets update mysecret --clear-annotations

Étapes suivantes

Découvrez comment gérer l'accès aux secrets.
Découvrez comment configurer des calendriers de rotation pour les secrets.
Découvrez comment configurer des notifications sur un secret.