Creazione e gestione delle annotazioni

In questo argomento viene illustrato il supporto delle annotazioni in Secret Manager.

Panoramica

Utilizza le annotazioni per archiviare i metadati personalizzati di un secret. Ad esempio, potresti voler annotare un secret con il percorso file in cui verrà montato. Le annotazioni possono essere utilizzate anche per agevolare l'amministrazione e l'utilizzo da parte dei carichi di lavoro.

Le annotazioni non sono la stessa cosa delle etichette. Le etichette vengono utilizzate per ordinare, filtrare e raggruppare le risorse, mentre le annotazioni vengono utilizzate per archiviare metadati arbitrari e non identificativi su un secret. Esiste una limitazione dei caratteri e della lunghezza dei caratteri quando si specificano i metadati in un'etichetta. I metadati di un'annotazione possono essere di piccole o grandi dimensioni, strutturati o non strutturati e possono includere caratteri non consentiti dalle etichette.

Ruoli obbligatori

L'aggiunta di annotazioni su un secret e l'aggiornamento delle annotazioni richiedono il ruolo Amministratore di Secret Manager (roles/secretmanager.admin) sul secret, sul progetto, sulla cartella o sull'organizzazione.
Per visualizzare le annotazioni è necessario il ruolo Visualizzatore Secret Manager (roles/secretmanager.viewer) sul secret, sul progetto, sulla cartella o sull'organizzazione.

Non è possibile concedere ruoli IAM su una versione del secret. Per ulteriori informazioni, consulta Controllo dell'accesso con IAM.

Aggiungi annotazioni a un secret

Puoi aggiungere annotazioni quando crei un nuovo secret o ne aggiorni uno esistente. I metadati di un'annotazione vengono memorizzati come coppie chiave-valore.

Console

Vai alla pagina Secret Manager nella console Google Cloud.

Vai alla pagina di Secret Manager
Nella pagina Secret Manager, fai clic su Crea secret.
Nella pagina Crea secret, in Nome, inserisci un nome per il secret (ad es. my-secret).
(Facoltativo) Per aggiungere una versione del secret anche durante la creazione del secret iniziale, inserisci un valore per il secret nel campo Valore secret (ad es. abcd1234).
Fai clic su Aggiungi annotazione.
Inserisci la chiave e il valore corrispondente.
Lascia invariata la sezione Regioni.
Fai clic sul pulsante Crea secret.

Interfaccia a riga di comando gcloud

Per utilizzare Secret Manager nella riga di comando, devi prima installare o eseguire l'upgrade alla versione 378.0.0 o successiva di gcloud CLI. In Compute Engine o Google Kubernetes Engine, devi eseguire l'autenticazione con l'ambito cloud-platform.

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

Per aggiungere annotazioni a un secret esistente, segui i passaggi descritti nella sezione Modificare le annotazioni.

Tieni presente quanto segue sulle chiavi di annotazione:

Le chiavi devono essere univoche per un secret. Non puoi ripetere una chiave nello stesso secret.
Le chiavi devono avere una lunghezza compresa tra 1 e 63 caratteri.
Le chiavi devono avere una codifica UTF-8 di massimo 128 byte.
Le chiavi devono iniziare e terminare con un carattere alfanumerico.
Le chiavi possono contenere trattini, trattini bassi e punti tra i caratteri alfanumerici.
La dimensione totale delle chiavi e dei valori di annotazione deve essere inferiore a 16 KiB.

Visualizza annotazioni

Le annotazioni allegate a un secret sono visibili nella scheda Panoramica della pagina Dettagli secret.

Console

Vai alla pagina Secret Manager nella console Google Cloud.

Vai alla pagina di Secret Manager
Nella pagina Secret Manager, fai clic sul nome del secret.
Viene visualizzata la pagina Dettagli secret. Seleziona la scheda Panoramica. Qui puoi vedere le annotazioni allegate al secret.Le chiavi sono elencate nella colonna a sinistra, mentre i valori sono visualizzati nella colonna a destra.

Interfaccia a riga di comando gcloud

 gcloud secrets describe mysecret

Modifica annotazioni

Puoi aggiornare le annotazioni nella pagina Modifica secret.

Console

Vai alla pagina Secret Manager nella console Google Cloud.

Vai alla pagina di Secret Manager
Nella pagina Secret Manager, fai clic sul nome del secret.
Viene visualizzata la pagina Dettagli secret. Fai clic su Modifica secret e scorri verso il basso fino ad Annotazioni.
Puoi modificare il valore di un'annotazione esistente, eliminarla o aggiungerne una nuova.
Fai clic su Aggiorna secret per salvare le modifiche.

Interfaccia a riga di comando gcloud

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

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

 gcloud secrets update mysecret --clear-annotations

Passaggi successivi

Scopri come gestire l'accesso ai secret.
Scopri come configurare pianificazioni di rotazione per i secret.
Scopri come configurare le notifiche su un secret.