Activar DAGs de Cloud Composer con funciones de Cloud Run y la API REST de Airflow

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

En esta página se describe cómo usar funciones de Cloud Run para activar DAGs de Cloud Composer en respuesta a eventos.

Nota: También puedes activar DAGs usando solo la API REST de Airflow.

Apache Airflow se ha diseñado para ejecutar DAGs de forma periódica, pero también puedes activarlos en respuesta a eventos. Una forma de hacerlo es usar funciones de Cloud Run para activar DAGs de Cloud Composer cuando se produzca un evento específico.

En el ejemplo de esta guía se ejecuta un DAG cada vez que se produce un cambio en un segmento de Cloud Storage. Los cambios en cualquier objeto de un contenedor activan una función. Esta función hace una solicitud a la API REST de Airflow de tu entorno de Cloud Composer. Airflow procesa esta solicitud y ejecuta un DAG. El DAG muestra información sobre el cambio.

Nota: En una guía alternativa se explica cómo crear una función que active un DAG cuando se envíe un mensaje a un tema de Pub/Sub.

Antes de empezar

Comprobar la configuración de red de tu entorno

Esta solución no funciona en las configuraciones de IP privada y Controles de Servicio de VPC porque no es posible configurar la conectividad de las funciones de Cloud Run al servidor web de Airflow en estas configuraciones.

En Cloud Composer 2, puedes usar otro método: Activar DAGs mediante funciones de Cloud Run y mensajes de Pub/Sub.

Habilitar APIs en tu proyecto

Consola

Enable the Cloud Composer and Cloud Run functions APIs.

Enable the APIs

gcloud

Enable the Cloud Composer and Cloud Run functions APIs:

gcloud services enable cloudfunctions.googleapis.com composer.googleapis.com

Habilitar la API REST de Airflow

En función de tu versión de Airflow:

• En Airflow 2, la API REST estable ya está habilitada de forma predeterminada. Si tu entorno tiene la API estable inhabilitada, habilita la API REST estable.
• En Airflow 1, habilita la API REST experimental.

Permitir llamadas a la API REST de Airflow mediante el control de acceso al servidor web

Las funciones de Cloud Run pueden acceder a la API REST de Airflow mediante una dirección IPv4 o IPv6.

Si no sabes cuál será el intervalo de IPs de llamada, usa una opción de configuración predeterminada en el control de acceso al servidor web, que es All IP addresses have access (default) para no bloquear accidentalmente tus funciones de Cloud Run.

Crea un segmento de Cloud Storage

En este ejemplo se activa un DAG en respuesta a los cambios que se produzcan en un segmento de Cloud Storage. Crea un segmento para usarlo en este ejemplo.

Nota: No uses los buckets de entorno de Cloud Composer, ya que esto podría provocar que la función se activara varias veces por segundo. Para este ejemplo, te recomendamos que crees un contenedor independiente.

Obtener la URL del servidor web de Airflow

En este ejemplo se realizan solicitudes a la API REST al endpoint del servidor web de Airflow. Usa la parte de la URL de la interfaz web de Airflow que va antes de .appspot.com en el código de Cloud Functions.

Consola

1. En la Google Cloud consola, ve a la página Entornos.

   Ir a Entornos

2. Haz clic en el nombre de tu entorno.

3. En la página Detalles del entorno, vaya a la pestaña Configuración del entorno.

4. La URL del servidor web de Airflow se indica en el elemento Interfaz web de Airflow.

gcloud

Ejecuta el siguiente comando:

gcloud composer environments describe ENVIRONMENT_NAME \
    --location LOCATION \
    --format='value(config.airflowUri)'

Sustituye:

• ENVIRONMENT_NAME con el nombre del entorno.
• LOCATION con la región en la que se encuentra el entorno.

Obtener el client_id del proxy de IAM

Precaución: Esta guía es para Cloud Composer 1 y los pasos descritos no funcionarán en Cloud Composer 2. En su lugar, sigue las instrucciones de la página Activar DAGs con funciones de Cloud Run para Cloud Composer 2.

Para enviar una solicitud al endpoint de la API REST de Airflow, la función requiere el ID de cliente del proxy de gestión de identidades y accesos que protege el servidor web de Airflow.

Cloud Composer no proporciona esta información directamente. En su lugar, haz una solicitud no autenticada al servidor web de Airflow y captura el ID de cliente de la URL de redirección:

cURL

curl -v AIRFLOW_URL 2>&1 >/dev/null | grep -o "client_id\=[A-Za-z0-9-]*\.apps\.googleusercontent\.com"

Sustituye AIRFLOW_URL por la URL de la interfaz web de Airflow.

En el resultado, busca la cadena 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. Rellena los valores de project_id, location y composer_environment y, a continuación, ejecuta el código en Cloud Shell o en tu entorno local.

# This script is intended to be used with Composer 1 environments
# In Composer 2, the Airflow Webserver is not in the tenant project
# so there is no tenant client ID
# See https://cloud.google.com/composer/docs/composer-2/environment-architecture
# for more details
import google.auth
import google.auth.transport.requests
import requests
import six.moves.urllib.parse

# Authenticate with Google Cloud.
# See: https://cloud.google.com/docs/authentication/getting-started
credentials, _ = google.auth.default(
    scopes=["https://www.googleapis.com/auth/cloud-platform"]
)
authed_session = google.auth.transport.requests.AuthorizedSession(credentials)

# project_id = 'YOUR_PROJECT_ID'
# location = 'us-central1'
# composer_environment = 'YOUR_COMPOSER_ENVIRONMENT_NAME'

environment_url = (
    "https://composer.googleapis.com/v1beta1/projects/{}/locations/{}"
    "/environments/{}"
).format(project_id, location, composer_environment)
composer_response = authed_session.request("GET", environment_url)
environment_data = composer_response.json()
composer_version = environment_data["config"]["softwareConfig"]["imageVersion"]
if "composer-1" not in composer_version:
    version_error = (
        "This script is intended to be used with Composer 1 environments. "
        "In Composer 2, the Airflow Webserver is not in the tenant project, "
        "so there is no tenant client ID. "
        "See https://cloud.google.com/composer/docs/composer-2/environment-architecture for more details."
    )
    raise (RuntimeError(version_error))
airflow_uri = environment_data["config"]["airflowUri"]

# The Composer environment response does not include the IAP client ID.
# Make a second, unauthenticated HTTP request to the web server to get the
# redirect URI.
redirect_response = requests.get(airflow_uri, allow_redirects=False)
redirect_location = redirect_response.headers["location"]

# Extract the client_id query parameter from the redirect.
parsed = six.moves.urllib.parse.urlparse(redirect_location)
query_string = six.moves.urllib.parse.parse_qs(parsed.query)
print(query_string["client_id"][0])

Subir un DAG a tu entorno

Sube un DAG a tu entorno. El siguiente ejemplo de DAG muestra la configuración de la ejecución del DAG recibida. Activarás este DAG desde una función, que crearás más adelante en esta guía.

import datetime

import airflow
from airflow.operators.bash import BashOperator


with airflow.DAG(
    "composer_sample_trigger_response_dag",
    start_date=datetime.datetime(2021, 1, 1),
    # Not scheduled, trigger only
    schedule_interval=None,
) as dag:
    # Print the dag_run's configuration, which includes information about the
    # Cloud Storage object change.
    print_gcs_info = BashOperator(
        task_id="print_gcs_info", bash_command="echo {{ dag_run.conf }}"
    )

Desplegar una función de Cloud Functions que active el DAG

Puedes desplegar una función de Cloud con el lenguaje que prefieras de los que admiten las funciones de Cloud Run o Cloud Run. En este tutorial se muestra una función de Cloud implementada en Python y Java.

Especificar los parámetros de configuración de la función de Cloud

• Activador. En este ejemplo, selecciona un activador que funcione cuando se cree un objeto en un segmento o cuando se sobrescriba un objeto.

  • Tipo de activador. Cloud Storage.

  • Tipo de evento. Finalizar o crear.

  • Categoría. Selecciona un contenedor que deba activar esta función.

  • Reintentar tras fallo. Te recomendamos que inhabilite esta opción para este ejemplo. Si usas tu propia función en un entorno de producción, habilita esta opción para gestionar los errores transitorios.

• Cuenta de servicio de entorno de ejecución, en la sección Ajustes de entorno de ejecución, compilación, conexiones y seguridad. Usa una de las siguientes opciones, según tus preferencias:

  • Selecciona Cuenta de servicio predeterminada de Compute Engine. Con los permisos de IAM predeterminados, esta cuenta puede ejecutar funciones que accedan a entornos de Cloud Composer.

  • Crea una cuenta de servicio personalizada que tenga el rol Usuario de Composer y especifícala como cuenta de servicio de tiempo de ejecución para esta función. Esta opción sigue el principio de mínimos privilegios.

• Tiempo de ejecución y punto de entrada, en el paso Código. Cuando añadas el código de este ejemplo, selecciona el entorno de ejecución Python 3.7 o una versión posterior y especifica trigger_dag como punto de entrada.

Añadir requisitos

Especifica las dependencias en el archivo requirements.txt:

requests-toolbelt==1.0.0
google-auth==2.38.0
google-cloud-pubsub==2.28.0

Coloca el siguiente código en el archivo main.py y haz las siguientes sustituciones:

• Sustituye el valor de la variable client_id por el valor client_id que has obtenido anteriormente.

• Sustituye el valor de la variable webserver_id por el ID de tu proyecto de arrendatario, que forma parte de la URL de la interfaz web de Airflow antes de .appspot.com. Ya has obtenido la URL de la interfaz web de Airflow.

• Especifica la versión de la API REST de Airflow que usas:

  • Si usas la API REST estable de Airflow, asigna el valor False a la variable USE_EXPERIMENTAL_API.
  • Si usas la API REST experimental de Airflow, no tienes que hacer ningún cambio. La variable USE_EXPERIMENTAL_API ya está definida como True.

Nota: En las versiones de Airflow anteriores a la 2.3.0, la base de datos de Airflow limita la longitud del campo de correo a 64 caracteres. A veces, las cuentas de servicio tienen direcciones de correo electrónico de más de 64 caracteres. Para acceder a la API REST de Airflow con una cuenta de servicio de este tipo, usa la solución alternativa que se describe en Acceder a la API REST de Airflow con una cuenta de servicio.

from google.auth.transport.requests import Request
from google.oauth2 import id_token
import requests


IAM_SCOPE = "https://www.googleapis.com/auth/iam"
OAUTH_TOKEN_URI = "https://www.googleapis.com/oauth2/v4/token"
# If you are using the stable API, set this value to False
# For more info about Airflow APIs see https://cloud.google.com/composer/docs/access-airflow-api
USE_EXPERIMENTAL_API = True


def trigger_dag(data, context=None):
    """Makes a POST request to the Composer DAG Trigger API

    When called via Google Cloud Functions (GCF),
    data and context are Background function parameters.

    For more info, refer to
    https://cloud.google.com/functions/docs/writing/background#functions_background_parameters-python

    To call this function from a Python script, omit the ``context`` argument
    and pass in a non-null value for the ``data`` argument.

    This function is currently only compatible with Composer v1 environments.
    """

    # Fill in with your Composer info here
    # Navigate to your webserver's login page and get this from the URL
    # Or use the script found at
    # https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/composer/rest/get_client_id.py
    client_id = "YOUR-CLIENT-ID"
    # This should be part of your webserver's URL:
    # {tenant-project-id}.appspot.com
    webserver_id = "YOUR-TENANT-PROJECT"
    # The name of the DAG you wish to trigger
    dag_name = "composer_sample_trigger_response_dag"

    if USE_EXPERIMENTAL_API:
        endpoint = f"api/experimental/dags/{dag_name}/dag_runs"
        json_data = {"conf": data, "replace_microseconds": "false"}
    else:
        endpoint = f"api/v1/dags/{dag_name}/dagRuns"
        json_data = {"conf": data}
    webserver_url = "https://" + webserver_id + ".appspot.com/" + endpoint
    # Make a POST request to IAP which then Triggers the DAG
    make_iap_request(webserver_url, client_id, method="POST", json=json_data)


# This code is copied from
# https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/iap/make_iap_request.py
# START COPIED IAP CODE
def make_iap_request(url, client_id, method="GET", **kwargs):
    """Makes a request to an application protected by Identity-Aware Proxy.
    Args:
      url: The Identity-Aware Proxy-protected URL to fetch.
      client_id: The client ID used by Identity-Aware Proxy.
      method: The request method to use
              ('GET', 'OPTIONS', 'HEAD', 'POST', 'PUT', 'PATCH', 'DELETE')
      **kwargs: Any of the parameters defined for the request function:
                https://github.com/requests/requests/blob/master/requests/api.py
                If no timeout is provided, it is set to 90 by default.
    Returns:
      The page body, or raises an exception if the page couldn't be retrieved.
    """
    # Set the default timeout, if missing
    if "timeout" not in kwargs:
        kwargs["timeout"] = 90

    # Obtain an OpenID Connect (OIDC) token from metadata server or using service
    # account.
    google_open_id_connect_token = id_token.fetch_id_token(Request(), client_id)

    # Fetch the Identity-Aware Proxy-protected URL, including an
    # Authorization header containing "Bearer " followed by a
    # Google-issued OpenID Connect token for the service account.
    resp = requests.request(
        method,
        url,
        headers={"Authorization": "Bearer {}".format(google_open_id_connect_token)},
        **kwargs,
    )
    if resp.status_code == 403:
        raise Exception(
            "Service account does not have permission to "
            "access the IAP-protected application."
        )
    elif resp.status_code != 200:
        raise Exception(
            "Bad response from application: {!r} / {!r} / {!r}".format(
                resp.status_code, resp.headers, resp.text
            )
        )
    else:
        return resp.text


# END COPIED IAP CODE

Probar la función

Para comprobar que tu función y tu DAG funcionan correctamente, haz lo siguiente:

1. Espera a que se implemente la función.
2. Sube un archivo a tu depósito de Cloud Storage. También puedes activar la función manualmente seleccionando la acción Probar la función en la consola de Google Cloud .
3. Consulta la página del DAG en la interfaz web de Airflow. El DAG debe tener una ejecución activa o ya completada.
4. En la interfaz de usuario de Airflow, consulta los registros de tareas de esta ejecución. Deberías ver que la tarea print_gcs_info envía 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

Siguientes pasos

• Acceder a la interfaz de usuario de Airflow
• Acceder a la API REST de Airflow
• Escribir DAGs
• Escribir Cloud Run Functions
• Triggers de Cloud Storage