Información general

Se pueden realizar Despliegues en tus pipelines de integración continua (CI). En general, estos pipelines tienen un paso de despliegue que se ejecuta después que el código fuente se pruebe y la imagen esté creada.

Si estás ejecutando despliegues mediante un proveedor de CI, puedes monitorizar tus despliegues con Deployment Visibility. Asegúrate de que se cumplan los siguientes requisitos:

1. Estás usando Pipeline Visibility para monitorizar tus pipelines de CI.
2. Tu proveedor de CI admite la característica Custom tags and measures at runtime (Etiquetas y medidas personalizadas en el tiempo de ejecución), que te permite añadir texto y etiquetas numéricas definidas por el usuario a los pipelines y trabajos en Pipeline Visibility.
3. Estás ejecutando despliegues en un trabajo de CI (o un nivel relacionado en tu proveedor de CI). El concepto de un trabajo de CI puede variar según tu proveedor. Para obtener más información sobre cómo Datadog define un trabajo de Ci, consulta la sección Terminología.

Configuración

Para configurar CD Visibility, utiliza el comando datadog-ci deployment mark dentro del trabajo de CI que está realizando el despliegue.

Se necesitan dos variables de entorno:

1. DD_API_KEY: dirigida a tu clave de API de Datadog.
2. DD_BETA_COMMANDS_ENABLED: establecida en 1.

Opcionalmente, puedes establecer la variable de entorno DD_SITE a un sitio de Datadog específico. Tu sitio es datadoghq.com.

Puedes mejorar el evento de despliegue que genera el comando datadog-ci deployment mark utilizando los siguientes parámetros:

Utiliza --no-fail (por defecto: false) para evitar que el comando de despliegue falle si hay problemas al enviar los datos.

Si estás utilizando acciones de GitHub como tu proveedor de CI, consulta la sección siguiente para consideraciones adicionales.

Una vez que hayas añadido el comando a un trabajo de CI, la página Deployments (Despliegues) y el Deployment Executions Explorer se rellenan con datos después de que se ejecuten los pipelines. Para obtener más información, consulta Buscar y gestionar despliegues y la documentación del CD Visibility Explorer.

Ejemplos

Este conjunto de comandos especifica que el trabajo de CI ejecute un despliegue en el entorno prod con la versión 1.0.0:

export DD_BETA_COMMANDS_ENABLED=1
export DD_API_KEY="<YOUR_API_KEY>"
export DD_SITE=datadoghq.com

datadog-ci deployment mark --env prod --revision 1.0.0

Este conjunto de comandos especifica que el trabajo de CI realiza un despliegue rollback (reversión) al entorno prod:

export DD_BETA_COMMANDS_ENABLED=1
export DD_API_KEY="<YOUR_API_KEY>"
export DD_SITE=datadoghq.com

datadog-ci deployment mark --env prod --is-rollback

Este conjunto de comandos especifica que el trabajo de CI ejecute un despliegue en el entorno prod y añada las etiquetas team:backend y reason:scheduled al evento de despliegue:

export DD_BETA_COMMANDS_ENABLED=1
export DD_API_KEY="<YOUR_API_KEY>"
export DD_SITE=datadoghq.com

datadog-ci deployment mark --env prod --tags team:backend --tags reason:scheduled

Marcar trabajos de acciones de GitHub como despliegues

Para marcar los trabajos de GitHub como despliegues, se requiere la versión datadog-ci CLI 2.29.0 o posterior. Si el nombre del trabajo no coincide con la entrada definida en el archivo de configuración del flujo de trabajo (el ID del trabajo de GitHub), la variable de entorno DD_GITHUB_JOB_NAME necesita ser expuesta, apuntando al nombre del trabajo. Por ejemplo:

1. Si se cambia el nombre del trabajo utilizando la propiedad name:

   jobs:
     deploy:
       name: My deployment job name
       env:
         DD_GITHUB_JOB_NAME: My deployment job name
       steps:
       - run: datadog-ci deployment mark ...
   

   Copy

2. Si se utiliza la estrategia de matriz, GitHub genera varios nombres de tarea añadiendo los valores de matriz al final del nombre de la tarea, entre paréntesis. La variable de entorno DD_GITHUB_JOB_NAME debe entonces ser condicional a los valores de la matriz:

   jobs:
     deployment:
       strategy:
         matrix:
           env: [dev, staging]
       env:
         DD_GITHUB_JOB_NAME: deployment (${{ matrix.env }})
       steps:
       - run: datadog-ci deployment mark ...
   

   Copy

Leer más

Más enlaces, artículos y documentación útiles:

Más información sobre Deployment VisibilityDOCUMENTACIÓN Aprende a consultar y visualizar las ejecuciones de despliegueDOCUMENTACIÓN