Instala las dependencias de Python para Cloud Composer

Cloud Composer 1 | Cloud Composer 2

En esta página, se describe cómo instalar paquetes de Python para tu entorno de Cloud Composer.

Acerca de los paquetes de PyPI preinstalados y personalizados en imágenes de Cloud Composer

Las imágenes de Cloud Composer contienen paquetes de PyPI preinstalados y personalizados.

• Los paquetes de PyPI preinstalados son paquetes que se incluyen en la imagen de Cloud Composer de tu entorno. Cada imagen de Cloud Composer contiene paquetes de PyPI que son específicos para tu versión de Cloud Composer y Airflow.

• Los paquetes personalizados de PyPI son paquetes que puedes instalar en tu entorno además de los paquetes preinstalados.

Nota: Si planeas actualizar a una versión posterior de Cloud Composer, puedes realizar una verificación de actualización. Esta verificación informa si los paquetes personalizados de PyPI de tu entorno tienen algún conflicto con los paquetes preinstalados en la nueva imagen de Cloud Composer.

Opciones para administrar paquetes de PyPI en entornos de Cloud Composer

Opción	Usar si
Instalar desde PyPI	La forma predeterminada de instalar paquetes en tu entorno
Realiza la instalación desde un repositorio con una dirección IP pública	El paquete está alojado en un repositorio de paquetes distinto de PyPI. Este repositorio tiene una dirección IP pública
Realiza la instalación desde un repositorio de Artifact Registry	El paquete se aloja en un repositorio de Artifact Registry.
Realiza la instalación desde un repositorio en la red de tu proyecto	Tu entorno no tiene acceso a la Internet pública. El paquete se aloja en un repositorio de paquetes en la red de tu proyecto.
Instalar como biblioteca local de Python	No se puede encontrar el paquete en PyPI y la biblioteca no tiene dependencias externas, como dist-packages.
Instala un complemento	El paquete proporciona una funcionalidad específica del complemento, como la modificación de la interfaz web de Airflow.
PythonVirtualenvOperator	No quieres que el paquete se instale para todos los trabajadores de Airflow o la dependencia entra en conflicto con los paquetes preinstalados. El paquete se puede encontrar en PyPI y no tiene dependencias externas.
KubernetesPodOperator y operadores GKE	Necesitas dependencias externas que no se pueden instalar desde pip, como dist-packages, o que están en un servidor pip interno. Esta opción requiere más configuración y mantenimiento. Considéralo solo si otras opciones no funcionan.

Antes de comenzar

• Debes tener una función que pueda activar las operaciones de actualización del entorno. Además, la cuenta de servicio del entorno debe tener una función que tenga suficientes permisos para realizar operaciones de actualización. Para obtener más información, consulta Control de acceso.
• Si tu entorno está protegido por un perímetro de Controles del servicio de VPC, antes de instalar dependencias de PyPI, debes otorgar identidades de usuario adicionales con acceso a los servicios que protege el perímetro de servicio y habilitar la compatibilidad con un repositorio privado de PyPI.
• 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.

• Las actualizaciones de dependencias de PyPI generan imágenes de Docker en Artifact Registry.

  Advertencia: No modifiques ni borres las imágenes que compiló Cloud Composer en Artifact Registry ni en el repositorio. No subas tus propias imágenes al repositorio. En su lugar, crea y mantén tu propio repositorio para tus imágenes (por ejemplo, para las imágenes que usa KubernetesPodOperator). No borres este repositorio por tu cuenta. El repositorio se borra después de borrar el entorno.

• Si un conflicto de dependencia hace que la actualización falle, tu entorno continuará ejecutándose con las dependencias existentes. Si la operación tiene éxito, puedes comenzar a usar las dependencias de Python recién instaladas en tus DAG.

Visualiza la lista de paquetes de PyPI

Puedes obtener la lista de paquetes para tu entorno en varios formatos.

Ver paquetes preinstalados

Si deseas ver la lista de paquetes preinstalados de tu entorno, consulta la lista de paquetes de la imagen de Cloud Composer de tu entorno.

Ver todos los paquetes

Para ver todos los paquetes (preinstalados y personalizados) en tu entorno:

gcloud

El siguiente comando de gcloud CLI muestra el resultado del comando python -m pip list para un trabajador de Airflow en tu entorno. Puedes usar el argumento --tree para obtener el resultado del comando python -m pipdeptree --warn.

gcloud beta composer environments list-packages \
    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

Ver paquetes personalizados de PyPI

Console

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

   Ir a Entornos

2. En la lista de entornos, haz clic en el nombre de tu entorno. Se abrirá la página Detalles del entorno.

3. Ve a la pestaña PyPI Packages.

gcloud

gcloud composer environments describe ENVIRONMENT_NAME \
  --location LOCATION \
  --format="value(config.softwareConfig.pypiPackages)"

Reemplaza lo siguiente:

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

Instala paquetes personalizados en un entorno de Cloud Composer

En esta sección, se describen diferentes métodos para instalar paquetes personalizados en tu entorno.

Instala paquetes desde PyPI

Se puede instalar un paquete desde el Índice de paquetes de Python si no tiene dependencias externas o si hay conflictos con paquetes preinstalados.

Nota: Puedes disminuir las restricciones de la versión para los paquetes de PyPI personalizados instalados. Por ejemplo, en lugar de especificar una versión como ==1.0.1, especifícala como >=1.0.1.

Haz lo siguiente para agregar, actualizar o borrar las dependencias de Python de tu entorno:

Console

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

   Ir a Entornos

2. En la lista de entornos, haz clic en el nombre de tu entorno. Se abrirá la página Detalles del entorno.

3. Ve a la pestaña Paquetes de PyPI.

4. Haz clic en Editar.

5. Haz clic en Agregar paquete.

6. En la sección Paquetes de PyPI, especifica los nombres de los paquetes con especificadores de versión y extras opcionales.

   Por ejemplo:

   • scikit-learn
   • scipy, >=0.13.3
   • nltk, [machine_learning]

7. Haz clic en Guardar.

gcloud

gcloud CLI tiene varios acuerdos para trabajar con paquetes personalizados de PyPI:

• --update-pypi-packages-from-file reemplaza todos los paquetes personalizados de PyPI existentes por los paquetes especificados. Se quitarán los paquetes que no especifiques.
• --update-pypi-package actualiza o instala un paquete.
• --remove-pypi-packages quita los paquetes especificados.
• --clear-pypi-packages quita todos los paquetes.

Cómo instalar requisitos desde un archivo

El archivo requirements.txt debe tener cada especificador de requisitos en una línea separada.

Por ejemplo:

scipy>=0.13.3
scikit-learn
nltk[machine_learning]

Actualiza tu entorno y especifica el archivo requirements.txt en el argumento --update-pypi-packages-from-file.

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
     --update-pypi-packages-from-file requirements.txt

Reemplaza lo siguiente:

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

Cómo instalar un paquete

Actualiza tu entorno y especifica el paquete, la versión y los extras en el argumento --update-pypi-package.

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
     --update-pypi-package PACKAGE_NAMEEXTRAS_AND_VERSION

Reemplaza lo siguiente:

• ENVIRONMENT_NAME por el nombre del entorno.
• LOCATION por la región en la que se encuentra el entorno
• PACKAGE_NAME por el nombre del paquete
• EXTRAS_AND_VERSION con la versión opcional y el especificador de extras Para omitir versiones y extras, especifica un valor vacío.

Nota: Según tu entorno de ejecución, es posible que debas escapar caracteres especiales como >. Para evitar posibles problemas, escribe el nombre y la versión del paquete entre comillas, por ejemplo: "scipy>=0.13.0".

Ejemplo:

gcloud composer environments update example-environment \
    --location us-central1 \
    --update-pypi-package "scipy>=0.13.3"

Cómo quitar paquetes

Actualiza tu entorno y especifica los paquetes que deseas borrar en el argumento --remove-pypi-packages:

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
     --remove-pypi-packages PACKAGE_NAMES

Reemplaza lo siguiente:

• ENVIRONMENT_NAME por el nombre del entorno.
• LOCATION por la región en la que se encuentra el entorno
• PACKAGE_NAMES por una lista de paquetes separados por comas.

Ejemplo:

gcloud composer environments update example-environment \
    --location us-central1 \
    --remove-pypi-packages scipy,scikit-learn

API

Realiza una solicitud a la API de environments.patch.

En esta solicitud, realiza lo siguiente:

1. En el parámetro updateMask, especifica la máscara:

   • Usa la máscara config.softwareConfig.pypiPackages para reemplazar todos los paquetes existentes con los paquetes especificados. Los paquetes que no especifiques se borrarán.
   • Usa config.softwareConfig.envVariables.PACKAGE_NAME para agregar o actualizar un paquete específico. Para agregar o actualizar varios paquetes, especifica varias máscaras con comas.

2. En el cuerpo de la solicitud, especifica los paquetes y valores para las versiones y los extras:

   {
     "config": {
       "softwareConfig": {
         "pypiPackages": {
           "PACKAGE_NAME": "EXTRAS_AND_VERSION"
         }
       }
     }
   }
   

   Reemplaza lo siguiente:

   • PACKAGE_NAME por el nombre del paquete
   • EXTRAS_AND_VERSION con la versión opcional y el especificador de extras Para omitir versiones y extras, especifica un valor vacío.
   • Si quieres agregar más de un paquete, agrega entradas adicionales para los paquetes a pypiPackages.

Ejemplo:

// PATCH https://composer.googleapis.com/v1/projects/example-project/
// locations/us-central1/environments/example-environment?updateMask=
// config.softwareConfig.pypiPackages.EXAMPLE_PACKAGE,
// config.softwareConfig.pypiPackages.ANOTHER_PACKAGE
{
  "config": {
    "softwareConfig": {
      "pypiPackages": {
        "EXAMPLE_PACKAGE": "",
        "ANOTHER_PACKAGE": ">=1.10.3"
      }
    }
  }
}

Terraform

El bloque pypi_packages del bloque software_config especifica los paquetes.

resource "google_composer_environment" "example" {
  name = "ENVIRONMENT_NAME"
  region = "LOCATION"

  config {

    software_config {

      pypi_packages = {
          PACKAGE_NAME = "EXTRAS_AND_VERSION"
      }

    }
  }
}

Reemplaza lo siguiente:

• ENVIRONMENT_NAME por el nombre del entorno.
• LOCATION por la región en la que se encuentra el entorno
• PACKAGE_NAME por el nombre del paquete
• EXTRAS_AND_VERSION con la versión opcional y el especificador de extras Para omitir versiones y extras, especifica un valor vacío.
• Si quieres agregar más de un paquete, agrega entradas adicionales para los paquetes a pypi_packages.

Ejemplo:

resource "google_composer_environment" "example" {
  name = "example-environment"
  region = "us-central1"

  config {

    software_config {
      pypi_packages = {
          scipy = ">=1.10.3"
          scikit-learn = ""
          nltk = "[machine_learning]"
      }
    }
  }
}

Instala paquetes desde un repositorio público

Puedes instalar paquetes alojados en otros repositorios que tengan una dirección IP pública.

Los paquetes deben estar configurados de forma correcta para que la herramienta pip predeterminada pueda instalarlos.

Nota: Cloud Composer no admite la personalización de pip y no resuelve dependencias y conflictos de paquetes fuera de los mecanismos de resolución que proporciona la herramienta pip predeterminada.

Para realizar la instalación desde un repositorio de paquetes que tiene una dirección pública, sigue estos pasos:

1. Crea un archivo pip.conf e incluye la siguiente información en él, si corresponde:

   • URL del repositorio
   • Credenciales de acceso del repositorio
   • Opciones de instalación de pip no predeterminadas

   Ejemplo:

   [global]
   index-url=https://example.com/
   

   Si deseas recuperar paquetes de varios repositorios, usa un repositorio virtual de Artifact Registry para controlar el orden en que pip busca en tus repositorios.

2. Determina el URI del bucket de tu entorno.

3. Sube el archivo pip.conf a la carpeta /config/pip/ en el bucket de tu entorno.

4. Instala paquetes usando uno de los métodos disponibles.

Instala paquetes desde un repositorio de Artifact Registry

Puedes almacenar paquetes en un repositorio de Artifact Registry en tu proyecto y configurar el entorno para que se instale desde él.

Nota: Si usas los Controles del servicio de VPC, puedes crear el repositorio de PyPI de Artifact Registry en el modo de VPC. En este caso, sigue el procedimiento para repositorios privados cuando asignes permisos.

Configura roles y permisos:

1. La cuenta de servicio de tu entorno debe tener la función iam.serviceAccountUser.

2. Asegúrate de que la cuenta de servicio de Cloud Build tenga permisos para leer desde tu repositorio de Artifact Registry.

3. Si el entorno tiene acceso restringido a otros servicios del proyecto, por ejemplo, si usas los Controles del servicio de VPC, haz lo siguiente:

   1. Asigna permisos para acceder a tu repositorio de Artifact Registry a la cuenta de servicio del entorno, en lugar de a la cuenta de servicio de Cloud Build.

   2. Asegúrate de que la conectividad con el repositorio de Artifact Registry esté configurada en tu proyecto.

Sigue estos pasos para instalar paquetes personalizados de PyPI desde un repositorio de Artifact Registry:

1. Crea un archivo pip.conf e incluye la siguiente información en él, si corresponde:

   • URL del repositorio de Artifact Registry
   • Credenciales de acceso del repositorio
   • Opciones de instalación de pip no predeterminadas
   • Si solo deseas usar tu repositorio de Artifact Registry como fuente de paquetes, vuelve a definir el parámetro index-url. De lo contrario, el repositorio que especificas en el parámetro extra-index-url se usa además del índice del paquete de PyPI predeterminado (pypi.python.org).

   Para un repositorio de Artifact Registry, agrega /simple/ a la URL del repositorio:

   [global]
   extra-index-url = https://us-central1-python.pkg.dev/example-project/example-repository/simple/
   

2. Sube este archivo pip.conf a la carpeta /config/pip/ en el bucket de tu entorno. Por ejemplo: gs://us-central1-example-bucket/config/pip/pip.conf.

3. Instala paquetes usando uno de los métodos disponibles.

Instala paquetes desde un repositorio privado

Puedes alojar un repositorio privado en la red de tu proyecto y configurar tu entorno para instalar paquetes de Python desde él.

Configura roles y permisos:

1. La cuenta de servicio de tu entorno de Cloud Composer debe tener la función iam.serviceAccountUser.

2. Si instalas paquetes de PyPI personalizados desde un repositorio en la red de tu proyecto y este repositorio no tiene una dirección IP pública, sigue estos pasos:

   1. Asigna permisos para acceder a este repositorio a la cuenta de servicio del entorno.

   2. Asegúrate de que la conectividad a este repositorio esté configurada en tu proyecto.

Para instalar paquetes desde un repositorio privado alojado en la red de tu proyecto, haz lo siguiente:

1. Crea un archivo pip.conf e incluye la siguiente información en él, si corresponde:

   • Dirección IP del repositorio en la red de tu proyecto
   • Credenciales de acceso del repositorio
   • Opciones de instalación de pip no predeterminadas

   Ejemplo:

   [global]
   extra-index-url=https://192.0.2.10/
   

2. Sube el archivo pip.conf a la carpeta /config/pip/ en el bucket de tu entorno. Por ejemplo: gs://us-central1-example-bucket/config/pip/pip.conf.

3. Instala paquetes usando uno de los métodos disponibles.

Instala una biblioteca local de Python

Para instalar una biblioteca interna o local de Python, sigue estos pasos:

1. Coloca las dependencias dentro de un subdirectorio en la carpeta dags/ del bucket de tu entorno. Para importar un módulo desde un subdirectorio, cada subdirectorio de la ruta de acceso del módulo debe contener un archivo de marcador de paquete __init__.py.

   En el siguiente ejemplo, la dependencia es coin_module.py:

   dags/
     use_local_deps.py  # A DAG file.
     dependencies/
       __init__.py
       coin_module.py
   

2. Importa la dependencia desde el archivo de definición de DAG.

   Por ejemplo:

from dependencies import coin_module

Nota: Se produce un error de importación si falta un archivo __init__.py. Los nombres del directorio y el archivo deben ser identificadores válidos de Python.

Usa paquetes que dependan de bibliotecas de objetos compartidos

Algunos paquetes de PyPI dependen de las bibliotecas a nivel del sistema. Si bien Cloud Composer no es compatible con las bibliotecas del sistema, puedes usar las siguientes opciones:

• Utiliza KubernetesPodOperator. Configura la imagen del operador como una imagen de compilación personalizada. Si encuentras paquetes que fallan durante la instalación debido a una dependencia no satisfecha del sistema, usa esta opción.

• Sube las bibliotecas de objetos compartidos al bucket de tu entorno. Si tus paquetes de PyPI se instalaron correctamente, pero fallan en el entorno de ejecución, usa esta opción.

  1. Busca de forma manual las bibliotecas de objetos compartidos para la dependencia de PyPI (un archivo .so).
  2. Sube las bibliotecas de objetos compartidos a la carpeta /plugins en el bucket de tu entorno.
  3. Configura la siguiente variable de entorno: LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/home/airflow/gcs/plugins

Nota: Los archivos de las carpetas plugins/ se sincronizan con el sistema de archivos local. Subir archivos .so grandes puede afectar el rendimiento del entorno y del servidor web de Airflow.

Instala paquetes en entornos de IP privadas

En esta sección, se explica cómo instalar paquetes en entornos de IP privada.

Según cómo configures tu proyecto, es posible que tu entorno no tenga acceso a la Internet pública.

Entorno de IP privada con acceso público a Internet

Si tu entorno de IP privada puede acceder a la Internet pública, puedes instalar paquetes mediante las opciones para entornos de IP públicas:

• Instalar desde PyPI. En este caso, no se requiere una configuración especial. Sigue el procedimiento que se describe en Instala un paquete desde PyPI.
• Realizar la instalación desde un repositorio con una dirección IP pública Sigue el procedimiento que se describe en Instala un paquete desde un repositorio privado.
• Realiza la instalación desde un repositorio privado de PyPI alojado en la red de tu proyecto.

Entorno de IP privada sin acceso a Internet

Si tu entorno de IP privada no tiene acceso a la Internet pública, puedes instalar paquetes de una de las siguientes maneras:

• Usa un repositorio privado de PyPI alojado en la red de tu proyecto.
• Usa una VM de servidor proxy en la red de tu proyecto para conectarte a un repositorio de PyPI en la Internet pública. Especifica la dirección del proxy en el archivo /config/pip/pip.conf del bucket de tu entorno.
• Usa un repositorio de Artifact Registry como la única fuente de paquetes. Para hacerlo, vuelve a definir el parámetro index-url, como se describe.
• Si tu política de seguridad permite el acceso a direcciones IP externas desde tu red de VPC, puedes habilitar la instalación de paquetes de repositorios en la Internet pública mediante la configuración de Cloud NAT.
• Coloca las dependencias de Python en la carpeta /dags en el bucket de tu entorno para instalarlas como bibliotecas locales. Esta podría no ser una buena opción si el árbol de dependencias es grande.

Instala en un entorno de IP privada con restricciones de ubicación de recursos

Mantener tu proyecto en línea con los requisitos de restricción de ubicación de recursos prohíbe el uso de algunas herramientas. En particular, Cloud Build no se puede usar para la instalación de paquetes, lo que evita el acceso directo a los repositorios en la Internet pública.

Si quieres instalar dependencias de Python en ese entorno, sigue las instrucciones para entornos de IP privados sin acceso a Internet.

Instala una dependencia de Python para un entorno de IP privada en un perímetro de Controles del servicio de VPC

La protección del proyecto con un perímetro de los Controles del servicio de VPC genera más restricciones de seguridad. En particular, Cloud Build no se puede usar para la instalación de paquetes, lo que evita el acceso directo a los repositorios en la Internet pública.

Si quieres instalar dependencias de Python para un entorno de IP privada dentro de un perímetro, sigue las instrucciones para entornos de IP privadas sin acceso a Internet.

¿Qué sigue?

• Solución de problemas de instalación de paquetes
• Solución de problemas relacionados con actualizaciones y actualizaciones