Usar anotaciones y etiquetas con Cloud Deploy

Puedes adjuntar anotaciones y etiquetas a tus recursos de Cloud Deploy. No son obligatorios.

En este documento se enumeran los recursos a los que puedes adjuntar etiquetas y anotaciones, y se describe cómo puedes usarlas y dónde puedes verlas.

Acerca de las anotaciones y las etiquetas

Las anotaciones son pares clave-valor de texto de formato libre. Puedes usarlos para adjuntar información arbitraria asociada al recurso.

Puedes usar etiquetas para organizar los recursos. Por ejemplo, puedes aplicar lógica en función de la selección de etiquetas.

Al igual que las anotaciones, las etiquetas son pares clave-valor. Sin embargo, deben cumplir las siguientes limitaciones:

  • Un recurso de Cloud Deploy puede tener un máximo de 64 etiquetas.

  • Tanto las claves como los valores deben tener 128 bytes como máximo.

  • Las claves y los valores solo pueden contener letras minúsculas, caracteres numéricos, guiones bajos y guiones.

  • Las claves deben empezar por una letra minúscula o un carácter internacional.

  • Todos los caracteres deben usar la codificación UTF-8. Se permite utilizar caracteres internacionales.

La marca --labels (por ejemplo, en gcloud deploy releases create) puede aceptar una lista de pares clave-valor:

"name=wrench,mass=1.3kg,count=3"

Consulta más información en la documentación de la API Cloud Deploy.

Añadir anotaciones y etiquetas a los recursos de Cloud Deploy

Puedes añadir anotaciones y etiquetas a los siguientes recursos de Cloud Deploy:

  • Flujos de procesamiento de entrega

    En el caso de las canalizaciones de entrega, debes añadir anotaciones y etiquetas al archivo de configuración YAML.

apiVersion: deploy.cloud.google.com/v1
  kind: DeliveryPipeline
  metadata:
   name:
   annotations:
     key: "value"
   labels:
     key: "value"
  description:
  serialPipeline:
   stages:
   - targetId:
     profiles: []
   - targetId:
     profiles: []
  • Destinos

    Añada anotaciones y etiquetas a los objetivos en el archivo YAML de configuración de objetivos.

    Por ejemplo, puedes incluir un enlace a más información sobre la monitorización de terceros de tu aplicación. Sin embargo, si el destino se comparte, recuerda que se puede usar en más de una aplicación, por lo que el enlace no debe ser específico de una aplicación.

  • Versiones

    Puedes añadir anotaciones o etiquetas (o ambas) a una versión con las marcas --labels y --annotations en el comando gcloud deploy releases create. Las etiquetas y las anotaciones que añadas a una versión no se conservarán como etiquetas ni anotaciones en los lanzamientos resultantes.

    Por ejemplo, puedes usar anotaciones para incluir una referencia a una solicitud de extracción de Git, un autor o un hash SHA de la confirmación de Git que contenga los cambios que se van a implementar. Consulta más información en el artículo Usar anotaciones para registrar la procedencia de la versión.

  • Implementaciones

    Puedes añadir anotaciones y etiquetas a los nuevos lanzamientos especificando --labels o --annotations en el comando gcloud deploy releases promote.

    Puedes añadir anotaciones y etiquetas a la primera publicación especificando --initial-rollout-labels o --initial-rollout-annotations en el comando gcloud deploy releases create.

    Estas son algunas de las acciones que puedes llevar a cabo con las anotaciones en un lanzamiento:

    • Crea una anotación que contenga la URL que apunta a los resultados de la prueba.
    • Crea una anotación con un número de incidencia relevante de un sistema de gestión de flujos de trabajo.

¿Dónde puedo encontrar las anotaciones de un recurso?

Puedes ver las anotaciones y las etiquetas de cualquier recurso admitido mediante el comando describe del recurso o consultando sus metadatos en laGoogle Cloud consola.

Desde la CLI de gcloud

Para ver las anotaciones y las etiquetas de un recurso desde la línea de comandos, usa el comando describe en ese recurso. En el siguiente ejemplo se muestran los detalles de un destino: