Cloud Composer 1 | Cloud Composer 2
En esta página, se describe cómo usar Cloud Functions para activar los DAG de Cloud Composer en respuesta a eventos.
Apache Airflow está diseñado para ejecutar DAG de forma periódica, pero también puedes activar los DAG en respuesta a eventos. Una forma de hacerlo es usar Cloud Functions para activar los DAG de Cloud Composer cuando se produce un evento especificado.
En el ejemplo de esta guía, se ejecuta un DAG cada vez que se produce un cambio en un bucket de Cloud Storage. Los cambios en cualquier objeto de un bucket activan una función. Esta función realiza una solicitud a la API de REST de Airflow del entorno de Cloud Composer. Airflow procesa esta solicitud y ejecuta un DAG. El DAG genera información sobre el cambio.
Antes de comenzar
Verifica la configuración de red de tu entorno
Esta solución no funciona en las configuraciones de IP privada ni de los Controles del servicio de VPC, ya que no es posible configurar la conectividad de Cloud Functions al servidor web de Airflow con estos parámetros de configuración.
En Cloud Composer 2, puedes usar otro enfoque: Activar DAG mediante Cloud Functions y mensajes de Pub/Sub
Habilita las API para tu proyecto.
Console
Enable the Cloud Composer and Cloud Functions APIs.
gcloud
Enable the Cloud Composer and Cloud Functions APIs:
gcloud services enable cloudfunctions.googleapis.comcomposer.googleapis.com
Habilita la API de REST de Airflow
Según tu versión de Airflow, ejecuta el siguiente comando:
- Para Airflow 2, la API de REST estable ya está habilitada de forma predeterminada. Si tu entorno tiene inhabilitada la API estable, habilita la API estable de REST.
- Para Airflow 1, habilita la API de REST experimental.
Permitir llamadas a la API de REST de Airflow con el control de acceso de Webserver
Cloud Functions puede comunicarse con la API de REST de Airflow con una dirección IPv4 o IPv6.
Si no estás seguro de cuál será el rango de IP de llamada, usa una opción de configuración
predeterminada en el Control de acceso del servidor web que es All IP addresses have access (default)
para no bloquear accidentalmente tus Cloud Functions.
Crea un bucket de Cloud Storage
Este ejemplo activa un DAG en respuesta a los cambios en un bucket de Cloud Storage. Crea un bucket nuevo para usar en este ejemplo.
Obtén la URL del servidor web de Airflow
En este ejemplo, se realizan solicitudes a la API de REST al extremo del servidor web de Airflow.
Debes usar la parte de la URL de la interfaz web de Airflow antes de .appspot.com
en el código de Cloud Function.
Console
En la consola de Google Cloud, ve a la página Entornos.
Haz clic en el nombre de tu entorno.
En la página Detalles del entorno, ve a la pestaña Configuración del entorno.
La URL del servidor web de Airflow aparece en el elemento de la IU web de Airflow.
gcloud
Ejecuta el siguiente comando:
gcloud composer environments describe ENVIRONMENT_NAME \
--location LOCATION \
--format='value(config.airflowUri)'
Reemplaza lo siguiente:
ENVIRONMENT_NAME
por el nombre del entorno.LOCATION
por la región en la que se encuentra el entorno
Obtén el ID de cliente del proxy de IAM
Para realizar una solicitud al extremo de API de REST de Airflow, la función requiere el ID de cliente del proxy de Identity and Access Management que protege el servidor web de Airflow.
Cloud Composer no proporciona esta información directamente. En cambio, realiza una solicitud no autenticada al servidor web de Airflow y captura el ID de cliente de la URL de redireccionamiento.
cURL
curl -v AIRFLOW_URL 2>&1 >/dev/null | grep -o "client_id\=[A-Za-z0-9-]*\.apps\.googleusercontent\.com"
Reemplaza AIRFLOW_URL
por la URL de la interfaz web de Airflow.
En el resultado, busca la string que sigue a client_id
. Por ejemplo:
client_id=836436932391-16q2c5f5dcsfnel77va9bvf4j280t35c.apps.googleusercontent.com
Python
Guarda el siguiente código en un archivo llamado get_client_id.py
. Completa tus valores para project_id
, location
y composer_environment
. Luego, ejecuta el código en Cloud Shell o en tu entorno local.
Sube un DAG a tu entorno
Sube un DAG a tu entorno. En el siguiente ejemplo de DAG, se muestra la configuración de ejecución del DAG recibido. Debes activar este DAG desde una función que crearás más adelante en esta guía.
Implementa una función de Cloud Functions que active el DAG
Puedes implementar una Cloud Function con tu lenguaje preferido compatible con Cloud Functions o Cloud Run. En este instructivo, se muestra una Cloud Function implementada en Python y Java.
Especifica los parámetros de configuración de Cloud Functions
Activador Para este ejemplo, selecciona un activador que funcione cuando se cree un objeto nuevo en un bucket o se reemplace un objeto existente.
Tipo de activador Cloud Storage
Tipo de evento Finalizar/Crear
Bucket Selecciona un bucket que debe activar esta función.
Volver a intentar en caso de error Te recomendamos inhabilitar esta opción para los fines de este ejemplo. Si usas tu propia función en un entorno de producción, habilita esta opción para controlar errores transitorios.
Cuenta de servicio del entorno de ejecución, en la sección Configuración del entorno de ejecución, la compilación, las conexiones y la seguridad Usa una de las siguientes opciones, según tus preferencias:
Selecciona Cuenta de servicio predeterminada de Compute Engine. Con los permisos predeterminados de IAM, esta cuenta puede ejecutar funciones que acceden a los entornos de Cloud Composer.
Crea una cuenta de servicio personalizada que tenga la función de usuario de Composer y especifícala como una cuenta de servicio del entorno de ejecución para esta función. Esta opción sigue el principio de privilegio mínimo.
Entorno de ejecución y punto de entrada, en el paso Code. Cuando agregues código para este ejemplo, selecciona el entorno de ejecución de Python 3.7 o una versión posterior y especifica
trigger_dag
como el punto de entrada.
Agrega requisitos
Especifica las dependencias en el archivo requirements.txt
:
Coloca el siguiente código en el archivo main.py
y realiza los siguientes reemplazos:
Reemplaza el valor de la variable
client_id
por el valorclient_id
que obtuviste antes.Reemplaza el valor de la variable
webserver_id
por el ID de proyecto de tu usuario, que es parte de la URL de la interfaz web de Airflow antes de.appspot.com
. Ya obtuviste la URL de la interfaz web de Airflow.Especifica la versión de la API de REST de Airflow que usas:
- Si usas la API de REST de Airflow estable, establece la variable
USE_EXPERIMENTAL_API
enFalse
. - Si usas la API de REST de Airflow experimental, no es necesario realizar cambios. La variable
USE_EXPERIMENTAL_API
ya está configurada comoTrue
.
- Si usas la API de REST de Airflow estable, establece la variable
Prueba la función
Para verificar que tu función y DAG funcionen según lo previsto, haz lo siguiente:
- Espera hasta que se implemente la función.
- Sube un archivo a tu bucket de Cloud Storage. Como alternativa, puedes activar la función de forma manual. Para ello, selecciona la acción Probar la función para ella en la consola de Google Cloud.
- Consulta la página del DAG en la interfaz web de Airflow. El DAG debe tener una DAG activa o ya completada.
- En la IU de Airflow, verifica los registros de tareas de esta ejecución. Deberías ver que la tarea
print_gcs_info
genera los datos recibidos de la función a los registros:
[2021-04-04 18:25:44,778] {bash_operator.py:154} INFO - Output:
[2021-04-04 18:25:44,781] {bash_operator.py:158} INFO - Triggered from GCF:
{bucket: example-storage-for-gcf-triggers, contentType: text/plain,
crc32c: dldNmg==, etag: COW+26Sb5e8CEAE=, generation: 1617560727904101,
... }
[2021-04-04 18:25:44,781] {bash_operator.py:162} INFO - Command exited with
return code 0h
¿Qué sigue?
- Accede a la IU de Airflow
- Accede a la API de REST de Airflow
- Escribir DAG
- Escribe Cloud Functions
- Activadores de Cloud Storage