Ejecuta un entorno de Airflow local con la herramienta de CLI de desarrollo local de Composer

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

En esta sección, se describe cómo crear, configurar y ejecutar un entorno de Airflow local con la herramienta de CLI de desarrollo local de Composer.

Información acerca de la herramienta de la CLI de desarrollo local de Composer

La herramienta de CLI de desarrollo local de Composer optimiza el desarrollo de DAG de Apache Airflow para Cloud Composer, ya que ejecuta un entorno de Airflow de forma local. Este entorno de Airflow local usa una imagen de una versión específica de Cloud Composer.

Puedes crear un entorno de Airflow local basado en un entorno de Cloud Composer existente. En este caso, el entorno de Airflow local toma la lista de paquetes de PyPI instalados y los nombres de las variables de entorno de tu entorno de Cloud Composer.

Puedes usar este entorno de Airflow local para fines de prueba y desarrollo, como probar un código DAG nuevo, paquetes de PyPI o opciones de configuración de Airflow.

Antes de comenzar

  • La herramienta de CLI de desarrollo local de Composer crea entornos de Airflow locales en un directorio en el que ejecutas el comando composer-dev create. Para acceder a tu entorno local de Airflow más adelante, ejecuta los comandos de la herramienta en la ruta en la que creaste el entorno local inicialmente. Todos los datos del entorno local se almacenan en un subdirectorio de la ruta en la que creaste el entorno local: ./composer/<local_environment_name>.

  • Tu computadora debe tener suficiente espacio en el disco para almacenar las imágenes de Cloud Composer. La herramienta de CLI de desarrollo local de Composer almacena un archivo de imagen para cada versión de Cloud Composer. Por ejemplo, si tienes dos entornos de Airflow locales con diferentes versiones de Cloud Composer, la herramienta de CLI de desarrollo local de Composer almacena dos imágenes de Cloud Composer.

  • La herramienta de CLI de desarrollo local de Composer usa un resultado con colores. Puedes inhabilitar el resultado coloreado con la variable NO_COLOR=1: NO_COLOR=1 composer-dev <other commands>.

  • Si solo tienes un entorno local, puedes omitir su nombre de todos los comandos composer-dev, excepto run-airflow-cmd.

  • Instala las dependencias de la herramienta de la CLI de desarrollo local de Composer:

  • Instala Docker. Docker debe estar instalado y en ejecución en el sistema local. Para verificar que Docker esté en ejecución, puedes ejecutar cualquier comando de la CLI de Docker, como docker ps.

Configura las credenciales

Si aún no lo hiciste, obtén credenciales de usuario nuevas para usar como credenciales predeterminadas de la aplicación:

gcloud auth application-default login

Accede a gcloud CLI con tu Cuenta de Google:

gcloud auth login

Todas las llamadas a la API que realiza la herramienta de CLI de desarrollo local de Composer y los DAGs se ejecutan desde la cuenta que usas en gcloud CLI. Por ejemplo, si un DAG en tu entorno local de Airflow lee el contenido de un bucket de Cloud Storage, esta cuenta debe tener permisos para acceder al bucket. Esto es diferente de los entornos de Cloud Composer, en los que la cuenta de servicio de un entorno realiza las llamadas.

Instala la herramienta de la CLI de desarrollo local de Composer

Clona el repositorio de la CLI de desarrollo local de Composer:

git clone https://github.com/GoogleCloudPlatform/composer-local-dev.git

En el directorio de nivel superior del repositorio clonado, ejecuta lo siguiente:

pip install .

Según la configuración de pip, es posible que la ruta de acceso en la que se instaló la herramienta no esté en la variable PATH. Si este es el caso, pip muestra un mensaje de advertencia. Puedes usar la información de este mensaje de advertencia para agregar este directorio a la variable PATH en tu sistema operativo.

Crea un entorno de Airflow local con una versión específica de Cloud Composer

Para obtener una lista de las versiones disponibles de Cloud Composer, ejecuta el siguiente comando:

composer-dev list-available-versions --include-past-releases --limit 10

Para crear un entorno local de Airflow con parámetros predeterminados, ejecuta lo siguiente:

composer-dev create \
  --from-image-version IMAGE_VERSION \
  LOCAL_ENVIRONMENT_NAME

Otros parámetros:

composer-dev create \
  --from-image-version IMAGE_VERSION \
  --project PROJECT_ID \
  --port WEB_SERVER_PORT \
  --dags-path LOCAL_DAGS_PATH \
  LOCAL_ENVIRONMENT_NAME

Reemplaza lo siguiente:

  • IMAGE_VERSION por el nombre de la imagen de Cloud Composer.
  • PROJECT_ID por el ID del proyecto.
  • WEB_SERVER_PORT con el puerto en el que debe escuchar el servidor web de Airflow.
  • LOCAL_DAGS_PATH con la ruta de acceso a un directorio local en el que se encuentran los archivos de DAG.
  • LOCAL_ENVIRONMENT_NAME por el nombre de este entorno local de Airflow.

Ejemplo:

composer-dev create \
  --from-image-version composer-2.11.1-airflow-2.10.2 \
  example-local-environment

Crea un entorno de Airflow local a partir de un entorno de Cloud Composer

Solo se toma la siguiente información de un entorno de Cloud Composer:

No se copian otros parámetros de información y configuración del entorno, como los archivos de DAG, el historial de ejecución de DAG, las variables de Airflow y las conexiones, de tu entorno de Cloud Composer.

Para crear un entorno de Airflow local a partir de un entorno de Cloud Composer existente, sigue estos pasos:

composer-dev create LOCAL_ENVIRONMENT_NAME \
    --from-source-environment ENVIRONMENT_NAME \
    --location LOCATION \
    --project PROJECT_ID \
    --port WEB_SERVER_PORT \
    --dags-path LOCAL_DAGS_PATH

Reemplaza lo siguiente:

  • LOCAL_ENVIRONMENT_NAME con un nombre para el entorno local de Airflow.
  • ENVIRONMENT_NAME por el nombre del entorno de Cloud Composer.
  • LOCATION con la región en la que se encuentra el entorno de Cloud Composer.
  • PROJECT_ID por el ID del proyecto.
  • WEB_SERVER_PORT con un puerto para el servidor web local de Airflow.
  • LOCAL_DAGS_PATH por una ruta de acceso a un directorio local donde se encuentran los DAG

Ejemplo:

composer-dev create example-local-environment \
  --from-source-environment example-environment \
  --location us-central1 \
  --project example-project \
  --port 8081 \
  --dags-path example_directory/dags

Cómo iniciar un entorno de Airflow local

Para iniciar un entorno de Airflow local, ejecuta lo siguiente:

composer-dev start LOCAL_ENVIRONMENT_NAME

Reemplaza lo siguiente:

  • LOCAL_ENVIRONMENT_NAME por el nombre de un entorno de Airflow local.

Detén o reinicia un entorno local de Airflow

Cuando reinicias un entorno de Airflow local, la herramienta de CLI de desarrollo local de Composer reinicia el contenedor de Docker en el que se ejecuta el entorno. Se detienen y vuelven a iniciarse todos los componentes de Airflow. Como resultado, todas las ejecuciones de DAG que se ejecutan durante un reinicio se marcan como fallidas .

Para reiniciar o iniciar un entorno de Airflow local detenido, ejecuta lo siguiente:

composer-dev restart LOCAL_ENVIRONMENT_NAME

Reemplaza lo siguiente:

  • LOCAL_ENVIRONMENT_NAME por el nombre de un entorno de Airflow local.

Para detener un entorno de Airflow local, ejecuta lo siguiente:

composer-dev stop LOCAL_ENVIRONMENT_NAME

Agregar y actualizar DAG

Los DAG se almacenan en el directorio que especificaste en el parámetro --dags-path cuando creaste tu entorno local de Airflow. De forma predeterminada, este directorio es ./composer/<local_environment_name>/dags. Puedes obtener el directorio que usa tu entorno con el comando describe.

Para agregar y actualizar DAG, cambia los archivos de este directorio. No necesitas reiniciar tu entorno de Airflow local.

Consulta los registros del entorno local de Airflow

Puedes ver los registros recientes de un contenedor de Docker que ejecuta tu entorno local de Airflow. De esta manera, puedes supervisar los eventos relacionados con el contenedor y verificar los registros de Airflow en busca de errores, como conflictos de dependencias causados por la instalación de paquetes de PyPI.

Para ver los registros de un contenedor de Docker que ejecuta tu entorno de Airflow local, ejecuta lo siguiente:

composer-dev logs LOCAL_ENVIRONMENT_NAME --max-lines 10

Para seguir el flujo de registro, omite el argumento --max-lines:

composer-dev logs LOCAL_ENVIRONMENT_NAME

Ejecuta un comando de la CLI de Airflow

Puedes ejecutar comandos de la CLI de Airflow en tu entorno local de Airflow.

Para ejecutar un comando de la CLI de Airflow, haz lo siguiente:

composer-dev run-airflow-cmd LOCAL_ENVIRONMENT_NAME \
  SUBCOMMAND SUBCOMMAND_ARGUMENTS

Ejemplo:

composer-dev run-airflow-cmd example-local-environment dags list -o table

Configura entornos de Airflow locales

La herramienta de CLI de desarrollo local de Composer almacena parámetros de configuración para un entorno de Airflow local, como las variables de entorno y los requisitos del paquete de PyPI, en el directorio del entorno local (./composer/<local_environment_name>).

La configuración se aplica cuando se inicia un entorno local de Airflow. Por ejemplo, si agregas requisitos de paquetes de PyPI en conflicto, la herramienta de línea de comandos de desarrollo local de Composer informará errores cuando inicies el entorno local.

Las conexiones de Airflow se almacenan en la base de datos del entorno local de Airflow. Para configurarlos, ejecuta un comando de la CLI de Airflow o almacena los parámetros de conexión en las variables de entorno. Para obtener más información sobre cómo crear y configurar conexiones, consulta Cómo administrar conexiones en la documentación de Airflow.

Obtén una lista y el estado de los entornos locales de Airflow

Para enumerar todos los entornos locales de Airflow disponibles y mostrar su estado, haz lo siguiente:

composer-dev list

Para describir un entorno específico y obtener detalles, como la versión de la imagen, la ruta de acceso de los DAG y la URL del servidor web de un entorno, sigue estos pasos:

composer-dev describe LOCAL_ENVIRONMENT_NAME

Reemplaza lo siguiente:

  • LOCAL_ENVIRONMENT_NAME por el nombre del entorno local de Airflow.

Lista de imágenes que usan los entornos de Airflow locales

Para obtener una lista de todas las imágenes que usa la herramienta de CLI de desarrollo local de Composer, ejecuta lo siguiente:

docker images --filter=reference='*/cloud-airflow-releaser/*/*'

Instala complementos y cambia datos

Los complementos y los datos de un entorno local de Airflow se toman del directorio del entorno local: ./composer/<local_environment_name>/data y ./composer/<local_environment_name>/plugins).

Para cambiar el contenido de los directorios /data y /plugins, agrega o quita archivos de estos directorios. Docker propaga automáticamente los cambios de archivo a tu entorno de Airflow local.

La herramienta de CLI de desarrollo local de Composer no admite la especificación de un directorio diferente para los datos y los complementos.

Configure las variables de entorno

Para configurar las variables de entorno, edita el archivo variables.env en el directorio del entorno: ./composer/<local_environment_name>/variables.env.

El archivo variables.env debe contener definiciones de pares clave-valor, una línea para cada variable de entorno. Para cambiar las opciones de configuración de Airflow, usa el formato AIRFLOW__SECTION__KEY. Para obtener más información sobre las variables de entorno disponibles, consulta la referencia de configuración de Airflow.

EXAMPLE_VARIABLE=True
ANOTHER_VARIABLE=test
AIRFLOW__WEBSERVER__DAG_DEFAULT_VIEW=graph

Para aplicar los cambios, reinicia tu entorno de Airflow local.

Instala o quita paquetes de PyPI

Para instalar o quitar paquetes de PyPI, modifica el archivo requirements.txt en el directorio del entorno: ./composer/<local_environment_name>/requirements.txt.

Los requisitos deben seguir el formato especificado en PEP-508, donde cada requisito se especifica en minúsculas y consta del nombre del paquete con extras opcionales y especificadores de versión.

Para aplicar los cambios, reinicia tu entorno de Airflow local.

Cómo cambiar a otra imagen de Cloud Composer

Puedes usar cualquier imagen de Cloud Composer con la herramienta de CLI de desarrollo local de Composer y cambiar entre las imágenes. Este enfoque es diferente de la actualización de tu entorno de Cloud Composer, ya que los parámetros de configuración de tu entorno de Airflow local se aplican cuando se inicia.

Por ejemplo, después de que se lance una nueva versión de Cloud Composer, puedes cambiar tu entorno para usar la nueva versión y mantener la configuración existente del entorno local de Airflow. Como otro ejemplo, puedes cambiar entre diferentes versiones de Airflow dentro de una versión específica de Cloud Composer.

Para cambiar la imagen del entorno que usa tu entorno de Airflow local, sigue estos pasos:

  1. Edita el archivo de configuración del entorno local: ./composer/<local_environment_name>/config.json.

  2. Cambia el valor del parámetro composer_image_version. Para ver los valores disponibles, puedes enumerar las versiones de Cloud Composer disponibles.

  3. Para aplicar los cambios, reinicia tu entorno de Airflow local.

Cómo borrar un entorno de Airflow local

Precaución: Asegúrate de haber guardado todos los datos necesarios del entorno, como los registros y la configuración.

Para borrar un entorno local de Airflow, ejecuta el siguiente comando:

composer-dev remove LOCAL_ENVIRONMENT_NAME

Si el entorno se está ejecutando, agrega la marca --force para forzar su eliminación.

Borra imágenes de Docker

Para borrar todas las imágenes que descargó la herramienta de CLI de Local Development de Composer, ejecuta lo siguiente:

docker rmi $(docker images --filter=reference='*/cloud-airflow-releaser/*/*' -q)

Soluciona problemas

En esta sección, se proporcionan soluciones a problemas habituales.

No se puede iniciar un entorno local en macOS

Si instalaste el paquete composer-dev en un directorio al que Docker no puede acceder, es posible que no se inicie tu entorno local.

Por ejemplo, si Python está instalado en el directorio /opt, como cuando lo instalas con la configuración predeterminada de Homebrew en MacOS, el paquete composer-dev también se instala en el directorio /opt. Debido a que Docker cumple con las reglas de la zona de pruebas de Apple, el directorio /opt no está disponible de forma predeterminada. Además, no puedes agregarlo a través de la IU (Configuración > Recursos > Uso compartido de archivos).

En este caso, la herramienta de CLI de desarrollo local de Composer genera un mensaje de error similar al siguiente ejemplo:

Failed to create container with an error: 400 Client Error for ...
Bad Request ("invalid mount config for type "bind": bind source path does not exist:
/opt/homebrew/lib/python3.9/site-packages/composer_local_dev/docker_files/entrypoint.sh

Possible reason is that composer-dev was installed in the path that is
not available to Docker. See...")

Puedes usar una de las siguientes soluciones:

  • Instala Python o el paquete composer-dev en un directorio diferente para que Docker pueda acceder al paquete.
  • Edita el archivo ~/Library/Group\ Containers/group.com.docker/settings.json de forma manual y agrega /opt a filesharingDirectories.

¿Qué sigue?