Instalar complementos personalizados

Cloud Composer 1 | Cloud Composer 2

El administrador de complementos de Apache Airflow te permite escribir operadores internos, hooks, sensores o interfaces personalizados de Apache Airflow. Para obtener más información, consulta los complementos personalizados en la documentación de Airflow. En esta página, se describe cómo instalar los complementos personalizados en tu entorno de Cloud Composer.

Cuando creas un entorno, Cloud Composer crea un bucket de Cloud Storage y lo asocia a tu entorno. Usa la carpeta plugins en el bucket asociado para instalar los complementos personalizados.

Importante: En Cloud Composer 1, los complementos solo son compatibles con los entornos de Airflow 1 con serialización de DAG inhabilitada. Los complementos no son compatibles con los entornos de Cloud Composer 1 con Airflow 2.

Antes de comenzar

• Tu cuenta debe tener una función que permita ver y modificar el contenido del bucket de tu entorno.
• Este método de instalación solo se aplica a los complementos de Airflow. Por ejemplo, no puedes usar este método para instalar módulos comunes de Python ni otras bibliotecas.
• Los complementos deben cumplir con los lineamientos de la plantilla de complementos de Airflow.

Instala un complemento

Para instalar un complemento personalizado en tu entorno de Cloud Composer, copia el código del complemento en la carpeta plugins del bucket de Cloud Storage conectado a tu entorno de Cloud Composer.

Para instalar un complemento, haz lo siguiente:

Consola

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

   Ir a Entornos

2. Busca tu entorno y sigue el vínculo de los DAG.

3. Sube un nivel de la carpeta y, luego, navega hacia la carpeta plugins/.

4. Sube los archivos de complementos. Para obtener más información sobre cómo subir objetos, consulta Sube objetos.

gcloud

Usa el siguiente comando de gcloud:

gcloud composer environments storage plugins import \
    --environment ENVIRONMENT_NAME \
    --location LOCATION \
    --source PATH_TO_LOCAL_FILE \
    --destination PATH_IN_SUBFOLDER

Reemplaza lo siguiente:

• ENVIRONMENT_NAME por el nombre del entorno.
• LOCATION por la región en la que se encuentra el entorno
• PATH_TO_LOCAL_FILE por la ruta del archivo que se va a subir.
• PATH_IN_SUBFOLDER por la ruta de la subcarpeta (opcional). Usa el argumento --destination para subir un complemento a una subcarpeta de la carpeta plugins. De lo contrario, omite el argumento --destination.

Visualiza una lista de complementos

Consola

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

   Ir a Entornos

2. Busca tu entorno y sigue el vínculo de los DAG.

3. Sube un nivel de la carpeta y, luego, navega hacia la carpeta plugins/.

4. Visualiza los archivos del complemento.

gcloud

Usa el siguiente comando de gcloud:

gcloud composer environments storage plugins list \
    --environment ENVIRONMENT_NAME \
    --location LOCATION

Reemplaza lo siguiente:

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

Borra un complemento

Para borrar un complemento de tu entorno de Cloud Composer, borra el código del complemento de la carpeta plugins en el bucket del entorno.

Para borrar un complemento, haz lo siguiente:

Consola

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

   Ir a Entornos

2. Busca tu entorno y sigue el vínculo de los DAG.

3. Sube un nivel de la carpeta y, luego, navega hacia la carpeta plugins/.

4. Borra los archivos del complemento. Para obtener más información sobre cómo borrar objetos, consulta Borra objetos.

gcloud

Usa el siguiente comando de gcloud:

gcloud composer environments storage plugins delete \
    --environment ENVIRONMENT_NAME \
    --location LOCATION \
    PLUGIN_TO_DELETE

Descarga complementos

Para descargar complementos, elige una opción:

Consola

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

   Ir a Entornos

2. Busca tu entorno y sigue el vínculo de los DAG.

3. Sube un nivel de la carpeta y, luego, navega hacia la carpeta plugins/.

4. Descarga los archivos del complemento. Para obtener más información sobre cómo borrar objetos, consulta Descarga objetos.

gcloud

Usa el siguiente comando de gcloud:

gcloud composer environments storage plugins export \
  --environment ENVIRONMENT_NAME \
  --location LOCATION \
  --destination PATH_TO_LOCAL_DESTINATION \
  --source PATH_IN_FOLDER

Reemplaza lo siguiente:

• ENVIRONMENT_NAME por el nombre del entorno.
• LOCATION por la región en la que se encuentra el entorno
• PATH_TO_LOCAL_DESTINATION por el destino del archivo descargado
• --source es una opción para descargar solo un complemento. PATH_IN_FOLDER es la ruta de la carpeta.

Solución de problemas relacionados con complementos

Un complemento recién subido no es visible en la IU de Airflow

Si usas el control de acceso a la IU de Airflow, es posible que el complemento recién subido no sea visible en la IU de Airflow. Para solucionar este problema, pídele al administrador de la IU de Airflow que configure el acceso al complemento recién subido o que te asigne la función Admin en la IU de Airflow.

¿Qué sigue?

• Datos almacenados en Cloud Storage
• Administrar DAG