Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3
En esta guía, se explica cómo crear una canalización de CI/CD para probar, sincronizar y, luego, implementar DAG en el entorno de Cloud Composer desde el repositorio de GitHub.
Si solo deseas sincronizar datos de otros servicios, consulta Transfiere datos de otros servicios.
Descripción general de la canalización de CI/CD
La canalización de CI/CD que se usa para probar, sincronizar y, luego, implementar DAG, sigue estos pasos:
Haces un cambio en un DAG y lo envías a una rama de desarrollo en tu repositorio.
Abres una solicitud de extracción en la rama principal de tu repositorio.
Cloud Build ejecuta pruebas de unidades para verificar que tu DAG sea válido.
Tu solicitud de extracción se aprobó y se combinó con la rama principal de tu repositorio.
Cloud Build sincroniza tu entorno de desarrollo de Cloud Composer con estos nuevos cambios.
Verifica que el DAG se comporte como se espera en tu entorno de desarrollo.
Si tu DAG funciona como se espera, súbelo a tu entorno de producción de Cloud Composer.
Objetivos
Antes de comenzar
En esta guía, se supone que trabajas con dos entornos idénticos de Cloud Composer: un entorno de desarrollo y uno de producción.
A los fines de esta guía, configurarás una canalización de CI/CD solo para tu entorno de desarrollo. Asegúrate de que el entorno que uses no sea uno de producción.
En esta guía, se supone que tienes los DAG y sus pruebas almacenados en un repositorio de GitHub.
El ejemplo de canalización de CI/CD muestra el contenido de un repositorio de ejemplo. Los DAG y las pruebas se almacenan en el directorio
dags/
, con los archivos de requisitos, el archivo de restricciones y los archivos de configuración de Cloud Build almacenados en el nivel superior. La utilidad de sincronización de DAG y sus requisitos se encuentran en el directorioutils
.
Crea un trabajo de verificación previo al envío y pruebas de unidades
El primer trabajo de Cloud Build ejecuta una verificación del envío previo, que ejecuta pruebas de unidades para tus DAG.
Cómo agregar pruebas de unidades
Si aún no lo hiciste, crea pruebas de unidades para tus DAG. Guarda estas pruebas junto con los DAG de tu repositorio, cada una con el sufijo _test
. Por ejemplo, el archivo de prueba para el DAG en example_dag.py
es example_dag_test.py
. Estas son las
pruebas que se ejecutan como una verificación del envío previo en tu repositorio.
Crea la configuración de YAML de Cloud Build para la verificación previa al envío
En tu repositorio, crea un archivo YAML llamado test-dags.cloudbuild.yaml
que configure tu trabajo de Cloud Build para las verificaciones del envío previo. En él, hay tres pasos:
- Instala las dependencias que necesitan tus DAG.
- Instala las dependencias que necesitan tus pruebas de unidades.
- Ejecuta las pruebas del DAG.
Crea el activador de Cloud Build para la verificación previa al envío
Sigue la guía Compila repositorios desde GitHub para crear un activador basado en una app de GitHub con la siguiente configuración:
Nombre:
test-dags
Evento: solicitud de extracción
Fuente: Repositorio: elige tu repositorio
Fuente: Rama base:
^main$
(si es necesario, cambiamain
por el nombre de la rama base de tu repositorio)Fuente (control de comentarios): no obligatorio
Configuración de compilación: Archivo de configuración de Cloud Build:
/test-dags.cloudbuild.yaml
(la ruta de acceso al archivo de compilación)
Crea un trabajo de sincronización de DAG y agrega una secuencia de comandos de utilidad de DAG
A continuación, configura un trabajo de Cloud Build que ejecute una secuencia de comandos de utilidad de DAG. La secuencia de comandos de utilidad en este trabajo sincroniza tus DAG con tu entorno de Cloud Composer después de que se combinen con la rama principal de tu repositorio.
Agrega la secuencia de comandos de utilidad de DAG
Agregar la secuencia de comandos de utilidad del DAG a tu repositorio Con esta secuencia de comandos de utilidad, se copian todos los archivos DAG del directorio dags/
de tu repositorio en un directorio temporal y se ignoran todos los archivos de Python que no son de DAG. Luego, la secuencia de comandos usa la biblioteca cliente de Cloud Storage para subir todos los archivos de ese directorio temporal al directorio dags/
en el bucket de tu entorno de Cloud Composer.
Crea la configuración de YAML de Cloud Build para sincronizar DAG
En tu repositorio, crea un archivo YAML llamado add-dags-to-composer.cloudbuild.yaml
que configure tu trabajo de Cloud Build para sincronizar los DAG. En él, hay dos pasos:
Instalar las dependencias que necesita la secuencia de comandos de utilidad de DAG
Ejecuta la secuencia de comandos de utilidad para sincronizar los DAG en tu repositorio con tu entorno de Cloud Composer.
Crea el activador de Cloud Build
Sigue la guía Compila repositorios desde GitHub para crear un activador basado en una app de GitHub con la siguiente configuración:
Nombre:
add-dags-to-composer
Evento: Enviar a una rama
Fuente: Repositorio: elige tu repositorio
Fuente: Rama base:
^main$
(si es necesario, cambiamain
por el nombre de la rama base de tu repositorio)Fuente: filtro de archivos incluidos (glob):
dags/**
Configuración de compilación: Archivo de configuración de Cloud Build:
/add-dags-to-composer.cloudbuild.yaml
(la ruta de acceso al archivo de compilación)
En la Configuración avanzada, agrega dos variables de sustitución:
_DAGS_DIRECTORY
: Es el directorio en el que se encuentran los DAG en tu repositorio. Si usas el repositorio de ejemplo de esta guía, esdags/
._DAGS_BUCKET
: Es el bucket de Cloud Storage que contiene el directoriodags/
en tu entorno de desarrollo de Cloud Composer. Omite el prefijogs://
. Por ejemplo:us-central1-example-env-1234ab56-bucket
Prueba tu canalización de CI/CD
En esta sección, sigue un flujo de desarrollo de DAG que usa tus activadores de Cloud Build recién creados.
Ejecuta un trabajo de envío previo
Crea una solicitud de extracción en tu rama principal para probar la compilación. Ubica la verificación de envío previo en la página. Haz clic en Detalles y elige Ver más detalles en Google Cloud Build para ver los registros de compilación en la consola de Google Cloud.
Si falló la verificación del envío previo, consulta Cómo abordar fallas de compilación.
Valida que el DAG funcione en tu entorno de desarrollo de Cloud Composer
Una vez que se apruebe tu solicitud de extracción, combínala con tu rama principal. Usa la
consola de Google Cloud para
ver los resultados de tu compilación. Si tienes muchos activadores de Cloud Build, puedes filtrar las compilaciones según el nombre del activador add-dags-to-composer
.
Después de que el trabajo de sincronización de Cloud Build se realice de forma correcta, el DAG sincronizado aparecerá en tu entorno de desarrollo de Cloud Composer. Allí puedes validar que el DAG funcione como se espera.
Agrega el DAG a tu entorno de producción
Después de que el DAG funcione como se espera, agrégalo de forma manual a tu entorno de producción. Para hacerlo, sube el archivo DAG al directorio dags/
en el bucket de tu entorno de producción de Cloud Composer.
Si tu trabajo de sincronización del DAG falló o si el DAG no se comporta como se espera en tu entorno de desarrollo de Cloud Composer, consulta cómo abordar las fallas de compilación.
Cómo abordar fallas de compilación
En esta sección, se explica cómo abordar situaciones comunes de fallas de compilación.
¿Qué sucede si falla la verificación antes del envío?
En la solicitud de extracción, haz clic en Detalles y elige Ver más detalles en Google Cloud Build para ver los registros de compilación en la consola de Google Cloud. Usa estos registros para depurar el problema de tu DAG. Una vez que hayas resuelto los problemas, confirma la solución y envíala a tu rama. La verificación del envío previo se vuelve a ejecutar y puedes seguir iterando con los registros como herramienta de depuración.
¿Qué sucede si mi trabajo de sincronización de DAG falla?
Usa la consola de Google Cloud para ver los resultados de tu compilación. Si tienes muchos activadores de Cloud Build, puedes filtrar las compilaciones según el nombre del activador add-dags-to-composer
. Examina los registros del trabajo de compilación y resuelve los errores. Si necesitas ayuda adicional para resolver los errores, utiliza los canales de asistencia.
¿Qué sucede si mi DAG no funciona correctamente en mi entorno de Cloud Composer?
Si el DAG no funciona como se espera en tu entorno de desarrollo de Cloud Composer, no lo promuevas de forma manual a tu entorno de producción de Cloud Composer. Como alternativa, toma una de las siguientes medidas:
- Revierte la solicitud de extracción con los cambios que dañaron el DAG para restablecerlo al estado inmediatamente anterior a los cambios (esto también revierte todos los demás archivos en esa solicitud de extracción).
- Crea una solicitud de extracción nueva para revertir de forma manual los cambios en el DAG dañado.
- Crea una solicitud de extracción nueva y corrige los errores en tu DAG.
Seguir cualquiera de estos pasos activa una nueva verificación de envío previo y, después de la combinación, el trabajo de sincronización de DAG.