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 implementar DAG en tu entorno de Cloud Composer desde tu GitHub en un repositorio de confianza.
Si solo quieres sincronizar datos de otros servicios, consulta Transfiere datos desde otros servicios.
Descripción general de la canalización de CI/CD
La canalización de CI/CD que prueba, sincroniza e implementa DAGs tiene los siguientes 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.
Se aprobó tu solicitud de extracción y se fusionó en la rama principal de tu repositorio.
Cloud Build sincroniza tus datos de entorno de Cloud Composer con estos cambios nuevos.
Verificas que el DAG se comporte como se espera en tu entorno de desarrollo.
Si tu DAG funciona como se espera, súbela a tu entorno de producción de Cloud Composer.
Objetivos
Antes de comenzar
En esta guía, se da por sentado que trabajas con dos entornos de Cloud Composer idénticos: un entorno de desarrollo y un entorno de producción.
A los efectos 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 usas no es un entorno de producción.
En esta guía, se supone que tienes tus DAG y sus pruebas almacenados en un GitHub en un repositorio de confianza.
En la canalización de CI/CD de ejemplo, se muestra el contenido de un repositorio de ejemplo. Los DAG y las pruebas se almacenados en el directorio
dags/
, con los archivos de requisitos, las restricciones de configuración de Terraform 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 enutils
.
Crea un trabajo de verificación previa al envío y pruebas de unidades
El primer trabajo de Cloud Build ejecuta una verificación previa al envío, que ejecuta la unidad pruebas 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 el
DAG en tu repositorio, cada uno con el sufijo _test
. Por ejemplo, la prueba
del DAG en example_dag.py
es example_dag_test.py
. Estos son los
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 previas al envío. 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 las instrucciones de la guía Cómo compilar repositorios desde GitHub para crear un activador basado en la 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$
(cambiamain
por el nombre de tu la rama base del repositorio, si es necesario)Fuente: Control de comentarios: no es obligatorio
Configuración de compilación: Archivo de configuración de Cloud Build:
/test-dags.cloudbuild.yaml
(la ruta de acceso a tu 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 DAGs. El de utilidad en este trabajo sincroniza tus DAG con tu El entorno de Cloud Composer después de combinarlos con la rama principal en tu repositorio.
Agrega la secuencia de comandos de utilidad de DAG
Agregar la secuencia de comandos de utilidad del DAG a tu repositorio Esta secuencia de comandos de utilidad copia todos los archivos DAG del directorio dags/
de tu
repositorio en un directorio temporal y omite todos los archivos Python que no sean DAG. El
de comandos usa la biblioteca cliente de Cloud Storage para subir todos los archivos
desde ese directorio temporal al directorio dags/
de tu
El bucket del 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 DAG. En él, hay dos pasos:
Instala las dependencias que necesita la secuencia de comandos de la utilidad de DAG.
Ejecuta la secuencia de comandos de utilidad para sincronizar los DAG de tu repositorio con tu entorno de Cloud Composer.
Crea el activador de Cloud Build
Sigue las instrucciones de la guía Cómo compilar repositorios desde GitHub para crear un activador basado en la 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$
(cambiamain
al nombre de la rama base de tu repositorio, si es necesario)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 a tu 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 la Directoriodags/
en tu Cloud Composer de desarrollo en un entorno de nube. 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 los activadores de Cloud Build que creaste recientemente.
Ejecuta un trabajo previo al envío
Crea una solicitud de extracción en tu rama principal para probar la compilación. Busca la verificación previa al envío en la página. Haz clic en Detalles y elige Consulta más detalles en Google Cloud Build para ver los registros de tu 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 la solicitud de extracción, combínala con la rama principal. Usa el
la consola de Google Cloud para
ver los resultados de tu compilación. Si tienes muchos
activadores de Cloud Build, puedes filtrar tus compilaciones según el nombre del activador
add-dags-to-composer
.
Una vez que se complete correctamente la tarea de sincronización de Cloud Build, el DAG sincronizado aparecerá en tu entorno de Cloud Composer de desarrollo. Allí, puedes confirmar que el DAG funciona como se espera.
Agrega el DAG a tu entorno de producción
Una vez que el DAG funcione según lo esperado, agrégalo de forma manual a tu entorno de producción. Para ello, sigue estos pasos:
subir el archivo DAG
al directorio dags/
en tu Cloud Composer de producción
en el bucket de tu entorno.
Si tu trabajo de sincronización de DAG falló o si tu DAG no se comporta como se espera en tu entorno de Cloud Composer de desarrollo, 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 mi verificación previa al envío falla?
En tu 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 ayudarte a depurar el problema con tu DAG. Cuando resuelvas los problemas, confirma la solución y envíala a tu . La verificación previa al envío 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 muchas
de Cloud Build, puedes filtrar tus 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
canales de asistencia.
¿Qué sucede si mi DAG no funciona correctamente en mi entorno de Cloud Composer?
Si tu DAG no funciona como se espera en tu desarrollo de Cloud Composer, no asciendas manualmente el DAG 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 tu DAG para restablecerlo al estado inmediatamente antes de 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 nueva solicitud de extracción para corregir los errores en tu DAG.
Seguir cualquiera de estos pasos activa una nueva verificación previa al envío y, luego de la combinación, el trabajo de sincronización de DAG.