Cómo crear y administrar anotaciones

En este tema, se analiza la compatibilidad con las anotaciones en Secret Manager.

Descripción general

Usa anotaciones para almacenar metadatos personalizados sobre un secreto. Por ejemplo, es posible que desees anotar un secreto con la ruta de archivo en la que se activará. Las anotaciones también se pueden usar para facilitar la administración y el consumo por parte de las cargas de trabajo.

Las anotaciones no son lo mismo que las etiquetas. Las etiquetas se usan para ordenar, filtrar y agrupar recursos, mientras que las anotaciones se usan para almacenar metadatos arbitrarios que no permiten identificar en un secreto. Existe una restricción de caracteres y una longitud de caracteres cuando se especifican metadatos en una etiqueta. Los metadatos de una anotación pueden ser pequeños o grandes, estructurados o no estructurados, y pueden incluir caracteres que las etiquetas no permiten.

Funciones obligatorias

  • Para agregar anotaciones en un secreto y actualizar anotaciones, se requiere la función de administrador de Secret Manager (roles/secretmanager.admin) en el secreto, el proyecto, la carpeta o la organización.

  • La visualización de anotaciones requiere el rol Visualizador de Secret Manager (roles/secretmanager.viewer) en el secreto, el proyecto, la carpeta o la organización.

No se pueden otorgar roles de IAM en una versión del Secret. Consulta Control de acceso con la IAM para obtener más información.

Agrega anotaciones a un Secret

Puedes agregar anotaciones cuando crees un secreto nuevo o actualices uno existente. Los metadatos en una anotación se almacenan como pares clave-valor.

Consola

  1. Ve a la página Secret Manager en la consola de Google Cloud.

    Ir a la página Secret Manager

  2. En la página de Secret Manager, haz clic en Crear secreto.

  3. En la página Crear secreto, en Nombre, ingresa un nombre para el secreto (p. ej., my-secret).

  4. (Opcional) También puedes agregar una versión del secreto cuando creas el secreto inicial. En el campo Valor secreto, ingresa un valor para el secreto (p. ej., abcd1234).

  5. Haz clic en Agregar anotación.

  6. Ingresa la clave y el valor correspondiente.

  7. Deja la sección Regiones sin modificar.

  8. Haz clic en el botón Crear secreto.

gcloud CLI

Para usar Secret Manager en la línea de comandos, primero instala o actualiza a la versión 378.0.0 o posterior de la CLI de gcloud. En Compute Engine o Google Kubernetes Engine, debes autenticarte con el permiso cloud-platform.

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

Para agregar anotaciones a un secreto existente, sigue los pasos que se mencionan en Editar anotaciones.

Ten en cuenta lo siguiente sobre las claves de anotación:

  • Las claves deben ser únicas en un secreto. No puedes repetir una clave en el mismo secreto.
  • Las claves deben tener entre 1 y 63 caracteres.
  • Las claves deben tener una codificación UTF-8 de 128 bytes como máximo.
  • Las claves deben comenzar y terminar con un carácter alfanumérico.
  • Las claves pueden tener guiones, guiones bajos y puntos entre los caracteres alfanuméricos.
  • El tamaño total de las claves y los valores de anotación debe ser inferior a 16 KiB.

Ver anotaciones

Las anotaciones adjuntas a un secreto se pueden ver en la pestaña Descripción general de la página Detalles del secreto.

Consola

  1. Ve a la página Secret Manager en la consola de Google Cloud.

    Ir a la página Secret Manager

  2. En la página Secret Manager, haz clic en el nombre del secreto.

  3. Se abrirá la página Detalles del secreto. Selecciona la pestaña Descripción general. Aquí puedes ver las anotaciones adjuntas al secreto.Las claves se enumeran en la columna izquierda, mientras que los valores se muestran en la columna derecha.

gcloud CLI

Para usar Secret Manager en la línea de comandos, primero instala o actualiza a la versión 378.0.0 o posterior de la CLI de gcloud. En Compute Engine o Google Kubernetes Engine, debes autenticarte con el permiso cloud-platform.

 gcloud secrets describe mysecret

Editar anotaciones

Puedes actualizar las anotaciones en la página Editar secreto.

Consola

  1. Ve a la página Secret Manager en la consola de Google Cloud.

    Ir a la página Secret Manager

  2. En la página Secret Manager, haz clic en el nombre del secreto.

  3. Se abrirá la página Detalles del secreto. Haz clic en Editar secreto y desplázate hacia abajo hasta Anotaciones.

  4. Puedes cambiar el valor de una anotación existente, borrarla o agregar una nueva.

  5. Haz clic en Actualizar secreto para guardar los cambios.

gcloud CLI

Para usar Secret Manager en la línea de comandos, primero instala o actualiza a la versión 378.0.0 o posterior de la CLI de gcloud. En Compute Engine o Google Kubernetes Engine, debes autenticarte con el permiso cloud-platform.

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

¿Qué sigue?